Attributes
An attribute or collection of attributes are used for people
.
Authentication
This method requires Authentication
Resource Structure
This resource conforms to the following XSD
Methods
Attributes ::
- list [GET] https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/{attributeGroupID}/Attributes
- show [GET] https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/{attributeGroupID}/Attributes/{id}
Method: list [GET]
The list
method will return a list of attributes.
Notes ::
list
andshow
are the only available methods for this resource; this resource cannot be updated via the API- By passing in the
content-type
ofapplication/help
in theaccept
header or using the {format} parameterhelp
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://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/{attributeGroupID}/Attributes.{format}
- [GET] https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/{attributeGroupID}/Attributes?format={format}
- [Header] Accept : {Content-type}
- {attributeGroupID}
- [GET] https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/{attributeGroupID}/Attributes
Sample Response ::
Given: [GET] https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/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 06:43:28 GMT
Content-Length: 1000
<?xml version="1.0" encoding="utf-8"?>
<attributes>
<attribute json:Array="true" id="958" uri="https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958" oldID="449">
<name>Baptism</name>
</attribute>
<attribute json:Array="true" id="961" uri="https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/961" oldID="452">
<name>Elementary - Accepting Christ</name>
</attribute>
<attribute json:Array="true" id="960" uri="https://demo.staging.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://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/959" oldID="450">
<name>Newcomers - Completed</name>
</attribute>
<attribute json:Array="true" id="89470" uri="https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/89470" oldID="">
<name>Wedding Anniversary</name>
</attribute>
</attributes>
Given: [GET] https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/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 18:02:58 GMT
Content-Length: 833
{
"attributes": {
"attribute": [
{
"@array": "true",
"@id": "958",
"@uri": "https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958",
"@oldID": "449",
"name": "Baptism"
},
{
"@array": "true",
"@id": "961",
"@uri": "https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/961",
"@oldID": "452",
"name": "Elementary - Accepting Christ"
},
....
]
}
}
Method: show [GET]
The show
method will return a single attribute for a given id
.
Notes ::
list
andshow
are the only available methods on this resource; this resource cannot be updated via the API- 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
- application/xml
- application/xsd
Format ::
- json
- xml
- xsd
Parameters ::
- {format}
- [GET] https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/{attributeGroupID}/Attributes/{id}.{format}
- [GET] https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/{attributeGroupID}/Attributes/{id}?format={format}
- [Header] Accept : {Content-type}
- {attributeGroupID}
- [GET] https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/{attributeGroupID}/Attributes/{id}
- {id}
- [GET] https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/{attributeGroupID}/Attributes/{id}
Sample Response ::
Given: [GET] https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958
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:29:05 GMT
Content-Length: 173
<?xml version="1.0" encoding="utf-8"?>
<attribute id="958" uri="https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958" oldID="449">
<name>Baptism</name>
</attribute>
Given: [GET] https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958.json
Response:
HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958.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:04:47 GMT
Content-Length: 144
{
"attribute": {
"@id": "958",
"@uri": "https://demo.staging.fellowshiponeapi.com/v1/People/AttributeGroups/145/Attributes/958",
"@oldID": "449",
"name": "Baptism"
}
}