DOCUMENTATION

Getting Started
Units and Metrics

Equipment Tracking

BLE Beacons
Categories
Equipment
Equipment Live Map
- Get live map tracker informationget
- Get Dropped Equipment Locationget
Equipment Locations
- Get All Equipment Locationsget
- GetLocation of a Specific Equipmentget
Pairings

DOCUMENTATION

Getting Started
Units and Metrics

Equipment Tracking

BLE Beacons
Categories
Equipment
Equipment Live Map
- Get live map tracker informationget
- Get Dropped Equipment Locationget
Equipment Locations
- Get All Equipment Locationsget
- GetLocation of a Specific Equipmentget
Pairings

Add a New Category with Subcategories

post https://{environment}/api/v4/categories

This endpoint allows you to create a new category with Subcategories

Submit Feedback: We value your feedback! Share your thoughts with us using our API feedback form. For API documentation issues or inaccuracies, please submit a support case.

URL Expired

The URL for this request expired after 30 days.

Body Params

Add new Equipment Category to the system

categoryName

string

required

Name of the Category

equipmentPrimaryCategory

array of strings

The unique Azuga ID of the Category.This is automatically generated when the Category object is created and cannot be altered

equipmentPrimaryCategory

subCategories

array of objects

subCategories

Responses

Response body

object

message

string

General message for the response

generatedAt

int64

Epoch Time in milliseconds

data

object

categoryId

string

required

The unique Azuga ID of the Category

name

string

required

The unique name of the Category

parentCategoryId

string

The unique Azuga ID of the Parent Category to which this category belongs

customerId

int64

required

The unique Azuga ID of the customer

level

integer

required

Hierarchical level of the category within the categorization system

equipmentCount

integer

Total number of Equipments within the category

createdBy

string

required

The unique Azuga ID of the User who created the record

createdAt

string

required

Timestamp of record creation in YYYY-MM-DD HH:mm:ss format.

updatedBy

string

required

The unique Azuga ID of the User who updated the record

updatedAt

string

required

Timestamp of record updation in YYYY-MM-DD HH:mm:ss format.

subCategory

array of objects

subCategory

object

categoryId

string

required

The unique Azuga ID of the Category

name

string

required

The unique name of the Category

parentCategoryId

string

The unique Azuga ID of the Parent Category to which this category belongs

customerId

int64

required

The unique Azuga ID of the Customergo

level

integer

required

Hierarchical level of the category within the categorization system

equipmentCount

integer

Total number of Equipments within the category

createdBy

string

required

The unique Azuga ID of the User who created the record

createdAt

string

required

Timestamp of record creation in YYYY-MM-DD HH:mm:ss format.

updatedBy

string

required

The unique Azuga ID of the User who updated the record

updatedAt

string

required

Timestamp of record updation in YYYY-MM-DD HH:mm:ss format.

Response body

object

errorMessage

string

required

High level error message

generatedAt

int64

required

Epoch Time in milliseconds

description

string

required

Error description

errorDetails

array of objects

required

errorDetails*

object

field

string

required

Field name/Key where the validation failed

description

string

required

Details of the field

code

string

required

Azuga error codes

Response body

object

errorMessage

string

required

High level error message

generatedAt

int64

required

Epoch Time in milliseconds

description

string

required

Error description

Response body

object

errorMessage

string

required

High level error message

generatedAt

int64

required

Epoch Time in milliseconds

description

string

required

Error description

Updated 2 months ago

Fetch All Categories

Update an Existing Category

Did this page help you?

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://fleet-rest.azuga.com/api/v4/categories \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 2 months ago

Fetch All Categories

Update an Existing Category

Did this page help you?

DOCUMENTATION
Getting Started
Units and Metrics

Equipment Tracking
BLE Beacons
Delete BLE Beacon devicedelete
Modify existing Beacon Detailsput
Retrieve specific ble beaconsget
Fetch All Beaconsget
Categories
Fetch All Uncategorized Equipmentget
Get Category Equipment Listget
Retrieve a particular Categoryget
Delete an Existing Categorydelete
Update an Existing Categoryput
Add a New Category with Subcategoriespost
Fetch All Categoriesget
Equipment
Update Equipment Categories in Bulkpatch
Retrieve a particular Equipmentget
Modify existing Equipment detailsput
Delete Equipmentdelete
Add new equipmentpost
Fetch All Equipmentget
Equipment Live Map
Get Dropped Equipment Locationget
Get live map tracker informationget
Equipment Locations
GetLocation of a Specific Equipmentget
Get All Equipment Locationsget
Pairings
Validate BLE Beacon pairing statusget
Unpair BLE from an Equipment Connectionput
Pair BLE Beacon to an Equipmentpost

DOCUMENTATION
Getting Started
Units and Metrics

Equipment Tracking
BLE Beacons
Delete BLE Beacon devicedelete
Modify existing Beacon Detailsput
Retrieve specific ble beaconsget
Fetch All Beaconsget
Categories
Fetch All Uncategorized Equipmentget
Get Category Equipment Listget
Retrieve a particular Categoryget
Delete an Existing Categorydelete
Update an Existing Categoryput
Add a New Category with Subcategoriespost
Fetch All Categoriesget
Equipment
Update Equipment Categories in Bulkpatch
Retrieve a particular Equipmentget
Modify existing Equipment detailsput
Delete Equipmentdelete
Add new equipmentpost
Fetch All Equipmentget
Equipment Live Map
Get Dropped Equipment Locationget
Get live map tracker informationget
Equipment Locations
GetLocation of a Specific Equipmentget
Get All Equipment Locationsget
Pairings
Validate BLE Beacon pairing statusget
Unpair BLE from an Equipment Connectionput
Pair BLE Beacon to an Equipmentpost

201Successful operation

400Invalid Request Body

403Unauthorized Request

500Failed Operation (Internal Server Error)