Combine Serial Issues

Start Combine Two Serial Issues or Part Process

POST /api/.../workflow

This method allows the caller to combine two serial issues or parts.

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. To combine two serial issues/parts request, this must be set to 28 (CombineSerialIssueParts).
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 DtoWorkflowRequestExtension No A combine serial issues/parts request requires a DtoCombineSerialIssuesExtensionData object.
WorkflowReplies List of DtoWorkflowReply Yes It is possible to pass in a list of replies for automated processing.
DtoWorkflowRequestExtension
Property Type Nullable Description
WorkflowRequestExtensionType Int No For a combine serial issues/parts request, the extension type must be 25 (CombineSerialIssuesExtensionData).
Data Object No This must be an extension data object of type DtoCombineSerialIssuesExtensionData.
DtoCombineSerialIssuesExtensionData
Property Type Nullable Required Description
IssueOrPartIDs Array No Yes Required. List of Issues/parts record IDs to be combined.
Request body
application/json, text/json 
{
    "WorkflowRequestType":28,
    "TxnBranchID":"3",
    "TxnUserID":"1",
    "TxnWorkstationID":"1237",
    "WorkflowReplies":null,
    "RequestExtension":{
        "WorkflowRequestExtensionType":25,
        "Data":{
            "IssueOrPartIDs":[84,85],
            
        }
    }
}

Response Information

Example: DtoWorkflowAnswer - Combine issues was successful
application/json, text/json 
{
  "WorkflowRequestGuid": "ddfe820f-c397-4ba1-9888-a567d7cb1ac3",
  "WorkflowRequestType": 28,
  "WorkflowStatus": 1,
  "Prompt": null,
  "InformationMessages": [
    {
      "Type": 1,
      "Title": "",
      "Message": "Combine issues was successful."
    }
  ],
  "AnswerExtension": null,
  "CircTranType": 0,
  "ReceiptType": 0,
  "ReceiptUrl": "",
  "FineEReceiptSent": false
}
Example: DtoWorkflowAnswer - 'Combine Issues' prompt
application/json, text/json 
{
  "WorkflowRequestGuid": "c16dde62-e9fb-4a3d-8849-42494564653f",
  "WorkflowRequestType": 28,
  "WorkflowStatus": -3,
  "Prompt": {
    "WorkflowPromptID": 120,
    "Name": null,
    "Description": null,
    "WorkflowPromptType": 43,
    "WorkflowPromptOptions": 6,
    "DefaultPromptOption": 4,
    "Title": "Combine Issues",
    "Message": "",
    "AlternateMessage": "",
    "AlternateYesText": "",
    "AlternateNoText": "",
    "AlternateCancelText": "",
    "AlternateContinueText": "",
    "PromptExtension": {
      "WorkflowPromptExtensionType": 40,
      "Data": {
        "CategoryID": 1,
        "ExpectArrivalDate": "2005-10-31T00:00:00-05:00",
        "NoteNonPub": "/Non Public Note",
        "NotePub": "/Public Note",
        "NoteStaff": "/Non public/warning note",
        "TitleOfSupIndex": null,
        "TitleOfSupIndexEnabled": false,
        "CombinedCodeDesignationList": [
          {
            "CombineCode": 0,
            "Designation": "Vol. 166 No. 18/19   (2005 31 Oct./2005 7 Nov.)"
          },
          {
            "CombineCode": 1,
            "Designation": "Vol. 166 No. 18   (2005 31 Oct./2005 7 Nov.)"
          },
          {
            "CombineCode": 2,
            "Designation": "Vol. 166 No. 18/19   (2005 31 Oct.)"
          }
        ]
      }
    }
  },
  "InformationMessages": [],
  "AnswerExtension": null,
  "CircTranType": 0,
  "ReceiptType": 0,
  "ReceiptUrl": "",
  "FineEReceiptSent": false
}
}

HTTP Response Codes

Code Description
200 OK. Success

Required Permissions

Permission IDs found here.

    CR_AccessSerials_Allow()
    CR_SerialIssuesStandingOrderParts_Modify