Member Types
A member type specifies the classification of a member of a group. A group members rights within InFellowship are determined by their member type.
Notes ::
- By passing in the
content-type
ofapplication/help
in theaccept
header or using the {format} parameterhelp
from https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes, 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
Member Types ::
- list [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes
- show [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes/{id}
Method: list [GET]
The list
method will return a list of member 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/membertypes.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes?format={format}
- [Header] Accept : {Content-type}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes
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"?>
<memberTypes>
<memberType json:Array="true" id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes/1">
<name>Leader</name>
<description></description>
<createdDate>2007-10-17T07:04:47</createdDate>
<createdByPerson id="0" uri="{{CONSUMER_ROOT_DOMAIN}}/people/0" />
<lastUpdatedDate></lastUpdatedDate><lastUpdatedByPerson id="" uri="" />
</memberType>
<memberType json:Array="true" id="2" uri=https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes/2">
<name>Member</name>
<description></description>
...
</memberType>
</memberTypes>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes.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/membertypes.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
{
"memberTypes":{
"memberType":[
{
"@array":"true",
"@id":"1",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes/1",
"name":"Leader",
"description":null,
"createdDate":"2007-10-17T07:04:47",
"createdByPerson": {
"@id":"0",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/0"
},
"lastUpdatedDate":null,
"lastUpdatedByPerson": {
"@id":"",
"@uri":""
}
},
{
"@array":"true",
"@id":"2",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes/2",
"name":"Member",
"description":null,
...
}
]
}
}
Method: show [GET]
The show
method will return a single member type
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/membertypes/{id}.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes/{id}?format={format}
- [Header] Accept : {Content-type}
- {id}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes/{id}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes/1
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes/1
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
<memberType json:Array="true" id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes/1">
<name>Leader</name>
<description></description>
<createdDate>2007-10-17T07:04:47</createdDate>
<createdByPerson id="0" uri="{{CONSUMER_ROOT_DOMAIN}}/people/0" />
<lastUpdatedDate></lastUpdatedDate>
<lastUpdatedByPerson id="" uri="" />
</memberType>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes/1.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/membertypes/1.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
{
"memberType":{
"@id":"1",
"@uri":https://CHURCHCODE.fellowshiponeapi.com/groups/v1/membertypes/1",
"name":"Leader",
"description":null,
"createdDate":"2007-10-17T07:04:47",
"createdByPerson": {
"@id":"0",
"@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/0"
},
"lastUpdatedDate":null,
"lastUpdatedByPerson": {
"@id":"",
"@uri":""
}
}
}