Fellowship One - Developer Community

Contribution SubTypes

A contribution subtype or collection of contribution subtypes 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/{id}/contributionsubtypes
show [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/{id}/contributionsubtypes/{id}

Method: list [GET]

The list method will return a list of contribution subtypes.

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/{contributionTypeID}/contributionsubtypes.{format}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/{contributionTypeID}/contributionsubtypes?format={format}
- [Header] Accept : {Content-type}

Sample Response ::

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

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Encoding: gzip
Content-Length: 265 bytes
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/4/contributionsubtypes
Content-Type: application/xml; charset=utf-8
Date: 2014 Jun 3 11:17:35
Server: Microsoft-IIS/8.0
X-AspNet-Version: 4.0.30319
X-AspNetMvc-Version: 3.0
X-Powered-By: ASP.NET

<?xml version="1.0" encoding="utf-8"?>
<contributionSubTypes>
  <contributionSubType json:Array="true" id="29" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionTypes/4/contributionsubtypes/29">
    <name>Property</name>
  </contributionSubType>
  <contributionSubType json:Array="true" id="30" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionTypes/4/contributionsubtypes/30">
    <name>Stocks or Bonds</name>
  </contributionSubType>
  <contributionSubType json:Array="true" id="31" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionTypes/4/contributionsubtypes/31">
    <name>Vehicle</name>
  </contributionSubType>
</contributionSubTypes>

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

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Encoding: gzip
Content-Length: 182 bytes
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/4/contributionsubtypes
Content-Type: application/json; charset=utf-8
Date: 2014 Jun 3 11:22:33
Server: Microsoft-IIS/8.0
X-AspNet-Version: 4.0.30319
X-AspNetMvc-Version: 3.0
X-Powered-By: ASP.NET

{
    "contributionSubTypes":{
      "contributionSubType":[
      {
        "@id":"29",
        "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionTypes/4/contributionsubtypes/29",
        "name":"Property"
      },
      {
        "@id":"30",
        "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionTypes/4/contributionsubtypes/30",
        "name":"Stocks or Bonds"
      },
      {
        "@id":"31",
        "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionTypes/4/contributionsubtypes/31",
        "name":"Vehicle"
      }
    ]
  }
}

Method: show [GET]

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

Sample Response ::

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

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Encoding: gzip
Content-Length: 182 bytes
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/4/contributionsubtypes
Content-Type: application/xml; charset=utf-8
Date: 2014 Jun 3 11:22:33
Server: Microsoft-IIS/8.0
X-AspNet-Version: 4.0.30319
X-AspNetMvc-Version: 3.0
X-Powered-By: ASP.NET

<?xml version="1.0" encoding="utf-8"?>
<contributionSubType id="30" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionTypes/4/contributionsubtypes/30">
  <name>Stocks or Bonds</name>
</contributionSubType>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/4/contributionsubtypes/30.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Encoding: gzip
Content-Length: 182 bytes
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributiontypes/4/contributionsubtypes
Content-Type: application/json; charset=utf-8
Date: 2014 Jun 3 11:22:33
Server: Microsoft-IIS/8.0
X-AspNet-Version: 4.0.30319
X-AspNetMvc-Version: 3.0
X-Powered-By: ASP.NET

{
  "contributionSubType":{
    "@id":"30",
    "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionTypes/4/contributionsubtypes/30",
    "name":"Stocks or Bonds"
  }
}