UpdatePatronNotesData
Provides the ability to prepend, append, or replace staff notes on patrons. For example, if the system tries to email a patron a notification, the system can append a note on the patron's record if the email bounces back.
| GET | /protected/1/{Access Token}/patron/{PatronBarcode}/notes?wsid={WorkstationID} |
Authorization required?
Yes
Protected method?
Yes
URI parameters
|
Name |
Required |
Description/Notes |
|---|---|---|
| PatronBarCode | Yes |
Barcode of Patron |
Query string parameters
|
Name |
Value | Required |
Description/Notes |
|---|---|---|---|
| wsid | >0 | Yes |
ID of workstation calling this method |
XML Body elements
|
Name |
Required |
Description/Notes |
|---|---|---|
| BlockingNote | No |
Blocking note text. |
| BlockingNoteMode | No |
Determines where the provided Blocking note text will be applied. 0 = Replace existing note text, 1 = Prepend to existing note text, 2 = Append to existing note text. Note: The default is BlockingNoteMode=2 if no mode is provided. |
| NonBlockingNote | No | Non-blocking note text |
| NonBlockingNoteMode | No |
Determines where the provided Non-blocking note text is applied. 0 = Replace existing note text, 1 = Prepend to existing note text, 2 = Append to existing note text. Note: The default is NonBlockingNoteMode=2 if no mode is provided. |
XML elements returned
The following table lists material type elements returned.
|
Name |
Description/Notes |
| PAPIErrorCode |
PAPI Error code: 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
http://localhost/PAPIService/REST/protected/v1/1033/100/1/rGhOMQjR7MXZuJYREw6TQHPGsy1tlZPr/patron/29800012345678/notes?wsid=1
Body
<UpdatePatronNotesData>
<BlockingNote>This note will block the patron. The note text will be replaced.</BlockingNote>
<BlockingNoteMode>0</BlockingNoteMode>
<NonBlockingNote>This note will not block the patron. The note text will be appended to the existing text.</NonBlockingNote>
<NonBlockingNoteMode>1</NonBlockingNoteMode>
</UpdatePatronNotesResult>
Return - Success
HTTP/1.1 200 OK
<UpdatePatronNotesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<PAPIErrorCode>1</PAPIErrorCode>
<ErrorMessage></ErrorMessage>
</UpdatePatronNotesResult>