People
A person is a resource that contains addresses
, communications
, attributes
, and requirements
. This resource does not contain the delete
method.
Authentication
These methods require Authentication
Resource Structure
This resource conforms to the following XSD
Resource Versioning
This resource has been versioned in order to enhance functionality without breaking compatibility.
- Passing a custom
content-type
ofapplication/vnd.fellowshiponeapi.com.people.people.v2+xml
will enable version 2 of the people resource using the XML format. For the JSON format use +json instead of +xml. - Version 2 changelog:
- Added
unsubscribed
field to People resource. - Added
include=requirements
to People search.
- Added
Methods
People ::
- search [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?{parameters}
- search include additional data [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?{parameters}&include={addresses|communications|attributes}
- list [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/Households/{householdID}/People
- show [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{id}
- edit [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Edit
- new [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/New
- create [POST] https://CHURCHCODE.fellowshiponeapi.com/v1/People
- update [PUT] [POST(Low REST)] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{id}
Method: search [GET]
The search
method will return a collection of people
for the parameters
provided.
Notes ::
- The parameters and the behaviors exposed for this method are identical to the people search functionality available in the Fellowship One Portal application.
- Searching by memberEnvNo, dob, lastUpdatedDate**, createdDate, checkinTagCode, barCode, id and hsdid are mutually exclusive and cannot be used with any other search parameters
- Search by Person: https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?searchFor=fl%2Cni&address=11801+Pinyon+Pine&communication=817-555-5555&includeInactive=True&status=7292&subStatus=3448&attribute=41688&includeDeceased=True
- All values passed in via searchfor must be url encoded (ex. Nick Floyd needs to be Nick%20Floyd)
searchFor
parameter must be at least 2 characters long
- Search by memberEnvNo: https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?memberEnvNo=12341234
- Search by DOB: https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?dob=1970-12-01
- Search by lastUpdatedDate: https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?lastUpdatedDate=2009-03-01 **
- This parameter will be used as: parameter.lastUpdatedDate >= person.lastUpdatedDate (greater than or equal to)
- Search by createdDate: https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?createdDate=2009-03-01
- This parameter will be used as: parameter.createdDate >= person.createdDate (greater than or equal to)
- Search by checkinTagCode: https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?checkinTagCode=ABC
- Search by barCode: https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?barCode=0000123123
- Search by id: https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?id=123
- id can be used as a comma seperated list of people [ids] to pull back a list of people
- Search by hsdid: https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?hsdid=456
- Search by Person: https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?searchFor=fl%2Cni&address=11801+Pinyon+Pine&communication=817-555-5555&includeInactive=True&status=7292&subStatus=3448&attribute=41688&includeDeceased=True
- By passing in the
content-type
ofapplication/help
in theaccept
header or using the {format} parameterhelp
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 - If the
include
parameter is used the the response content will include any resource specified in the value (see below)
Content-types ::
- application/json - version 1
- application/xml - version 1
- application/help - version 1
- application/vnd.fellowshiponeapi.com.people.people.v2+json - version 2
- application/vnd.fellowshiponeapi.com.people.people.v2+xml - version 2
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}
- searchFor = Name of the person you are searching for
- ex. searchfor=fl%2Cni
- address = all address values
- ex. address=11801+Pinyon+Pine
- communication = all communication values
- ex. communication=817-555-5555
- dob = Date of birth for the person your searching for (format: yyyy-mm-dd)*
- ex. dob=1970-12-01
- status = status id
- ex. status=7292
- subStatus = sub status id
- ex. subStatus=3448
- attribute = attribute id
- ex. attribute=41688
- checkinTagCode = checkinTagCode*
- ex. checkinTagCode=ABC
- memberEnvNo = memberEnvNo*
- ex. memberEnvNo=12341234
- barCode = barCode*
- ex. barCode=0000123132
- id = id*
- ex. id=123
- ex. id=123,456,789 (comma seperated list of people [ids] to pull back a list of people)
- hsdid = hsdid*
- ex. hsdid=123
- includeInactive = include in active people
- ex. includeInactive=True
- includeDeceased = include deceased people
- ex. includeDeceased=True
- lastUpdatedDate = The date of the last time the person's information was updated (format: yyyy-mm-dd)**
- ex. lastUpdatedDate=2009-03-01
- createdDate = The date when the person's information was created / inserted into the system (format: yyyy-mm-dd)*
- ex. createdDate=2009-03-01
- 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
- searchFor = Name of the person you are searching for
*Search parameters that are mutually exclusive. They may not be used in combination with each other or any search parameter other than paging parameters
**lastupdateddate: This parameter will return individuals based on the following scenarios for a given date:
- If a
household address
and/orcommunication
is updated and/or created allindividuals
in thathousehold
will be returned - If a
individual address
and/orcommunication
is updated and/or created then theindividual
will be returned - If a
individual attribute
is updated and/or created then theindividual
will be returned - If a
household
is created then allindividuals
in thathousehold
will be returned - If an
individual
is updated and/or created then theindividual
will be returned
- If a
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?searchFor=fl%2Cni&page=1&recordsperpage=10
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 04:10:16 GMT
Content-Length: 7356
<?xml version="1.0" encoding="utf-8"?>
<results count="4" pageNumber="1" totalRecords="4" additionalPages="0">
<person json:Array="true" id="22114941" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941" imageURI="" oldID="" iCode="rD94LTAKe4ROXa50SLH7oQ==" householdID="14338522" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName>Nicholas</firstName>
<lastName>Floyd</lastName>
<suffix></suffix>
<middleName>A</middleName>
<goesByName>Nick</goesByName>
<formerName></formerName>
<gender>Male</gender>
<dateOfBirth>1976-08-13T00:00:00</dateOfBirth>
<maritalStatus>Married</maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1">
<name>Member</name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer>Fellowship Technologies</employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode>dfhg</barCode>
<memberEnvelopeCode>12341234</memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank></thank>
<firstRecord>2008-12-11T07:41:07</firstRecord>
<attributes/>
<addresses/>
<communications/>
<lastMatchDate></lastMatchDate>
<createdDate>2008-12-11T07:41:08</createdDate>
<lastUpdatedDate>2009-04-30T15:12:49</lastUpdatedDate>
</person>
<person json:Array="true" id="22115065" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115065" imageURI="" oldID="" iCode="RsE88wQpSpyLQOPPK/SOqQ==" householdID="1551428" oldHouseholdID="1339213">
<title></title>
<salutation></salutation>
...
</person>
</results>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search.json?searchFor=fl%2Cni&page=1&recordsperpage=10
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:02:00 GMT
Content-Length: 4945
{
"results": {
"@count": "4",
"@pageNumber": "1",
"@totalRecords": "4",
"@additionalPages": "0",
"person": [
{
"@array": "true",
"@id": "22114941",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941",
"@imageURI": "",
"@oldID": "",
"@iCode": "rD94LTAKe4ROXa50SLH7oQ==",
"@householdID": "14338522",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": "Nicholas",
"lastName": "Floyd",
"suffix": null,
"middleName": "A",
"goesByName": "Nick",
"formerName": null,
"gender": "Male",
"dateOfBirth": "1976-08-13T00:00:00",
"maritalStatus": "Married",
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1",
"name": "Member",
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": "Fellowship Technologies",
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": "dfhg",
"memberEnvelopeCode": "12341234",
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": null,
"firstRecord": "2008-12-11T07:41:07",
"attributes": null,
"addresses": null,
"communications": null,
"lastMatchDate": null,
"createdDate": "2008-12-11T07:41:08",
"lastUpdatedDate": "2009-04-30T15:12:49"
},
{
"@array": "true",
"@id": "22115065",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115065",
"@imageURI": "",
"@oldID": "",
"@iCode": "RsE88wQpSpyLQOPPK/SOqQ==",
"@householdID": "1551428",
"@oldHouseholdID": "1339213",
"title": null,
"salutation": null,
...
}
]
}
}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?searchFor=fl%2Cni&page=1&recordsperpage=10
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+xml
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 04:10:16 GMT
Content-Length: 7356
<?xml version="1.0" encoding="utf-8"?>
<results count="4" pageNumber="1" totalRecords="4" additionalPages="0">
<person json:Array="true" id="22114941" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941" imageURI="" oldID="" iCode="rD94LTAKe4ROXa50SLH7oQ==" householdID="14338522" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName>Nicholas</firstName>
<lastName>Floyd</lastName>
<suffix></suffix>
<middleName>A</middleName>
<goesByName>Nick</goesByName>
<formerName></formerName>
<gender>Male</gender>
<dateOfBirth>1976-08-13T00:00:00</dateOfBirth>
<maritalStatus>Married</maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1">
<name>Member</name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer>Fellowship Technologies</employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode>dfhg</barCode>
<memberEnvelopeCode>12341234</memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank></thank>
<firstRecord>2008-12-11T07:41:07</firstRecord>
<attributes/>
<addresses/>
<communications/>
<peopleRequirements/>
<lastMatchDate></lastMatchDate>
<unsubscribed>false</unsubscribed>
<createdDate>2008-12-11T07:41:08</createdDate>
<lastUpdatedDate>2009-04-30T15:12:49</lastUpdatedDate>
</person>
<person json:Array="true" id="22115065" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115065" imageURI="" oldID="" iCode="RsE88wQpSpyLQOPPK/SOqQ==" householdID="1551428" oldHouseholdID="1339213">
<title></title>
<salutation></salutation>
...
</person>
</results>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search.json?searchFor=fl%2Cni&page=1&recordsperpage=10
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:02:00 GMT
Content-Length: 4945
{
"results": {
"@count": "4",
"@pageNumber": "1",
"@totalRecords": "4",
"@additionalPages": "0",
"person": [
{
"@array": "true",
"@id": "22114941",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941",
"@imageURI": "",
"@oldID": "",
"@iCode": "rD94LTAKe4ROXa50SLH7oQ==",
"@householdID": "14338522",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": "Nicholas",
"lastName": "Floyd",
"suffix": null,
"middleName": "A",
"goesByName": "Nick",
"formerName": null,
"gender": "Male",
"dateOfBirth": "1976-08-13T00:00:00",
"maritalStatus": "Married",
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1",
"name": "Member",
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": "Fellowship Technologies",
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": "dfhg",
"memberEnvelopeCode": "12341234",
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": null,
"firstRecord": "2008-12-11T07:41:07",
"attributes": null,
"addresses": null,
"communications": null,
"peopleRequirements": null,
"lastMatchDate": null,
"unsubscribed": null,
"createdDate": "2008-12-11T07:41:08",
"lastUpdatedDate": "2009-04-30T15:12:49"
},
{
"@array": "true",
"@id": "22115065",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115065",
"@imageURI": "",
"@oldID": "",
"@iCode": "RsE88wQpSpyLQOPPK/SOqQ==",
"@householdID": "1551428",
"@oldHouseholdID": "1339213",
"title": null,
"salutation": null,
...
}
]
}
}
Search with additional data [include={addresses | communications | attributes | requirements}]
Using the include
query string parameter the People search data can include addresses
, communications
, attributes
, and requirements
(for the given context - person
)
Notes ::
- All behaviors and patterns of search are supported
- Acceptable values for the
include
query string parameter are: addresses | communications | attributes | requirements include=requirements
may only be used when requesting v2 of the resource. See examples below.
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?searchFor=fl%2Cni&include=addresses,communications,attributes
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 20:57:38 GMT
Content-Length: 77647
<?xml version="1.0" encoding="utf-8"?>
<results count="20" pageNumber="1" totalRecords="908" additionalPages="45">
<person json:Array="true" id="1635797" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797" imageURI="" oldID="1320171" iCode="fYib7xVjRuvrKbvxWfE4tg==" householdID="1552410" oldHouseholdID="1340195">
<title></title>
<salutation></salutation>
<prefix>Mrs.</prefix>
<firstName>Allie</firstName>
<lastName>Almuete</lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName></goesByName>
<formerName></formerName>
<gender>Female</gender>
<dateOfBirth>1963-03-22T00:00:00</dateOfBirth>
<maritalStatus>Married</maritalStatus>
<householdMemberType id="2" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/2">
<name>Spouse</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1155" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1155">
<name>Bad Cat's Cool Dudes</name>
<comment>smooth</comment>
<date>2008-09-15T00:00:00</date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank>false</thank>
<firstRecord>1999-07-19T00:00:00</firstRecord>
<attributes>
<attribute json:Array="true" id="236549" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797/Attributes/236549">
<person id="1635797" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797" />
<attributeGroup id="145" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145">
<name>Experiences</name>
<attribute id="958" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958">
<name>Baptism</name>
</attribute>
</attributeGroup>
<startDate>2000-03-01T00:00:00</startDate>
<endDate></endDate>
<comment></comment>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</attribute>
</attributes>
<addresses />
<communications>
<communication json:Array="true" id="4053474" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/Communications/4053474">
<household id="1552410" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/Households/1552410" />
<person id="1635797" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797" />
<communicationType id="4" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/Communications/CommunicationTypes/4">
<name>Email</name>
</communicationType>
<communicationGeneralType>Email</communicationGeneralType>
<communicationValue>JimandAlli.Choate@fellowshiponemail.com</communicationValue>
<searchCommunicationValue>JimandAlli.Choate@fellowshiponemail.com</searchCommunicationValue>
<listed>false</listed>
<communicationComment></communicationComment>
<createdDate></createdDate>
<lastUpdatedDate>2004-03-14T16:40:40</lastUpdatedDate>
</communication>
</communications>
<lastMatchDate></lastMatchDate>
<createdDate></createdDate>
<lastUpdatedDate>2008-11-04T13:15:17</lastUpdatedDate>
</person>
<person json:Array="true" id="1635788" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635788" imageURI="" oldID="1320176" iCode="QYQ0AqAZqVqfhpsz1HUN3g==" householdID="1552411" oldHouseholdID="1340196">
<title></title>
<salutation></salutation>
<prefix>Mr.</prefix>
<firstName>Armando</firstName>
<lastName>Almuete</lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName></goesByName>
<formerName></formerName>
<gender>Male</gender>
<dateOfBirth>1989-03-31T00:00:00</dateOfBirth>
<maritalStatus>Child/Yth</maritalStatus>
<householdMemberType id="3" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/3">
<name>Child</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1155" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1155">
<name>Bad Cat's Cool Dudes</name>
<comment>smooth</comment>
<date>2008-09-15T00:00:00</date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="15075" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Schools/15075">
<name>Colleyville Middle</name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank>false</thank>
<firstRecord>1999-07-19T00:00:00</firstRecord>
<attributes>
<attribute json:Array="true" id="236555" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635788/Attributes/236555">
<person id="1635788" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635788" />
<attributeGroup id="145" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145">
<name>Experiences</name>
<attribute id="958" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958">
<name>Baptism</name>
</attribute>
</attributeGroup>
<startDate>2001-10-03T00:00:00</startDate>
<endDate></endDate>
<comment></comment>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</attribute>
</attributes>
<addresses />
<communications />
<lastMatchDate></lastMatchDate>
<createdDate></createdDate>
<lastUpdatedDate>2008-11-04T13:15:18</lastUpdatedDate>
</person>
...
</results>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search.json?searchFor=fl%2Cni&include=addresses,communications,attributes
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 20:59:11 GMT
Content-Length: 54997
{
"results": {
"@count": "20",
"@pageNumber": "1",
"@totalRecords": "908",
"@additionalPages": "45",
"person": [
{
"@array": "true",
"@id": "1635797",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797",
"@imageURI": "",
"@oldID": "1320171",
"@iCode": "fYib7xVjRuvrKbvxWfE4tg==",
"@householdID": "1552410",
"@oldHouseholdID": "1340195",
"title": null,
"salutation": null,
"prefix": "Mrs.",
"firstName": "Allie",
"lastName": "Almuete",
"suffix": null,
"middleName": null,
"goesByName": null,
"formerName": null,
"gender": "Female",
"dateOfBirth": "1963-03-22T00:00:00",
"maritalStatus": "Married",
"householdMemberType": {
"@id": "2",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/2",
"name": "Spouse"
},
"isAuthorized": "true",
"status": {
"@id": "1155",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1155",
"name": "Bad Cat's Cool Dudes",
"comment": "smooth",
"date": "2008-09-15T00:00:00",
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": "false",
"firstRecord": "1999-07-19T00:00:00",
"attributes": {
"attribute": [
{
"@array": "true",
"@id": "236549",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797/Attributes/236549",
"person": {
"@id": "1635797",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797"
},
"attributeGroup": {
"@id": "145",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145",
"name": "Experiences",
"attribute": {
"@id": "958",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958",
"name": "Baptism"
}
},
"startDate": "2000-03-01T00:00:00",
"endDate": null,
"comment": null,
"createdDate": null,
"lastUpdatedDate": null
}
]
},
"addresses": null,
"communications": {
"communication": [
{
"@array": "true",
"@id": "4053474",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/Communications/4053474",
"household": {
"@id": "1552410",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/Households/1552410"
},
"person": {
"@id": "1635797",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797"
},
"communicationType": {
"@id": "4",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/Communications/CommunicationTypes/4",
"name": "Email"
},
"communicationGeneralType": "Email",
"communicationValue": "JimandAlli.Choate@fellowshiponemail.com",
"searchCommunicationValue": "JimandAlli.Choate@fellowshiponemail.com",
"listed": "false",
"communicationComment": null,
"createdDate": null,
"lastUpdatedDate": "2004-03-14T16:40:40"
}
]
},
"lastMatchDate": null,
"createdDate": null,
"lastUpdatedDate": "2008-11-04T13:15:17"
},
{
"@array": "true",
"@id": "1635788",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635788",
"@imageURI": "",
"@oldID": "1320176",
"@iCode": "QYQ0AqAZqVqfhpsz1HUN3g==",
"@householdID": "1552411",
"@oldHouseholdID": "1340196",
"title": null,
"salutation": null,
"prefix": "Mr.",
"firstName": "Armando",
"lastName": "Almuete",
"suffix": null,
"middleName": null,
"goesByName": null,
"formerName": null,
"gender": "Male",
"dateOfBirth": "1989-03-31T00:00:00",
"maritalStatus": "Child/Yth",
"householdMemberType": {
"@id": "3",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/3",
"name": "Child"
},
"isAuthorized": "true",
"status": {
"@id": "1155",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1155",
"name": "Bad Cat's Cool Dudes",
"comment": "smooth",
"date": "2008-09-15T00:00:00",
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "15075",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Schools/15075",
"name": "Colleyville Middle"
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": "false",
"firstRecord": "1999-07-19T00:00:00",
"attributes": {
"attribute": [
{
"@array": "true",
"@id": "236555",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635788/Attributes/236555",
"person": {
"@id": "1635788",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635788"
},
"attributeGroup": {
"@id": "145",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145",
"name": "Experiences",
"attribute": {
"@id": "958",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958",
"name": "Baptism"
}
},
"startDate": "2001-10-03T00:00:00",
"endDate": null,
"comment": null,
"createdDate": null,
"lastUpdatedDate": null
}
]
},
"addresses": null,
"communications": null,
"lastMatchDate": null,
"createdDate": null,
"lastUpdatedDate": "2008-11-04T13:15:18"
},
...
]
}
}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search?searchFor=fl%2Cni&include=addresses,communications,attributes,requirements
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+xml
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 20:57:38 GMT
Content-Length: 77647
<?xml version="1.0" encoding="utf-8"?>
<results count="20" pageNumber="1" totalRecords="908" additionalPages="45">
<person json:Array="true" id="1635797" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797" imageURI="" oldID="1320171" iCode="fYib7xVjRuvrKbvxWfE4tg==" householdID="1552410" oldHouseholdID="1340195">
<title></title>
<salutation></salutation>
<prefix>Mrs.</prefix>
<firstName>Allie</firstName>
<lastName>Almuete</lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName></goesByName>
<formerName></formerName>
<gender>Female</gender>
<dateOfBirth>1963-03-22T00:00:00</dateOfBirth>
<maritalStatus>Married</maritalStatus>
<householdMemberType id="2" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/2">
<name>Spouse</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1155" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1155">
<name>Bad Cat's Cool Dudes</name>
<comment>smooth</comment>
<date>2008-09-15T00:00:00</date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank>false</thank>
<firstRecord>1999-07-19T00:00:00</firstRecord>
<attributes>
<attribute json:Array="true" id="236549" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797/Attributes/236549">
<person id="1635797" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797" />
<attributeGroup id="145" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145">
<name>Experiences</name>
<attribute id="958" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958">
<name>Baptism</name>
</attribute>
</attributeGroup>
<startDate>2000-03-01T00:00:00</startDate>
<endDate></endDate>
<comment></comment>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</attribute>
</attributes>
<addresses />
<communications>
<communication json:Array="true" id="4053474" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/Communications/4053474">
<household id="1552410" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/Households/1552410" />
<person id="1635797" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797" />
<communicationType id="4" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/Communications/CommunicationTypes/4">
<name>Email</name>
</communicationType>
<communicationGeneralType>Email</communicationGeneralType>
<communicationValue>JimandAlli.Choate@fellowshiponemail.com</communicationValue>
<searchCommunicationValue>JimandAlli.Choate@fellowshiponemail.com</searchCommunicationValue>
<listed>false</listed>
<communicationComment></communicationComment>
<createdDate></createdDate>
<lastUpdatedDate>2004-03-14T16:40:40</lastUpdatedDate>
</communication>
</communications>
<peopleRequirements>
<peopleRequirement json:Array="true" id="49713" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797/Requirements/49713" requirementDocumentURI="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797/Requirements/49713/Documents">
<person id="1632443" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797" />
<requirement id="349" uri=https://CHURCHCODE.fellowshiponeapi.com/v1/Requirements/349">
<name>Sample Requirement</name>
</requirement>
<requirementStatus id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/1">
<name>Pending</name>
</requirementStatus>
<requirementDate>2004-03-31T00:00:00</requirementDate>
<staffPerson id="1999191" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1999191" />
<backgroundCheck>
<trackingNumber></trackingNumber>
<requestDate></requestDate>
<backgroundCheckStatus id="" uri="">
<name>Submitted</name>
</backgroundCheckStatus>
</backgroundCheck>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</peopleRequirement>
</peopleRequirements>
<lastMatchDate></lastMatchDate>
<unsubscribed>false</unsubscribed>
<createdDate></createdDate>
<lastUpdatedDate>2008-11-04T13:15:17</lastUpdatedDate>
</person>
<person json:Array="true" id="1635788" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635788" imageURI="" oldID="1320176" iCode="QYQ0AqAZqVqfhpsz1HUN3g==" householdID="1552411" oldHouseholdID="1340196">
<title></title>
<salutation></salutation>
<prefix>Mr.</prefix>
<firstName>Armando</firstName>
<lastName>Almuete</lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName></goesByName>
<formerName></formerName>
<gender>Male</gender>
<dateOfBirth>1989-03-31T00:00:00</dateOfBirth>
<maritalStatus>Child/Yth</maritalStatus>
<householdMemberType id="3" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/3">
<name>Child</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1155" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1155">
<name>Bad Cat's Cool Dudes</name>
<comment>smooth</comment>
<date>2008-09-15T00:00:00</date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="15075" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Schools/15075">
<name>Colleyville Middle</name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank>false</thank>
<firstRecord>1999-07-19T00:00:00</firstRecord>
<attributes>
<attribute json:Array="true" id="236555" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635788/Attributes/236555">
<person id="1635788" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635788" />
<attributeGroup id="145" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145">
<name>Experiences</name>
<attribute id="958" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958">
<name>Baptism</name>
</attribute>
</attributeGroup>
<startDate>2001-10-03T00:00:00</startDate>
<endDate></endDate>
<comment></comment>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</attribute>
</attributes>
<addresses />
<communications />
<peopleRequirements />
<lastMatchDate></lastMatchDate>
<unsubscribed>false</unsubscribed>
<createdDate></createdDate>
<lastUpdatedDate>2008-11-04T13:15:18</lastUpdatedDate>
</person>
...
</results>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/Search.json?searchFor=fl%2Cni&include=addresses,communications,attributes,requirements
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 20:59:11 GMT
Content-Length: 54997
{
"results": {
"@count": "20",
"@pageNumber": "1",
"@totalRecords": "908",
"@additionalPages": "45",
"person": [
{
"@array": "true",
"@id": "1635797",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797",
"@imageURI": "",
"@oldID": "1320171",
"@iCode": "fYib7xVjRuvrKbvxWfE4tg==",
"@householdID": "1552410",
"@oldHouseholdID": "1340195",
"title": null,
"salutation": null,
"prefix": "Mrs.",
"firstName": "Allie",
"lastName": "Almuete",
"suffix": null,
"middleName": null,
"goesByName": null,
"formerName": null,
"gender": "Female",
"dateOfBirth": "1963-03-22T00:00:00",
"maritalStatus": "Married",
"householdMemberType": {
"@id": "2",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/2",
"name": "Spouse"
},
"isAuthorized": "true",
"status": {
"@id": "1155",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1155",
"name": "Bad Cat's Cool Dudes",
"comment": "smooth",
"date": "2008-09-15T00:00:00",
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": "false",
"firstRecord": "1999-07-19T00:00:00",
"attributes": {
"attribute": [
{
"@array": "true",
"@id": "236549",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797/Attributes/236549",
"person": {
"@id": "1635797",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797"
},
"attributeGroup": {
"@id": "145",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145",
"name": "Experiences",
"attribute": {
"@id": "958",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958",
"name": "Baptism"
}
},
"startDate": "2000-03-01T00:00:00",
"endDate": null,
"comment": null,
"createdDate": null,
"lastUpdatedDate": null
}
]
},
"addresses": null,
"communications": {
"communication": [
{
"@array": "true",
"@id": "4053474",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/Communications/4053474",
"household": {
"@id": "1552410",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/Households/1552410"
},
"person": {
"@id": "1635797",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635797"
},
"communicationType": {
"@id": "4",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/Communications/CommunicationTypes/4",
"name": "Email"
},
"communicationGeneralType": "Email",
"communicationValue": "JimandAlli.Choate@fellowshiponemail.com",
"searchCommunicationValue": "JimandAlli.Choate@fellowshiponemail.com",
"listed": "false",
"communicationComment": null,
"createdDate": null,
"lastUpdatedDate": "2004-03-14T16:40:40"
}
]
},
"peopleRequirements":{
"peopleRequirement":[
{
"@id":"49713",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/v1/People/1632443/Requirements/49713",
"@requirementDocumentURI":"https://CHURCHCODE.fellowshiponeapi.com/v1/People/1632443/Requirements/49713/Documents",
"person":{
"@id":"1632443",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/v1/People/1632443"
},
"requirement":{
"@id":"349",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/v1/Requirements/349",
"name":"Sample Requirement"
},
"requirementStatus":{
"@id":"1",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/v1/Requirements/RequirementStatuses/1",
"name":"Pending"
},
"requirementDate":"2004-03-31T00:00:00",
"staffPerson":{
"@id":"1999191",
"@uri":"https://CHURCHCODE.fellowshiponeapi.com/v1/People/1999191"
},
"backgroundCheck":{
"trackingNumber":null,
"requestDate":null,
"backgroundCheckStatus":{
"@id":"",
"@uri":"",
"name":"Submitted"
}
},
"createdDate":null,
"lastUpdatedDate":null
}
]
},
"lastMatchDate": null,
"unsubscribed": false,
"createdDate": null,
"lastUpdatedDate": "2008-11-04T13:15:17"
},
{
"@array": "true",
"@id": "1635788",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635788",
"@imageURI": "",
"@oldID": "1320176",
"@iCode": "QYQ0AqAZqVqfhpsz1HUN3g==",
"@householdID": "1552411",
"@oldHouseholdID": "1340196",
"title": null,
"salutation": null,
"prefix": "Mr.",
"firstName": "Armando",
"lastName": "Almuete",
"suffix": null,
"middleName": null,
"goesByName": null,
"formerName": null,
"gender": "Male",
"dateOfBirth": "1989-03-31T00:00:00",
"maritalStatus": "Child/Yth",
"householdMemberType": {
"@id": "3",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/3",
"name": "Child"
},
"isAuthorized": "true",
"status": {
"@id": "1155",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1155",
"name": "Bad Cat's Cool Dudes",
"comment": "smooth",
"date": "2008-09-15T00:00:00",
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "15075",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Schools/15075",
"name": "Colleyville Middle"
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": "false",
"firstRecord": "1999-07-19T00:00:00",
"attributes": {
"attribute": [
{
"@array": "true",
"@id": "236555",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635788/Attributes/236555",
"person": {
"@id": "1635788",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/1635788"
},
"attributeGroup": {
"@id": "145",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145",
"name": "Experiences",
"attribute": {
"@id": "958",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958",
"name": "Baptism"
}
},
"startDate": "2001-10-03T00:00:00",
"endDate": null,
"comment": null,
"createdDate": null,
"lastUpdatedDate": null
}
]
},
"addresses": null,
"communications": null,
"peopleRequirements": null,
"lastMatchDate": null,
"unsubscribed": null,
"createdDate": null,
"lastUpdatedDate": "2008-11-04T13:15:18"
},
...
]
}
}
Method: list [GET]
The list
method will return a collection of people
based on context (households
).
Notes ::
- By passing in the
content-type
ofapplication/help
in theaccept
header or using the {format} parameterhelp
from https://CHURCHCODE.fellowshiponeapi.com/v1/People, the API will return an html representation of the help documents for this resource (*authentication not required*)
Content-types ::
- application/json - version 1
- application/xml - version 1
- application/help - version 1
- application/vnd.fellowshiponeapi.com.people.people.v2+json - version 2
- application/vnd.fellowshiponeapi.com.people.people.v2+xml - version 2
Format ::
- json
- xml
- help
Parameters ::
- {format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/Households/{householdID}/People.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/Households/{householdID}/People?format={format}
- [Header] Accept : {Content-type}
- {householdID}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/Households/{householdID}/People
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/Households/1999107/People
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/Households/1999107/People
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:33:21 GMT
Content-Length: 5833
<?xml version="1.0" encoding="utf-8"?>
<people>
<person json:Array="true" id="8711560" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/8711560" imageURI="" oldID="" iCode="NbF7/uuRd7a6mFP1lqtzAQ==" householdID="1999107" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName>Charles</firstName>
<lastName>Abreu</lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName>Kevin</goesByName>
<formerName></formerName>
<gender>Male</gender>
<dateOfBirth>1978-03-07T00:00:00</dateOfBirth>
<maritalStatus>Married</maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="4" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/4">
<name>Attendee</name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank>false</thank>
<firstRecord>2006-02-03T11:27:40</firstRecord>
<lastMatchDate></lastMatchDate>
<createdDate>2006-02-03T11:27:40</createdDate>
<lastUpdatedDate>2008-11-04T14:33:45</lastUpdatedDate>
</person>
<person json:Array="true" id="2229015" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/2229015" imageURI="" oldID="" iCode="0X2Jshw/PBlxU4/aCUvi8g==" householdID="1999107" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName>Erin</firstName>
<lastName>Abreu</lastName>
...
</person>
</people>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/Households/1999107/People.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/Households/1999107/People.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:34:59 GMT
Content-Length: 3974
{
"people": {
"person": [
{
"@array": "true",
"@id": "8711560",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/8711560",
"@imageURI": "",
"@oldID": "",
"@iCode": "NbF7/uuRd7a6mFP1lqtzAQ==",
"@householdID": "1999107",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": "Charles",
"lastName": "Abreu",
"suffix": null,
"middleName": null,
"goesByName": "Kevin",
"formerName": null,
"gender": "Male",
"dateOfBirth": "1978-03-07T00:00:00",
"maritalStatus": "Married",
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "4",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/4",
"name": "Attendee",
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": "false",
"firstRecord": "2006-02-03T11:27:40",
"lastMatchDate": null,
"createdDate": "2006-02-03T11:27:40",
"lastUpdatedDate": "2008-11-04T14:33:45"
},
{
"@array": "true",
"@id": "2229015",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/2229015",
"@oldID": "",
"@iCode": "0X2Jshw/PBlxU4/aCUvi8g==",
"@householdID": "1999107",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": "Erin",
"lastName": "Abreu"
...
}
]
}
}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/Households/1999107/People
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+xml
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/Households/1999107/People
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:33:21 GMT
Content-Length: 5833
<?xml version="1.0" encoding="utf-8"?>
<people>
<person json:Array="true" id="8711560" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/8711560" imageURI="" oldID="" iCode="NbF7/uuRd7a6mFP1lqtzAQ==" householdID="1999107" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName>Charles</firstName>
<lastName>Abreu</lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName>Kevin</goesByName>
<formerName></formerName>
<gender>Male</gender>
<dateOfBirth>1978-03-07T00:00:00</dateOfBirth>
<maritalStatus>Married</maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="4" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/4">
<name>Attendee</name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank>false</thank>
<firstRecord>2006-02-03T11:27:40</firstRecord>
<lastMatchDate></lastMatchDate>
<unsubscribed>false</unsubscribed>
<createdDate>2006-02-03T11:27:40</createdDate>
<lastUpdatedDate>2008-11-04T14:33:45</lastUpdatedDate>
</person>
<person json:Array="true" id="2229015" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/2229015" imageURI="" oldID="" iCode="0X2Jshw/PBlxU4/aCUvi8g==" householdID="1999107" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName>Erin</firstName>
<lastName>Abreu</lastName>
...
</person>
</people>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/Households/1999107/People.json
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+xml
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/Households/1999107/People.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:34:59 GMT
Content-Length: 3974
{
"people": {
"person": [
{
"@array": "true",
"@id": "8711560",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/8711560",
"@imageURI": "",
"@oldID": "",
"@iCode": "NbF7/uuRd7a6mFP1lqtzAQ==",
"@householdID": "1999107",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": "Charles",
"lastName": "Abreu",
"suffix": null,
"middleName": null,
"goesByName": "Kevin",
"formerName": null,
"gender": "Male",
"dateOfBirth": "1978-03-07T00:00:00",
"maritalStatus": "Married",
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "4",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/4",
"name": "Attendee",
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": "false",
"firstRecord": "2006-02-03T11:27:40",
"lastMatchDate": null,
"unsubscribed:" null,
"createdDate": "2006-02-03T11:27:40",
"lastUpdatedDate": "2008-11-04T14:33:45"
},
{
"@array": "true",
"@id": "2229015",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/2229015",
"@oldID": "",
"@iCode": "0X2Jshw/PBlxU4/aCUvi8g==",
"@householdID": "1999107",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": "Erin",
"lastName": "Abreu"
...
}
]
}
}
Method: show [GET]
The show
method will return a single person
for a 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 - version 1
- application/xml - version 1
- application/help - version 1
- application/vnd.fellowshiponeapi.com.people.people.v2+json - version 2
- application/vnd.fellowshiponeapi.com.people.people.v2+xml - version 2
Format ::
- json
- xml
- xsd
Parameters ::
- {format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{id}.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{id}?format={format}
- [Header] Accept : {Content-type}
- {id}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{id}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:36:38 GMT
Content-Length: 1779
<?xml version="1.0" encoding="utf-8"?>
<person id="22114941" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941" imageURI="" oldID="" iCode="rD94LTAKe4ROXa50SLH7oQ==" householdID="14338522" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName>Nicholas</firstName>
<lastName>Floyd</lastName>
<suffix></suffix>
<middleName>A</middleName>
<goesByName>Nick</goesByName>
<formerName></formerName>
<gender>Male</gender>
<dateOfBirth>1976-08-13T00:00:00</dateOfBirth>
<maritalStatus>Married</maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1">
<name>Member</name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer>Fellowship Technologies</employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode>dfhg</barCode>
<memberEnvelopeCode>12341234</memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank></thank>
<firstRecord>2008-12-11T07:41:07</firstRecord>
<lastMatchDate></lastMatchDate>
<createdDate>2008-12-11T07:41:08</createdDate>
<lastUpdatedDate>2009-04-30T15:12:49</lastUpdatedDate>
</person>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941.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/22114941.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:37:32 GMT
Content-Length: 1245
{
"person": {
"@id": "22114941",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941",
"@imageURI": "",
"@oldID": "",
"@iCode": "rD94LTAKe4ROXa50SLH7oQ==",
"@householdID": "14338522",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": "Nicholas",
"lastName": "Floyd",
"suffix": null,
"middleName": "A",
"goesByName": "Nick",
"formerName": null,
"gender": "Male",
"dateOfBirth": "1976-08-13T00:00:00",
"maritalStatus": "Married",
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1",
"name": "Member",
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": "Fellowship Technologies",
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": "dfhg",
"memberEnvelopeCode": "12341234",
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": null,
"firstRecord": "2008-12-11T07:41:07",
"lastMatchDate": null,
"createdDate": "2008-12-11T07:41:08",
"lastUpdatedDate": "2009-04-30T15:12:49"
}
}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+xml
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:36:38 GMT
Content-Length: 1779
<?xml version="1.0" encoding="utf-8"?>
<person id="22114941" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941" imageURI="" oldID="" iCode="rD94LTAKe4ROXa50SLH7oQ==" householdID="14338522" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName>Nicholas</firstName>
<lastName>Floyd</lastName>
<suffix></suffix>
<middleName>A</middleName>
<goesByName>Nick</goesByName>
<formerName></formerName>
<gender>Male</gender>
<dateOfBirth>1976-08-13T00:00:00</dateOfBirth>
<maritalStatus>Married</maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1">
<name>Member</name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer>Fellowship Technologies</employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode>dfhg</barCode>
<memberEnvelopeCode>12341234</memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank></thank>
<firstRecord>2008-12-11T07:41:07</firstRecord>
<lastMatchDate></lastMatchDate>
<unsubscribed>false</unsubscribed>
<createdDate>2008-12-11T07:41:08</createdDate>
<lastUpdatedDate>2009-04-30T15:12:49</lastUpdatedDate>
</person>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941.json *Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+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/22114941.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:37:32 GMT
Content-Length: 1245
{
"person": {
"@id": "22114941",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941",
"@imageURI": "",
"@oldID": "",
"@iCode": "rD94LTAKe4ROXa50SLH7oQ==",
"@householdID": "14338522",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": "Nicholas",
"lastName": "Floyd",
"suffix": null,
"middleName": "A",
"goesByName": "Nick",
"formerName": null,
"gender": "Male",
"dateOfBirth": "1976-08-13T00:00:00",
"maritalStatus": "Married",
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1",
"name": "Member",
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": "Fellowship Technologies",
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": "dfhg",
"memberEnvelopeCode": "12341234",
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": null,
"firstRecord": "2008-12-11T07:41:07",
"lastMatchDate": null,
"unsubscribed": null,
"createdDate": "2008-12-11T07:41:08",
"lastUpdatedDate": "2009-04-30T15:12:49"
}
}
Method: edit [GET]
The edit
method will return a single person for a given id
. The purpose of the edit
method is to retrieve a resource in its most recent condition with its latest values.
Content-types ::
- application/json - version 1
- application/xml - version 1
- application/help - version 1
- application/vnd.fellowshiponeapi.com.people.people.v2+json - version 2
- application/vnd.fellowshiponeapi.com.people.people.v2+xml - version 2
Format ::
- json
- xml
Parameters ::
- {format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{id}/edit.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{id}/edit?format={format}
- [Header] Accept : {Content-type}
- {id}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{id}/edit
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941/edit
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:38:35 GMT
Content-Length: 1779
<?xml version="1.0" encoding="utf-8"?>
<person id="22114941" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941" imageURI="" oldID="" iCode="rD94LTAKe4ROXa50SLH7oQ==" householdID="14338522" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName>Nicholas</firstName>
<lastName>Floyd</lastName>
<suffix></suffix>
<middleName>A</middleName>
<goesByName>Nick</goesByName>
<formerName></formerName>
<gender>Male</gender>
<dateOfBirth>1976-08-13T00:00:00</dateOfBirth>
<maritalStatus>Married</maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1">
<name>Member</name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer>Fellowship Technologies</employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode>dfhg</barCode>
<memberEnvelopeCode>12341234</memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank></thank>
<firstRecord>2008-12-11T07:41:07</firstRecord>
<lastMatchDate></lastMatchDate>
<createdDate>2008-12-11T07:41:08</createdDate>
<lastUpdatedDate>2009-04-30T15:12:49</lastUpdatedDate>
</person>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941/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/22114941.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:37:32 GMT
Content-Length: 1245
{
"person": {
"@id": "22114941",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941",
"@imageURI": "",
"@oldID": "",
"@iCode": "rD94LTAKe4ROXa50SLH7oQ==",
"@householdID": "14338522",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": "Nicholas",
"lastName": "Floyd",
"suffix": null,
"middleName": "A",
"goesByName": "Nick",
"formerName": null,
"gender": "Male",
"dateOfBirth": "1976-08-13T00:00:00",
"maritalStatus": "Married",
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1",
"name": "Member",
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": "Fellowship Technologies",
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": "dfhg",
"memberEnvelopeCode": "12341234",
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": null,
"firstRecord": "2008-12-11T07:41:07",
"lastMatchDate": null,
"createdDate": "2008-12-11T07:41:08",
"lastUpdatedDate": "2009-04-30T15:12:49"
}
}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941/edit
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+xml
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:38:35 GMT
Content-Length: 1779
<?xml version="1.0" encoding="utf-8"?>
<person id="22114941" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941" imageURI="" oldID="" iCode="rD94LTAKe4ROXa50SLH7oQ==" householdID="14338522" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName>Nicholas</firstName>
<lastName>Floyd</lastName>
<suffix></suffix>
<middleName>A</middleName>
<goesByName>Nick</goesByName>
<formerName></formerName>
<gender>Male</gender>
<dateOfBirth>1976-08-13T00:00:00</dateOfBirth>
<maritalStatus>Married</maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1">
<name>Member</name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer>Fellowship Technologies</employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode>dfhg</barCode>
<memberEnvelopeCode>12341234</memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank></thank>
<firstRecord>2008-12-11T07:41:07</firstRecord>
<lastMatchDate></lastMatchDate>
<unsubscribed>false</unsubscribed>
<createdDate>2008-12-11T07:41:08</createdDate>
<lastUpdatedDate>2009-04-30T15:12:49</lastUpdatedDate>
</person>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941/edit.json
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+xml
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:37:32 GMT
Content-Length: 1245
{
"person": {
"@id": "22114941",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/22114941",
"@imageURI": "",
"@oldID": "",
"@iCode": "rD94LTAKe4ROXa50SLH7oQ==",
"@householdID": "14338522",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": "Nicholas",
"lastName": "Floyd",
"suffix": null,
"middleName": "A",
"goesByName": "Nick",
"formerName": null,
"gender": "Male",
"dateOfBirth": "1976-08-13T00:00:00",
"maritalStatus": "Married",
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1",
"name": "Member",
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": "Fellowship Technologies",
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": "dfhg",
"memberEnvelopeCode": "12341234",
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": null,
"firstRecord": "2008-12-11T07:41:07",
"lastMatchDate": null,
"unsubscribed": null,
"createdDate": "2008-12-11T07:41:08",
"lastUpdatedDate": "2009-04-30T15:12:49"
}
}
Method: new [GET]
The new
method will return a single person. The purpose of the new
method is to retrieve an empty resource with the proper structure.
Content-types ::
- application/json - version 1
- application/xml - version 1
- application/help - version 1
- application/vnd.fellowshiponeapi.com.people.people.v2+json - version 2
- application/vnd.fellowshiponeapi.com.people.people.v2+xml - version 2
Format ::
- json
- xml
Parameters ::
- {format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/new.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/new?format={format}
- [Header] Accept : {Content-type}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/New
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:40:27 GMT
Content-Length: 1492
<?xml version="1.0" encoding="utf-8"?>
<person id="" uri="" imageURI="" oldID="" iCode="" householdID="" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName></firstName>
<lastName></lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName></goesByName>
<formerName></formerName>
<gender></gender>
<dateOfBirth></dateOfBirth>
<maritalStatus></maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="" uri="">
<name></name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank></thank>
<firstRecord></firstRecord>
<lastMatchDate></lastMatchDate>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</person>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/New.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:41:20 GMT
Content-Length: 986
{
"person": {
"@id": "",
"@uri": "",
"@imageURI": "",
"@oldID": "",
"@iCode": "",
"@householdID": "",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": null,
"lastName": null,
"suffix": null,
"middleName": null,
"goesByName": null,
"formerName": null,
"gender": null,
"dateOfBirth": null,
"maritalStatus": null,
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "",
"@uri": "",
"name": null,
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": null,
"firstRecord": null,
"lastMatchDate": null,
"createdDate": null,
"lastUpdatedDate": null
}
}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/New
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+xml
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:40:27 GMT
Content-Length: 1492
<?xml version="1.0" encoding="utf-8"?>
<person id="" uri="" imageURI="" oldID="" iCode="" householdID="" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName></firstName>
<lastName></lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName></goesByName>
<formerName></formerName>
<gender></gender>
<dateOfBirth></dateOfBirth>
<maritalStatus></maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="" uri="">
<name></name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank></thank>
<firstRecord></firstRecord>
<lastMatchDate></lastMatchDate>
<unsubscribed>false</unsubscribed>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</person>
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/v1/People/New.json
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:41:20 GMT
Content-Length: 986
{
"person": {
"@id": "",
"@uri": "",
"@imageURI": "",
"@oldID": "",
"@iCode": "",
"@householdID": "",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": null,
"lastName": null,
"suffix": null,
"middleName": null,
"goesByName": null,
"formerName": null,
"gender": null,
"dateOfBirth": null,
"maritalStatus": null,
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "",
"@uri": "",
"name": null,
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": null,
"firstRecord": null,
"lastMatchDate": null,
"unsubscribed": false,
"createdDate": null,
"lastUpdatedDate": null
}
}
Method: create [POST]
The create
method will create a single person.
Notes ::
- This method will return a 201 - Created if successfully created
Content-types ::
- application/json - version 1
- application/xml - version 1
- application/vnd.fellowshiponeapi.com.people.people.v2+json - version 2
- application/vnd.fellowshiponeapi.com.people.people.v2+xml - version 2
Format ::
- json
- xml
Parameters ::
- {format}
- [POST] https://CHURCHCODE.fellowshiponeapi.com/v1/People.{format}
- [POST] https://CHURCHCODE.fellowshiponeapi.com/v1/People?format={format}
- [Header] Accept : {Content-type}
Required Fields ::
- householdID
- householdMemberType id
- status id
- firstName
- lastName
Sample Response ::
Given: [POST] https://CHURCHCODE.fellowshiponeapi.com/v1/People
Request body:
<?xml version="1.0" encoding="utf-8"?>
<person id="" uri="" imageURI="" oldID="" iCode="" householdID="14338522" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName>Nick</firstName>
<lastName>Floyd</lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName></goesByName>
<formerName></formerName>
<gender></gender>
<dateOfBirth></dateOfBirth>
<maritalStatus></maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1" uri="">
<name></name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank></thank>
<firstRecord></firstRecord>
<lastMatchDate></lastMatchDate>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</person>
Response:
HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115188
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:43:53 GMT
Content-Length: 1709
<?xml version="1.0" encoding="utf-8"?>
<person id="22115188" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115188" imageURI="" oldID="" iCode="dinc3LUdZ1YrUF/Os9Ik6A==" householdID="14338522" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName>Nick</firstName>
<lastName>Floyd</lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName></goesByName>
<formerName></formerName>
<gender></gender>
<dateOfBirth></dateOfBirth>
<maritalStatus></maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1">
<name>Member</name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank>true</thank>
<firstRecord>2009-05-01T00:43:52</firstRecord>
<lastMatchDate></lastMatchDate>
<createdDate>2009-05-01T00:43:50</createdDate>
<lastUpdatedDate>2009-05-01T00:43:52</lastUpdatedDate>
</person>
Given: [POST] https://CHURCHCODE.fellowshiponeapi.com/v1/People.json
Request body:
{
"person": {
"@id": "",
"@uri": "",
"@imageURI": "",
"@oldID": "",
"@iCode": "",
"@householdID": "14338522",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": "Nick",
"lastName": "Floyd",
"suffix": null,
"middleName": null,
"goesByName": null,
"formerName": null,
"gender": null,
"dateOfBirth": null,
"maritalStatus": null,
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "1",
"@uri": "",
"name": null,
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": null,
"firstRecord": null,
"lastMatchDate": null,
"createdDate": null,
"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.json/22115189
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:46:51 GMT
Content-Length: 1189
{
"person": {
"@id": "22115189",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115189",
"@imageURI": "",
"@oldID": "",
"@iCode": "AnzuAZSIPebTlqj6WaeMIw==",
"@householdID": "14338522",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": "Nick",
"lastName": "Floyd",
"suffix": null,
"middleName": null,
"goesByName": null,
"formerName": null,
"gender": null,
"dateOfBirth": null,
"maritalStatus": null,
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1",
"name": "Member",
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": "true",
"firstRecord": "2009-05-01T00:46:51",
"lastMatchDate": null,
"createdDate": "2009-05-01T00:46:51",
"lastUpdatedDate": "2009-05-01T00:46:51"
}
}
Sample Response ::
Given: [POST] https://CHURCHCODE.fellowshiponeapi.com/v1/People
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+xml
Request body:
<?xml version="1.0" encoding="utf-8"?>
<person id="" uri="" imageURI="" oldID="" iCode="" householdID="14338522" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName>Nick</firstName>
<lastName>Floyd</lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName></goesByName>
<formerName></formerName>
<gender></gender>
<dateOfBirth></dateOfBirth>
<maritalStatus></maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1" uri="">
<name></name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank></thank>
<firstRecord></firstRecord>
<lastMatchDate></lastMatchDate>
<unsubscribed>false</unsubscribed>
<createdDate></createdDate>
<lastUpdatedDate></lastUpdatedDate>
</person>
Response:
HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115188
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:43:53 GMT
Content-Length: 1709
<?xml version="1.0" encoding="utf-8"?>
<person id="22115188" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115188" imageURI="" oldID="" iCode="dinc3LUdZ1YrUF/Os9Ik6A==" householdID="14338522" oldHouseholdID="">
<title></title>
<salutation></salutation>
<prefix></prefix>
<firstName>Nick</firstName>
<lastName>Floyd</lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName></goesByName>
<formerName></formerName>
<gender></gender>
<dateOfBirth></dateOfBirth>
<maritalStatus></maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1">
<name>Member</name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank>true</thank>
<firstRecord>2009-05-01T00:43:52</firstRecord>
<lastMatchDate></lastMatchDate>
<unsubscribed>false</unsubscribed>
<createdDate>2009-05-01T00:43:50</createdDate>
<lastUpdatedDate>2009-05-01T00:43:52</lastUpdatedDate>
</person>
Given: [POST] https://CHURCHCODE.fellowshiponeapi.com/v1/People.json
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+json
Request body:
{
"person": {
"@id": "",
"@uri": "",
"@imageURI": "",
"@oldID": "",
"@iCode": "",
"@householdID": "14338522",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": "Nick",
"lastName": "Floyd",
"suffix": null,
"middleName": null,
"goesByName": null,
"formerName": null,
"gender": null,
"dateOfBirth": null,
"maritalStatus": null,
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "1",
"@uri": "",
"name": null,
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": null,
"firstRecord": null,
"lastMatchDate": null,
"unsubscribed": false,
"createdDate": null,
"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.json/22115189
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:46:51 GMT
Content-Length: 1189
{
"person": {
"@id": "22115189",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115189",
"@imageURI": "",
"@oldID": "",
"@iCode": "AnzuAZSIPebTlqj6WaeMIw==",
"@householdID": "14338522",
"@oldHouseholdID": "",
"title": null,
"salutation": null,
"prefix": null,
"firstName": "Nick",
"lastName": "Floyd",
"suffix": null,
"middleName": null,
"goesByName": null,
"formerName": null,
"gender": null,
"dateOfBirth": null,
"maritalStatus": null,
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1",
"name": "Member",
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": "true",
"firstRecord": "2009-05-01T00:46:51",
"lastMatchDate": null,
"unsubscribed": false,
"createdDate": "2009-05-01T00:46:51",
"lastUpdatedDate": "2009-05-01T00:46:51"
}
}
Method: update [PUT] [POST (Low REST)]
The update
method will update a single person.
Content-types ::
- application/json - version 1
- application/xml - version 1
- application/vnd.fellowshiponeapi.com.people.people.v2+json - version 2
- application/vnd.fellowshiponeapi.com.people.people.v2+xml - version 2
Format ::
- json
- xml
Parameters ::
- {format}
- [PUT] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{id}.{format}
- [PUT] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{id}?format={format}
- [Header] Accept : {Content-type}
- {id}
- [PUT] https://CHURCHCODE.fellowshiponeapi.com/v1/People/{id}
Required Fields ::
- person id
- householdID
- householdMemberType id
- status id
- lastName
Sample Response ::
Given: [PUT] https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159
Request body:
<?xml version="1.0" encoding="utf-8"?>
<person id="22115159" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159" imageURI="" oldID="" iCode="bc2KX74gNPnldq+ZTTEWyg==" householdID="14338522" oldHouseholdID="">
<title>Mr.</title>
<salutation></salutation>
<prefix></prefix>
<firstName>Nick</firstName>
<lastName>Floyd</lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName></goesByName>
<formerName></formerName>
<gender></gender>
<dateOfBirth></dateOfBirth>
<maritalStatus></maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1">
<name>Member</name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank></thank>
<firstRecord>2009-04-11T02:47:26</firstRecord>
<lastMatchDate></lastMatchDate>
<createdDate>2009-04-11T02:47:26</createdDate>
<lastUpdatedDate>2009-04-11T02:53:10</lastUpdatedDate>
</person>
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:49:13 GMT
Content-Length: 1708
<?xml version="1.0" encoding="utf-8"?>
<person id="22115159" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159" imageURI="" oldID="" iCode="bc2KX74gNPnldq+ZTTEWyg==" householdID="14338522" oldHouseholdID="">
<title>Mr.</title>
<salutation></salutation>
<prefix></prefix>
<firstName>Nick</firstName>
<lastName>Floyd</lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName></goesByName>
<formerName></formerName>
<gender></gender>
<dateOfBirth></dateOfBirth>
<maritalStatus></maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1">
<name>Member</name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank></thank>
<firstRecord>2009-04-11T02:47:26</firstRecord>
<lastMatchDate></lastMatchDate>
<createdDate>2009-04-11T02:47:26</createdDate>
<lastUpdatedDate>2009-05-01T00:49:14</lastUpdatedDate>
</person>
Given: [PUT] https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159.json
Request body:
{
"person": {
"@id": "22115159",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159",
"@imageURI": "",
"@oldID": "",
"@iCode": "bc2KX74gNPnldq+ZTTEWyg==",
"@householdID": "14338522",
"@oldHouseholdID": "",
"title": "Mr.",
"salutation": null,
"prefix": null,
"firstName": "Nick",
"lastName": "Floyd",
"suffix": null,
"middleName": null,
"goesByName": null,
"formerName": null,
"gender": null,
"dateOfBirth": null,
"maritalStatus": null,
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1",
"name": "Member",
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": null,
"firstRecord": "2009-04-11T02:47:26",
"lastMatchDate": null,
"createdDate": "2009-04-11T02:47:26",
"lastUpdatedDate": "2009-05-01T00:49:14"
}
}
Response
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:51:08 GMT
Content-Length: 1188
{
"person": {
"@id": "22115159",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159",
"@imageURI": "",
"@oldID": "",
"@iCode": "bc2KX74gNPnldq+ZTTEWyg==",
"@householdID": "14338522",
"@oldHouseholdID": "",
"title": "Mr.",
"salutation": null,
"prefix": null,
"firstName": "Nick",
"lastName": "Floyd",
"suffix": null,
"middleName": null,
"goesByName": null,
"formerName": null,
"gender": null,
"dateOfBirth": null,
"maritalStatus": null,
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1",
"name": "Member",
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": null,
"firstRecord": "2009-04-11T02:47:26",
"lastMatchDate": null,
"createdDate": "2009-04-11T02:47:26",
"lastUpdatedDate": "2009-05-01T00:51:08"
}
}
Sample Response ::
Given: [PUT] https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+xml
Request body:
<?xml version="1.0" encoding="utf-8"?>
<person id="22115159" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159" imageURI="" oldID="" iCode="bc2KX74gNPnldq+ZTTEWyg==" householdID="14338522" oldHouseholdID="">
<title>Mr.</title>
<salutation></salutation>
<prefix></prefix>
<firstName>Nick</firstName>
<lastName>Floyd</lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName></goesByName>
<formerName></formerName>
<gender></gender>
<dateOfBirth></dateOfBirth>
<maritalStatus></maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1">
<name>Member</name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank></thank>
<firstRecord>2009-04-11T02:47:26</firstRecord>
<lastMatchDate></lastMatchDate>
<unsubscribed>false</unsubscribed>
<createdDate>2009-04-11T02:47:26</createdDate>
<lastUpdatedDate>2009-04-11T02:53:10</lastUpdatedDate>
</person>
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:49:13 GMT
Content-Length: 1708
<?xml version="1.0" encoding="utf-8"?>
<person id="22115159" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159" imageURI="" oldID="" iCode="bc2KX74gNPnldq+ZTTEWyg==" householdID="14338522" oldHouseholdID="">
<title>Mr.</title>
<salutation></salutation>
<prefix></prefix>
<firstName>Nick</firstName>
<lastName>Floyd</lastName>
<suffix></suffix>
<middleName></middleName>
<goesByName></goesByName>
<formerName></formerName>
<gender></gender>
<dateOfBirth></dateOfBirth>
<maritalStatus></maritalStatus>
<householdMemberType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1">
<name>Head</name>
</householdMemberType>
<isAuthorized>true</isAuthorized>
<status id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1">
<name>Member</name>
<comment></comment>
<date></date>
<subStatus id="" uri="">
<name></name>
</subStatus>
</status>
<occupation id="" uri="">
<name></name>
<description></description>
</occupation>
<employer></employer>
<school id="" uri="">
<name></name>
</school>
<denomination id="" uri="">
<name></name>
</denomination>
<formerChurch></formerChurch>
<barCode></barCode>
<memberEnvelopeCode></memberEnvelopeCode>
<defaultTagComment></defaultTagComment>
<weblink>
<userID></userID>
<passwordHint></passwordHint>
<passwordAnswer></passwordAnswer>
</weblink>
<solicit></solicit>
<thank></thank>
<firstRecord>2009-04-11T02:47:26</firstRecord>
<lastMatchDate></lastMatchDate>
<unsubscribed>false</unsubscribed>
<createdDate>2009-04-11T02:47:26</createdDate>
<lastUpdatedDate>2009-05-01T00:49:14</lastUpdatedDate>
</person>
Given: [PUT] https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159.json
*Content-Type:* application/vnd.fellowshiponeapi.com.people.people.v2+json
Request body:
{
"person": {
"@id": "22115159",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159",
"@imageURI": "",
"@oldID": "",
"@iCode": "bc2KX74gNPnldq+ZTTEWyg==",
"@householdID": "14338522",
"@oldHouseholdID": "",
"title": "Mr.",
"salutation": null,
"prefix": null,
"firstName": "Nick",
"lastName": "Floyd",
"suffix": null,
"middleName": null,
"goesByName": null,
"formerName": null,
"gender": null,
"dateOfBirth": null,
"maritalStatus": null,
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1",
"name": "Member",
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": null,
"firstRecord": "2009-04-11T02:47:26",
"lastMatchDate": null,
"unsubscribed": false,
"createdDate": "2009-04-11T02:47:26",
"lastUpdatedDate": "2009-05-01T00:49:14"
}
}
Response
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Fri, 01 May 2009 05:51:08 GMT
Content-Length: 1188
{
"person": {
"@id": "22115159",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/22115159",
"@imageURI": "",
"@oldID": "",
"@iCode": "bc2KX74gNPnldq+ZTTEWyg==",
"@householdID": "14338522",
"@oldHouseholdID": "",
"title": "Mr.",
"salutation": null,
"prefix": null,
"firstName": "Nick",
"lastName": "Floyd",
"suffix": null,
"middleName": null,
"goesByName": null,
"formerName": null,
"gender": null,
"dateOfBirth": null,
"maritalStatus": null,
"householdMemberType": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/HouseholdMemberTypes/1",
"name": "Head"
},
"isAuthorized": "true",
"status": {
"@id": "1",
"@uri": "https://CHURCHCODE.fellowshiponeapi.com/v1/People/Statuses/1",
"name": "Member",
"comment": null,
"date": null,
"subStatus": {
"@id": "",
"@uri": "",
"name": null
}
},
"occupation": {
"@id": "",
"@uri": "",
"name": null,
"description": null
},
"employer": null,
"school": {
"@id": "",
"@uri": "",
"name": null
},
"denomination": {
"@id": "",
"@uri": "",
"name": null
},
"formerChurch": null,
"barCode": null,
"memberEnvelopeCode": null,
"defaultTagComment": null,
"weblink": {
"userID": null,
"passwordHint": null,
"passwordAnswer": null
},
"solicit": null,
"thank": null,
"firstRecord": "2009-04-11T02:47:26",
"lastMatchDate": null,
"unsubscribed": false,
"createdDate": "2009-04-11T02:47:26",
"lastUpdatedDate": "2009-05-01T00:51:08"
}
}