Background Check Statuses
A background specifies whether the requirement is for an Individual or an Activity.
Authentication
This method requires Authentication
Resource Structure
This resource conforms to the following XSD
Methods
Members ::
- list [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses
- show [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses/{id}
Method: list [GET]
The list
method will return a list of backgroundCheckStatuses
for the church.
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/v1/requirements/backgroundCheckStatuses.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses?format={format}
- [Header] Accept : {Content-type}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Mon, 06 Dec 2010 19:24:56 GMT
Content-Length: 4118
<?xml version="1.0" encoding="utf-8"?>
<backgroundCheckStatuses>
<backgroundCheckStatus json:Array="true" id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/1">
<name>Submitted</name>
</backgroundCheckStatus>
<backgroundCheckStatus json:Array="true" id="2" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/2">
<name>Accepted</name>
</backgroundCheckStatus>
...
</backgroundCheckStatuses>
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Mon, 06 Dec 2010 19:27:12 GMT
Content-Length: 3429
{
"backgroundCheckStatuses":{
"backgroundCheckStatus":[
{
"@id":"1",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses/1",
"name":"Submitted"
},
...
]
}
}
Method: show [GET]
The show
keyword will return a single backgroundCheckStatus
with the 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/v1/requirements/backgroundCheckStatuses/{id}.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses/{id}?format={format}
- [Header] Accept : {Content-type}
- {id}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses/{id}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses/1
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses/1
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 07 Dec 2010 16:24:43 GMT
Content-Length: 565
<?xml version="1.0" encoding="utf-8"?>
<backgroundCheckStatus id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/1">
<name>Submitted</name>
</backgroundCheckStatus>
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses/1.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses/1.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 07 Dec 2010 16:25:24 GMT
Content-Length: 478
{
"backgroundCheckStatus":{
"@id":"0",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/v1/requirements/backgroundCheckStatuses/1",
"name":"Submitted"
}
}