Fellowship One REST API

API Index | Authentication | HTTP Status Codes | HTTP Headers | Single Sign On Client Implementation | Single Sign On Host Implementation

Statuses

A status or collection of statuses are used for people.

Authentication

This method requires Authentication

Resource Structure

This resource conforms to the following XSD

Methods

Statuses ::

• list [GET] https://demo.staging.fellowshiponeapi.com/v1/People/Statuses
• show [GET] https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/{id}

Method: list [GET]

The list method will return a list of statuses.

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://demo.staging.fellowshiponeapi.com/v1/People/Statuses.{format}
  • [GET] https://demo.staging.fellowshiponeapi.com/v1/People/Statuses?format={format}
  • [Header] Accept : {Content-type}

Sample Response ::

Given: [GET] https://demo.staging.fellowshiponeapi.com/v1/People/Statuses

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/Statuses
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:29:50 GMT
Content-Length: 6950

<?xml version="1.0" encoding="utf-8"?>
<statuses>
  <status json:Array="true" id="1" uri="https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/1">
	<name>Member</name>
	<subStatus json:Array="true" id="400" uri="https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/400">
	  <name>Letter</name>
	</subStatus>
	<subStatus json:Array="true" id="4182" uri="https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/4182">
	  <name>Dismember22</name>
	</subStatus>
  </status>
  <status json:Array="true" id="3" uri="https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/3">
	<name>Child of Member</name>
	<subStatus json:Array="true" id="840" uri="https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/3/SubStatuses/840">
	  <name>Select List?</name>
	</subStatus>
  </status>
  <status json:Array="true" id="4" uri="https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/4">
	<name>Attendee</name>
	<subStatus json:Array="true" id="2355" uri="https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/4/SubStatuses/2355">
	  <name>uu</name>
	</subStatus>
  </status>
  ...
<statuses>

Given: [GET] https://demo.staging.fellowshiponeapi.com/v1/People/Statuses.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/Statuses.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:57:51 GMT
Content-Length: 5813

{
	"statuses": {
		"status": [
			{
				"@array": "true",
				"@id": "1",
				"@uri": "https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/1",
				"name": "Member",
				"subStatus": [
					{
						"@array": "true",
						"@id": "400",
						"@uri": "https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/400",
						"name": "Letter"
					},
					{
						"@array": "true",
						"@id": "4182",
						"@uri": "https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/4182",
						"name": "Dismember22"
					}
				]
			},
			{
				"@array": "true",
				"@id": "3",
				"@uri": "https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/3",
				"name": "Child of Member",
				"subStatus": [
					{
						"@array": "true",
						"@id": "840",
						"@uri": "https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/3/SubStatuses/840",
						"name": "Select List?"
					}
				]
			},
			{
				"@array": "true",
				"@id": "4",
				"@uri": "https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/4",
				"name": "Attendee",
				"subStatus": [
					{
						"@array": "true",
						"@id": "2355",
						"@uri": "https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/4/SubStatuses/2355",
						"name": "uu"
					}
				]
			},
			...
		]
	}
}

Method: show [GET]

The show method will return a single status 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://demo.staging.fellowshiponeapi.com/v1/People/Statuses/{id}.{format}
  • [GET] https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/{id}?format={format}
  • [Header] Accept : {Content-type}
• {id}
  • [GET] https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/{id}

Sample Response ::

Given: [GET] https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/1

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/Statuses/1
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:30:30 GMT
Content-Length: 432

<?xml version="1.0" encoding="utf-8"?>
<status id="1" uri="https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/1">
  <name>Member</name>
  <subStatus id="400" uri="https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/400">
	<name>Letter</name>
  </subStatus>
  <subStatus id="4182" uri="https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/4182">
	<name>Dismember22</name>
  </subStatus>
</status>

Given: [GET] https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/1.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/Statuses/1.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:59:21 GMT
Content-Length: 334

{
	"status": {
		"@id": "1",
		"@uri": "https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/1",
		"name": "Member",
		"subStatus": [
			{
				"@id": "400",
				"@uri": "https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/400",
				"name": "Letter"
			},
			{
				"@id": "4182",
				"@uri": "https://demo.staging.fellowshiponeapi.com/v1/People/Statuses/1/SubStatuses/4182",
				"name": "Dismember22"
			}
		]
	}
}