Fellowship One RESTful API - CommunicationTypes

Communication Types

A communication type or collection of communication types are used for households or people communications.

Authentication

This method requires Authentication

Resource Structure

This resource conforms to the following XSD

Methods

Communication Types ::

list [GET] https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes
show [GET] https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/{id}

Method: list [GET]

The list method will return a list of communication types based on context (households or people).

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)
Communications Type ID 6 - Infellowship Login is read only and can not be created, updated or deleted

Content-types ::

application/json
application/xml
application/help

Format ::

json
xml
help

Parameters ::

{format}
- [GET] https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes.{format}
- [GET] https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes?format={format}
- [Header] Accept : {Content-type}

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 07 Apr 2009 16:59:23 GMT
Content-Length: 2599

<?xml version="1.0" encoding="utf-8"?>
<communicationTypes>
  <communicationType json:Array="true" id="1" uri="https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/1" generalType="Telephone">
	<name>Home Phone</name>
  </communicationType>
  <communicationType json:Array="true" id="2" uri="https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/2" generalType="Telephone">
	<name>Work Phone</name>
  </communicationType>
  <communicationType json:Array="true" id="3" uri="https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/3" generalType="Telephone">
	<name>Mobile Phone</name>
  </communicationType>
  <communicationType json:Array="true" id="4" uri="https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/4" generalType="Email">
	<name>Email</name>
  </communicationType>
  <communicationType json:Array="true" id="5" uri="https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/5" generalType="Email">
	<name>Home Email</name>
  </communicationType>
  <communicationType json:Array="true" id="6" uri="https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/6" generalType="Email">
	<name>Infellowship Login</name>
  </communicationType>
  <communicationType json:Array="true" id="102" uri="https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/102" generalType="Web">
	<name>Web Address</name>
  </communicationType>
  <communicationType json:Array="true" id="127" uri="https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/127" generalType="Email">
	<name>Work Email</name>
  </communicationType>
  <communicationType json:Array="true" id="138" uri="https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/138" generalType="Telephone">
	<name>Emergency Phone</name>
  </communicationType>
  <communicationType json:Array="true" id="201" uri="https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/201" generalType="SocialMedia">
	<name>Facebook</name>
  </communicationType>
  <communicationType json:Array="true" id="202" uri="https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/202" generalType="SocialMedia">
	<name>Linked-In</name>
  </communicationType>
  <communicationType json:Array="true" id="203" uri="https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/203" generalType="SocialMedia">
	<name>Twitter</name>
  </communicationType>
</communicationTypes>

Given: [GET] https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes.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 06:36:38 GMT
Content-Length: 2400

{
	"communicationTypes": {
		"communicationType": [
			{
				"@array": "true",
				"@id": "1",
				"@uri": "https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/1",
				"@generalType": "Telephone",
				"name": "Home Phone"
			},
			{
				"@array": "true",
				"@id": "2",
				"@uri": "https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/2",
				"@generalType": "Telephone",
				"name": "Work Phone"
			},
			{
				"@array": "true",
				"@id": "3",
				"@uri": "https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/3",
				"@generalType": "Telephone",
				"name": "Mobile Phone"
			},
			{
				"@array": "true",
				"@id": "4",
				"@uri": "https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/4",
				"@generalType": "Email",
				"name": "Email"
			},
							{
				"@array": "true",
				"@id": "5",
				"@uri": "https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/5",
				"@generalType": "Email",
				"name": "Home Email"
			},
			{
				"@array": "true",
				"@id": "6",
				"@uri": "https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/6",
				"@generalType": "Email",
				"name": "InFellowship Login"
			},
			{
				"@array": "true",
				"@id": "102",
				"@uri": "https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/102",
				"@generalType": "Web",
				"name": "Web Address"
			},
			{
				"@array": "true",
				"@id": "127",
				"@uri": "https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/127",
				"@generalType": "Email",
				"name": "Work Email"
			},
			{
				"@array": "true",
				"@id": "138",
				"@uri": "https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/138",
				"@generalType": "Telephone",
				"name": "Emergency Phone"
			},
			{
				"@array": "true",
				"@id": "201",
				"@uri": "https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/201",
				"@generalType": "SocialMedia",
				"name": "Facebook"
			},
			{
				"@array": "true",
				"@id": "202",
				"@uri": "https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/202",
				"@generalType": "SocialMedia",
				"name": "Linked-In"
			},
			{
				"@array": "true",
				"@id": "203",
				"@uri": "https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/203",
				"@generalType": "SocialMedia",
				"name": "Twitter"
			}
		]
	}
}

Method: show [GET]

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

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/1

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/1
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 07 Apr 2009 17:01:38 GMT
Content-Length: 172

<?xml version="1.0" encoding="utf-8"?>
<communicationType id="1" uri="https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/1" generalType="Telephone">
	<name>Home Phone</name>
</communicationType>

Given: [GET] https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/1.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/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 06:38:33 GMT
Content-Length: 132

{
	"communicationType": {
		"@id": "1",
		"@uri": "https://demo.fellowshiponeapi.com/v1/Communications/CommunicationTypes/1",
		"@generalType": "Telephone",
		"name": "Home Phone"
	}
}

Fellowship One REST API

Communication Types

Authentication

Resource Structure

Methods

Method: list [GET]

Method: show [GET]