Category

A Category is a simple description, which can be appended to any unit.
When appended, the category can be used to identify a set of units which share similar characteristics, ie. make, model/year etc.

URL Structure is:
https://api.trackunit.com/public/Category

GetCategory

Will list parameters on a specified category.

Parameters

Name

Data type

Unit of measurement

Note

id *

String

N/A

The id of the category.

Errors

Error Code

Description

categoryNotFound

Category with supplied “Id” was not found

Columns

Name

Data type

Unit of measurement

Nullability

Note

id

String

N/A

FALSE

Unique identifier.

name

String

N/A

TRUE

Name of category.

Request (example)

{
  "id": "30559"
}

Response

{
   "list":[
   {
        "id": "30559",
      "name": "CADDY"
        }
   ]
}
 

CreateCategory

Will create a new category.

Parameters

Name

Data type

Unit of measurement

Note

name*

String

N/A

Name of the category.

Request (example)

{
  "name": "CATEPILLAR"
}

Response

{
  "id": "30819"
}
 

UpdateCategory

Will update parameters on any of the existing categories.

Parameters

Naame

Data type

Unit of measurement

Description

id *

String

Unique identifier.

name

String

Name of the category.

Request (example)

{
  "id": "30818",
  "name": "BENFORD"
}

Response

{}
 

DeleteCategory

Will delete an existing category.

Parameters

Parameter

Data type

Note

id *

String

Id of the category.

Request (example)

{
  "id": "30818"
}

Response

{}