Delivery Options

Get Delivery Option

GET /api/.../deliveryoptions/{id}

Return an individual DeliveryOption.

Request Information

Parameters
Name Type Required Description
id Integer Yes Unique Id assigned to delivery option.

Response Information

Example
application/json, text/json 
{
    "DeliveryOptionID":1,
    "Description":
    "Mailing Address"
}

List Delivery Options

GET /api/.../deliveryoptions

Return a list of all delivery options in the system.

GET /api/.../deliveryoptions?orgid={orgid}

Return a list of all delivery options for an individual organization.

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

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

GET /api/.../deliveryoptions?orgid={orgid}&includeEmptyObject=true&pac=false

Return a list of all delivery options for an individual organization for PAC or staff client.

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 DeliveryOptionID 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.
pac Boolean No Set to 'false' to return the delivery options for the staff client,'true' for delivery options for PAC. Must be used with the 'orgid' and 'includeEmptyobject' parameters.

Response Information

Example
application/json, text/json 
[
    {
        "DeliveryOptionID":1,
        "Description":"Mailing Address"
    },
    {
        "DeliveryOptionID":2,
        "Description":"Email Address"
    },
    {
        "DeliveryOptionID":3,
        "Description":"Phone 1"
    }
]