Fellowship One RESTful API - AttributeGroups

Attribute Groups

An attribute group or collection of attribute groups are used for people.

Authentication

This method requires Authentication

Resource Structure

This resource conforms to the following XSD

Methods

Attribute Groups ::

list [GET] https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups
show [GET] https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/{id}

Method: list [GET]

The list method will return a list of attribute groups.

Notes ::

list and show are the only available methods for this resource; this resource cannot be updated via the API
By passing in the content-type of application/help in the accept header or using the {format} parameter help the API will return an html representation of the help documents for this resource (authentication not required)

Content-types ::

application/json
application/xml
application/help

Format ::

json
xml
help

Parameters ::

{format}
- [GET] https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups.{format}
- [GET] https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups?format={format}
- [Header] Accept : {Content-type}

Sample Response ::

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

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups
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 05:11:13 GMT
Content-Length: 9423

<?xml version="1.0" encoding="utf-8"?>
<attributeGroups>
  <attributeGroup json:Array="true" id="145" uri="https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145" oldID="">
	<name>Experiences</name>
	<attribute json:Array="true" id="958" uri="https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958" oldID="449">
	  <name>Baptism</name>
	</attribute>
	<attribute json:Array="true" id="961" uri="https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/961" oldID="452">
	  <name>Elementary - Accepting Christ</name>
	</attribute>
	<attribute json:Array="true" id="960" uri="https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/960" oldID="451">
	  <name>Made a Profession of Faith</name>
	</attribute>
	<attribute json:Array="true" id="959" uri="https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/959" oldID="450">
	  <name>Newcomers - Completed</name>
	</attribute>
	<attribute json:Array="true" id="89470" uri="https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/89470" oldID="">
	  <name>Wedding Anniversary</name>
	</attribute>
  </attributeGroup>
	...
</attributeGroups>

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups.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/AttributeGroups.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 18:06:25 GMT
Content-Length: 9799

{
	"attributeGroups": {
		"attributeGroup": [
			{
				"@array": "true",
				"@id": "145",
				"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145",
				"@oldID": "",
				"name": "Experiences",
				"attribute": [
					{
						"@array": "true",
						"@id": "958",
						"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958",
						"@oldID": "449",
						"name": "Baptism"
					},
					{
						"@array": "true",
						"@id": "961",
						"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/961",
						"@oldID": "452",
						"name": "Elementary - Accepting Christ"
					},
					{
						"@array": "true",
						"@id": "960",
						"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/960",
						"@oldID": "451",
						"name": "Made a Profession of Faith"
					},
					{
						"@array": "true",
						"@id": "959",
						"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/959",
						"@oldID": "450",
						"name": "Newcomers - Completed"
					},
					{
						"@array": "true",
						"@id": "89470",
						"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/89470",
						"@oldID": "",
						"name": "Wedding Anniversary"
					}
				]
			},
			{
				"@array": "true",
				"@id": "151",
				"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/151",
				"@oldID": "",
				"name": "Arts & Crafts"
			},
			{
				"@array": "true",
				"@id": "152",
				"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/152",
				"@oldID": "",
				"name": "Adventure Weekv",
				"attribute": [
					{
						"@array": "true",
						"@id": "29762",
						"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/152/Attributes/29762",
						"@oldID": "",
						"name": "Activity Team"
					},
					{
						"@array": "true",
						"@id": "56854",
						"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/152/Attributes/56854",
						"@oldID": "",
						"name": "Brian's QA"
					},
					{
						"@array": "true",
						"@id": "984",
						"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/152/Attributes/984",
						"@oldID": "",
						"name": "Sign Builder Team"
					},
					{
						"@array": "true",
						"@id": "980",
						"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/152/Attributes/980",
						"@oldID": "",
						"name": "Snack Team"
					}
				]
			},
			...
		]
	}
}

Method: show [GET]

The show method will return a single attribute group for a given id.

Notes ::

list and show are the only available methods on this resource; this resource cannot be updated via the API
By passing in the content-type of application/xsd in the accept header or using the {format} parameter xsd the API will return an xsd for a single version of this resource (authentication not required)

Content-types ::

application/json
application/xml
application/xsd

Format ::

json
xml
xsd

Parameters ::

{format}
- [GET] https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/{id}.{format}
- [GET] https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/{id}?format={format}
- [Header] Accept : {Content-type}
{id}
- [GET] https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/{id}

Sample Response ::

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145
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 06:50:01 GMT
Content-Length: 1056

<?xml version="1.0" encoding="utf-8"?>
<attributeGroup id="145" uri="https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145" oldID="">
  <name>Experiences</name>
  <attribute id="958" uri="https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958" oldID="449">
	<name>Baptism</name>
  </attribute>
  <attribute id="961" uri="https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/961" oldID="452">
	<name>Elementary - Accepting Christ</name>
  </attribute>
  <attribute id="960" uri="https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/960" oldID="451">
	<name>Made a Profession of Faith</name>
  </attribute>
  <attribute id="959" uri="https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/959" oldID="450">
	<name>Newcomers - Completed</name>
  </attribute>
  <attribute id="89470" uri="https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/89470" oldID="">
	<name>Wedding Anniversary</name>
  </attribute>
</attributeGroup>

Given: [GET] https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145.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/AttributeGroups/145.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 18:08:11 GMT
Content-Length: 872

{
	"attributeGroup": {
		"@id": "145",
		"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145",
		"@oldID": "",
		"name": "Experiences",
		"attribute": [
			{
				"@id": "958",
				"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958",
				"@oldID": "449",
				"name": "Baptism"
			},
			{
				"@id": "961",
				"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/961",
				"@oldID": "452",
				"name": "Elementary - Accepting Christ"
			},
			{
				"@id": "960",
				"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/960",
				"@oldID": "451",
				"name": "Made a Profession of Faith"
			},
			{
				"@id": "959",
				"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/959",
				"@oldID": "450",
				"name": "Newcomers - Completed"
			},
			{
				"@id": "89470",
				"@uri": "https://churchcode.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/89470",
				"@oldID": "",
				"name": "Wedding Anniversary"
			}
		]
	}
}

Fellowship One REST API

Attribute Groups

Authentication

Resource Structure

Methods

Method: list [GET]

Method: show [GET]