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 ::

  • search [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Requirements/Search?{parameters}
  • show [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}/Requirements/{id}
  • new [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Requirements/New
  • edit [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}Requirements/{id}/Edit
  • create [POST] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}/Requirements
  • update [PUT] [POST(Low REST)] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}/Requirements/{id}
  • delete [DELETE] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}/Requirements/{id}
  • delete [GET(Low REST)] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}Requirements/{id}/Delete

Method: search [GET]

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

Notes ::

  • By passing in the content-type of application/help in the accept header or using the {format} parameter help from https://CHURCHCODE.fellowshiponeapi.com/v1/People, the API will return an html representation of the help documents for this resource (*authentication not required*)
  • If the recordsPerPage parameter is not used or its value is less than 1, the API will default the parameter to 20
  • If the recordsPerPage parameter's value is less than 10, the API will default the parameter to 10
  • If the page parameter is not used or its value is less than 1, the API will default the parameter to 1

Content-types ::

  • application/json
  • application/xml
  • application/help

Format ::

  • json
  • xml
  • help

Parameters ::

  • {format}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search.{format}?{search parameters}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?format={format}&{search parameters}
    • [Header] Accept : {Content-type}
  • {search parameters}
    • trackingNumber = the tracking number of the back ground request.
    • requirementDate = used to return all records greater than or equal to the date specified.
    • backgroundCheckStatusID = return all records that match the specified background check status ID. Please note that this will limit your search results to only background check requirements.
    • requirementStatusID = return all records that match the spcified requirement status ID
    • recordsPerPage = number of records to return for each query (default is 20)
      • ex. recordsPerPage=15
    • page = page number for the given result set
      • ex. page=3

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 ::

  • By passing in the content-type of application/help in the accept header or using the {format} parameter help 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/{personID}/Requirements.{format}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}/Requirements?format={format}
  • [Header] Accept : {Content-type}

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 ::

  • 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

Format ::

  • json
  • xml
  • xsd

Parameters ::

  • {format}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}/Requirements/{id}.{format}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}/Requirements/{id}?format={format}
  • [Header] Accept : {Content-type}
  • {id}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}/Requirements/{id}

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 ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

  • {format}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}Requirements/{id}/edit.{format}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}Requirements/{id}/edit?format={format}
  • [Header] Accept : {Content-type}
  • {id}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}/Requirements/{id}/edit

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 ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

  • {format}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Requirements/new.{format}
    • [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Requirements/new?format={format}
  • [Header] Accept : {Content-type}

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 ::

  • This method will return a 201 - Created if successfully created

Content-types ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

  • {format}
    • [POST] https://CHURCHCODE.fellowshiponeapi.com/v1/People/11851041/Requirements.{format}
    • [POST] https://CHURCHCODE.fellowshiponeapi.com/v1/People/11851041/Requirements?format={format}
  • [Header] Accept : {Content-type}

Required Fields ::

  • person id
  • requirement id
  • requirementStatus id
  • requirementDate
  • staffPerson id

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 ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

  • {format}
    • [PUT] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}/Requirements/{id}.{format}
    • [PUT] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}/Requirements/{id}?format={format}
  • [Header] Accept : {Content-type}

Required Fields ::

  • name

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 ::

  • If delete is called the resource will no longer be available from the API and will return a 410 - Entity is GONE if the resource is ever requested again
  • This method will return a 204 - No Content if a successful deletion occurs
  • Content-type and Format are not used by this action

Parameters ::

  • {id}
    • [GET(Low REST)] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}/Requirements/{id}/Delete
    • [DELETE] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{personID}/Requirements/{id}

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