Requirements
A requirement defines an item that needs to be completed for volunteers or to track different stages of membership.
Authentication
This method requires Authentication
Requirements
This resource conforms to the following XSD
Methods
Requirements ::
- show [GET] https://demo.fellowshiponeapi.com/v1/Requirements/{id}
- new [GET] https://demo.fellowshiponeapi.com/v1/Requirements/New
- edit [GET] https://demo.fellowshiponeapi.com/v1/Requirements/{id}/Edit
- create [POST] https://demo.fellowshiponeapi.com/v1/Requirements
- update [PUT] [POST(Low REST)] https://demo.fellowshiponeapi.com/v1/Requirements/{id}
Method: list [GET]
The list
method will return a list of all requirements for a church.
Notes ::
- 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://demo.fellowshiponeapi.com/v1/Requirements.{format}
- [GET] https://demo.fellowshiponeapi.com/v1/Requirements?format={format}
- [Header] Accept : {Content-type}
Sample Response ::
Given: [GET] https://demo.fellowshiponeapi.com/v1/Requirements
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/requirements
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 30 May 2012 19:52:20 GMT
Content-Length: 12338
<?xml version="1.0" encoding="utf-8"?>
<requirements>
<requirement json:Array="true" id="350" uri="https://demo.fellowshiponeapi.com/v1/Requirements/350" oldID="252">
<name>Background Check</name>
<isActive>true</isActive>
<hasDocument>true</hasDocument>
<isConfidential>false</isConfidential>
<isBackgroundCheck>true</isBackgroundCheck>
<isReferenceCheck>false</isReferenceCheck>
<quantity>1</quantity>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</requirement>
<requirement json:Array="true" id="351" uri="https://demo.fellowshiponeapi.com/v1/Requirements/351" oldID="253">
...
</requirement>
</requirements>
Given: [GET] https://demo.fellowshiponeapi.com/v1/Requirements.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/requirements.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 30 May 2012 19:52:20 GMT
Content-Length: 8509
{
"requirements":{
"requirement":[
{
"@array":"true",
"@id":"350",
"@uri":"https://demo.fellowshiponeapi.com/v1/Requirements/350",
"@oldID":"252",
"name":"Background Check",
"isActive":"true",
"hasDocument":"true",
"isConfidential":"false",
"isBackgroundCheck":"true",
"isReferenceCheck":"false",
"quantity":"1",
"createdDate":null,
"lastUpdatedDate":null
},
{
"@array":"true",
"@id":"351",
"@uri":"https://demo.fellowshiponeapi.com/v1/Requirements/351",
"@oldID":"253",
...
}
]
}
}
Method: show [GET]
The show
method will return a single requirement.
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
Format ::
- json
- xml
- xsd
Parameters ::
- {format}
- [GET] https://demo.fellowshiponeapi.com/v1/Requirements/{id}.{format}
- [GET] https://demo.fellowshiponeapi.com/v1/Requirements/{id}?format={format}
- [Header] Accept : {Content-type}
- {id}
- [GET] https://demo.fellowshiponeapi.com/v1/Requirements/{id}
Sample Response ::
Given: [GET] https://demo.fellowshiponeapi.com/v1/Requirements/350
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/requirements/350
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 30 May 2012 19:52:20 GMT
Content-Length: 613
<?xml version="1.0" encoding="utf-8"?>
<requirement id="350" uri="https://demo.fellowshiponeapi.com/v1/Requirements/350" oldID="252">
<name>Background Check</name>
<isActive>true</isActive>
<hasDocument>true</hasDocument>
<isConfidential>false</isConfidential>
<isBackgroundCheck>true</isBackgroundCheck>
<isReferenceCheck>false</isReferenceCheck>
<quantity>1</quantity>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</requirement>
Given: [GET] https://demo.fellowshiponeapi.com/v1/Requirements/350.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/requirements/350.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 30 May 2012 19:52:20 GMT
Content-Length: 417
{
"requirement":{
"@id":"350",
"@uri":"https://demo.fellowshiponeapi.com/v1/Requirements/350",
"@oldID":"252",
"name":"Background Check",
"isActive":"true",
"hasDocument":"true",
"isConfidential":"false",
"isBackgroundCheck":"true",
"isReferenceCheck":"false",
"quantity":"1",
"createdDate":null,
"lastUpdatedDate":null
}
}
Method: edit [GET]
The edit
method will return a single requirement. The purpose of the edit
method is to retrieve a resource in its most recent condition with its latest values.
Content-types ::
- application/json
- application/xml
Format ::
- json
- xml
Parameters ::
- {format}
- [GET] https://demo.fellowshiponeapi.com/v1/Requirements/{id}/edit.{format}
- [GET] https://demo.fellowshiponeapi.com/v1/Requirements/{id}/edit?format={format}
- [Header] Accept : {Content-type}
- {id}
- [GET] https://demo.fellowshiponeapi.com/v1/Requirements/{id}/edit
Sample Response ::
Given: [GET] https://demo.fellowshiponeapi.com/v1/Requirements/350/edit
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/requirements/350/edit
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 30 May 2012 19:52:20 GMT
Content-Length: 613
<?xml version="1.0" encoding="utf-8"?>
<requirement id="350" uri="https://demo.fellowshiponeapi.com/v1/Requirements/350" oldID="252">
<name>Background Check</name>
<isActive>true</isActive>
<hasDocument>true</hasDocument>
<isConfidential>false</isConfidential>
<isBackgroundCheck>true</isBackgroundCheck>
<isReferenceCheck>false</isReferenceCheck>
<quantity>1</quantity>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</requirement>
Given: [GET] https://demo.fellowshiponeapi.com/v1/Requirements/350/edit.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/requirements/350/edit.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 30 May 2012 19:52:20 GMT
Content-Length: 417
{
"requirement":{
"@id":"350",
"@uri":"https://demo.fellowshiponeapi.com/v1/Requirements/350",
"@oldID":"252",
"name":"Background Check",
"isActive":"true",
"hasDocument":"true",
"isConfidential":"false",
"isBackgroundCheck":"true",
"isReferenceCheck":"false",
"quantity":"1",
"createdDate":null,
"lastUpdatedDate":null
}
}
Method: new [GET]
The new
method will return a blank requirement. The purpose of the new
method is to retrieve an empty resource with the proper structure.
Content-types ::
- application/json
- application/xml
Format ::
- json
- xml
Parameters ::
- {format}
- [GET] https://demo.fellowshiponeapi.com/v1/Requirements/new.{format}
- [GET] https://demo.fellowshiponeapi.com/v1/Requirements/new?format={format}
- [Header] Accept : {Content-type}
Sample Response ::
Given: [GET] https://demo.fellowshiponeapi.com/v1/Requirements/new
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 30 May 2012 19:52:20 GMT
Content-Length: 543
<?xml version="1.0" encoding="utf-8"?>
<requirement id="" uri="" oldID="">
<name></name>
<isActive>false</isActive>
<hasDocument>false</hasDocument>
<isConfidential>false</isConfidential>
<isBackgroundCheck>false</isBackgroundCheck>
<isReferenceCheck>false</isReferenceCheck>
<quantity></quantity>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</requirement>
Given: [GET] https://demo.fellowshiponeapi.com/v1/Requirements/new.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 30 May 2012 19:52:20 GMT
Content-Length: 351
{
"requirement":{
"@id":"",
"@uri":"",
"@oldID":"",
"name":null,
"isActive":"false",
"hasDocument":"false",
"isConfidential":"false",
"isBackgroundCheck":"false",
"isReferenceCheck":"false",
"quantity":null,
"createdDate":null,
"lastUpdatedDate":null
}
}
Method: create [POST]
The create
method will create a single requirement.
Notes ::
- This method will return a 201 - Created if successfully created
Content-types ::
- application/json
- application/xml
Format ::
- json
- xml
Parameters ::
- {format}
- [POST] https://demo.fellowshiponeapi.com/v1/Requirements.{format}
- [POST] https://demo.fellowshiponeapi.com/v1/Requirements?format={format}
- [Header] Accept : {Content-type}
Required Fields ::
- name
Sample Response ::
Given: [POST] https://demo.fellowshiponeapi.com/v1/Requirements
Request body:
<?xml version="1.0" encoding="utf-8"?>
<requirement id="" uri="" oldID="">
<name>API Test Requirement</name>
<isActive>true</isActive>
<hasDocument>true</hasDocument>
<isConfidential>false</isConfidential>
<isBackgroundCheck>false</isBackgroundCheck>
<isReferenceCheck>true</isReferenceCheck>
<quantity>1</quantity>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</requirement>
Response:
HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Location: https://demo.fellowshiponeapi.com/v1/requirements/25556
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 30 May 2012 19:52:20 GMT
Content-Length: 637
<?xml version="1.0" encoding="utf-8"?>
<requirement id="25556" uri="https://demo.fellowshiponeapi.com/v1/Requirements/25556" oldID="">
<name>API Test Requirement</name>
<isActive>true</isActive>
<hasDocument>true</hasDocument>
<isConfidential>false</isConfidential>
<isBackgroundCheck>false</isBackgroundCheck>
<isReferenceCheck>true</isReferenceCheck>
<quantity>1</quantity>
<createdDate>2012-05-30T14:38:44</createdDate>
<lastUpdatedDate></lastUpdatedDate>
</requirement>
Given: [POST] https://demo.fellowshiponeapi.com/v1/Requirements.json
Request body:
{
"requirement":{
"@id":"",
"@uri":"",
"@oldID":"",
"name":"API Test Requirement 1",
"isActive":"true",
"hasDocument":"false",
"isConfidential":"false",
"isBackgroundCheck":"false",
"isReferenceCheck":"false",
"quantity":"1",
"createdDate":null,
"lastUpdatedDate":null
}
}
Response:
HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/json; charset=utf-8
Location: https://demo.fellowshiponeapi.com/v1/requirements.json/25557
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 30 May 2012 19:52:20 GMT
Content-Length: 456
{
"requirement":{
"@id":"25557",
"@uri":"https://demo.fellowshiponeapi.com/v1/Requirements/25557",
"@oldID":"",
"name":"API Test Requirement 1",
"isActive":"true",
"hasDocument":"false",
"isConfidential":"false",
"isBackgroundCheck":"false",
"isReferenceCheck":"false",
"quantity":"1",
"createdDate":"2012-05-30T14:44:40",
"lastUpdatedDate":null
}
}
Method: update [PUT] [POST (Low REST)]
The update
method will update a single requirement.
Content-types ::
- application/json
- application/xml
Format ::
- json
- xml
Parameters ::
- {format}
- [PUT] https://demo.fellowshiponeapi.com/v1/Requirements/{id}.{format}
- [PUT] https://demo.fellowshiponeapi.com/v1/Requirements/{id}?format={format}
- [Header] Accept : {Content-type}
Required Fields ::
- name
Sample Response ::
Given: [PUT] https://demo.fellowshiponeapi.com/v1/Requirements/350
Request body:
<?xml version="1.0" encoding="utf-8"?>
<requirement id="" uri="" oldID="">
<name>API Test Requirement 3</name>
<isActive>true</isActive>
<hasDocument>true</hasDocument>
<isConfidential>false</isConfidential>
<isBackgroundCheck>false</isBackgroundCheck>
<isReferenceCheck>true</isReferenceCheck>
<quantity>1</quantity>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</requirement>
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/requirements/350
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 30 May 2012 19:52:20 GMT
Content-Length: 629
<?xml version="1.0" encoding="utf-8"?>
<requirement id="350" uri="https://demo.fellowshiponeapi.com/v1/Requirements/350" oldID="">
<name>API Test Requirement 3</name>
<isActive>true</isActive>
<hasDocument>true</hasDocument>
<isConfidential>false</isConfidential>
<isBackgroundCheck>false</isBackgroundCheck>
<isReferenceCheck>true</isReferenceCheck>
<quantity>1</quantity>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</requirement>
Given: [PUT] https://demo.fellowshiponeapi.com/v1/Requirements/350.json
Request body:
{
"requirement":{
"@id":"",
"@uri":"",
"@oldID":"",
"name":"API Test Requirement 1",
"isActive":"true",
"hasDocument":"false",
"isConfidential":"false",
"isBackgroundCheck":"false",
"isReferenceCheck":"false",
"quantity":"1",
"createdDate":null,
"lastUpdatedDate":null
}
}
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/requirements/350.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Wed, 30 May 2012 19:52:20 GMT
Content-Length: 435
{
"requirement":{
"@id":"350",
"@uri":"https://demo.fellowshiponeapi.com/v1/Requirements/350",
"@oldID":"",
"name":"API Test Requirement 1",
"isActive":"true",
"hasDocument":"false",
"isConfidential":"false",
"isBackgroundCheck":"false",
"isReferenceCheck":"false",
"quantity":"1",
"createdDate":null,
"lastUpdatedDate":null
}
}