Delivery Route Options

Get Delivery Route Options

GET /api/.../readerservices/deliveryroute?orgid={orgid}&includeEmptyObject=true

Return a list of all delivery route options for an individual organization. Include the '(none)' entry for a user listbox or combobox.

Request Information

Parameters
Name Type Required Description
orgid Integer No Filter by organization Id.
includeEmptyObject Boolean No Set to 'true' to return an empty object with DeliveryRouteID set to '0' and Description set to '(none)'. This may be used when populating a listbox for a user selection. Must be used with the orgid parameter.

Response Information

Example
application/json, text/json 
[
  {
    "DeliveryRouteID": 0,
    "Description": "(None)",
    "Name": "(None)"
  },
  {
    "DeliveryRouteID": 1,
    "Description": "City",
    "Name": null
  },
  {
    "DeliveryRouteID": 3,
    "Description": "East side",
    "Name": null
  },
  {
    "DeliveryRouteID": 10,
    "Description": "John's route",
    "Name": null
  },
  {
    "DeliveryRouteID": 2,
    "Description": "North suburbs",
    "Name": null
  }
]