fbpx

Groups

Authentication
March 4, 2018
Vehicle
March 4, 2018

All major entities in the Pay as you Track system are contained within groups. They are referred to as ‘Folders’ in the front end. There are 3 main types: Vehicles (type 3), Locations (type 5), Users (type 2), Drivers (type 4).

Calls in this section

GetByTypeID

Retrieve all groups for a given type. Look for a return of “ok” in the status field. Note that every folder belongs to one and only one parent group.

Request (Query Parameters)
ParameterValueNotes
opGroupRequired
subopGetByTypeIDRequired
groupTypeID{integer type id}Required, see above

*Optional Parameters

Response
{
  "version": "0.6",
  "reqId": "",
  "status": "ok",
  "sig": "-681761976",
  "dataset": {
    "datasetname": "GroupDataSet",
    "tables": [
      {
        "cols": [
          {
            "id": "0",
            "label": "GroupID",
            "type": "number",
            "p": {
              "autoincrement": true
            }
          },
          {
            "id": "1",
            "label": "Description",
            "type": "string",
            "p": {}
          },
          {
            "id": "2",
            "label": "ParentID",
            "type": "number",
            "p": {}
          },
          {
            "id": "3",
            "label": "GroupTypeIDC",
            "type": "number",
            "p": {}
          },
          {
            "id": "4",
            "label": "TimeStamp",
            "type": "string",
            "p": {}
          }
        ],
        "rows": [],
        "p": {
          "tablename": "Folders",
          "primarykey": [
            0
          ]
        }
      }
    ]
  }
}

Back to: Contents