RDC Batch Items

An rdcBatchItem or collection of rdcBatchItems are all the item records that make up an rdcBatch

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

Funds ::

  • list [GET] https://demo.fellowshiponeapi.com/giving/v1/batches/{batchID}/rdcbatchitems
  • show [GET] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/{id}
  • new [GET] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/new
  • edit [GET] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/{id}/edit
  • create [POST] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems
  • update [PUT] [POST(Low REST)] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/{id}

Method: list [GET]

The list method will return a list of rdcBatchItems that are associated with the specific rdcBatch.

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/{batchID}/rdcbatchitems.{format}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/batches/{batchID}/rdcbatchitems?format={format}
    • [Header] Accept : {Content-type}

Sample Response ::

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

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 16:32:44 GMT
Content-Length: 3893

<?xml version="1.0" encoding="utf-8"?>
<rdcBatchItems>
    <rdcBatchItem json:Array="true" id="10" uri="https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/10" activityInstanceID="" referenceImageID="" ppMerchantAccountID="83" locationID="1">
    <batch id="1519121" uri="https://demo.fellowshiponeapi.com/giving/v1/batches/1519121">
        <name>RDCBatch Create JSON Test 1868295507</name>
    </batch>
    <originalHousehold id="3180561" uri="https://demo.fellowshiponeapi.com/giving/v1/households/3180561" />
    <originalIndividual id="1635014" uri="https://demo.fellowshiponeapi.com/giving/v1/people/1635014" />
    <householdID id="" uri="" />
    <individual id="" uri="" />
    <itemCreatedDate>0001-01-01T00:00:00</itemCreatedDate>
    <accountNumber>112233</accountNumber>
    <routingNumber></routingNumber>
    <amount>100.0000</amount>
    <nameOnAccount>Chad Meyer</nameOnAccount>
    <itemDescription>Chedda Comin 2</itemDescription>
    <customField1></customField1>
    <customField2></customField2>
    <customField3></customField3>
    <referenceNumber></referenceNumber>
    <checkNumber></checkNumber>
    <transactionNumber></transactionNumber>
    <referenceImage id="284137" uri="https://demo.fellowshiponeapi.com/giving/v1/referenceImages/284137" />
    <returnDate></returnDate>
    <isAccountShared>true</isAccountShared>
    <createdDate>2010-05-03T11:14:10</createdDate>
    <createdByPerson id="2229409" uri="{{CONSUMER_ROOT_DOMAIN}}/people/2229409" />
    <lastUpdatedDate>2010-05-27T11:41:23</lastUpdatedDate>
    <lastUpdatedByPerson id="2229409" uri="{{CONSUMER_ROOT_DOMAIN}}/people/2229409" />
    </rdcBatchItem>
    <rdcBatchItem json:Array="true" id="11" uri="https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/11" activityInstanceID="" referenceImageID="" ppMerchantAccountID="83" locationID="1">
    <batch id="1519121" uri="https://demo.fellowshiponeapi.com/giving/v1/batches/1519121">
        <name>RDCBatch Create JSON Test 1868295507</name>
    </batch>
    <originalHousehold id="3180561" uri="https://demo.fellowshiponeapi.com/giving/v1/households/3180561" />
    <originalIndividual id="1635014" uri="https://demo.fellowshiponeapi.com/giving/v1/people/1635014" />
    <householdID id="" uri="" />
    <individual id="" uri="" />
    <itemCreatedDate>0001-01-01T00:00:00</itemCreatedDate>
    <accountNumber>0098648572</accountNumber>
    <routingNumber></routingNumber>
    <amount>100.0000</amount>
    <nameOnAccount>Nicholas Floyd</nameOnAccount>
    <itemDescription>Chedda Comin 3</itemDescription>
    <customField1></customField1>
    <customField2></customField2>
    <customField3></customField3>
    <referenceNumber></referenceNumber>
    <checkNumber></checkNumber>
    <transactionNumber></transactionNumber>
    <referenceImage id="284137" uri="https://demo.fellowshiponeapi.com/giving/v1/referenceImages/284138" />
    <returnDate></returnDate>
    <isAccountShared>true</isAccountShared>
    <createdDate>2010-05-03T11:14:10</createdDate>
    <createdByPerson id="2229409" uri="{{CONSUMER_ROOT_DOMAIN}}/people/2229409" />
    <lastUpdatedDate>2010-05-27T11:41:23</lastUpdatedDate>
    <lastUpdatedByPerson id="2229409" uri="{{CONSUMER_ROOT_DOMAIN}}/people/2229409" />
    </rdcBatchItem>

    ...
</rdcBatchItems>

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

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 16:32:44 GMT
Content-Length: 3100

{
   "rdcBatchItems":{
      "rdcBatchItem":[
         {
            "@array":"true",
            "@id":"74",
            "@uri":"{{CONSUMER_DOMAIN}/rdcbatchitems/74",
            "@referenceImageID":"284137",
            "@contributionReceiptID":"136261053",
            "@ppMerchantAccountID":"3178",
            "@locationID":"139593",
            "batch":{
               "@id":"1519663",
               "@uri":"{{CONSUMER_DOMAIN}batches/1519663",
               "name":null
            },
            "originalHousehold":{
               "@id":"",
               "@uri":""
            },
            "originalIndividual":{
               "@id":"",
               "@uri":""
            },
            "household":{
               "@id":"",
               "@uri":""
            },
            "individual":{
               "@id":"",
               "@uri":""
            },
            "itemCreatedDate":"2011-04-13T10:43:02.477",
            "accountNumber":"1234567890",
            "routingNumber":"111000025",
            "amount":"50.9950",
            "nameOnAccount":null,
            "itemDescription":null,
            "customField1":null,
            "customField2":null,
            "customField3":null,
            "referenceNumber":"T:65H8W0X7w",
            "checkNumber":"1099",
            "transactionNumber":null,
            "referenceImage":{
               "@id":"284137",
               "@uri":"{{CONSUMER_DOMAIN}/ReferenceImages/284137"
            },
            "returnDate":null,
            "isSharedAccount":"false",
            "createdDate":"2011-04-13T10:43:02.477",
            "createdByPerson":{
               "@id":"0",
               "@uri":"{{CONSUMER_ROOT_DOMAIN}/people/0"
            },
            "lastUpdatedDate":"0001-01-01T00:00:00",
            "lastUpdatedByPerson":{
               "@id":"",
               "@uri":""
            }
         },
         {
            "@array":"true",
           ...
         }
      ]
   }
}

Method: show [GET]

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

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/10

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 18:35:04 GMT
Content-Length: 1241

<rdcBatchItem id="10" uri="https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/10" activityInstanceID="" referenceImageID="" ppMerchantAccountID="83" locationID="1">
    <batch id="1519121" uri="https://demo.fellowshiponeapi.com/giving/v1/batches/1519121">
        <name>RDCBatch Create JSON Test 1868295507</name>
    </batch>
    <originalHousehold id="3180561" uri="https://demo.fellowshiponeapi.com/giving/v1/households/3180561" />
    <originalIndividual id="1635014" uri="https://demo.fellowshiponeapi.com/giving/v1/people/1635014" />
    <householdID id="" uri="" />
    <individual id="" uri="" />
    <itemCreatedDate>0001-01-01T00:00:00</itemCreatedDate>
    <accountNumber>112233</accountNumber>
    <routingNumber></routingNumber>
    <amount>100.0000</amount>
    <nameOnAccount>Chad Meyer</nameOnAccount>
    <itemDescription>Chedda Comin 2</itemDescription>
    <customField1></customField1>
    <customField2></customField2>
    <customField3></customField3>
    <referenceNumber></referenceNumber>
    <checkNumber></checkNumber>
    <transactionNumber></transactionNumber>
    <referenceImage id="284137" uri="https://demo.fellowshiponeapi.com/giving/v1/referenceImages/284137" />
    <returnDate></returnDate>
    <isAccountShared>true</isAccountShared>
    <createdDate>2010-05-03T11:14:10</createdDate>
    <createdByPerson id="2229409" uri="{{CONSUMER_ROOT_DOMAIN}}/people/2229409" />
    <lastUpdatedDate>2010-05-27T11:41:23</lastUpdatedDate>
    <lastUpdatedByPerson id="2229409" uri="{{CONSUMER_ROOT_DOMAIN}}/people/2229409" />
</rdcBatchItem>

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/10.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 18:37:05 GMT
Content-Length: 1018

{
   "rdcBatchItem":{
      "@id":"74",
      "@uri":"https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/74",
      "@referenceImageID":"284137",
      "@ppMerchantAccountID":"3178",
      "@locationID":"139593",
      "batch":{
         "@id":"1519663",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/batches/1519663",
         "name":null
      },
      "originalHousehold":{
         "@id":"",
         "@uri":""
      },
      "originalIndividual":{
         "@id":"",
         "@uri":""
      },
      "household":{
         "@id":"",
         "@uri":""
      },
      "individual":{
         "@id":"",
         "@uri":""
      },
      "itemCreatedDate":"2011-04-13T10:43:02.477",
      "accountNumber":"1234567890",
      "routingNumber":"111000025",
      "amount":"50.9950",
      "nameOnAccount":null,
      "itemDescription":null,
      "customField1":null,
      "customField2":null,
      "customField3":null,
      "referenceNumber":"T:65H8W0X7w",
      "checkNumber":"1099",
      "transactionNumber":null,
      "referenceImage":{
         "@id":"284137",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/ReferenceImages/284137"
      },
      "returnDate":null,
      "isSharedAccount":"false",
      "createdDate":"2011-04-13T10:43:02.477",
      "createdByPerson":{
         "@id":"0",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/0"
      },
      "lastUpdatedDate":"0001-01-01T00:00:00",
      "lastUpdatedByPerson":{
         "@id":"",
         "@uri":""
      }
   }
}

Method: edit [GET]

The edit method will return a single rdcBatchItem for a given id. The purpose of the edit method is to retrieve a resource in its most recent condition with its latest values.

Content-types ::

  • application/json
  • application/xml
  • application/help

Format ::

  • json
  • xml
  • help

Parameters ::

  • {format}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/rdcbatches/{id}/edit.{format}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/rdcbatches/{id}/edit?format={format}
    • [Header] Accept : {Content-type}
  • {id}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/rdcbatches/{id}/edit

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1rdcbatches/10/edit

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 18:40:41 GMT
Content-Length: 1241

<rdcBatchItem id="10" uri="https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/10" activityInstanceID="" referenceImageID="" ppMerchantAccountID="83" locationID="1">
    <batch id="1519121" uri="https://demo.fellowshiponeapi.com/giving/v1/batches/1519121">
        <name>RDCBatch Create JSON Test 1868295507</name>
    </batch>
    <originalHousehold id="3180561" uri="https://demo.fellowshiponeapi.com/giving/v1/households/3180561" />
    <originalIndividual id="1635014" uri="https://demo.fellowshiponeapi.com/giving/v1/people/1635014" />
    <householdID id="" uri="" />
    <individual id="" uri="" />
    <itemCreatedDate>0001-01-01T00:00:00</itemCreatedDate>
    <accountNumber>112233</accountNumber>
    <routingNumber></routingNumber>
    <amount>100.0000</amount>
    <nameOnAccount>Chad Meyer</nameOnAccount>
    <itemDescription>Chedda Comin 2</itemDescription>
    <customField1></customField1>
    <customField2></customField2>
    <customField3></customField3>
    <referenceNumber></referenceNumber>
    <checkNumber></checkNumber>
    <transactionNumber></transactionNumber>
    <referenceImage id="284137" uri="https://demo.fellowshiponeapi.com/giving/v1/referenceImages/284137" />
    <returnDate></returnDate>
    <isAccountShared>true</isAccountShared>
    <createdDate>2010-05-03T11:14:10</createdDate>
    <createdByPerson id="2229409" uri="{{CONSUMER_ROOT_DOMAIN}}/people/2229409" />
    <lastUpdatedDate>2010-05-27T11:41:23</lastUpdatedDate>
    <lastUpdatedByPerson id="2229409" uri="{{CONSUMER_ROOT_DOMAIN}}/people/2229409" />
</rdcBatchItem>

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/10/edit?json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 18:44:59 GMT
Content-Length: 1018

{
   "rdcBatchItem":{
      "@id":"74",
      "@uri":"https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/74",
      "@referenceImageID":"284137",
      "@ppMerchantAccountID":"3178",
      "@locationID":"139593",
      "batch":{
         "@id":"1519663",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/batches/1519663",
         "name":null
      },
      "originalHousehold":{
         "@id":"",
         "@uri":""
      },
      "originalIndividual":{
         "@id":"",
         "@uri":""
      },
      "household":{
         "@id":"",
         "@uri":""
      },
      "individual":{
         "@id":"",
         "@uri":""
      },
      "itemCreatedDate":"2011-04-13T10:43:02.477",
      "accountNumber":"1234567890",
      "routingNumber":"111000025",
      "amount":"50.9950",
      "nameOnAccount":null,
      "itemDescription":null,
      "customField1":null,
      "customField2":null,
      "customField3":null,
      "referenceNumber":"T:65H8W0X7w",
      "checkNumber":"1099",
      "transactionNumber":null,
      "referenceImage":{
         "@id":"284137",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/ReferenceImages/284137"
      },
      "returnDate":null,
      "isSharedAccount":"false",
      "createdDate":"2011-04-13T10:43:02.477",
      "createdByPerson":{
         "@id":"0",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/0"
      },
      "lastUpdatedDate":"0001-01-01T00:00:00",
      "lastUpdatedByPerson":{
         "@id":"",
         "@uri":""
      }
   }
}

Method: new [GET]

The new method will return a single rdcBatchItem. The purpose of the new method is to retrieve an empty resource with the proper structure.

Content-types ::

  • application/json
  • application/xml
  • application/help

Format ::

  • json
  • xml
  • help

Parameters ::

  • {format}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/new.{format}
    • [GET] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/new?format={format}
    • [Header] Accept : {Content-type}

Sample Response ::

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/new

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 18:47:37 GMT
Content-Length: 891

<?xml version="1.0" encoding="utf-8"?>
<rdcBatchItem id="" uri="" activityInstanceID="" referenceImageID="" ppMerchantAccountID="" locationID="">
    <batch id="" uri="">
    <name></name>
    </batch>
    <originalHousehold id="" uri="" />
    <originalIndividual id="" uri="" />
    <household id="" uri="" />
    <individual id="" uri="" />
    <itemCreatedDate></itemCreatedDate>
    <accountNumber></accountNumber>
    <routingNumber></routingNumber>
    <amount></amount>
    <nameOnAccount></nameOnAccount>
    <itemDescription></itemDescription>
    <customField1></customField1>
    <customField2></customField2>
    <customField3></customField3>
    <referenceNumber></referenceNumber>
    <checkNumber></checkNumber>
    <transactionNumber></transactionNumber>
    <referenceImage id="284137" uri="https://demo.fellowshiponeapi.com/giving/v1/referenceImages/284137" />
    <returnDate></returnDate>
    <isAccountShared>true</isAccountShared>
    <createdDate></createdDate>
    <createdByPerson id="" uri="" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
</rdcBatchItem>

Given: [GET] https://demo.fellowshiponeapi.com/giving/v1/RDCBatcheItems/new.json

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 18:48:28 GMT
Content-Length: 680

{
   "rdcBatchItem":{
      "@id":"",
      "@uri":"",
      "@referenceImageID":"",
      "@contributionReceiptID":"",
      "@ppMerchantAccountID":"",
      "@locationID":"",
      "batch":{
         "@id":"",
         "@uri":"",
         "name":null
      },
      "originalHousehold":{
         "@id":"",
         "@uri":""
      },
      "originalIndividual":{
         "@id":"",
         "@uri":""
      },
      "household":{
         "@id":"",
         "@uri":""
      },
      "individual":{
         "@id":"",
         "@uri":""
      },
      "itemCreatedDate":null,
      "accountNumber":null,
      "routingNumber":null,
      "amount":null,
      "nameOnAccount":null,
      "itemDescription":null,
      "customField1":null,
      "customField2":null,
      "customField3":null,
      "referenceNumber":null,
      "checkNumber":null,
      "transactionNumber":null,
      "referenceImage":{
         "@id":"",
         "@uri":""
      },
      "returnDate":null,
      "isSharedAccount":null,
      "createdDate":null,
      "createdByPerson":{
         "@id":"",
         "@uri":""
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":"",
         "@uri":""
      }
   }
}

Method: create [POST]

The create method will create a single rdcbatchitem.

Notes ::

  • This method will return a 201 - Created if successfully created

Content-types ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

  • {format}
    • [POST] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems.{format}
    • [POST] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems?format={format}
    • [Header] Accept : {Content-type}

Required Fields ::

  • batchId
  • amount

Sample Response ::

Given: [POST] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems

Request body:

<rdcBatchItem id="" uri="" activityInstanceID="" referenceImageID="" ppMerchantAccountID="83" locationID="1">
    <batch id="1519121" uri="">
        <name>RDCBatch Create JSON Test 1868295507</name>
    </batch>
    <originalHousehold id="3180561" uri="" />
    <originalIndividual id="1635014" uri="" />
    <householdID id="" uri="" />
    <individual id="" uri="" />
    <itemCreatedDate>0001-01-01T00:00:00</itemCreatedDate>
    <accountNumber>112233</accountNumber>
    <routingNumber></routingNumber>
    <amount>100.0000</amount>
    <nameOnAccount>Chad Meyer</nameOnAccount>
    <itemDescription>Chedda Comin 2</itemDescription>
    <customField1></customField1>
    <customField2></customField2>
    <customField3></customField3>
    <referenceNumber></referenceNumber>
    <checkNumber></checkNumber>
    <transactionNumber></transactionNumber>
    <referenceImage id="284137" uri="https://demo.fellowshiponeapi.com/giving/v1/referenceImages/284137" />
    <returnDate></returnDate>
    <isAccountShared>true</isAccountShared>
    <createdDate></createdDate>
    <createdDate></createdDate>
    <createdByPerson id="" uri="" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
</rdcBatchItem>

Response:

HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 19:00:52 GMT
Content-Length: 1241

<rdcBatchItem id="10" uri="https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/10" activityInstanceID="" referenceImageID="" ppMerchantAccountID="83" locationID="1">
    <batch id="1519121" uri="https://demo.fellowshiponeapi.com/giving/v1/batches/1519121">
        <name>RDCBatch Create JSON Test 1868295507</name>
    </batch>
    <originalHousehold id="3180561" uri="https://demo.fellowshiponeapi.com/giving/v1/households/3180561" />
    <originalIndividual id="1635014" uri="https://demo.fellowshiponeapi.com/giving/v1/people/1635014" />
    <householdID id="" uri="" />
    <individual id="" uri="" />
    <itemCreatedDate>0001-01-01T00:00:00</itemCreatedDate>
    <accountNumber>112233</accountNumber>
    <routingNumber></routingNumber>
    <amount>100.0000</amount>
    <nameOnAccount>Chad Meyer</nameOnAccount>
    <itemDescription>Chedda Comin 2</itemDescription>
    <customField1></customField1>
    <customField2></customField2>
    <customField3></customField3>
    <referenceNumber></referenceNumber>
    <checkNumber></checkNumber>
    <transactionNumber></transactionNumber>
    <referenceImage id="284137" uri="https://demo.fellowshiponeapi.com/giving/v1/referenceImages/284137" />
    <returnDate></returnDate>
    <isAccountShared>true</isAccountShared>
    <createdDate>2010-05-03T11:14:10</createdDate>
    <createdByPerson id="2229409" uri="{{CONSUMER_ROOT_DOMAIN}}/people/2229409" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
</rdcBatchItem>

Given: [POST] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems.json

Request body:

{
   "rdcBatchItem":{
      "@id":"",
      "@uri":"",
      "@activityInstanceID":"",
      "@referenceImageID":"",
      "@ppMerchantAccountID":"83",
      "@locationID":"1",
      "batch":{
         "@id":"1519121",
         "@uri":"",
         "name":"RDCBatch Create JSON Test 1868295507"
      },
      "originalHousehold":{
         "@id":"3180561",
         "@uri":""
      },
      "originalIndividual":{
         "@id":"1635014",
         "@uri":""
      },
      "household":{
         "@id":"",
         "@uri":""
      },
      "individual":{
         "@id":"",
         "@uri":""
      },
      "itemCreatedDate":"0001-01-01T00:00:00",
      "accountNumber":"112233",
      "routingNumber":"111000025",
      "amount":"100.0000",
      "nameOnAccount":"Chad Meyer",
      "itemDescription":"Chedda Comin 2",
      "customField1":null,
      "customField2":null,
      "customField3":null,
      "referenceNumber":null,
      "checkNumber":null,
      "transactionNumber":null,
      "referenceImage":{
         "@id":"",
         "@uri":""
      },
      "returnDate":null,
      "isSharedAccount":null,
      "createdDate":null
   }
}

Response:

HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 19:07:04 GMT
Content-Length: 1018

{
   "rdcBatchItem":{
      "@id":"10",
      "@uri":"https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/10",
      "@activityInstanceID":"",
      "@referenceImageID":"",
      "@ppMerchantAccountID":"83",
      "@locationID":"1",
      "batch":{
         "@id":"1519121",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/batches/1519121",
         "name":"RDCBatch Create JSON Test 1868295507"
      },
      "originalHousehold":{
         "@id":"3180561",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/households/3180561"
      },
      "originalIndividual":{
         "@id":"1635014",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/people/1635014"
      },
      "household":{
         "@id":"",
         "@uri":""
      },
      "individual":{
         "@id":"",
         "@uri":""
      },
      "itemCreatedDate":"0001-01-01T00:00:00",
      "accountNumber":"112233",
      "routingNumber":"111000025",
      "amount":"100.0000",
      "nameOnAccount":"Chad Meyer",
      "itemDescription":"Chedda Comin 2",
      "customField1":null,
      "customField2":null,
      "customField3":null,
      "referenceNumber":null,
      "checkNumber":null,
      "transactionNumber":null,
      "referenceImage":{
         "@id":"",
         "@uri":""
      },
      "returnDate":null,
      "isSharedAccount":null,
      "createdDate":"2010-05-20T14:29:04",
      "createdByPerson":{
         "@id":"2229409",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/2229409"
      },
      "lastUpdatedDate":null,
      "lastUpdatedByPerson":{
         "@id":"",
         "@uri":""
      }
   }
}

Method: update [PUT] [POST (Low REST)]

The update method will update a single fund.

Content-types ::

  • application/json
  • application/xml

Format ::

  • json
  • xml

Parameters ::

  • {format}
    • [PUT] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/{id}.{format}
    • [PUT] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/{id}?format={format}
    • [Header] Accept : {Content-type}
  • {id}
    • [PUT] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/{id}

Required Fields ::

  • batchId
  • amount

Sample Response ::

Given: [PUT] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/10

Request body:

<rdcBatchItem id="10" uri="https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/10" activityInstanceID="" referenceImageID="" ppMerchantAccountID="83" locationID="1">
    <batch id="1519121" uri="https://demo.fellowshiponeapi.com/giving/v1/batches/1519121">
        <name>RDCBatch Create JSON Test 1868295507</name>
    </batch>
    <originalHousehold id="3180561" uri="https://demo.fellowshiponeapi.com/giving/v1/households/3180561" />
    <originalIndividual id="1635014" uri="https://demo.fellowshiponeapi.com/giving/v1/people/1635014" />
    <householdID id="" uri="" />
    <individual id="" uri="" />
    <itemCreatedDate>0001-01-01T00:00:00</itemCreatedDate>
    <accountNumber>112233</accountNumber>
    <routingNumber></routingNumber>
    <amount>100.0000</amount>
    <nameOnAccount>Chad Meyer</nameOnAccount>
    <itemDescription>Chedda Comin 2</itemDescription>
    <customField1></customField1>
    <customField2></customField2>
    <customField3></customField3>
    <referenceNumber></referenceNumber>
    <checkNumber></checkNumber>
    <transactionNumber></transactionNumber>
    <referenceImage id="284137" uri="https://demo.fellowshiponeapi.com/giving/v1/referenceImages/284137" />
    <returnDate></returnDate>
    <isAccountShared>true</isAccountShared>
    <createdDate></createdDate>
    <createdByPerson id="" uri="" />
    <lastUpdatedDate></lastUpdatedDate>
    <lastUpdatedByPerson id="" uri="" />
</rdcBatchItem>

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 19:26:32 GMT
Content-Length: 1241

<rdcBatchItem id="10" uri="https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/10" activityInstanceID="" referenceImageID="" ppMerchantAccountID="83" locationID="1">
    <batch id="1519121" uri="https://demo.fellowshiponeapi.com/giving/v1/batches/1519121">
        <name>RDCBatch Create JSON Test 1868295507</name>
    </batch>
    <originalHousehold id="3180561" uri="https://demo.fellowshiponeapi.com/giving/v1/households/3180561" />
    <originalIndividual id="1635014" uri="https://demo.fellowshiponeapi.com/giving/v1/people/1635014" />
    <householdID id="" uri="" />
    <individual id="" uri="" />
    <itemCreatedDate>0001-01-01T00:00:00</itemCreatedDate>
    <accountNumber>112233</accountNumber>
    <routingNumber></routingNumber>
    <amount>100.0000</amount>
    <nameOnAccount>Chad Meyer</nameOnAccount>
    <itemDescription>Chedda Comin 2</itemDescription>
    <customField1></customField1>
    <customField2></customField2>
    <customField3></customField3>
    <referenceNumber></referenceNumber>
    <checkNumber></checkNumber>
    <transactionNumber></transactionNumber>
    <referenceImage id="284137" uri="https://demo.fellowshiponeapi.com/giving/v1/referenceImages/284137" />
    <returnDate></returnDate>
    <isAccountShared>true</isAccountShared>
    <createdDate></createdDate>
    <createdDate>2010-05-03T11:14:10</createdDate>
    <createdByPerson id="2229409" uri="{{CONSUMER_ROOT_DOMAIN}}/people/2229409" />
    <lastUpdatedDate>2010-05-27T11:41:23</lastUpdatedDate>
    <lastUpdatedByPerson id="2229409" uri="{{CONSUMER_ROOT_DOMAIN}}/people/2229409" />
</rdcBatchItem>

Given: [PUT] https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/10.json

Request body:

{
   "rdcBatchItem":{
      "@id":"10",
      "@uri":"https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/10",
      "@activityInstanceID":"",
      "@referenceImageID":"",
      "@ppMerchantAccountID":"83",
      "@locationID":"1",
      "batch":{
         "@id":"1519121",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/batches/1519121",
         "name":"RDCBatch Create JSON Test 1868295507"
      },
      "originalHousehold":{
         "@id":"3180561",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/households/3180561"
      },
      "originalIndividual":{
         "@id":"1635014",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/people/1635014"
      },
      "household":{
         "@id":"",
         "@uri":""
      },
      "individual":{
         "@id":"",
         "@uri":""
      },
      "itemCreatedDate":"0001-01-01T00:00:00",
      "accountNumber":"112233",
      "routingNumber":"111000025",
      "amount":"100.0000",
      "nameOnAccount":"Chad Meyer",
      "itemDescription":"Chedda Comin 2",
      "customField1":null,
      "customField2":null,
      "customField3":null,
      "referenceNumber":null,
      "checkNumber":null,
      "transactionNumber":null,
      "referenceImage":{
         "@id":"",
         "@uri":""
      },
      "returnDate":null,
      "isSharedAccount":null,
      "createdDate":null,
      "createdByPerson":{
         "@id":"",
         "@uri":""
      },
      "lastUpdatedDate":"null",
      "lastUpdatedByPerson":{
         "@id":"",
         "@uri":""
      }
   }
}

Response:

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: application/json; charset=utf-8
Server: Microsoft-IIS/7.0
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Tue, 13 Apr 2010 19:18:09 GMT
Content-Length: 1018

{
   "rdcBatchItem":{
      "@id":"10",
      "@uri":"https://demo.fellowshiponeapi.com/giving/v1/rdcbatchitems/10",
      "@activityInstanceID":"",
      "@referenceImageID":"",
      "@ppMerchantAccountID":"83",
      "@locationID":"1",
      "batch":{
         "@id":"1519121",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/batches/1519121",
         "name":"RDCBatch Create JSON Test 1868295507"
      },
      "originalHousehold":{
         "@id":"3180561",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/households/3180561"
      },
      "originalIndividual":{
         "@id":"1635014",
         "@uri":"https://demo.fellowshiponeapi.com/giving/v1/people/1635014"
      },
      "household":{
         "@id":"",
         "@uri":""
      },
      "individual":{
         "@id":"",
         "@uri":""
      },
      "itemCreatedDate":"0001-01-01T00:00:00",
      "accountNumber":"112233",
      "routingNumber":"111000025",
      "amount":"100.0000",
      "nameOnAccount":"Chad Meyer",
      "itemDescription":"Chedda Comin 2",
      "customField1":null,
      "customField2":null,
      "customField3":null,
      "referenceNumber":null,
      "checkNumber":null,
      "transactionNumber":null,
      "referenceImage":{
         "@id":"",
         "@uri":""
      },
      "returnDate":null,
      "isSharedAccount":null,
      "createdDate":"2010-05-20T14:29:04",
      "createdByPerson":{
         "@id":"2229409",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/2229409"
      },
      "lastUpdatedDate":"2010-05-20T14:29:04",
      "lastUpdatedByPerson":{
         "@id":"2229409",
         "@uri":"{{CONSUMER_ROOT_DOMAIN}}/people/2229409"
      }
   }
}