Fellowship One REST API

People Requirements

A people requirement associates a requirement and it's meta data with an individual.

Authentication

This method requires Authentication

PeopleRequirements

This resource conforms to the following XSD

Methods

PeopleRequirements ::

Method: search [GET]

The search method will return a collection of peopleRequirements for the parameters provided.

Notes ::

Content-types ::

Format ::

Parameters ::

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/Requirements/Search?requirementDate=1/1/2011&page=1&recordsperpage=10

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: Tue, 12 Jun 2012 05:17:54 GMT
Content-Length: 2582

<?xml version="1.0" encoding="utf-8"?>
<results count="2" pageNumber="1" totalRecords="2" additionalPages="0">
  <peopleRequirement json:Array="true" id="1690036" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036" requirementDocumentURI="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036/Documents">
	<person id="11851041" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041" />
	<requirement id="350" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/350">
	  <name>API Test Requirement 1</name>
	</requirement>
	<requirementStatus id="2" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/2">
	  <name>Approved</name>
	</requirementStatus>
	<requirementDate>2011-06-06T13:10:28</requirementDate>
	<staffPerson id="11851041" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041" />
	<backgroundCheck>
	  <trackingNumber>Test</trackingNumber>
	  <requestDate>2012-06-07T09:28:35</requestDate>
	  <backgroundCheckStatus id="1" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/1">
		<name>Submitted</name>
	  </backgroundCheckStatus>
	</backgroundCheck>
	<createdDate>2012-06-07T22:04:37</createdDate>
	<lastUpdatedDate></lastUpdatedDate>
  </peopleRequirement>
  <peopleRequirement json:Array="true" id="771697" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/771697" requirementDocumentURI="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/771697/Documents">
	...
  </peopleRequirement>
</results>

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/Requirements/Search.json?requirementDate=1/1/2011&page=1&recordsperpage=10

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: Tue, 12 Jun 2012 04:52:18 GMT
Content-Length: 2014

{
   "results":{
	  "@count":"2",
	  "@pageNumber":"1",
	  "@totalRecords":"2",
	  "@additionalPages":"0",
	  "peopleRequirement":[
		 {
			"@array":"true",
			"@id":"1690036",
			"@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036",
			"@requirementDocumentURI":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036/Documents",
			"person":{
			   "@id":"11851041",
			   "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041"
			},
			"requirement":{
			   "@id":"350",
			   "@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/350",
			   "name":"API Test Requirement 1"
			},
			"requirementStatus":{
			   "@id":"2",
			   "@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/2",
			   "name":"Approved"
			},
			"requirementDate":"2011-06-06T13:10:28",
			"staffPerson":{
			   "@id":"11851041",
			   "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041"
			},
			"backgroundCheck":{
			   "trackingNumber":"Test",
			   "requestDate":"2012-06-07T09:28:35",
			   "backgroundCheckStatus":{
				  "@id":"1",
				  "@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/1",
				  "name":"Submitted"
			   }
			},
			"createdDate":"2012-06-07T22:04:37",
			"lastUpdatedDate":null
		 },
		 {
			"@array":"true",
			"@id":"771697",
			"@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/771697",
			"@requirementDocumentURI":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/771697/Documents",
			...
		 }
	  ]
   }
}

Method: list [GET]

The list method will return a list of all peopleRequirement records in the context of a person.

Notes ::

Content-types ::

Format ::

Parameters ::

Sample Response ::

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

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://churchcode.fellowshiponeapi.com/v1/people/11851041/requirements
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 12 Jun 2012 05:25:02 GMT
Content-Length: 2542

<?xml version="1.0" encoding="utf-8"?>
<peopleRequirements>
  <peopleRequirement json:Array="true" id="1690036" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036" requirementDocumentURI="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036/Documents">
	<person id="11851041" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041" />
	<requirement id="350" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/350">
	  <name>API Test Requirement 1</name>
	</requirement>
	<requirementStatus id="2" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/2">
	  <name>Approved</name>
	</requirementStatus>
	<requirementDate>2011-06-06T13:10:28</requirementDate>
	<staffPerson id="11851041" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041" />
	<backgroundCheck>
	  <trackingNumber>Test</trackingNumber>
	  <requestDate>2012-06-07T09:28:35</requestDate>
	  <backgroundCheckStatus id="1" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/1">
		<name>Submitted</name>
	  </backgroundCheckStatus>
	</backgroundCheck>
	<createdDate>2012-06-07T22:04:37</createdDate>
	<lastUpdatedDate></lastUpdatedDate>
  </peopleRequirement>
  <peopleRequirement json:Array="true" id="771697" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/771697" requirementDocumentURI="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/771697/Documents">
	...
  </peopleRequirement>
</peopleRequirements>

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/people/11851041/requirements.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/11851041/requirements.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 12 Jun 2012 05:28:38 GMT
Content-Length: 1991

{
   "peopleRequirements":{
	  "peopleRequirement":[
		 {
			"@array":"true",
			"@id":"1690036",
			"@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036",
			"@requirementDocumentURI":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036/Documents",
			"person":{
			   "@id":"11851041",
			   "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041"
			},
			"requirement":{
			   "@id":"350",
			   "@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/350",
			   "name":"API Test Requirement 1"
			},
			"requirementStatus":{
			   "@id":"2",
			   "@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/2",
			   "name":"Approved"
			},
			"requirementDate":"2011-06-06T13:10:28",
			"staffPerson":{
			   "@id":"11851041",
			   "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041"
			},
			"backgroundCheck":{
			   "trackingNumber":"Test",
			   "requestDate":"2012-06-07T09:28:35",
			   "backgroundCheckStatus":{
				  "@id":"1",
				  "@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/1",
				  "name":"Submitted"
			   }
			},
			"createdDate":"2012-06-07T22:04:37",
			"lastUpdatedDate":null
		 },
		 {
			"@array":"true",
			"@id":"771697",
			"@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/771697",
			"@requirementDocumentURI":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/771697/Documents",
			...
		 }
	  ]
   }
}

Method: show [GET]

The show method will return a single peopleRequirement in the context of a person.

Notes ::

Content-types ::

Format ::

Parameters ::

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://churchcode.fellowshiponeapi.com/v1/people/11851041/requirements/1690036
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 12 Jun 2012 05:42:20 GMT
Content-Length: 1208

<?xml version="1.0" encoding="utf-8"?>
<peopleRequirement id="1690036" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036" requirementDocumentURI="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036/Documents">
  <person id="11851041" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041" />
  <requirement id="350" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/350">
	<name>API Test Requirement 1</name>
  </requirement>
  <requirementStatus id="2" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/2">
	<name>Approved</name>
  </requirementStatus>
  <requirementDate>2011-06-06T13:10:28</requirementDate>
  <staffPerson id="11851041" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041" />
  <backgroundCheck>
	<trackingNumber>Test</trackingNumber>
	<requestDate>2012-06-07T09:28:35</requestDate>
	<backgroundCheckStatus id="1" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/1">
	  <name>Submitted</name>
	</backgroundCheckStatus>
  </backgroundCheck>
  <createdDate>2012-06-07T22:04:37</createdDate>
  <lastUpdatedDate></lastUpdatedDate>
</peopleRequirement>

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036.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/11851041/requirements/1690036.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 12 Jun 2012 05:44:23 GMT
Content-Length: 971

{
   "peopleRequirement":{
	  "@id":"1690036",
	  "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036",
	  "@requirementDocumentURI":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036/Documents",
	  "person":{
		 "@id":"11851041",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041"
	  },
	  "requirement":{
		 "@id":"350",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/350",
		 "name":"API Test Requirement 1"
	  },
	  "requirementStatus":{
		 "@id":"2",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/2",
		 "name":"Approved"
	  },
	  "requirementDate":"2011-06-06T13:10:28",
	  "staffPerson":{
		 "@id":"11851041",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041"
	  },
	  "backgroundCheck":{
		 "trackingNumber":"Test",
		 "requestDate":"2012-06-07T09:28:35",
		 "backgroundCheckStatus":{
			"@id":"1",
			"@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/1",
			"name":"Submitted"
		 }
	  },
	  "createdDate":"2012-06-07T22:04:37",
	  "lastUpdatedDate":null
   }
}

Method: edit [GET]

The edit method will return a single peopleRequirement. The purpose of the edit method is to retrieve a resource in its most recent condition with its latest values.

Content-types ::

Format ::

Parameters ::

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036/edit

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://churchcode.fellowshiponeapi.com/v1/people/11851041/requirements/1690036/edit
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 12 Jun 2012 05:53:40 GMT
Content-Length: 1208

<?xml version="1.0" encoding="utf-8"?>
<peopleRequirement id="1690036" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036" requirementDocumentURI="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036/Documents">
  <person id="11851041" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041" />
  <requirement id="350" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/350">
	<name>API Test Requirement 1</name>
  </requirement>
  <requirementStatus id="2" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/2">
	<name>Approved</name>
  </requirementStatus>
  <requirementDate>2011-06-06T13:10:28</requirementDate>
  <staffPerson id="11851041" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041" />
  <backgroundCheck>
	<trackingNumber>Test</trackingNumber>
	<requestDate>2012-06-07T09:28:35</requestDate>
	<backgroundCheckStatus id="1" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/1">
	  <name>Submitted</name>
	</backgroundCheckStatus>
  </backgroundCheck>
  <createdDate>2012-06-07T22:04:37</createdDate>
  <lastUpdatedDate></lastUpdatedDate>
</peopleRequirement>

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036/edit.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/11851041/requirements/1690036/edit.json
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Tue, 12 Jun 2012 05:56:19 GMT
Content-Length: 971

{
   "peopleRequirement":{
	  "@id":"1690036",
	  "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036",
	  "@requirementDocumentURI":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036/Documents",
	  "person":{
		 "@id":"11851041",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041"
	  },
	  "requirement":{
		 "@id":"350",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/350",
		 "name":"API Test Requirement 1"
	  },
	  "requirementStatus":{
		 "@id":"2",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/2",
		 "name":"Approved"
	  },
	  "requirementDate":"2011-06-06T13:10:28",
	  "staffPerson":{
		 "@id":"11851041",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041"
	  },
	  "backgroundCheck":{
		 "trackingNumber":"Test",
		 "requestDate":"2012-06-07T09:28:35",
		 "backgroundCheckStatus":{
			"@id":"1",
			"@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/1",
			"name":"Submitted"
		 }
	  },
	  "createdDate":"2012-06-07T22:04:37",
	  "lastUpdatedDate":null
   }
}

Method: new [GET]

The new method will return a blank peopleRequirement. The purpose of the new method is to retrieve an empty resource with the proper structure.

Content-types ::

Format ::

Parameters ::

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/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: Tue, 12 Jun 2012 06:00:19 GMT
Content-Length: 659

<?xml version="1.0" encoding="utf-8"?>
<peopleRequirement id="" uri="" requirementDocumentURI="/Documents">
  <person id="" uri="" />
  <requirement id="" uri="">
	<name></name>
  </requirement>
  <requirementStatus id="" uri="">
	<name>Pending</name>
  </requirementStatus>
  <requirementDate></requirementDate>
  <staffPerson id="" uri="" />
  <backgroundCheck>
	<trackingNumber></trackingNumber>
	<requestDate></requestDate>
	<backgroundCheckStatus id="" uri="">
	  <name></name>
	</backgroundCheckStatus>
  </backgroundCheck>
  <createdDate></createdDate>
  <lastUpdatedDate></lastUpdatedDate>
</peopleRequirement>

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/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: Tue, 12 Jun 2012 06:00:51 GMT
Content-Length: 434

{
   "peopleRequirement":{
	  "@id":"",
	  "@uri":"",
	  "@requirementDocumentURI":"/Documents",
	  "person":{
		 "@id":"",
		 "@uri":""
	  },
	  "requirement":{
		 "@id":"",
		 "@uri":"",
		 "name":null
	  },
	  "requirementStatus":{
		 "@id":"",
		 "@uri":"",
		 "name":"Pending"
	  },
	  "requirementDate":null,
	  "staffPerson":{
		 "@id":"",
		 "@uri":""
	  },
	  "backgroundCheck":{
		 "trackingNumber":null,
		 "requestDate":null,
		 "backgroundCheckStatus":{
			"@id":"",
			"@uri":"",
			"name":null
		 }
	  },
	  "createdDate":null,
	  "lastUpdatedDate":null
   }
}

Method: create [POST]

The create method will create a single peopleRequirement in the context of a person.

Notes ::

Content-types ::

Format ::

Parameters ::

Required Fields ::

Sample Response ::

Given: [POST] https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements

Request body:

<?xml version="1.0" encoding="utf-8"?>
<peopleRequirement id="1690036" uri="" requirementDocumentURI="">
  <person id="11851041" uri="" />
  <requirement id="350" uri="">
	<name>API Test Requirement 1</name>
  </requirement>
  <requirementStatus id="2" uri="">
	<name>Approved</name>
  </requirementStatus>
  <requirementDate>2011-06-06T13:10:28</requirementDate>
  <staffPerson id="11851041" uri="" />
  <backgroundCheck>
	<trackingNumber>Test</trackingNumber>
	<requestDate>2012-06-07T09:28:35</requestDate>
	<backgroundCheckStatus id="1" uri="">
	  <name>Submitted</name>
	</backgroundCheckStatus>
  </backgroundCheck>
  <createdDate></createdDate>
  <lastUpdatedDate></lastUpdatedDate>
</peopleRequirement>

Response:

HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Location: https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036
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"?>
<peopleRequirement id="1690036" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036" requirementDocumentURI="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036/Documents">
  <person id="11851041" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041" />
  <requirement id="350" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/350">
	<name>API Test Requirement 1</name>
  </requirement>
  <requirementStatus id="2" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/2">
	<name>Approved</name>
  </requirementStatus>
  <requirementDate>2011-06-06T13:10:28</requirementDate>
  <staffPerson id="11851041" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041" />
  <backgroundCheck>
	<trackingNumber>Test</trackingNumber>
	<requestDate>2012-06-07T09:28:35</requestDate>
	<backgroundCheckStatus id="1" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/1">
	  <name>Submitted</name>
	</backgroundCheckStatus>
  </backgroundCheck>
  <createdDate>2012-06-07T22:04:37</createdDate>
  <lastUpdatedDate></lastUpdatedDate>
</peopleRequirement>

Given: [POST] https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements.json

Request body:

{
   "peopleRequirement":{
	  "@id":"1690036",
	  "@uri":"",
	  "@requirementDocumentURI":"",
	  "person":{
		 "@id":"11851041",
		 "@uri":""
	  },
	  "requirement":{
		 "@id":"350",
		 "@uri":"",
		 "name":"API Test Requirement 1"
	  },
	  "requirementStatus":{
		 "@id":"2",
		 "@uri":"",
		 "name":"Approved"
	  },
	  "requirementDate":"2011-06-06T13:10:28",
	  "staffPerson":{
		 "@id":"11851041",
		 "@uri":""
	  },
	  "backgroundCheck":{
		 "trackingNumber":"Test",
		 "requestDate":"2012-06-07T09:28:35",
		 "backgroundCheckStatus":{
			"@id":"1",
			"@uri":"",
			"name":"Submitted"
		 }
	  },
	  "createdDate":"",
	  "lastUpdatedDate":null
   }
}

Response:

HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/json; charset=utf-8
Location: https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036.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: 456

{
   "peopleRequirement":{
	  "@id":"1690036",
	  "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036",
	  "@requirementDocumentURI":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036/Documents",
	  "person":{
		 "@id":"11851041",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041"
	  },
	  "requirement":{
		 "@id":"350",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/350",
		 "name":"API Test Requirement 1"
	  },
	  "requirementStatus":{
		 "@id":"2",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/2",
		 "name":"Approved"
	  },
	  "requirementDate":"2011-06-06T13:10:28",
	  "staffPerson":{
		 "@id":"11851041",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041"
	  },
	  "backgroundCheck":{
		 "trackingNumber":"Test",
		 "requestDate":"2012-06-07T09:28:35",
		 "backgroundCheckStatus":{
			"@id":"1",
			"@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/1",
			"name":"Submitted"
		 }
	  },
	  "createdDate":"2012-06-07T22:04:37",
	  "lastUpdatedDate":null
   }
}

Method: update [PUT] [POST (Low REST)]

The update method will update a single peopleRequirement.

Content-types ::

Format ::

Parameters ::

Required Fields ::

Sample Response ::

Given: [PUT] https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036

Request body:

<?xml version="1.0" encoding="utf-8"?>
<peopleRequirement id="1690036" uri="" requirementDocumentURI="">
  <person id="11851041" uri="" />
  <requirement id="350" uri="">
	<name>API Test Requirement 1</name>
  </requirement>
  <requirementStatus id="2" uri="">
	<name>Approved</name>
  </requirementStatus>
  <requirementDate>2011-06-06T13:10:28</requirementDate>
  <staffPerson id="11851041" uri="" />
  <backgroundCheck>
	<trackingNumber>Test</trackingNumber>
	<requestDate>2012-06-07T09:28:35</requestDate>
	<backgroundCheckStatus id="1" uri="">
	  <name>Submitted</name>
	</backgroundCheckStatus>
  </backgroundCheck>
  <createdDate></createdDate>
  <lastUpdatedDate></lastUpdatedDate>
</peopleRequirement>

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036
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"?>
<peopleRequirement id="1690036" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036" requirementDocumentURI="https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036/Documents">
  <person id="11851041" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041" />
  <requirement id="350" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/350">
	<name>API Test Requirement 1</name>
  </requirement>
  <requirementStatus id="2" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/2">
	<name>Approved</name>
  </requirementStatus>
  <requirementDate>2011-06-06T13:10:28</requirementDate>
  <staffPerson id="11851041" uri="https://churchcode.fellowshiponeapi.com/v1/People/11851041" />
  <backgroundCheck>
	<trackingNumber>Test</trackingNumber>
	<requestDate>2012-06-07T09:28:35</requestDate>
	<backgroundCheckStatus id="1" uri="https://churchcode.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/1">
	  <name>Submitted</name>
	</backgroundCheckStatus>
  </backgroundCheck>
  <createdDate>2012-06-07T22:04:37</createdDate>
  <lastUpdatedDate></lastUpdatedDate>
</peopleRequirement>

Given: [PUT] https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036.json

Request body:

{
   "peopleRequirement":{
	  "@id":"1690036",
	  "@uri":"",
	  "@requirementDocumentURI":"",
	  "person":{
		 "@id":"11851041",
		 "@uri":""
	  },
	  "requirement":{
		 "@id":"350",
		 "@uri":"",
		 "name":"API Test Requirement 1"
	  },
	  "requirementStatus":{
		 "@id":"2",
		 "@uri":"",
		 "name":"Approved"
	  },
	  "requirementDate":"2011-06-06T13:10:28",
	  "staffPerson":{
		 "@id":"11851041",
		 "@uri":""
	  },
	  "backgroundCheck":{
		 "trackingNumber":"Test",
		 "requestDate":"2012-06-07T09:28:35",
		 "backgroundCheckStatus":{
			"@id":"1",
			"@uri":"",
			"name":"Submitted"
		 }
	  },
	  "createdDate":"",
	  "lastUpdatedDate":null
   }
}

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036.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

{
   "peopleRequirement":{
	  "@id":"1690036",
	  "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036",
	  "@requirementDocumentURI":"https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036/Documents",
	  "person":{
		 "@id":"11851041",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041"
	  },
	  "requirement":{
		 "@id":"350",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/350",
		 "name":"API Test Requirement 1"
	  },
	  "requirementStatus":{
		 "@id":"2",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/2",
		 "name":"Approved"
	  },
	  "requirementDate":"2011-06-06T13:10:28",
	  "staffPerson":{
		 "@id":"11851041",
		 "@uri":"https://churchcode.fellowshiponeapi.com/v1/People/11851041"
	  },
	  "backgroundCheck":{
		 "trackingNumber":"Test",
		 "requestDate":"2012-06-07T09:28:35",
		 "backgroundCheckStatus":{
			"@id":"1",
			"@uri":"https://churchcode.fellowshiponeapi.com/v1/Requirements/BackgroundCheckStatuses/1",
			"name":"Submitted"
		 }
	  },
	  "createdDate":"2012-06-07T22:04:37",
	  "lastUpdatedDate":null
   }
}

Method: delete [DELETE]

The delete method will delete a single peopleRequirement.

Notes ::

Parameters ::

Sample Response ::

Given: [DELETE] https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036

Response:

HTTP/1.1 204 The resource https://churchcode.fellowshiponeapi.com/v1/People/11851041/Requirements/1690036 has been deleted.
Cache-Control: private
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:53:25 GMT