Fellowship One - Developer Community

Contribution Types

A contribution type or collection of contribution types are used for 'contribution receipts'.

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/contributiontypes, 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

Contribution Types ::

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

Method: list [GET]

The list method will return a list of contribution 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/contributiontypes.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes?format={format}
- [Header] Accept : {Content-type}

Sample Response ::

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

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes
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"?>
<contributionTypes>
  <contributionType json:Array="true" id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/1">
    <name>Check</name>
  </contributionType>
  <contributionType json:Array="true" id="2" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/2">
    <name>Cash</name>
  </contributionType>
  <contributionType json:Array="true" id="5" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/5">
    <name>ACH</name>
  </contributionType>
  <contributionType json:Array="true" id="3" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/3">
    <name>Credit Card</name>
  </contributionType>
  <contributionType json:Array="true" id="4" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/4">
    <name>Non-Cash</name>
  </contributionType>
  <contributionType json:Array="true" id="6" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/6">
    <name>Voucher</name>
  </contributionType>
</contributionTypes>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes.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/contributiontypes.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

{
   "contributionTypes":{
      "contributionType":[
         {
            "@array":"true",
            "@id":"1",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/1",
            "name":"Check"
         },
         {
            "@array":"true",
            "@id":"2",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/2",
            "name":"Cash"
         },
         {
            "@array":"true",
            "@id":"5",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/5",
            "name":"ACH"
         },
         {
            "@array":"true",
            "@id":"3",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/3",
            "name":"Credit Card"
         },
         {
            "@array":"true",
            "@id":"4",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/4",
            "name":"Non-Cash"
         },
         {
            "@array":"true",
            "@id":"6",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/6",
            "name":"Voucher"
         }
      ]
   }
}

Method: show [GET]

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

Sample Response ::

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/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/contributiontypes/2
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"?>
<contributionType id="2" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/2">
  <name>Cash</name>
</contributionType>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/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/contributiontypes/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

{
   "contributionType":{
      "@id":"2",
      "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/2",
      "name":"Cash"
   }
}