Group

A Group is essentially a collection of units.

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

GetGroup

Will list parameters on a specified group.

Parameters

NameData typeUnit of measurementNote
idStringN/AIf supplied, only the specific group is returned.
unitIdStringN/AIf supplied, only groups which this unit belongs to are returned.

Errors

Error CodeDescription
groupNotFoundGroup with supplied “Id” was not found

Columns

Refer to the following table for description of columns:

NameData typeUnit of measurementNullabilityNote
idStringN/AFALSEUnique identifier.
nameStringN/AFALSEName of the group.

Request (example)

{
   "id": "8818"
 }

Response

{
 "list":[
 		{
    	"id": "8818",
      "name": "Kramer maskiner"
    }
 ]
}
 

CreateGroup

Will create a new group.

Parameters

NameData typeUnit of measurementNote
nameStringN/AName of group.
unitsString[]N/AList of units to add to group.

Request (example)

{
 		"name": "Vehicles, GE",
    "units": "87282,87283"
 }

Response

{}
 

UpdateGroup

Will update parameters on any of the existing groups.

Parameters

NaameData typeUnit of measurementDescription
id *StringUnique identifier.
nameStringName of the group.
addUnitsString[]Units to add to group.
removeUnitsString[]Units to remove from group. Only allowed when Clear is “false” (or omitted).
clearBoolIf specified (and equal to “true”), all units from the group will be removed. Units from “AddUnits” are then added.

Request (example)

{
   "id": "8819",
   "name": "Vehicles, SE",
   "removeUnits": "72916"
 }

Response

{}
 

DeleteGroup

Will delete an existing group.

Parameters

ParameterData typeNote
id *StringId of the group

Request (example)

{
  "id": "8819"
}

Response

{}