Delivery Stop Options

Get Delivery Stop Options

GET /api/.../readerservices/deliverystop?id={routeid}&includeEmptyObject=true

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

Request Information

Parameters
Name Type Required Description
id Integer No Filter by delivery route Id.
includeEmptyObject Boolean No Set to 'true' to return an empty object with DeliveryModeID 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 route parameter.

Response Information

Example
application/json, text/json 
[
   {
    "DeliveryStopID": 0,
    "Description": "(None)",
    "Name": null
  },
  {
    "DeliveryStopID": 2,
    "Description": "Main St in the villge",
    "Name": "Village Center"
  },
  {
    "DeliveryStopID": 3,
    "Description": null,
    "Name": "Post Office"
  }
]