Get Available Vehicles API

Require Authentication

This API is used to get available vehicles for the company based on combination of deviceID and token.

URL

api/manageassets/vehicles

Required parameter (POST)

deviceID
token

Optional parameter (GET)

All optional parameters use GET method. So it should be embedded in the URL, e.g: api/manageassets/vehicles?q=vehicle%20name&o=vehicleNo

q «contains keyword that want to be looked for. Keyword will search vehicleName and vehicleNo field only»
o «used to sort data, contains field name. Available value: vehicleID, vehicleName, vehicleNo, vehicleType, vehicleYear, createdDate, updatedDate. Default value: vehicleNo»
ot «used to sort data, contains sort type. Available value: asc, desc. Default value: asc»
per_page «indicates how many data that will be displayed in each call. Value must be a number between 1 to 500. Default value: 500»
offset «indicates the first data index that will be displayed in each call. Value must be a number with minimum value is 0. Default value: 0»

Example JSON Payload

{
	"deviceID": "ABCD-EFGH-IJKL-MNOP",
	"token": "bb602ab13b8090268cd6e3bb9dfa39e2"
}

Possible return HTTP status code

Return message

{
  "status": "success",
  "message": {
    "current_parameter": "?offset=0",
    "next_parameter": "",
    "previous_parameter": "",
    "start": 0,
    "total": 2,
    "lists": [{
      "vehicleID": 3,
      "companyID": 1,
      "vehicleName": "My Future Car",
      "vehicleType": "BMW",
      "vehicleNo": "N14DR",
      "vehicleDescription": "Future car",
      "vehicleColor": "Black",
      "vehicleYear": 2028,
      "createdDate": 1467819009,
      "updatedDate": 1467819009,
      "createdByUserID": 3,
      "updatedByUserID": 3
    }, {
      "vehicleID": 2,
      "companyID": 1,
      "vehicleName": "REDDY",
      "vehicleType": "KIA",
      "vehicleNo": "N1929CJ",
      "vehicleDescription": "SOLD THIS YEAR",
      "vehicleColor": "RED",
      "vehicleYear": 2003,
      "createdDate": 1467650668,
      "updatedDate": 1467650668,
      "createdByUserID": 3,
      "updatedByUserID": 3
    }]
  }
}

Note: use "next_parameter" and "previous_parameter" to go to next or previous result page. Just combine it with the API URL, e.g: "api/manageassets/vehicles"+next_parameter or "api/manageassets/vehicles"+previous_parameter

Superfy Platform API Documentation