Fund Types

A fund type or collection of fund types are used for funds.

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/funds/fundtypes, 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

Fund Types ::

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

Method: list [GET]

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

Sample Response ::

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

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds/fundtypes
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 18:48:17 GMT
Content-Length: 497

<?xml version="1.0" encoding="utf-8"?>
<fundTypes>
  <fundType json:Array="true" id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds/fundtypes/0">
    <name>All</name>
  </fundType>
  <fundType json:Array="true" id="1" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds/fundtypes/1">
    <name>Contribution</name>
  </fundType>
  <fundType json:Array="true" id="2" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds/fundtypes/2">
    <name>Reeipt</name>
  </fundType>
</fundTypes>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds/fundtypes.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/funds/fundtypes.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 18:51:03 GMT
Content-Length: 379

{
   "fundTypes":{
      "fundType":[
         {
            "@array":"true",
            "@id":"0",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds/fundtypes/0",
            "name":"All"
         },
         {
            "@array":"true",
            "@id":"1",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds/fundtypes/1",
            "name":"Contribution"
         },
         {
            "@array":"true",
            "@id":"2",
            "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds/fundtypes/2",
            "name":"Reeipt"
         }
      ]
   }
}

Method: show [GET]

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

Sample Response ::

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds/fundtypes/0

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds/fundtypes/0
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 18:55:18 GMT
Content-Length: 159

<?xml version="1.0" encoding="utf-8"?>
<fundType id="0" uri="https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds/fundtypes/0">
  <name>All</name>
</fundType>

Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds/fundtypes/1.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/funds/fundtypes/1.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 18:56:25 GMT
Content-Length: 118

{
   "fundType":{
      "@id":"1",
      "@uri":"https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds/fundtypes/1",
      "name":"Contribution"
   }
}