Outreach Services Patrons

Get Outreach Services Patrons Combined Pick List By Selection Criteria

POST /api/.../orsmanager/picklist

Returns combined pick list for patrons found in the branch using supplied selection criteria.

Required Permissions

Permission IDs found here.

Name
OutreachServicesManager_Access

Request Information

searchData JSON
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 1
application/json, text/json 
{
    "OrganizationID": 3,
    "StatusID": 1,
    "NextDeliveryDateStart": null,
    "NextDeliveryDateEnd": null,
    "DeliveryRoutes": [
    
    ],
    "DeliveryModes": [
    
    ]
}
Example 2
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 
[
  {
    "ItemRecordID": 1770414,
    "Barcode": "0002700089598",
    "BrowseAuthor": null,
    "BrowseTitle": "Snowboarding basics.",
    "CallNumber": "796.9 Sno",
    "ItemStatusID": 1,
    "RecordStatusID": 1,
    "AssignedBranchID": 34,
    "AssignedCollectionID": 32,
    "MaterialTypeID": 1,
    "AssociatedBibRecordID": 574441,
    "ShelfLocationID": null,
    "PatronID": null,
    "ShelfLocation": null,
    "SysHoldRequestID": 0,
    "HoldingPatronBarcode": null,
    "HoldingPatronPickupBranchID": 0,
    "BrowseTitleNonFilingCount": 0,
    "IsElectronicItem": false,
     "ORSPatronID": 0,
    "HoldingPatronID": 0
  },
  {
    "ItemRecordID": 70,
    "Barcode": "0000100004183",
    "BrowseAuthor": "Auchincloss, Louis.",
    "BrowseTitle": "The cat and the King",
    "CallNumber": "Fict",
    "ItemStatusID": 2,
    "RecordStatusID": 1,
    "AssignedBranchID": 90,
    "AssignedCollectionID": null,
    "MaterialTypeID": 1,
    "AssociatedBibRecordID": 87429,
    "ShelfLocationID": null,
    "PatronID": null,
    "ShelfLocation": null,
    "SysHoldRequestID": 0,
    "HoldingPatronBarcode": null,
    "HoldingPatronPickupBranchID": 0,
    "BrowseTitleNonFilingCount": 4,
    "IsElectronicItem": false,
     "ORSPatronID": 0,
    "HoldingPatronID": 0
  }
]

Get Outreach Services Patrons Combined Pick List By List of Patron IDs

POST /api/.../orsmanager/patrons/picklist

Returns combined pick list using list of patronids.

Required Permissions

Permission IDs found here.

Name
OutreachServicesManager_Access

Request Information

Property Type Nullable Description
patronRecordIDs List of integer No Required. List of Patron record IDs. Unique identifier for each patron to update. This value is included in the response data as ORSPatronID.
Request body
Example
        [356950,12]

Response Information

Example
application/json, text/json 
[  
  {
    "ItemRecordID": 53817,
    "Barcode": "0000200176253",
    "BrowseAuthor": "Peet, Bill.",
    "BrowseTitle": "The wump world",
    "CallNumber": "JP FICT PEE",
    "ItemStatusID": 1,
    "RecordStatusID": 1,
    "AssignedBranchID": 90,
    "AssignedCollectionID": 34,
    "MaterialTypeID": 1,
    "AssociatedBibRecordID": 8638,
    "ShelfLocationID": null,
    "PatronID": null,
    "ShelfLocation": null,
    "SysHoldRequestID": 0,
    "HoldingPatronBarcode": null,
    "HoldingPatronPickupBranchID": 0,
    "BrowseTitleNonFilingCount": 4,
    "IsElectronicItem": false,
    "VolumeNumber": null,
    "LastCircTransactionDate": "2004-08-17T00:00:00-04:00",
    "ORSPatronID": 123,
    "HoldingPatronID": 0
  },
  {
    "ItemRecordID": 9346373,
    "Barcode": null,
    "BrowseAuthor": "Caine, Lynn.",
    "BrowseTitle": "Lifelines",
    "CallNumber": "396 Cai",
    "ItemStatusID": 13,
    "RecordStatusID": 1,
    "AssignedBranchID": 103,
    "AssignedCollectionID": 11,
    "MaterialTypeID": 5,
    "AssociatedBibRecordID": 3,
    "ShelfLocationID": null,
    "PatronID": null,
    "ShelfLocation": null,
    "SysHoldRequestID": 0,
    "HoldingPatronBarcode": null,
    "HoldingPatronPickupBranchID": 0,
    "BrowseTitleNonFilingCount": 0,
    "IsElectronicItem": false,
    "VolumeNumber": null,
    "LastCircTransactionDate": "2019-10-17T00:00:00-04:00",
    "ORSPatronID": 123,
    "HoldingPatronID": 0
  }
]

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE due to invalid input or data validation.
403 FAILURE. User or workstation is not privileged.