This is an open BETA version of the software and is intended only for experienced users of EquipCalendar.
Inventory Categories
The inventory categories as applied to your inventory assets.
HTTP Methods and URLs
This endpoint uses the following HTTP methods and urls:
| GET | Used for retrieving all inventory categories | https://api.equipcalendar.com/v2/inventorycategory |
| GET | Used for retrieving a single inventory category | https://api.equipcalendar.com/v2/inventorycategory/{id:int} |
| POST | Used for creating an inventory category | https://api.equipcalendar.com/v2/inventorycategory |
| PUT | Used for updating an inventory category | https://api.equipcalendar.com/v2/inventorycategory/{id:int} |
| DELETE | Used for deleting an inventory category | https://api.equipcalendar.com/v2/inventorycategory/{id:int} |
All requests to this endpoint must contain an access_token (encoded using base64) in the Authorization HTTP Header. See the Authentication endpoint for more details.
Request Header (Example)
GET /v2/inventorycategory HTTP/1.1 Host: https://api.equipcalendar.com Connection: keep-alive User-Agent: Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 Chrome/43.0.2357.124 Safari/537.36 Content-Type: application/json Accept: */* Accept-Encoding: gzip, deflate Accept-Language: en-US,en;q=0.8 Authorization: bearer MmViNDg0OGEtNDk1ZS00NDQ2LWE0MjEtYjBiOTYwM2E1Mno5Omd1aWQ=
Retrieving all inventory categories
GET https://api.equipcalendar.com/v2/inventorycategory
Request Body
NONE
Response
{
"data": [
{
"id": 12186,
"name": "Chairs",
"inactive": 0,
"Links": [
{
"rel": "self",
"method": "GET",
"href": "https://api.equipcalendar.com/v2/inventorycategory/12186"
},
{
"rel": "edit",
"method": "PUT",
"href": "https://api.equipcalendar.com/v2/inventorycategory/12186"
},
{
"rel": "delete",
"method": "DELETE",
"href": "https://api.equipcalendar.com/v2/inventorycategory/12186"
},
{
"rel": "add",
"method": "POST",
"href": "https://api.equipcalendar.com/v2/inventorycategory"
}
]
},
{
"id": 12177,
"name": "Tables",
"inactive": 1,
"Links": [
{
"rel": "self",
"method": "GET",
"href": "https://api.equipcalendar.com/v2/inventorycategory/12177"
},
{
"rel": "edit",
"method": "PUT",
"href": "https://api.equipcalendar.com/v2/inventorycategory/12177"
},
{
"rel": "delete",
"method": "DELETE",
"href": "https://api.equipcalendar.com/v2/inventorycategory/12177"
},
{
"rel": "add",
"method": "POST",
"href": "https://api.equipcalendar.com/v2/inventorycategory"
}
]
},
{
"id": 175,
"name": "Linens",
"inactive": 0,</snipped for brevity>
Retrieve a single inventory category
GET https://api.equipcalendar.com/v2/inventorycategory/{id:int}
Parameter(s)
| Field | Description | Data Type | Comments | |
|---|---|---|---|---|
| id | the identifier of the object to address | integer | 2^31-1 (2,147,483,647) | Required |
Request Body
NONE
Response
{
"data": [
{
"id": 12186,
"name": "Chairs",
"inactive": 0,
"Links": [
{
"rel": "self",
"method": "GET",
"href": "https://api.equipcalendar.com/v2/inventorycategory/12186"
},
{
"rel": "edit",
"method": "PUT",
"href": "https://api.equipcalendar.com/v2/inventorycategory/12186"
},
{
"rel": "delete",
"method": "DELETE",
"href": "https://api.equipcalendar.com/v2/inventorycategory/12186"
},
{
"rel": "add",
"method": "POST",
"href": "https://api.equipcalendar.com/v2/inventorycategory"
}
]
}
]
}
Create an inventory category
POST https://api.equipcalendar.com/v2/inventorycategory
Parameter(s)
NONE
Request Body Fields
| Field | Description | Data Type | Comments | |
|---|---|---|---|---|
| name | Name of the category | string | Required | |
| inactive | Category available for use | boolean/integer | 1 = True, 0 = False | Required |
Request Body Example
{
"name": "Lamps",
"inactive": 0
}
Response
{
"data": [
{
"id": 121508,
"name": "Lamps",
"inactive": 0,
"Links": [
{
"rel": "self",
"method": "GET",
"href": "https://api.equipcalendar.com/v2/inventorycategory/121508"
},
{
"rel": "edit",
"method": "PUT",
"href": "https://api.equipcalendar.com/v2/inventorycategory/121508"
},
{
"rel": "delete",
"method": "DELETE",
"href": "https://api.equipcalendar.com/v2/inventorycategory/121508"
},
{
"rel": "add",
"method": "POST",
"href": "https://api.equipcalendar.com/v2/inventorycategory"
}
]
}
]
}
Update an inventory category
PUT https://api.equipcalendar.com/v2/inventorycategory/{id:int}
Parameter(s)
| Field | Description | Data Type | Comments | |
|---|---|---|---|---|
| id | the identifier of the object to address | integer | 2^31-1 (2,147,483,647) | Required |
Request Body Fields
| Field | Description | Data Type | Comments | |
|---|---|---|---|---|
| id | Object identifier | integer | 2^31-1 (2,147,483,647) | Required |
| name | Name of the category | string | Required | |
| inactive | Category available for use | boolean/integer | 1 = True, 0 = False | Required |
Request Body Example
{
"id": 12186,
"name": "Chairs/Stools",
"inactive": 0
}
Response
{
"data": [
{
"id": 12186,
"name": "Chairs/Stools",
"inactive": 0,
"Links": [
{
"rel": "self",
"method": "GET",
"href": "https://api.equipcalendar.com/v2/inventorycategory/12186"
},
{
"rel": "edit",
"method": "PUT",
"href": "https://api.equipcalendar.com/v2/inventorycategory/12186"
},
{
"rel": "delete",
"method": "DELETE",
"href": "https://api.equipcalendar.com/v2/inventorycategory/12186"
},
{
"rel": "add",
"method": "POST",
"href": "https://api.equipcalendar.com/v2/inventorycategory"
}
]
}
]
}
Delete an inventory category
DELETE https://api.equipcalendar.com/v2/inventorycategory/{id:int}
Parameter(s)
| Field | Description | Data Type | Comments | |
|---|---|---|---|---|
| id | the identifier of the object to address | integer | 2^31-1 (2,147,483,647) | Required |
Request Body
NONE
Response
{
"id": 112162
}
© 2024 EQPD, LLC