User Wise Vehicle Data

This API is meant to get the vehicle’s data of user.

GEThttps://yourdomain.com/webservice?token=getObject&UserName=XXXX&Password=YYYY&format=XXXXX
Request Parameters
Parameter Type Value Description
UserNameStringIt is username and it is Mandatory
PasswordStringIt is password and it is Mandatory
formatStringjson/xmlFormat of data and by default it is XML
Description

Method

getObject

Request

Acceptance Criteria

  1. License  is not expired

  2. API is specific project  VTS.


Response

Key

Data Type

Mandatory

Description / Logic / Remark

Status

String

Yes

INACTIVE,IDLE,STOP,RUNNING 

Status can be one of this 

Datetime

dd-MM-yyyy HH:mm:ss

Yes

Live data time of vehicle

Vehicle_No

String

Yes

Vehicle number

Vehicletype

String

Yes

Vehicle type

Power

String

Yes

on/off

GPS

String

Yes

on/off

CurrentLocation

String

Yes

Geo location

POI

String

Yes

Point of interest or address data

latitude

String

yes

Vehicle current latitude

longitude

String

yes

Vehicle current longitude


Error Code

Status

0

Fail

1

Success


Sample Response
SUCCESS-JSON 
{
  "root": {
    "detaildata": [
      {
        "Status": "INACTIVE",
        "Datetime": "18-03-2023 18:37:00",
        "Vehicle_No": "XX",
        "Vehicletype": "Truck",
        "Power": "--",
        "GPS": "on",
        "CurrentLocation": "XXXXX",
        "POI": "--",
        "lattitude": "35.7628315",
        "longitude": "-5.8408395"
      }
    ]
  }
}
FAIL 

{
  "root": {
    "detaildata": [
      {
        "Error": "Incorrect username / password"
      }
    ]
  }
}
FAIL 
{
  "root": {
    "detaildata": [
      {
        "Error": "License Expired."
      }
    ]
  }
}
Response codes
Code Description
Error codes
Code Name Description