Fellowship One REST API

API Index | Authentication | HTTP Status Codes | HTTP Headers | Single Sign On Client Implementation | Single Sign On Host Implementation

Requirement Statuses

A requirement type 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/requirementStatuses
• show [GET] https://churchcode.fellowshiponeapi.com/v1/requirements/requirementStatuses/{id}

Method: list [GET]

The list method will return a list of requirementStatuses for the church.

Notes ::

• By passing in the content-type of application/xsd in the accept header or using the {format} parameter xsd the API will return an xsd 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/requirementStatuses.{format}
• [GET] https://churchcode.fellowshiponeapi.com/v1/requirements/requirementStatuses?format={format}
• [Header] Accept : {Content-type}

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/requirements/requirementStatuses

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://churchcode.fellowshiponeapi.com/v1/requirements/requirementStatuses
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"?>
<requirementStatuses>
	<requirementStatus json:Array="true" id="1" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/1">
		<name>Pending</name>
	</requirementStatus>
	<requirementStatus json:Array="true" id="2" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/2">
		...	
</requirementStatuses>

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/requirements/requirementStatuses.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/requirementStatuses.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

{
   "requirementStatuses":{
	  "requirementStatus":[
		 {
			"@id":"1",
			"@uri":"https://churchcode.fellowshiponeapi.com/v1/requirements/requirementStatuses/1",
			"name":"Pending"
		 },
		 ...
	  ]
   }
}

Method: show [GET]

The show keyword will return a single requirementStatus with the given id.

Notes ::

• By passing in the content-type of application/xsd in the accept header or using the {format} parameter xsd the API will return an xsd 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/requirementStatuses/{id}.{format}
• [GET] https://churchcode.fellowshiponeapi.com/v1/requirements/requirementStatuses/{id}?format={format}
• [Header] Accept : {Content-type}
• {id}
• [GET] https://churchcode.fellowshiponeapi.com/v1/requirements/requirementStatuses/{id}

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/requirements/requirementStatuses/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/requirementStatuses/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"?>
<requirementStatus id="1" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/1">
	<name>Pending</name>
</requirementStatus>

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/requirements/requirementStatuses/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/requirementStatuses/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

{
   "requirementStatus":{
	  "@id":"1",
	  "@uri":"https://churchcode.fellowshiponeapi.com/v1/requirements/requirementStatuses/1",
	  "name":"Pending"
   }
}