© 2024 Clarivate
PATCH /api/.../patrons/{id}
When you secure a patron record, all circulation and payment activity, and most other patron record updates, are prevented in both the staff client and the PACs (PowerPAC, Mobile PAC, and Children's PAC).
The patron status object locked must be acquired before securing the record.
CR_AccessPatronServices_Allow, CR_PatronStatus_Access, CR_SecurePatronRecord_Allow
Name | Type | Required | Description |
---|---|---|---|
id | Integer | Yes | The unique id assigned to the patron code. Used to return a single object. |
The PATCH data object contains the name/value pairs of the properties to update. For securing a patron, the RecordStatus must be set to 3 (secured).
{
"RecordStatus":3
}
On success, returns new record status date.
"2015-06-24T16:56:16.933-04:00"
{
"ErrorCode":10000,
"Message":"Patron record is locked by another user and may not be secured.",
"MessageDetail":null,
"StackTrace":null,
"InnerException":null,
"Data":null
}
Code | Description |
---|---|
200 | OK. Success |
400 | Bad Request. Unable to secure patron record. |
403 | Forbidden. User does not have permission. |
404 | Not Found. Patron not found |
PATCH /api/.../patrons/{id}
Release a patron record.
The patron status object locked must be acquired before releasing the record.
CR_AccessPatronServices_Allow,
CR_PatronStatus_Access,
CR_ReleasePatronRecord_Allow
Name | Type | Required | Description |
---|---|---|---|
id | Integer | Yes | The unique id assigned to the patron code. Used to return a single object. |
The PATCH data object contains the name/value pairs of the properties to update. For releasing a patron, the RecordStatus must be set to 1 (final).
{
"RecordStatus":1
}
{
"ErrorCode":10000,
"Message":"Patron record is locked by another user and may not be released.",
"MessageDetail":null,
"StackTrace":null,
"InnerException":null,
"Data":null
}
Code | Description |
---|---|
200 | OK. Success |
400 | Bad Request. Unable to release patron record. |
403 | Forbidden. User does not have permission. |
404 | Not Found. Patron not found |