Sub Statuses
A sub status or collection of sub statuses are used for people
.
Authentication
This method requires Authentication
Resource Structure
This resource conforms to the following XSD
Methods
Statuses ::
- list [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/{statusID}/SubStatuses
- show [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/{statusID}/SubStatuses/{id}
Method: list [GET]
The list
method will return a list of sub statuses.
Notes ::
list
andshow
are the only available methods for this resource; this resource cannot be updated via the API- By passing in the
content-type
ofapplication/help
in theaccept
header or using the {format} parameterhelp
the API will return an html representation of the help documents for this resource (authentication not required)
Content-types ::
- application/json
- application/xml
- application/help
Format ::
- json
- xml
- help
Parameters ::
- {format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/{statusID}/SubStatuses.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/{statusID}/SubStatuses?format={format}
- [Header] Accept : {Content-type}
- {statusID}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/{statusID}/SubStatuses
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Sun, 12 Apr 2009 05:48:42 GMT
Content-Length: 308
<?xml version="1.0" encoding="utf-8"?>
<subStatuses>
<subStatus id="400" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/400">
<name>Letter</name>
</subStatus>
<subStatus id="4182" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/4182">
<name>Dismember22</name>
</subStatus>
</subStatuses>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 18:55:48 GMT
Content-Length: 284
{
"subStatuses": {
"subStatus": [
{
"@array": "true",
"@id": "400",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/400",
"name": "Letter"
},
{
"@array": "true",
"@id": "4182",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/4182",
"name": "Dismember22"
}
]
}
}
Method: show [GET]
The show
method will return a single sub status for a given id
.
Notes ::
list
andshow
are the only available methods on this resource; this resource cannot be updated via the API- 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
Format ::
- json
- xml
- xsd
Parameters ::
- {format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/{statusID}/SubStatuses/{id}.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/{statusID}/SubStatuses/{id}?format={format}
- [Header] Accept : {Content-type}
- {statusID}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/{statusID}/SubStatuses/{id}
- {id}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/{statusID}/SubStatuses/{id}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/400
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/400
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Sun, 12 Apr 2009 05:50:29 GMT
Content-Length: 152
<?xml version="1.0" encoding="utf-8"?>
<subStatus id="400" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/400">
<name>Letter</name>
</subStatus>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/400.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/400.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 18:56:49 GMT
Content-Length: 120
{
"subStatus": {
"@id": "400",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/400",
"name": "Letter"
}
}