Reference Images
A reference image is a jpeg image that is associated with an existing contributionReceipt
or RDCBatchItem
.
Notes ::
- By passing in the
content-type
ofapplication/help
in theaccept
header or using the {format} parameterhelp
from https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds, the API will return an html representation of the help documents for this resource (*authentication not required*) - The
content-type
of this resource will always beimage/jpg
Authentication
This method requires Authentication
Methods
Funds ::
- show [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionreceipts/{contributionReceiptId}/ReferenceImages/{id}
- show [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/RDCBatchItems/{rdcBatchItemId}/ReferenceImages/{id}
- create [POST] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionreceipts/{contributionReceiptId}/ReferenceImages
- create [POST] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/RDCBatchItems/{rdcBatchItemId}/ReferenceImages
Method: show [GET]
The show
method will stream a jepg reference image for a given id
.
Notes ::
- The contributionReceiptId/RDCBatchItemId and id paramter are required to return a reference image.
Content-types ::
- application/help
Format ::
- help
Parameters ::
- {contributionReceiptId}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionreceipts/{contributionReceiptId}/referenceimages/{id}
- {id}
- [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionreceipts/{contributionReceiptId}/referenceimages/{id}
Sample Response ::
Given: [GET] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionreceipts/109798659/referenceimages/26294502
Response:
HTTP/1.1 200 OK
Cache-Control: private
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 4.0.30319
X-Powered-By: ASP.NET
Date: Fri, 21 Jan 2011 20:50:14 GMT
Content-Length: 2355
Method: create [POST]
The create
method will create a reference image for a contribution receipt.
Notes ::
- This method will return a 201 - Created if successfully created
Content-types ::
- image/jpeg
Format ::
- jpeg
Parameters ::
- {format}
- [POST] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionreceipts/{contributionReceiptId}/referenceimages
- [Header] Accept : {Content-type}
Sample Response ::
Given: [POST] https://CHURCHCODE.fellowshiponeapi.com/giving/v1/contributionreceipts/{109798659}/referenceimages
*Note: Convert jpeg image to byte array and stream it via the
Response:
HTTP/1.1 201 Created
Cache-Control: private
Content-Type: application/xml; charset=utf-8
Location: https://CHURCHCODE.fellowshiponeapi.com/giving/v1/funds/28929
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: 543