Check In Serial Record

Start Serial record check in Process

POST /api/.../workflow

This method allows the caller to check a serial record.

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 bib record for standing order part if linked bib does not exist
  • Create item record if template exists.
  • If barcode is supplied, validate format, duplicate barcodes, ephemeral items

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 22.
TxnBranchID Int No Transacting branch ID. This should represent where the request originated from. Typically the same as the logged on branch, but in the case of offline processing it would be the branch that was logged into during offline processing.
TxnUserID Int No Transacting Polaris user ID. This should represent who originally created this request. Typically the same as the logged on user, but in the case of offline processing it would be the user that was logged on during offline processing.
TxnWorkstationID Int No Transacting workstation ID. This should represent where the request originated from. Typically the same as the logged on workstation, but in the case of offline processing it would be the workstation that was logged into during offline processing.
RequestExtension DtoWorkflowRequestExtension No To check in a serial record requires a SerialCheckinExtensionData object.
WorkflowReplies List of DtoWorkflowReply Yes It is possible to pass in a list of replies for automated processing.
SerialCheckinExtensionData
Property Type Nullable Description
WorkflowRequestExtensionType Int No To check in a serial record, the extension type must be a 22 (SerialCheckinData).
Data Object No This must be an extension data object of type DtoSerialCheckinExtensionData
DtoSerialCheckinExtensionData
Property Type Nullable Description
IssueID Integer No Primary key. Used to check in the serial issue record.
CopyID Integer No
PubPatternID Integer No
DestinationOrgID Integer No
IssueStatusID Integer No
Destination String Yes

Check in Request body

application/json, text/json 
{
    "WorkflowRequestType":25,
    "TxnBranchID":"3",
    "TxnUserID":"1",
    "TxnWorkstationID":"1237",
    "RequestExtension":
    {
        "WorkflowRequestExtensionType":22,
        "Data":{
            CheckinTypeID: 0
            CopyID: 7
            Designation: "(2013)"
            DestinationOrgID: 103
            IssueID: 2953
            IssueStatusID: 2
            PubPatternID: 947
        }
    },
    "WorkflowReplies":null
}

Response Information

Example - Create Item for Issue/Part response
application/json, text/json 
{
    "WorkflowRequestGuid":"0da2f26d-f645-4711-98e2-aed902df43f8",
    "WorkflowRequestType":25,
    "WorkflowStatus":-3,
    "Prompt":{"WorkflowPromptID":107,
    "Name":null,"Description":null,
    "WorkflowPromptType":38,
    "WorkflowPromptOptions":6,
    "DefaultPromptOption":4,
    "Title":"Create Item for Issue/Part",
    "Message":"","AlternateMessage":"",
    "AlternateYesText":"","AlternateNoText":"",
    "AlternateCancelText":"",
    "AlternateContinueText":"",
        "PromptExtension":
        {
            "WorkflowPromptExtensionType":36,
            "Data":
            {
                "Title":"Semi - Pro football guide.",
                "DestinationOrgID":103,
                "DestinationOrgName":"Stillwater Public Library (STI)",
                "Designation":"(2013)",
                "UnitPrice":123.4500,
                "Barcode":null,
                "UnitPriceEnabled":true
            }
        }
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example - Invalid item barcode response
application/json, text/json 
{
    "WorkflowRequestGuid":"0da2f26d-f645-4711-98e2-aed902df43f8",
    "WorkflowRequestType":25,
    "WorkflowStatus":-3,
    "Prompt":
    {
        "WorkflowPromptID":63,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":1,
        "WorkflowPromptOptions":1,
        "DefaultPromptOption":3,
        "Title":"Invalid barcode format",
        "Message":"This barcode format is not defined. 
Do you want to use this barcode for this item?",
        "AlternateMessage":"",
        "AlternateYesText":"",
        "AlternateNoText":"",
        "AlternateCancelText":"",
        "AlternateContinueText":"",
        "PromptExtension":null
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example - Duplicate barcode response
application/json, text/json 
{
    "WorkflowRequestGuid":"6a37de20-4ddf-4e14-b053-b2af0c436238",
    "WorkflowRequestType":25,
    "WorkflowStatus":-3,
    "Prompt":
    {
        "WorkflowPromptID":64,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":1,
        "WorkflowPromptOptions":6,
        "DefaultPromptOption":4,
        "Title":"Duplicate barcode",
        "Message":"This barcode 0000401507652 is already in use. An item record will be generated without a barcode.",
        "AlternateMessage":"",
        "AlternateYesText":"",
        "AlternateNoText":"",
        "AlternateCancelText":"",
        "AlternateContinueText":"",
        "PromptExtension":null
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example - Create Part Bibliographic Record response
application/json, text/json 
{
    "WorkflowRequestGuid":"3e047328-2ac5-4bfa-b3cc-3e98b749b1c6",
    "WorkflowRequestType":25,
    "WorkflowStatus":-3,
    "Prompt":
    {
        "WorkflowPromptID":109,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":40,"WorkflowPromptOptions":6,"DefaultPromptOption":4,
        "Title":"Create Part Bibliographic Record",
        "Message":"","AlternateMessage":"",
        "AlternateYesText":"","AlternateNoText":"",
        "AlternateCancelText":"","AlternateContinueText":"",
        "PromptExtension":
        {
            "WorkflowPromptExtensionType":37,
            "Data":
            {
                "SeriesTitle":"testing of Time-Life old-fashioned Christmas cookbook.",
                "DisplayInPac":true
            }
        }
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,"ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example - Prompt to route and print route slip response
application/json, text/json 
{
    "WorkflowRequestGuid": "49f17779-138e-472a-8b8d-a5b8cef150be",
    "WorkflowRequestType": 25,
    "WorkflowStatus": -3,
    "Prompt": {
        "WorkflowPromptID": 111,
        "Name": null,
        "Description": null,
        "WorkflowPromptType": 1,
        "WorkflowPromptOptions": 6,
        "DefaultPromptOption": 5,
        "Title": "Print Route Slip",
        "Message": "Vol. 45 No. 5  (May 2004) is linked to a route list. Click OK to print the route slip or cancel to continue without printing.",
        "AlternateMessage": "",
        "AlternateYesText": "",
        "AlternateNoText": "",
        "AlternateCancelText": "",
        "AlternateContinueText": "OK",
        "PromptExtension": null
    },
    "InformationMessages": [],
    "AnswerExtension": null,
    "CircTranType": 0,
    "ReceiptType": 0,
    "ReceiptUrl": "",
    "FineEReceiptSent": false,
    "ErrorCode": null
}

Check in serial record Response Information

Example: DtoWorkflowAnswer - Check in successful
application/json, text/json 
{
    "WorkflowRequestGuid":"0da2f26d-f645-4711-98e2-aed902df43f8",
    "WorkflowRequestType":25,
    "WorkflowStatus":1,
    "Prompt":null,
    "InformationMessages":
    [
        {
            "Type":1,"Title":"",
            "Message":"The record has been checked in."
        }
    ],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example: DtoWorkflowAnswer - Check in successful with option to print a route slip
application/json, text/json 
{
    "WorkflowRequestGuid": "49f17779-138e-472a-8b8d-a5b8cef150be",
    "WorkflowRequestType": 25,
    "WorkflowStatus": 1,
    "Prompt": null,
    "InformationMessages": [
        {
            "Type": 1,
            "Title": "",
            "Message": "The record has been checked in."
        }
    ],
    "AnswerExtension": {
        "WorkflowAnswerExtensionType": 10,
        "Data": {
            "ReportTitle": null,
            "ReportURL": "reports/execution?reportName=RouteSlip&reportPath=%2FSystem%2FInternal%2F&reportParameters=OrganizationList%3D7%7CWrkStaID%3D1090%7CUserID%3D1&reportFormat=PDF"
        }
    },
    "CircTranType": 0,
    "ReceiptType": 0,
    "ReceiptUrl": "",
    "FineEReceiptSent": false,
    "ErrorCode": null
}

HTTP Response Codes

Code Description
200 OK. Success

Required Permissions

Permission IDs found here.

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