Group Types
A group type is a category that can be used by administrators to keep track of various areas of ministry.
Notes ::
- By passing in the
content-type
ofapplication/help
in theaccept
header or using the {format} parameterhelp
from https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes, the API will return an html representation of the help documents for this resource (*authentication not required*)
Authentication
This method requires Authentication
Resource Structure
This resource conforms to the following XSD
Methods
Group Types ::
- search [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/search?{parameters}
- list [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes
- show [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/{id}
Method: search [GET]
The search
method will return a collection of grouptypes
for the parameters
provided.
Notes ::
- Search by Group Type name: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/search?searchfor=My%20Group%20Type
- All values passed in via searchFor must be url encoded (ex. My Group Type needs to be My%20Group%20Type)
- Search by IsSearchable: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/search?issearchable=true
- Will return all group types that are marked as searchable in Portal.
- By passing in the
content-type
ofapplication/xsd
in theaccept
header or using the {format} parameterxsd
the API will return anxsd
for a single version of this resource (authentication not required)
Content-types ::
- application/json
- application/xml
- application/xsd
- application/help
Format ::
- json
- xml
- xsd
- help
Parameters ::
{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/search.{format}?{search parameters}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/search?format={format}&{search parameters}
- [Header] Accept : {Content-type}
{search parameters}
- searchFor = Name of the group type you are searching for
- isSearchable = include group types that are marked as searchable. *ex. isSearchable=true
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/search?searchFor=Test
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/search&searchFor=test
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 14 Apr 2010 19:03:54 GMT
Content-Length: 1011
<?xml version="1.0" encoding="utf-8"?>
<groupTypes count="2" pageNumber="1" totalRecords="2" additionalPages="0">
<groupType json:Array="true" id="6" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/6">
<name>Test GT</name>
<description></description>
<isWebEnabled>false</isWebEnabled>
<isSearchable>false</isSearchable>
<createdDate>2007-10-17T07:04:47</createdDate>
<createdByPerson id="1632371" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1632371" />
<lastUpdatedDate>2010-11-05T14:50:17</lastUpdatedDate>
<lastUpdatedByPerson id="" uri="" />
</groupType>
<groupType json:Array="true" id="6598" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/6598">
<name>This is a test from MAH</name>
<description>MAH</description>
...
</groupType>
</groupTypes>
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/search.json?searchFor=Test
Response:
{
"groupTypes":{
"@count":"2",
"@pageNumber":"1",
"@totalRecords":"2",
"@additionalPages":"0",
"groupType":[
{
"@array":"true",
"@id":"6",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/6",
"name":"Test GT",
"description":null,
"isWebEnabled":"false",
"isSearchable":"false",
"createdDate":"2007-10-17T07:04:47",
"createdByPerson":{
"@id":"1632371",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1632371"
},
"lastUpdatedDate":"2010-11-05T14:50:17",
"lastUpdatedByPerson":{
"@id":"",
"@uri":""
}
},
{
"@array":"true",
"@id":"6598",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/6598",
"name":"This is a test from MAH",
"description":"MAH",
"isWebEnabled":"false",
"isSearchable":"false",
"createdDate":"2010-03-22T10:36:53",
"createdByPerson":{
"@id":"11168465",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/11168465"
},
"lastUpdatedDate":"2010-11-05T14:50:17",
"lastUpdatedByPerson":{
"@id":"11168465",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/11168465"
}
}
]
}
}
Method: list [GET]
The list
method will return a list of group types.
Notes ::
- By passing in the
content-type
ofapplication/xsd
in theaccept
header or using the {format} parameterxsd
the API will return anxsd
for a single version of this resource (authentication not required)
Content-types ::
- application/json
- application/xml
- application/xsd
- application/help
Format ::
- json
- xml
- xsd
- help
Parameters ::
- {format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes?format={format}
- [Header] Accept : {Content-type}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 14 Apr 2010 19:03:54 GMT
Content-Length: 1011
<?xml version="1.0" encoding="utf-8"?>
<groupTypes>
<groupType json:Array="true" id="6" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/6">
<name>Test GT</name>
<description></description>
<isWebenabled>false</isWebenabled>
<isSearchable>false</isSearchable>
<createdDate>2007-10-17T07:04:47</createdDate>
<createdByPerson id="1632371" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1632371" />
<lastUpdatedDate></lastUpdatedDate><lastUpdatedByPerson id="" uri="" />
</groupType>
<groupType json:Array="true" id="7" uri=https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/7">
<name>Home Team</name>
<description></description>
...
</groupType>
</groupTypes>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 02 Nov 2010 20:38:35 GMT
Content-Length: 5384
{
"groupTypes":{
"groupType":[
{
"@array":"true",
"@id":"2450",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/2450",
"name":"Awannas",
"description":"fdsfsd",
"isWebEnabled":"false",
"isSearchable":"false",
"createdDate":"2008-09-25T12:57:19",
"createdByPerson":{
"@id":"1999191",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1999191"
},
"lastUpdatedDate":"2010-11-05T14:50:17",
"lastUpdatedByPerson":{
"@id":"",
"@uri":""
}
},
{
"@array":"true",
"@id":"2437",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/2437",
...
}
]
}
}
Method: show [GET]
The show
method will return a single grouptype
for a given id
.
Notes ::
- By passing in the
content-type
ofapplication/xsd
in theaccept
header or using the {format} parameterxsd
the API will return anxsd
for a single version of this resource (authentication not required)
Content-types ::
- application/json
- application/xml
- application/xsd
- application/help
Format ::
- json
- xml
- xsd
- help
Parameters ::
- {format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/{id}.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/{id}?format={format}
- [Header] Accept : {Content-type}
- {id}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/{id}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/6
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/6
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 14 Apr 2010 19:09:54 GMT
Content-Length: 176
<groupType json:Array="true" id="6" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/6">
<name>Test GT</name>
<description></description>
<isWebenabled>false</isWebenabled>
<isSearchable>false</isSearchable>
<createdDate>2007-10-17T07:04:47</createdDate>
<createdByPerson id="1632371" uri="{{CONSUMER_ROOT_DOMAIN}}/people/1632371" />
<lastUpdatedDate></lastUpdatedDate>
<lastUpdatedByPerson id="" uri="" />
</groupType>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/6.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptypes/6.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 14 Apr 2010 19:10:42 GMT
Content-Length: 119
{
"groupType":{
"@id":"6",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/grouptype/6",
"name":"Test GT",
"description":null,
"isWebEnabled":"false",
"isSearchable":"false",
"createdDate":"2007-10-17T07:04:47",
"createdByPerson":{
"@id":"1632371",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/1632371"
},
"lastUpdatedDate":"2010-11-05T14:50:17",
"lastUpdatedByPerson":{
"@id":"",
"@uri":""
}
}
}