Circulation Checkout Receipt

Get circulation checkout receipt URL

GET /api/.../receipts/url?receipttype=checkout&patronid={id}

Returns an URL of check-out receipt template file

Request Information

Parameters
Name Type Required Description
receipttype String Yes Possible value is "checkout"
patronid Integer Yes The unique id assigned to the patron.

Response Information

Examples
receipts/print_cko_receipt?patronid=1&branchid=1&userid=1 receipts/print_cko_receipt?patronid=1&branchid=1&userid=1&visitingpatron=true

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE. Bad request or Invalid patron ID
404 Bad request. Patron not found

Get circulation checkout receipt html document

POST /{path}

Parameters
Name Type Required Description
path String Yes receipt URL returned by "Get circulation checkout receipt URL".
Post Data: Array of integers
Property Type Nullable Description
ItemRecordID Integer No Item record identifier.
Post Data: Array of objects
Property Type Nullable Description
ItemRecordID Integer No Item record identifier.
IsEphemeral Boolean No Is this item an ephemeral item record?
Count Integer No If an ephemeral item record, how many were checked out?
Example with array of integers
application/json, text/json 
    [87899,7815207]

Response Information

an html document.

Note: content to be printed on the receipt is controled by logon branch's SA value - "Check out: receipt options".

Preview of an example html document

        Check Out Receipt

        Saratoga Springs Public Library



        Tuesday, February 25, 2014 10:36:4 AM
        12324
        Zhang, TestLeap 
        ID Number: ID Number
        Privileges / Restrictions: Privileges/Restrictions
        Voter Registration: Voter Registration
        CybraryN Use Only (XXX,YYY): CybraryN Use Only
        Favorite Brady: Greg

        Item: 0000201144276
        Title: China homecoming.
        Call no.: J 951 Fri
        Material: Book
        Due: 03/24/2014

        Item: BulkCreate007815207
        Title: Zhongguo da xing gong ye qi ye fa zhan bao gao
        Call no.: 
        Material: Book
        Due: 03/24/2014

        Total items: 2

                Thank You!
                for visiting our library

                Happy Holiday!


        911
Example with array of objects
application/json, text/json 
    [{ItemRecordID: 1, IsEphemeral: true, Count: 3}]

Response Information

an html document.

Note: content to be printed on the receipt is controled by logon branch's SA value - "Check out: receipt options".

Preview of an example html document

        Check Out Receipt

        Saratoga Springs Public Library



        Tuesday, February 25, 2014 10:36:4 AM
        12324
        Zhang, TestLeap 
        ID Number: ID Number
        Privileges / Restrictions: Privileges/Restrictions
        Voter Registration: Voter Registration
        CybraryN Use Only (XXX,YYY): CybraryN Use Only
        Favorite Brady: Greg

        Item: 39876000009926
        Title: 3 uncataloged items
        Call no.: 
        Material: Book
        Due: No Due Date

        Total items: 3

                Thank You!
                for visiting our library

                Happy Holiday!


        911

HTTP Response Codes

Code Description
200 OK. Success
401 Unauthorized