PatronAssociationsGet
Returns patron associations for a patron identified with given barcode.
| GET | /public/1/patron/{PatronBarcode}/associations |
Authorization required?
Yes
URI Parameters
| Name |
Required |
Description/Notes |
|
PatronBarcode |
Yes |
Calling patron barcode |
XML Elements Returned
|
Name |
Description/Notes |
| PatronID |
Associated patron's record ID |
| PatronBarcode | Associated patron's barcode |
|
PatronCodeID |
Associated patron’s patron code ID |
|
PatronOrgID |
ID of the organization to which the associated patron is assigned |
|
BlockMe |
Shows whether the patron will be blocked if the associated patron is blocked |
|
AllowMe |
Shows whether the patron is allowed to pick up held items for associated patrons |
|
Note |
Associated patron notes |
| PatronExpirationDate | Associated patron's registration expiration date. |
Example
Copy
http://localhost/PAPIService/REST/public/v2/1033/100/1/patron/21756003332022?PreferAssociatedPatron=trueReturn - Success
Copy
<?xml version="1.0" encoding="UTF-8"?>
<PatronAssociationsGetResult>
<PAPIErrorCode>0</PAPIErrorCode>
<ErrorMessage>string</ErrorMessage>
<PatronAssociations>
<PatronAssociationsItem>
<PatronID>0</PatronID>
<PatronBarcode>string</PatronBarcode>
<PatronCodeID>0</PatronCodeID>
<PatronOrgID>0</PatronOrgID>
<BlockMe>true</BlockMe>
<AllowMe>true</AllowMe>
<Note>string</Note>
<PatronExpirationDate>2026-05-26T10:06:37.187Z</PatronExpirationDate>
</PatronAssociationsItem>
</PatronAssociations>
</PatronAssociationsGetResult>