Outreach Patron Reader Services Info

Get Outreach Patron Reader Services Info

GET /api/.../patrons/{id}/readerservices?extendedData={true/false}

Return patron reader services information.

Required Permissions

Permission IDs found here.

Name
AccessPatronServices_Allow
PatronStatus_Access
PatronStatus_DisplayReaderServices
PatronStatus_ModifyReaderServices

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the patron.
extendedData Boolean No Set to true to return extended data.

Response Information

Example
application/json, text/json 
{
    "PatronID":357374,
    "ORSStatusID":1,
    "Enabled":true,
    "Note":null,
    "SearchFilter":"",
    "ActivationDate":"2000-08-10T00:00:00-04:00",
    "LastServiceDate":"2018-12-17T05:00:00-05:00",
    "NextServiceDate":"2018-12-17T05:00:00-05:00",
    "DeliveryModeID":12,"DeliveryRouteID":5,
    "DeliveryStopID":1,
    "DeliveryScheduleTypeID":0,
    "DeliveryScheduleEvery":2,
    "DeliveryScheduleDate":"2019-09-18T04:00:00-04:00",
    "ResponsiblePickupPerson":"John Smith",
    "DeliveryNote":null,
    "NumItemsToSend":100,
    "ResendItems":true,
    "ResendMonthsToWait":110,
    "PatronSelectionsOnly":true,
    "DisabilityList":[1,6,8],
    "EquipmentList":[4,5,8]
}
Example with extended data
application/json, text/json 
{
  "NameFirst": "Astro",
  "NameLast": "Jetson",
  "NameMiddle": "\"Fido\"",
  "DeliveryMode": "Bookmobile",
  "DeliveryRoute": "Route One",
  "PatronID": 358255,
  "ORSStatusID": 1,
  "Enabled": true,
  "Note": "",
  "SearchFilter": "",
  "ActivationDate": "2019-09-11T00:00:00-04:00",
  "LastServiceDate": "2020-03-05T13:55:15.493-05:00",
  "NextServiceDate": "2020-04-05T23:59:59-04:00",
  "DeliveryModeID": 23,
  "DeliveryRouteID": 25,
  "DeliveryStopID": 1,
  "DeliveryScheduleTypeID": 5,
  "DeliveryScheduleEvery": 0,
  "DeliveryScheduleDate": null,
  "ResponsiblePickupPerson": "Joe",
  "DeliveryNote": "Has a dog",
  "NumItemsToSend": 5,
  "ResendItems": false,
  "ResendMonthsToWait": 120,
  "PatronSelectionsOnly": false,
  "ExistingORSPatron": true,
  "DisabilityList": [
    17,
    22
  ],
  "EquipmentList": []
}

HTTP Response Codes

Code Description
200 OK. Success