Outreach Services Patrons

Get Outreach Services Patrons

POST /api/.../orsmanager/patrons

Return list of ORS patrons based on an array of patron IDs or a DtoORSManagerPatronInfo object.

When supplying a list of patron IDs, only patrons with valid ORS patron data will be returned. Duplicate patrons IDs will be ignored.

Required Permissions

Permission IDs found here.

Name
OutreachServicesManager_Access

Request Information

DtoORSManagerPatronInfo
Property Type Nullable Description
OrganizationID Int No OrganizationID of the Patron
StatusID Int No Possible values are Active(1) or Inactive(2)
NextDeliveryDateStart DateTime Yes Start of date range for the patron's next delivery
NextDeliveryDateEnd DateTime Yes End of date range for the patron's next delivery
DeliveryRoutes Array Yes Array of integers mapping to the Delivery Routes here
DeliveryModes Array Yes Array of integers mapping to the Delivery Modes here

Example with array of patron IDs.
application/json, text/json 
[877656, 865622, 6545]

Example with DtoORSManagerPatronInfo object.
application/json, text/json 
{
    "OrganizationID": 3,
    "StatusID": 1,
    "NextDeliveryDateStart": null,
    "NextDeliveryDateEnd": null,
    "DeliveryRoutes": [
    
    ],
    "DeliveryModes": [
    
    ]
}

Example with DtoORSManagerPatronInfo object. Delivery information supplied.
application/json, text/json 
{
    "OrganizationID": 7,
    "StatusID": 2,
    "NextDeliveryDateStart": "2020-01-01T00:00:00.000Z",
    "NextDeliveryDateEnd": "2020-01-31T23:59:59.000Z",
    "DeliveryRoutes": [
        1,3,7
    ],
    "DeliveryModes": [
        1,2
    ]
}

Response Information

Example
application/json, text/json 
{
    "PatronID": 36281,
    "Barcode": "1000201183752",
    "NameFirst": "Christine",
    "NameLast": "TEST",
    "NameMiddle": "R",
    "DeliveryRouteID": 0,
    "DeliveryModeID": 0,
    "DeliveryStopID": 0,
    "LastServiceDate": null,
    "Street": "8989 Second Ave",
    "City": "DACULA",
    "State": "GA",
    "Zip": "30019",
    "Phone": "315-555-1212",
    "RecordStatusID": 1,
    "BirthDate": "1998-01-09T00:00:00-04:00",
    "OrganizationID": 3,
    "PatronCodeID": 1,
    "FullName": "TEST, Christine R"
},
{
    "PatronID": 357126,
    "Barcode": "1000402261985a",
    "NameFirst": "Emil",
    "NameLast": "Petteys",
    "NameMiddle": "D",
    "DeliveryRouteID": 0,
    "DeliveryModeID": 0,
    "DeliveryStopID": 0,
    "LastServiceDate": "2013-01-18T15:27:52.12-05:00",
    "Street": "1000 Hopson Rd",
    "City": "DELTONA",
    "State": "FL",
    "Zip": "32725",
    "Phone": "315-555-1212",
    "RecordStatusID": 1,
    "BirthDate": "1980-07-01T00:00:00-04:00",
    "OrganizationID": 3,
    "PatronCodeID": 1,
    "FullName": "Petteys, Emil D"
}

HTTP Response Codes

Code Description
200 OK. Success