POST /api/.../workflow
This method allows the caller to receive item for an ill request.
| Name | Type | Required | Description |
|---|---|---|---|
| WorkflowRequest | DtoWorkflowRequest | Yes | Define this parameter in the request body. |
| Property | Type | Nullable | Description |
|---|---|---|---|
| WorkflowRequestType | Int | No | Required. For receive ill request, this must be set to 18. |
| 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 | A receive item for ill request requires a DtoWorkflowRequestExtension that contains a DtoReceiveILLExtensionData object. |
| WorkflowReplies | List of DtoWorkflowReply | Yes | It is possible to pass in a list of replies for automated processing. |
| Property | Type | Nullable | Description |
|---|---|---|---|
| WorkflowRequestExtensionType | Int | No | To receive for ill request, the extension type must be a 14 (ReceiveILLData). |
| Data | Object | No | This must be an extension data object of type DtoReceiveILLExtensionData |
{
"WorkflowRequestType":18,
"TxnBranchID":"3",
"TxnUserID":"1",
"TxnWorkstationID":"1205",
"WorkflowReplies":null,
"RequestExtension":
{
"WorkflowRequestExtensionType":14,
"Data":
{
"ILLRequestID":482
}
}
}
{
"WorkflowRequestGuid":"5ffd562b-a6c1-47c4-9c9a-729cdd26d39d",
"WorkflowRequestType":18,"WorkflowStatus":1,"Prompt":null,
"InformationMessages":
[
{
"Type":1,
"Title":"",
"Message":"This ILL item was created. Item status is Transferred."
}
],
"AnswerExtension":
{
"WorkflowAnswerExtensionType":8,
"Data":
{
"ILLRequestInfo":
{
"ILLRequestID":55,
"PatronName":"Patenaude, Ethel",
"PatronBarcode":"1000200303591",
"PatronPhone":"315-634-1234",
"PatronEmail":null,
"PatronID":1500,
"PickupBranchID":5,
"CreationDate":"2008-11-20T14:00:58.7-05:00",
"NeedByDate":"2009-09-16T14:00:58.7-04:00",
"ActivationDate":null,
"Author":"GRAY ROBERT",
"Title":"TIMES LIKE THIS 01(1)98 01(1)99 02(98)99 01(1)98 01(1)99 02(99)99 01(2)98 02(98)99 02(99)99 01(1)98 01(1)99 02(98)99 01(1)98 01(1)99 02(99)99 01(2)98 02(99)99 02(99)99 01(1)98 01(2)99 02(98)99 01(2)98 02(98)99 02(99)99 01(2)98 02(99)99 02(99)99 01(1)98","BrowseAuthor":"GRAY ROBERT","BrowseTitle":"TIMES LIKE THIS 01(1)98 01(1)99 02(98)99 01(1)98 01(1)99 02(99)99 01(2)98 02(98)99 02(99)99 01(1)98 01(1)99 02(98)99 01(1)98 01(1)99 02(99)99 01(2)98 02(99)99 02(99)99 01(1)98 01(2)99 02(98)99 01(2)98 02(98)99 02(99)99 01(2)98 02(99)99 02(99)99 01(1)98",
"MARCTOMID":5,
"MediumType":"Other",
"Publisher":null,
"PublicationYear":0,
"LCCN":null,
"ISBN":null,
"ISSN":null,
"VolumeAndIssue":null,
"Series":null,
"Edition":null,
"RequestType":"Loan",
"RequestTypeID":1,
"ItemBarcode":null,
"ILLStatusID":11,
"CurrentStatus":"Received",
"PreviousStatus":"Inactive",
"StatusTransitionDate":"2017-07-06T10:20:47.55-04:00",
"StaffNotes1":"NCIP ITEM",
"StaffNotes2":null,
"OPACNotes":null,
"InnReachType":0,
"MARCTOMDescription":"Sound Recording",
"CentralItemType":0,
"CentralCode":null,
"ReturnUncirc":false,
"InnReachBibCallNumber":null,
"BibliographicRecordID":1122585,
"HoldTillDate":null,
"ItemStatusID":5,
"ItemRecordID":10776661,
"InnReachTrackingID":0,
"AssignedBranchID":3,
"ILLMessageDetailSentDate":null
}
}
},
"CircTranType":0,
"ReceiptType":0,
"ReceiptUrl":"",
"FineEReceiptSent":false
}
{
"WorkflowRequestGuid":"c5e5f255-a44c-463f-a5d3-881895876ccc",
"WorkflowRequestType":18,
"WorkflowStatus":-3,
"Prompt":
{
"WorkflowPromptID":55,
"Name":null,
"Description":null,
"WorkflowPromptType":15,
"WorkflowPromptOptions":6,
"DefaultPromptOption":5,
"Title":"Brief Item Entry",
"Message":"Brief Item Entry.",
"AlternateYesText":"",
"AlternateNoText":"",
"AlternateCancelText":"",
"AlternateContinueText":"",
"PromptExtension":
{
"WorkflowPromptExtensionType":21,
"Data":
{
"Barcode":null,
"Title":"HAMMER AT THE KEYBOARD",
"Author":"NUTHERKRUSHER AARON",
"CallNumberPrefix":null,
"CallNumberSuffix":null,
"CallNumber":null,
"FreeTextBlock":"ILL request free text",
"OTFBlock":false,
"MaterialTypeID":1,
"LoanPeriodCodeID":9,
"FineCodeID":3,
"ShelfLocationID":0,
"ClassificationNumber":"C",
"IsILLRequestItem":true
}
}
},
"InformationMessages":[],
"AnswerExtension":null,
"CircTranType":0,
"ReceiptType":0,
"ReceiptUrl":"",
"FineEReceiptSent":false
}
| Code | Description |
|---|---|
| 200 | OK. Success |
| 403 | Not permitted. |
Permission IDs found here.
AccessCirculationControl_Allow
CR_ILLRequests_Access
CR_ILLRequests_Modify
CreateOnTheFlyRecords_Allow