SynchTasksNotifyPatron
Writes patron notification transaction information into the Polaris database for additional processing within the Polaris ILS.
| PUT | /protected/1/{AccessToken}/synch/tasks/notifypatron |
Authorization required?
Yes
Query String Parameters
|
Name |
Value |
Required |
Description/Notes |
|
wsid |
>0 |
No |
ID of workstation calling this method |
|
userid |
>0 |
No |
ID of user calling this method (not patron ID) |
XML Body Elements
Important: XML elements must be in the order shown below.
|
Name |
Description/Notes |
| VendorID | Free text string. Consult with Polaris. |
| VendorContractID | Free text string. Consult with Polaris. |
| PatronBarcode | The Patron barcode, as represented in Polaris. |
| Message | Patron notification message from a third-party vendor that integrates with Polaris. |
XML Elements Returned
|
Name |
Description/Notes |
|
PAPIErrorCode |
Negative values represent errors and are defined elsewhere. Note: On successful completion, the PAPI error code is populated with a positive integer representing the number of rows returned. |
|
ErrorMessage |
Error or information message |
Example
Copy
http://[HOSTNAME]/PAPIService/REST/protected/v1/1033/100/1/[Access token]/synch/tasks/notifypatronBody
Copy
<SynchTasksNotifyPatronData>
<VendorID>3M Cloud Library</VendorID>
<VendorContractID>12345</VendorContractID>
<PatronBarcode>1000200692332</PatronBarcode>
<Message>Please resolve your holds</Message>
</SynchTasksNotifyPatronData>Return - Success
Copy
Return - Success
HTTP/1.1 200 OK
<SynchTasksNotifyPatronResult
xmlns:i="http://www.w3.org/2001/XMLSchemainstance">
<PAPIErrorCode>0</PAPIErrorCode>
<ErrorMessage/>
</SynchTasksNotifyPatronResult>Return - Failed
Copy
Return - Failed
HTTP/1.1 200 OK
<SynchTasksNotifyPatronResult
xmlns:i="http://www.w3.org/2001/XMLSchemainstance">
<PAPIErrorCode>-3000</PAPIErrorCode>
<ErrorMessage>Error retrieving patron ID.</ErrorMessage>
</SynchTasksNotifyPatronResult>