Fellowship One - Developer Community

Account Types

An account type or collection of account types are used for 'accounts'.

Notes ::

By passing in the content-type of application/help in the accept header or using the {format} parameter help from https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes, the API will return an html representation of the help documents for this resource (*authentication not required*)

Authentication

This method requires Authentication

Resource Structure

This resource conforms to the following XSD

Methods

accounts ::

list [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes
show [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/{id}

Method: list [GET]

The list method will return a list of account types.

Notes ::

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
application/help

Format ::

json
xml
xsd
help

Parameters ::

{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes?format={format}
- [Header] Accept : {Content-type}

Sample Response ::

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 14 Apr 2010 19:03:54 GMT
Content-Length: 1011

<?xml version="1.0" encoding="utf-8"?>
<accountTypes>
  <accountType json:Array="true" id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/1">
    <name>Checking</name>
  </accountType>
  <accountType json:Array="true" id="2" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/2">
    <name>Cash</name>
  </accountType>
  <accountType json:Array="true" id="13" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/13">
    <name>ACH</name>
  </accountType>
  <accountType json:Array="true" id="14" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/14">
    <name>CreditCard</name>
  </accountType>
  <accountType json:Array="true" id="15" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/15">
    <name>Online</name>
  </accountType>
  <accountType json:Array="true" id="16" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/16">
    <name>Voucher</name>
  </accountType>
</accountTypes>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 14 Apr 2010 19:05:24 GMT
Content-Length: 776

{
   "accountTypes":{
      "accountType":[
         {
            "@array":"true",
            "@id":"1",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/1",
            "name":"Checking"
         },
         {
            "@array":"true",
            "@id":"2",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/2",
            "name":"Cash"
         },
         {
            "@array":"true",
            "@id":"13",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/13",
            "name":"ACH"
         },
         {
            "@array":"true",
            "@id":"14",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/14",
            "name":"CreditCard"
         },
         {
            "@array":"true",
            "@id":"15",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/15",
            "name":"Online"
         },
         {
            "@array":"true",
            "@id":"16",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/16",
            "name":"Voucher"
         }
      ]
   }
}

Method: show [GET]

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

Notes ::

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
application/help

Format ::

json
xml
xsd
help

Parameters ::

{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/{id}.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/{id}?format={format}
- [Header] Accept : {Content-type}
{id}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/{id}

Sample Response ::

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/1

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/1
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 14 Apr 2010 19:09:54 GMT
Content-Length: 176

<?xml version="1.0" encoding="utf-8"?>
<accountType id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/1">
  <name>Checking</name>
</accountType>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/2.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/2.json
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 14 Apr 2010 19:10:42 GMT
Content-Length: 119

{
   "accountType":{
      "@id":"2",
      "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/accounts/accounttypes/2",
      "name":"Cash"
   }
}