Shelf Locations

List Shelf Locations

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

Return a list of all shelf locations for an individual organization.

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

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

Request Information

Parameters
Name Type Required Description
orgid Integer Yes Filter by organization Id. Providing 0 will return a list of all unique shelf location descriptions
includeEmptyObject Boolean No Set to 'true' to return an empty object with ShelfLocationID 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.
includeEmptyObject Boolean No Set to 'true' to return an empty object with ShelfLocationID 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 
[
    {
        "ShelfLocationID": 1,
        "OrganizationID": 3,
        "Description": "Lobby"
    },
    {
        "ShelfLocationID": 2,
        "OrganizationID": 3,
        "Description": "Reference Desk"
    }
 ]

HTTP Response Codes

Code Description
200 OK. Success
400 Bad request
404 Invalid organization ID