Outreach Patron's General preferences

Get General

GET /api/.../patrons/{id}/readerservices/preferences/general

Return existing outreach patron's equipement and disability lists.

Request Information

Response Information

Example
application/json, text/json
{
  "PatronID": 357374,
  "ORSDisabilities": [
    6,
    8
  ],
  "ORSEquipment": [
    4,
    5
  ]
}

Permission IDs found here.

Name
AccessPatronServices_Allow
PatronStatus_Access
PatronStatus_DisplayReaderServices
PatronStatus_ModifyReaderServices

Update General

PUT /api/.../patrons/{id}/readerservices/preferences/general

Update outreach patron's equipment and disability lists.

Required Permissions

Permission IDs found here.

Name
AccessPatronServices_Allow
PatronStatus_Access
PatronStatus_DisplayReaderServices
PatronStatus_ModifyReaderServices

Request Information

Parameters
Name Type Required Description
orsData ORSPatronGeneralPreferences Yes Define this parameter in the request body.
id Integer Yes The unique id assigned to the patron.
ORSPatronGeneralPreferences
Property Type Nullable Description
PatronID Int No The unique id assigned to the patron.
ORSDisabilities List of integers Yes List of disabilities.
ORSEquipment List of integers Yes List of equipment.
Request body
Example
application/json, text/json
{
  "PatronID": 357374,
  "ORSDisabilities": [
    6,
    8
  ],
  "ORSEquipment": [
    4
  ]
}    

Response Information

Returns updated eqipments and disability lists if update is successful.
Example
application/json, text/json
{
  {
  "PatronID": 357374,
  "ORSDisabilities": [
    6,
    8
  ],
  "ORSEquipment": [
    4
  ]
}

HTTP Response Codes

Code Description
200 OK. Success
400 Null object. Bad request
409 CONFLICT. Patron record is secured.