Bulk Check In Serial Records

Start Serial record check in Process

POST /api/.../workflow

This method allows the caller to check in multiple subscription issue records.

Permissions

This call requires the CR_AccessSerials_Allow (ID: 63) and CR_SerialIssuesStandingOrderParts_CheckIn (ID: 5). CR_SerialIssuesStandingOrderParts_CheckIn permission is based on the destination branch.

Workflow Steps

  • Validate data in the request
  • Check if the subscription issue is linked to a subscription that was canceled (can be bypassed)
  • Create item record if template exists.
  • If barcode is supplied, validate format, duplicate barcodes, ephemeral items
  • Check in the subscription issue record.
  • If the subscription issue record or its holdings record is linked to a Route List, prompt to print a pickup list after check in

Request Information

Parameters
Name Type Required Description
WorkflowRequest DtoWorkflowRequest Yes Define this parameter in the request body.
DtoWorkflowRequest
Property Type Nullable Description
WorkflowRequestType Int No Required. This value must be set to 40.
TxnBranchID Int No Transacting branch ID. This should represent where the request originated from. Typically the same as the logged on branch.
TxnUserID Int No Transacting Polaris user ID. This should represent who originally created this request. Typically the same as the logged on user.
TxnWorkstationID Int No Transacting workstation ID. This should represent where the request originated from. Typically the same as the logged on workstation.
RequestExtension Integer[] No To bulk check in multiple subscription issue records requires a list of record IDs. WorkflowRequestExtensionType must be 33
WorkflowReplies List of DtoWorkflowReply Yes It is possible to pass in a list of replies for automated processing.

Check in Request body

application/json, text/json 
{
    "WorkflowRequestType":40,
    "TxnBranchID":"3",
    "TxnUserID":"1",
    "TxnWorkstationID":"1237",
    "RequestExtension":
    {
        "WorkflowRequestExtensionType":33,
        "Data":[123, 4567]
    },
    "WorkflowReplies":null
}

Response Information

Example - Create Item for Issue/Part response

TBD

Example - Invalid item barcode response

TBD

Example - Duplicate barcode response

TBD

Example - Prompt to route and print route slip response

TBD

Check in serial record Response Information

Example: DtoWorkflowAnswer - Bulk check in successful
application/json, text/json 
{
  "WorkflowRequestGuid": "00000000-0000-0000-0000-000000000000",
  "WorkflowRequestType": 40,
  "WorkflowStatus": 1,
  "Prompt": null,
  "InformationMessages": [
    {
      "Type": 1,
      "Title": "",
      "Message": "(2013): The record has been checked in."
    },
    {
      "Type": 1,
      "Title": "",
      "Message": "Vol 1 Issue 1 (Friday Jan. 5 2018): The record has been checked in."
    }
  ],
  "AnswerExtension": {
    "WorkflowAnswerExtensionType": 16,
    "Data": {
      "ProcessedRecordIds": [
        5057,
        33937
      ]
    }
  },
  "CircTranType": 0,
  "ReceiptType": 0,
  "ReceiptUrl": "",
  "FineEReceiptSent": false,
  "ErrorCode": null
}
Example: DtoWorkflowAnswer - Check in successful with option to print a route slip

TBD

HTTP Response Codes

Code Description
200 OK. Success
401 Unauthorized
403
403 Forbidden. Required permission is denied.
404 Record was not found.
500 Internal Server Error

Required Permissions

Permission IDs found here.

    CR_AccessSerials_Allow()
    CR_SerialIssuesStandingOrderParts_CheckIn (based on the destination branch ID)
    CR_CreateAndDeleteItemRecordFromAcquisitionsAndSerials_Allow
    CR_OverrideInvalidItemBarcodeMsg_Allow