List Item Statuses

GET /api/.../itemstatuses

Return a list of all item statuses in the system.

Response Information

Example
application/json, text/json 
[
  {
    "ItemStatusID": 1,
    "Description": "In",
    "Name": "In",
    "BannerText": "In"
  },
  {
    "ItemStatusID": 2,
    "Description": "Out",
    "Name": "Out",
    "BannerText": "Out"
  },
  {
    "ItemStatusID": 3,
    "Description": "Out-ILL",
    "Name":"Out-ILL",
    "BannerText": "Out-ILL"
  }
]

Filtered Item Statuses

Get allowable item statuses

GET /api/.../itemstatuses?currentItemStatusID={ItemStatusID}&functionCode={M}

Return a list of allowed item statuses for manual change during circulation.

Request Information

Parameters
Name Type Required Description
currentItemStatusID Integer Yes Define this parameter in the request query string. The current status id of the item.
functionCode String Yes Define this parameter in the request query string to get the filtered list during manual change. Possible Values: M

Response Information

Example
application/json, text/json 
    [
        {
            "ItemStatusID":10,
            "Description":"Missing",
            "Name":"Missing",
            "BannerText": "Missing"
        },
        {
            "ItemStatusID":11,
            "Description":"Withdrawn",
            "Name":"Withdrawn",
            "BannerText": "Withdrawn"
        },
        {
            "ItemStatusID":12,
            "Description":"Bindery",
            "Name":"Bindery",
            "BannerText": "Bindery"

        },
        {
            "ItemStatusID":14,
            "Description":"In-Repair",
            "Name":"In-Repair",
            "BannerText": "In-Repair"
        },
        {
            "ItemStatusID":16,
            "Description":"Unavailable",
            "Name":"Unavailable",
            "BannerText": "Unavailable"
        },
        {
            "ItemStatusID":18,
            "Description":"Routed",
            "Name":"Routed",
            "BannerText": "Routed"
        }
    ]

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
  • Bad request
  • Invalid functionCode OR Invalid currentItemStatusID