Fellowship One REST API

People Attributes

An attribute or collection of attributes can belong to people and are context aware.

Authentication

This method requires Authentication

Resource Structure

This resource conforms to the following XSD

Methods

People Attributes ::

Method: list [GET]

The list method will return a list of attributes based on context (people).

Notes ::

Content-types ::

Format ::

Parameters ::

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 28 Apr 2009 07:38:06 GMT
Content-Length: 1549

<?xml version="1.0" encoding="utf-8"?>
<attributes>
  <attribute json:Array="true" id="29717631" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717631">
	<person id="1636208" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208" />
	<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></startDate>
	<endDate></endDate>
	<comment>Nicks stest</comment>
	<createdDate>2009-03-20T08:14:23</createdDate>
	<lastUpdatedDate>2009-03-24T11:12:17</lastUpdatedDate>
  </attribute>
  <attribute json:Array="true" id="235585" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/235585">
	<person id="1636208" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208" />
	<attributeGroup id="145" uri="https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145">
	  <name>Experiences</name>
	  <attribute id="959" uri="https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/959">
		<name>Newcomers - Completed</name>
	  </attribute>
	</attributeGroup>
	<startDate>2004-01-08T00:00:00</startDate>
	<endDate></endDate>
	<comment></comment>
	<createdDate></createdDate>
	<lastUpdatedDate></lastUpdatedDate>
  </attribute>
</attributes>

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes.json

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes.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 19:03:08 GMT
Content-Length: 1174

{
	"attributes": {
		"attribute": [
			{
				"@array": "true",
				"@id": "29717631",
				"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717631",
				"person": {
					"@id": "1636208",
					"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208"
				},
				"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": null,
				"endDate": null,
				"comment": "Nicks stest",
				"createdDate": "2009-03-20T08:14:23",
				"lastUpdatedDate": "2009-03-24T11:12:17"
			},
			{
				"@array": "true",
				"@id": "235585",
				"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/235585",
				"person": {
					"@id": "1636208",
					"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208"
				},
				"attributeGroup": {
					"@id": "145",
					"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145",
					"name": "Experiences",
					"attribute": {
						"@id": "959",
						"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/959",
						"name": "Newcomers - Completed"
					}
				},
				"startDate": "2004-01-08T00:00:00",
				"endDate": null,
				"comment": null,
				"createdDate": null,
				"lastUpdatedDate": null
			}
		]
	}
}

Method: show [GET]

The show method will return a single attribute for a given context (people) for a given id.

Notes ::

Content-types ::

Format ::

Parameters ::

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717631

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717631
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 28 Apr 2009 07:38:26 GMT
Content-Length: 748

<?xml version="1.0" encoding="utf-8"?>
<attribute id="29717631" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717631">
  <person id="1636208" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208" />
  <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></startDate>
  <endDate></endDate>
  <comment>Nicks stest</comment>
  <createdDate>2009-03-20T08:14:23</createdDate>
  <lastUpdatedDate>2009-03-24T11:12:17</lastUpdatedDate>
</attribute>

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717631.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/1636208/Attributes/29717631.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 19:07:37 GMT
Content-Length: 577

{
	"attribute": {
		"@id": "29717631",
		"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717631",
		"person": {
			"@id": "1636208",
			"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208"
		},
		"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": null,
		"endDate": null,
		"comment": "Nicks stest",
		"createdDate": "2009-03-20T08:14:23",
		"lastUpdatedDate": "2009-03-24T11:12:17"
	}
}

Method: edit [GET]

The edit method will return a single attribute for a given context (people) 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 ::

Format ::

Parameters ::

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717631/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: Sun, 12 Apr 2009 03:02:23 GMT
Content-Length: 691

<?xml version="1.0" encoding="utf-8"?>
<attribute id="29717631" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717631">
  <person id="1636208" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208" />
  <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></startDate>
  <endDate></endDate>
  <comment>Nicks stest</comment>
  <createdDate>2009-03-20T08:14:23</createdDate>
  <lastUpdatedDate>2009-03-24T11:12:17</lastUpdatedDate>
</attribute>

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717631/edit.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 19:09:13 GMT
Content-Length: 577

{
	"attribute": {
		"@id": "29717631",
		"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717631",
		"person": {
			"@id": "1636208",
			"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208"
		},
		"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": null,
		"endDate": null,
		"comment": "Nicks stest",
		"createdDate": "2009-03-20T08:14:23",
		"lastUpdatedDate": "2009-03-24T11:12:17"
	}
}

Method: new [GET]

The new method will return a single attribute with context (people). The purpose of the new method is to retrieve an empty resource with the proper structure.

Notes ::

Content-types ::

Format ::

Parameters ::

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/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: Tue, 28 Apr 2009 07:47:40 GMT
Content-Length: 445

<?xml version="1.0" encoding="utf-8"?>
<attribute id="" uri="">
  <person id="1636208" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208" />
  <attributeGroup id="" uri="">
	<name></name>
	<attribute id="" uri="">
	  <name></name>
	</attribute>
  </attributeGroup>
  <startDate></startDate>
  <endDate></endDate>
  <comment></comment>
  <createdDate></createdDate>
  <lastUpdatedDate></lastUpdatedDate>
</attribute>

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/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 19:10:54 GMT Content-Length: 303

{ "attribute": { "@id": "", "@uri": "", "person": { "@id": "1636208", "@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208" }, "attributeGroup": { "@id": "", "@uri": "", "name": null, "attribute": { "@id": "", "@uri": "", "name": null } }, "startDate": null, "endDate": null, "comment": null, "createdDate": null, "lastUpdatedDate": null } }

Method: create [POST]

The create method will create a single attribute with context (people).

Notes ::

Content-types ::

Format ::

Parameters ::

Required Fields ::

Sample Response ::

Given: [POST] https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes

Request body:

<?xml version="1.0" encoding="utf-8"?>
<attribute id="" uri="">
  <person id="1636208" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208" />
  <attributeGroup id="" uri="">
	<name></name>
	<attribute id="958" uri="">
		<name></name>
	</attribute>
  </attributeGroup>
  <startDate></startDate>
  <endDate></endDate>
  <comment></comment>
  <createdDate></createdDate>
  <lastUpdatedDate></lastUpdatedDate>
</attribute>

Response:

HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Location: https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717636
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Sun, 12 Apr 2009 03:07:10 GMT
Content-Length: 661

<?xml version="1.0" encoding="utf-8"?>
<attribute id="29717636" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717636">
  <person id="1636208" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208" />
  <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></startDate>
  <endDate></endDate>
  <comment></comment>
  <createdDate>2009-04-11T22:07:09</createdDate>
  <lastUpdatedDate></lastUpdatedDate>
</attribute>

Given: [POST] https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes.json

Request body:

{
	"attribute": {
		"@id": "",
		"@uri": "",
		"person": {
			"@id": "1636208",
			"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208"
		},
		"attributeGroup": {
			"@id": "",
			"@uri": "",
			"name": null,
			"attribute": {
				"@id": "958",
				"@uri": "",
				"name": null
			}
		},
		"startDate": null,
		"endDate": null,
		"comment": 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/1636208/Attributes.json/29717646
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 19:13:31 GMT
Content-Length: 551

{
	"attribute": {
		"@id": "29717646",
		"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717646",
		"person": {
			"@id": "1636208",
			"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208"
		},
		"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": null,
		"endDate": null,
		"comment": null,
		"createdDate": "2009-05-01T14:13:29",
		"lastUpdatedDate": null
	}
}

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

The update method will update a single attribute with context (people).

Notes ::

Content-types ::

Format ::

Parameters ::

Required Fields ::

Sample Response ::

Given: [PUT] https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717636

Request body:

<?xml version="1.0" encoding="utf-8"?>
<attribute id="29717636" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717636">
  <person id="1636208" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208" />
  <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">Baptism</attribute>
  </attributeGroup>
  <startDate></startDate>
  <endDate></endDate>
  <comment>New Comment</comment>
  <createdDate>2009-04-11T22:07:09</createdDate>
  <lastUpdatedDate></lastUpdatedDate>
</attribute>

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717636
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Sun, 12 Apr 2009 03:13:44 GMT
Content-Length: 691

<?xml version="1.0" encoding="utf-8"?>
<attribute id="29717636" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717636">
  <person id="1636208" uri="https://churchcode.fellowshiponeapi.com/v1/People/1636208" />
  <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></startDate>
  <endDate></endDate>
  <comment></comment>
  <createdDate>2009-04-11T22:07:09</createdDate>
  <lastUpdatedDate>2009-04-12T22:07:09</lastUpdatedDate>
</attribute>

Given: [PUT] https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717636

Request body:

{
	"attribute": {
		"@id": "29717646",
		"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717646",
		"person": {
			"@id": "1636208",
			"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208"
		},
		"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": null,
		"endDate": null,
		"comment": null,
		"createdDate": "2009-05-01T14:13:29",
		"lastUpdatedDate": null
	}
}

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717646.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 19:19:31 GMT
Content-Length: 568

{
	"attribute": {
		"@id": "29717646",
		"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717646",
		"person": {
			"@id": "1636208",
			"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/1636208"
		},
		"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": null,
		"endDate": null,
		"comment": null,
		"createdDate": "2009-05-01T14:13:29",
		"lastUpdatedDate": "2009-05-01T14:19:29"
	}
}

Method: delete [DELETE]

The delete method will delete a single attribute with context (people).

Notes ::

Parameters ::

Sample Response ::

Given: [Delete] https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717636

Response:

HTTP/1.1 204 The resource https://churchcode.fellowshiponeapi.com/v1/People/1636208/Attributes/29717636 has been deleted.
Cache-Control: private
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Sun, 12 Apr 2009 03:16:21 GMT