~~Title: GET ~~ ====== GET /isi// ====== Return an inventory content type. ^ Authentication | Required | ^ URI Path | /rest/isi// | ^ Version|6.0.1| ===== Method Parameters ===== ^ Parameter ^ Required ^ Type ^ Description ^ | id | no | string | ID to return. If not specified a list of the types will be returned. | ==== Options ==== ^ Parameter ^ Type ^ Description ^ | item | string | Return list of all items. | | category | string | Return list of all categories. | | config | none | Return inventory configuration settings. | | room | string | Rooms associated with inventory system. | | user | string | List of users with inventory access only. | ===== Query Parameters ===== ^ Parameter ^ Type ^ Description ^ | none ||| ===== Resource Errors ===== ^ HTTP Code ^ Description ^ | 200 | Success. | | 401 | Not authorized. | | 404 | No content found. | | 405 | Method specified is not supported. | ===== Response Parameters ===== == item == ^ Name ^ Type ^ Description ^ | description | string | Category description. | | id | string of numbers | Item ID. | | category | string of numbers | Category ID for this item. | | max | int | Maximum quantity which can be reported. 0 Means unlimited quantities. | | price | string | Price of each item. | | tenant | string | Tenant ID for this category. | == category == ^ Name ^ Type ^ Description ^ | color | string | Optional HTML compatible color used on reports and as a simple way to visually distinguish different categories. | | description | string | Category description. | | id | string of numbers | Category ID. | | tenant | string | Tenant ID for this category. | == config == ^ Name ^ Type ^ Description ^ | minQuantity | number | Minimum quantity allowed when posting items. Default is 1. | | roomList | boolean | Is system configured to use custom room list. Default is false to use guest database. | | servers | array | Array of server configuration. | == room == ^ Name ^ Type ^ Description ^ | description | string | Room description. | | id | string | Room number. | | tenant | string | Tenant ID for this category. | == servers == ^ Name ^ Type ^ Description ^ | id | number | Room number. | | enabled | boolean | Is this server enabled. System supports up to 5 servers. | == user == ^ Name ^ Type ^ Description ^ | firstName | string | First name. | | lastLogin | string | Date in ISO format. | | lastName | string | Last name. | | username | string | Username. | ===== Examples ===== ==== Item ==== == Request == GET /rest/isi/item == Response == { "items" : [ { "category" : "2", "description" : "Trail Mix", "id" : "1", "max" : 5, "price" : "3.50", "tenant" : "" }, { "category" : "3", "description" : "Jack Daniels", "id" : "2", "max" : 2, "price" : "20.00", "tenant" : "" } ] } == Request == GET /rest/isi/item/11 == Response == { "category" : "045", "description" : "Ketel One Vodka Mini", "id" : "11", "max" : 0, "price" : "65.00", "tenant" : "" } ==== Category ==== == Request == GET /rest/isi/category == Response == { "categories" : [ { "color" : "#03a9f5", "description" : "Beverages", "id" : "1", "tenant" : "" }, { "color" : "#01978b", "description" : "Snacks", "id" : "2", "tenant" : "" } ] } == Request == GET /rest/isi/category/1 == Response == { "color" : "#03a9f5", "description" : "Beverages", "id" : "1", "tenant" : "" } ==== Room ==== == Request == GET /rest/isi/room == Response == { "rooms" : [ { "description" : "test", "id" : "2000", "tenant" : "" }, { "description" : "test 2", "id" : "2001", "tenant" : "" } ] } == Request == GET /rest/isi/room/1001 == Response == { "description" : "", "id" : "1001", "tenant" : "" } ==== User ==== == Request == GET /rest/isi/user == Response == { "users" : [ { "firstName" : "Jane", "lastLogin" : "Tue, 12 Sep 2017 09:34:49 -0700", "lastName" : "Doe", "username" : "jane" }, { "firstName" : "Brock", "lastLogin" : "Tue, 12 Sep 2017 14:04:45 -0700", "lastName" : "Sampson", "username" : "sampson" } ] } ==== Config ==== == Request == GET /rest/isi/config == Response == { "minQuantity" : 1, "roomList" : false, "servers" : [ { "enabled" : true, "id" : 1 }, { "enabled" : false, "id" : 2 }, { "enabled" : false, "id" : 3 }, { "enabled" : false, "id" : 4 }, { "enabled" : false, "id" : 5 } ] }