Batch Types

A batch type or collection of batch types are used for 'batches'.

Notes ::

  • By passing in the content-type of application/help in the accept header or using the {format} parameter help from https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes, 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

Batch Types ::

  • list [GET] https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes
  • show [GET] https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes/{id}

Method: list [GET]

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

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes
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"?>
<batchTypes>
  <batchType json:Array="true" id="1" uri="https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes/1">
    <name>Standard</name>
  </batchType>
  <batchType json:Array="true" id="2" uri="https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes/2">
    <name>Credit Card</name>
  </batchType>
  <batchType json:Array="true" id="3" uri="https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes/3">
    <name>Remote Deposit Capture</name>
  </batchType>
</batchTypes>

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes.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

{
   "batchTypes":{
      "batchType":[
         {
            "@array":"true",
            "@id":"1",
            "@uri":"https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes/1",
            "name":"Standard"
         },
         {
            "@array":"true",
            "@id":"2",
            "@uri":"https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes/2",
            "name":"Credit Card"
         },
         {
            "@array":"true",
            "@id":"3",
            "@uri":"https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes/3",
            "name":"Remote Deposit Capture"
         }
      ]
   }
}

Method: show [GET]

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

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes/1

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes/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"?>
<batchType id="1" uri="https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes/1">
  <name>Standard</name>
</batchType>

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes/1.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Content-Location: https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes/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 19:10:42 GMT
Content-Length: 119

{
   "batchType":{
      "@id":"1",
      "@uri":"https://demo.fellowshiponeapi.com/giving/v1/batches/batchtypes/1",
      "name":"Standard"
   }
}