This is an open BETA version of the software and is intended only for experienced users of EquipCalendar.
Inventory
The inventory assets available to rent from your company.
HTTP Methods and URLs
This endpoint uses the following HTTP methods and urls:
| GET | Used for retrieving all inventory | https://api.equipcalendar.com/v2/inventory |
| GET | Used for retrieving a single inventory item | https://api.equipcalendar.com/v2/inventory/{id:int} |
| POST | Used for creating an inventory item | https://api.equipcalendar.com/v2/inventory |
| PUT | Used for updating an inventory item | https://api.equipcalendar.com/v2/inventory/{id:int} |
| DELETE | Used for deleting an inventory item | https://api.equipcalendar.com/v2/inventory/{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/inventory 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
GET https://api.equipcalendar.com/v2/inventory
Request Body
NONE
Response
{
"data": [
{
"id": 186,
"name": "18-channel Dimmer Racks",
"quantityAvailable": 2,
"active": 1,
"Links": [
{
"rel": "self",
"method": "GET",
"href": "https://api.equipcalendar.com/v2/inventory/186"
},
{
"rel": "edit",
"method": "PUT",
"href": "https://api.equipcalendar.com/v2/inventory/186"
},
{
"rel": "delete",
"method": "DELETE",
"href": "https://api.equipcalendar.com/v2/inventory/186"
},
{
"rel": "add",
"method": "POST",
"href": "https://api.equipcalendar.com/v2/inventory"
}
]
},
{
"id": 177,
"name": "19 degree Leko",
"quantityAvailable": 8,
"active": 1,
"Links": [
{
"rel": "self",
"method": "GET",
"href": "https://api.equipcalendar.com/v2/inventory/177"
},
{
"rel": "edit",
"method": "PUT",
"href": "https://api.equipcalendar.com/v2/inventory/177"
},
{
"rel": "delete",
"method": "DELETE",
"href": "https://api.equipcalendar.com/v2/inventory/177"
},
{
"rel": "add",
"method": "POST",
"href": "https://api.equipcalendar.com/v2/inventory"
}
]
},
{
"id": 175,
"name": "1K in PRT",
"quantityAvailable": 360,
"active": 1,</snipped for brevity>
Retrieve a single inventory item
GET https://api.equipcalendar.com/v2/inventory/{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": 175,
"name": "1K in PRT",
"quantityAvailable": 360,
"active": 1,
"Links": [
{
"rel": "self",
"method": "GET",
"href": "https://api.equipcalendar.com/v2/inventory/175"
},
{
"rel": "edit",
"method": "PUT",
"href": "https://api.equipcalendar.com/v2/inventory/175"
},
{
"rel": "delete",
"method": "DELETE",
"href": "https://api.equipcalendar.com/v2/inventory/175"
},
{
"rel": "add",
"method": "POST",
"href": "https://api.equipcalendar.com/v2/inventory"
}
]
}
]
}
Create an inventory item
POST https://api.equipcalendar.com/v2/inventory
Parameter(s)
NONE
Request Body Fields
| Field | Description | Data Type | Comments | |
|---|---|---|---|---|
| name | Name or description of the inventory item | string | Required | |
| quantityAvailable | integer | Greater than or equal to zero | Required | |
| active | Item available for new events | boolean/integer | 1 = True, 0 = False | Required |
Request Body Example
{
"name": "24-channel Dimmer Racks",
"quantityAvailable": 3,
"active": 1
}
Response
{
"data": [
{
"id": 508,
"name": "24-channel Dimmer Racks",
"quantityAvailable": 3,
"active": 1,
"Links": [
{
"rel": "self",
"method": "GET",
"href": "https://api.equipcalendar.com/v2/inventory/508"
},
{
"rel": "edit",
"method": "PUT",
"href": "https://api.equipcalendar.com/v2/inventory/508"
},
{
"rel": "delete",
"method": "DELETE",
"href": "https://api.equipcalendar.com/v2/inventory/508"
},
{
"rel": "add",
"method": "POST",
"href": "https://api.equipcalendar.com/v2/inventory"
}
]
}
]
}
Update an inventory item
PUT https://api.equipcalendar.com/v2/inventory/{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 or description of the inventory item | string | Required | |
| quantityAvailable | integer | Greater than or equal to zero | Required | |
| active | Item available for new events | boolean/integer | 1 = True, 0 = False | Required |
Request Body Example
{
"id": 186,
"name": "18-channel Dimmer Racks",
"quantityAvailable": 4,
"active": 1
}
Response
{
"data": [
{
"id": 186,
"name": "18-channel Dimmer Racks",
"quantityAvailable": 4,
"active": 1,
"Links": [
{
"rel": "self",
"method": "GET",
"href": "https://api.equipcalendar.com/v2/inventory/186"
},
{
"rel": "edit",
"method": "PUT",
"href": "https://api.equipcalendar.com/v2/inventory/186"
},
{
"rel": "delete",
"method": "DELETE",
"href": "https://api.equipcalendar.com/v2/inventory/186"
},
{
"rel": "add",
"method": "POST",
"href": "https://api.equipcalendar.com/v2/inventory"
}
]
}
]
}
Delete an inventory item
DELETE https://api.equipcalendar.com/v2/inventory/{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": 162
}
© 2024 EQPD, LLC