Receipt Options

Load Receipt Options

GET /api/.../printoptions?workstationid={wkstid}&type={optiontype}

Return a list of print options set for the circulation actions.

Update Receipt Options And Message Text

PUT /api/.../printoptionsandmessage?workstationid={wkstid}

Insert or update print options set for the circulation actions and update message text (Check out and Fine receipts).

Request Information

Parameters
Name Type Required Description
workstationid int Yes Identity of the logon workstation.
DtoPrintOptionsWithMessage Message Text And List of Print Options Yes Define in the request body
Request body
Example
application/json, text/json 
        {
          "PrintOptions": [
            {
              "nPrintOptionID": 0,
              "nPrinterDriverID": 0,
              "csPrinterName": "string",
              "bRowPrint": true,
              "bCheckOutReceipt": true,
              "bCheckoutReceiptNoEReceipt": true,
              "bHoldSlip": true,
              "bFineReceipt": true,
              "bFineReceiptNoEReceipt": true,
              "bILLSlip": true,
              "bInTransitSlip": true,
              "bInTransitHoldsOnlySlip": true,
              "bHoldCallSlip": true,
              "bHoldPickupSlip": true,
              "bINNReachPickupSlip": true,
              "isCheckOutLost": true,
              "nScrollLines": 0
            }
          ],
          "Message": "string"
        }

HTTP Response Codes

Code Description
200 OK. Success
400 Bad request
401 Unauthorized

Update Receipt Options

PUT /api/.../printoptions?workstationid={wkstid}&type={optiontype}

Insert or update print options set for the circulation actions.

Request Information

Parameters
Name Type Required Description
workstationid int Yes Identity of the logon workstation.
type int No Print option type. Possible values are:
All = 0,
ChkInPrintOptions = 1,
ChkOutPrintOptions = 2,
PatStatPrintOptions = 3,
ILLPrintOptions = 4,
HoldPrintOptions = 5,
ItemChkInPrintOptions = 6,
ChkInOfflinePrintOptions = 7,
ChkOutOfflinePrintOptions = 8,
ChkInReceivePrintOptions = 9

Response Information

Example
application/json, text/json 
[
    {
    "nPrintOptionID": 1,
    "nPrinterDriverID": 0,
    "csPrinterName": "\\GALILEO-R12\HP LaserJet 600 PCL6 (Development)",
    "bRowPrint": true,
    "bCheckOutReceipt": null,
    "bCheckoutReceiptNoEReceipt": null,
    "bHoldSlip": false,
    "bFineReceipt": false,
    "bFineReceiptNoEReceipt": false,
    "bILLSlip": null,
    "bInTransitSlip": false,
    "bInTransitHoldsOnlySlip": false,
    "bHoldCallSlip": false,
    "bHoldPickupSlip": false,
    "isCheckOutLost": false,
    "nScrollLines": 8
  },
  {
    "nPrintOptionID": 2,
    "nPrinterDriverID": 2,
    "csPrinterName": "Star TSP600 Cutter (TSP643)",
    "bRowPrint": true,
    "bCheckOutReceipt": false,
    "bCheckoutReceiptNoEReceipt": false,
    "bHoldSlip": false,
    "bFineReceipt": false,
    "bFineReceiptNoEReceipt": false,
    "bILLSlip": null,
    "bInTransitSlip": false,
    "bInTransitHoldsOnlySlip": false,
    "bHoldCallSlip": false,
    "bHoldPickupSlip": false,
    "isCheckOutLost": false,
    "nScrollLines": 8
  },
  {
    "nPrintOptionID": 3,
    "nPrinterDriverID": 0,
    "csPrinterName": "Generic / Text Only",
    "bRowPrint": true,
    "bCheckOutReceipt": true,
    "bCheckoutReceiptNoEReceipt": true,
    "bHoldSlip": false,
    "bFineReceipt": true,
    "bFineReceiptNoEReceipt": false,
    "bILLSlip": null,
    "bInTransitSlip": false,
    "bInTransitHoldsOnlySlip": false,
    "bHoldCallSlip": false,
    "bHoldPickupSlip": false,
    "isCheckOutLost": false,
    "nScrollLines": 8
  },
  {
    "nPrintOptionID": 4,
    "nPrinterDriverID": 0,
    "csPrinterName": "Star TSP600 Cutter (TSP643)",
    "bRowPrint": true,
    "bCheckOutReceipt": null,
    "bCheckoutReceiptNoEReceipt": null,
    "bHoldSlip": null,
    "bFineReceipt": null,
    "bFineReceiptNoEReceipt": null,
    "bILLSlip": false,
    "bInTransitSlip": false,
    "bInTransitHoldsOnlySlip": null,
    "bHoldCallSlip": null,
    "bHoldPickupSlip": true,
    "isCheckOutLost": false,
    "nScrollLines": 8
  },
  {
    "nPrintOptionID": 5,
    "nPrinterDriverID": 2,
    "csPrinterName": "Star TSP600 Cutter (TSP643)",
    "bRowPrint": true,
    "bCheckOutReceipt": null,
    "bCheckoutReceiptNoEReceipt": null,
    "bHoldSlip": true,
    "bFineReceipt": null,
    "bFineReceiptNoEReceipt": null,
    "bILLSlip": null,
    "bInTransitSlip": false,
    "bInTransitHoldsOnlySlip": null,
    "bHoldCallSlip": false,
    "bHoldPickupSlip": false,
    "isCheckOutLost": false,
    "nScrollLines": 8
  },
  {
    "nPrintOptionID": 6,
    "nPrinterDriverID": 0,
    "csPrinterName": null,
    "bRowPrint": null,
    "bCheckOutReceipt": null,
    "bCheckoutReceiptNoEReceipt": null,
    "bHoldSlip": false,
    "bFineReceipt": false,
    "bFineReceiptNoEReceipt": false,
    "bILLSlip": null,
    "bInTransitSlip": false,
    "bInTransitHoldsOnlySlip": false,
    "bHoldCallSlip": false,
    "bHoldPickupSlip": false,
    "isCheckOutLost": false,
    "nScrollLines": 8
  }
]

HTTP Response Codes

Code Description
200 OK. Success
501 Not implemeneted. Invalid print option type.