Fellowship One REST API

Address Types

An address type or collection of address types are used for households or people addresses.

Authentication

This method requires Authentication

Resource Structure

This resource conforms to the following XSD

Methods

Address Types ::

Method: list [GET]

The list method will return a list of address types.

Notes ::

Content-types ::

Format ::

Parameters ::

Sample Response ::

Given: [GET] https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes.xml
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:11:07 GMT
Content-Length: 1408

<?xml version="1.0" encoding="utf-8"?>
<addressTypes>
  <addressType json:Array="true" id="1" uri="https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/1">
	<name>Primary</name>
  </addressType>
  <addressType json:Array="true" id="2" uri="https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/2">
	<name>Secondary</name>
  </addressType>
  <addressType json:Array="true" id="3" uri="https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/3">
	<name>College</name>
  </addressType>
  <addressType json:Array="true" id="4" uri="https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/4">
	<name>Vacation</name>
  </addressType>
  <addressType json:Array="true" id="5" uri="https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/5">
	<name>Business</name>
  </addressType>
  <addressType json:Array="true" id="6" uri="https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/6">
	<name>Org</name>
  </addressType>
  <addressType json:Array="true" id="7" uri="https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/7">
	<name>Previous</name>
  </addressType>
  <addressType json:Array="true" id="8" uri="https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/8">
	<name>Statement</name>
  </addressType>
  <addressType json:Array="true" id="101" uri="https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/101">
	<name>Mail Returned Incorrect</name>
  </addressType>
</addressTypes>

Given: [GET] https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes.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/Addresses/AddressTypes.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 05:56:30 GMT
Content-Length: 1074

{
	"addressTypes": {
		"addressType": [
			{
				"@array": "true",
				"@id": "1",
				"@uri": "https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/1",
				"name": "Primary"
			},
			{
				"@array": "true",
				"@id": "2",
				"@uri": "https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/2",
				"name": "Secondary"
			},
			{
				"@array": "true",
				"@id": "3",
				"@uri": "https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/3",
				"name": "College"
			},
			{
				"@array": "true",
				"@id": "4",
				"@uri": "https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/4",
				"name": "Vacation"
			},
			{
				"@array": "true",
				"@id": "5",
				"@uri": "https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/5",
				"name": "Business"
			},
			{
				"@array": "true",
				"@id": "6",
				"@uri": "https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/6",
				"name": "Org"
			},
			{
				"@array": "true",
				"@id": "7",
				"@uri": "https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/7",
				"name": "Previous"
			},
			{
				"@array": "true",
				"@id": "8",
				"@uri": "https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/8",
				"name": "Statement"
			},
			{
				"@array": "true",
				"@id": "101",
				"@uri": "https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/101",
				"name": "Mail Returned Incorrect"
			}
		]
	}
}

Method: show [GET]

The show method will return a single address type for a given id.

Notes ::

Content-types ::

Format ::

Parameters ::

Sample Response ::

Given: [GET] https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/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/Addresses/AddressTypes/1.xml
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:11:38 GMT
Content-Length: 165

<?xml version="1.0" encoding="utf-8"?>
<addressType id="1" uri="https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/1">
  <name>Primary</name>
</addressType>

Given: [GET] https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/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/Addresses/AddressTypes/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:00:14 GMT
Content-Length: 112

{
	"addressType": {
		"@id": "1",
		"@uri": "https://demo.staging.fellowshiponeapi.com/v1/Addresses/AddressTypes/1",
		"name": "Primary"
	}
}