POST /api/.../workflow
This method allows the caller to check in multiple subscription issue records.
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.
| Name | Type | Required | Description |
|---|---|---|---|
| WorkflowRequest | DtoWorkflowRequest | Yes | Define this parameter in the request body. |
| 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. |
{
"WorkflowRequestType":40,
"TxnBranchID":"3",
"TxnUserID":"1",
"TxnWorkstationID":"1237",
"RequestExtension":
{
"WorkflowRequestExtensionType":33,
"Data":[123, 4567]
},
"WorkflowReplies":null
}
{
"WorkflowRequestGuid": "35a2245c-e9b6-4154-ad2e-24b7071d1a19",
"WorkflowRequestType": 40,
"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": "(2027)",
"UnitPrice": 123.45,
"Barcode": null,
"UnitPriceEnabled": false
}
}
},
"InformationMessages": [],
"AnswerExtension": null,
"CircTranType": 0,
"ReceiptType": 0,
"ReceiptUrl": "",
"FineEReceiptSent": false,
"ErrorCode": null
}
{
"WorkflowRequestGuid": "35a2245c-e9b6-4154-ad2e-24b7071d1a19",
"WorkflowRequestType": 40,
"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,
"ErrorCode": null
}
{
"WorkflowRequestGuid": "35a2245c-e9b6-4154-ad2e-24b7071d1a19",
"WorkflowRequestType": 40,
"WorkflowStatus": -3,
"Prompt": {
"WorkflowPromptID": 64,
"Name": null,
"Description": null,
"WorkflowPromptType": 1,
"WorkflowPromptOptions": 6,
"DefaultPromptOption": 4,
"Title": "Duplicate barcode",
"Message": "This barcode bulk-scki-item0005 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,
"ErrorCode": null
}
{
"WorkflowRequestGuid": "c001c39b-b52f-408a-967e-5d856083f710",
"WorkflowRequestType": 40,
"WorkflowStatus": -3,
"Prompt": {
"WorkflowPromptID": 111,
"Name": null,
"Description": null,
"WorkflowPromptType": 1,
"WorkflowPromptOptions": 6,
"DefaultPromptOption": 5,
"Title": "Print Route Slip",
"Message": "(Mar. 2013) 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": {
"WorkflowAnswerExtensionType": 16,
"Data": {
"ProcessedRecordIds": [
2610
]
}
},
"CircTranType": 0,
"ReceiptType": 0,
"ReceiptUrl": "",
"FineEReceiptSent": false,
"ErrorCode": null
}
{
"WorkflowRequestGuid": "35a2245c-e9b6-4154-ad2e-24b7071d1a19",
"WorkflowRequestType": 40,
"WorkflowStatus": 1,
"Prompt": null,
"InformationMessages": [
{
"Type": 1,
"Title": "",
"Message": "(2013): The record has been checked in."
},
{
"Type": 4,
"Title": "",
"Message": "Semi - Pro football guide. (2026): Procedure canceled"
},
{
"Type": 1,
"Title": "",
"Message": "Semi - Pro football guide. (2027): The record has been checked in."
}
],
"AnswerExtension": {
"WorkflowAnswerExtensionType": 16,
"Data": {
"ProcessedRecordIds": [
5057,
2967
]
}
},
"CircTranType": 0,
"ReceiptType": 0,
"ReceiptUrl": "",
"FineEReceiptSent": false,
"ErrorCode": null
}
{
"WorkflowRequestGuid": "8b213233-b682-47bd-a084-142215fef299",
"WorkflowRequestType": 40,
"WorkflowStatus": 1,
"Prompt": null,
"InformationMessages": [
{
"Type": 1,
"Title": "",
"Message": "Gladstone (2048): The record has been checked in."
},
{
"Type": 1,
"Title": "",
"Message": "Gladstone (2049): Route slip added to batch print queue."
},
{
"Type": 1,
"Title": "",
"Message": "Gladstone (2049): The record has been checked in."
}
],
"AnswerExtension": {
"WorkflowAnswerExtensionType": 16,
"Data": {
"ProcessedRecordIds": [
4375,
4376
]
}
},
"CircTranType": 0,
"ReceiptType": 0,
"ReceiptUrl": "",
"FineEReceiptSent": false,
"ErrorCode": null
}
{
"WorkflowRequestGuid": "c698df5b-0c49-4b8c-93ce-8385c77c72af",
"WorkflowRequestType": 40,
"WorkflowStatus": 1,
"Prompt": null,
"InformationMessages": [
{
"Type": 1,
"Title": "",
"Message": "The Reader's adviser (Mar. 2011): The record has been checked in."
},
{
"Type": 1,
"Title": "",
"Message": "The Reader's adviser (Mar. 2015): The record has been checked in."
},
{
"Type": 1,
"Title": "",
"Message": "The Reader's adviser (Nov. 2015): The record has been checked in."
}
],
"AnswerExtension": {
"WorkflowAnswerExtensionType": 16,
"Data": {
"ProcessedRecordIds": [
2605,
2617,
2619
],
"ReportTitle": null,
"ReportURL": "reports/execution?reportName=RouteSlip&reportPath=%2FSystem%2FInternal%2F&reportParameters=OrganizationList%3D3%7CWrkStaID%3D1201%7CUserID%3D1018&reportFormat=PDF"
}
},
"CircTranType": 0,
"ReceiptType": 0,
"ReceiptUrl": "",
"FineEReceiptSent": false,
"ErrorCode": null
}
| Code | Description |
|---|---|
| 200 | OK. Success |
| 401 | Unauthorized |
| 403 | |
| 403 | Forbidden. Required permission is denied. |
| 404 | Record was not found. |
| 500 | Internal Server Error |
Permission IDs found here.
CR_AccessSerials_Allow()
CR_SerialIssuesStandingOrderParts_CheckIn (based on the destination branch ID)
CR_CreateAndDeleteItemRecordFromAcquisitionsAndSerials_Allow
CR_OverrideInvalidItemBarcodeMsg_Allow