Vehicle Live Status and Count

This API is meant to get the vehicle’s live data status and it

GEThttps://yourdomain.com/webservice?token=getLiveVehicleStatusAndCount&user=XXX&pass=XX&access_token=hjdhfjhdf434&company=XXX&location=XXX&app=00
Request Parameters
Parameter Type Value Description
userStringIt is username and it is Mandatory
passStringIt is password and it is Mandatory
access_tokenStringIt is acces token and it si mandatory
companyStringIt is company name or short name and it is mandatory
locationStringIt is branch name and is is optional
appIntegerit is application id and Mandatory
Description

Method Name

getLiveVehicleStatusAndCount

Prerequisites

Before calling this API we need to generate token using  generateAccessToken API.

Request

Request interval:-

Every 1 min

If user is invalid then 2 min


Response

Key

Format

Mandetory

Description

VehicleData

String yes

Store details of vehicle

RUNNING

Stringyes

Vehicles are in running condition

IDLE 

Stringyes

Vehicles are in idle  condition

STOP

Stringyes

Vehicles are in Stop  condition

INACTIVE

Stringyes

Vehicles are in Stop  condition

NO DATA

Stringyes

Data not received from vehicle

count

Int 

yes

Numbers of vehicles

Precentage

float

yes

Percentage of vehicle


Error Code

Status

0

Fail

1

Success


Sample Response
SUCCESS
{
  "root": {
    "VehicleData": [
      {
        "RUNNING": {
          "Count": ,
          "Precentage": "%"
        },
        "IDLE": {
          "Count": ,
          "Precentage": "%"
        },
        "STOP": {
          "Count": ,
          "Precentage": "%"
        },
        "INACTIVE": {
          "Count": ,
          "Precentage": "%"
        },
        "NO DATA": {
          "Count": ,
          "Precentage": "%"
        }
      }
    ]
  }
}
FAIL
{
   "root": {
       "error": "The call exceeded the limit of one/two minutes one call."
   }
}

FAIL
{
   "root": {
       "error": "App parameter value is invalid."
   }
}
FAIL
{
   "root": {
       "error": "This API service is not available for you."
   }
}
FAIL
{
   "root": {
       "error": "No Company Found."
   }
}
FAIL
{
   "root": {
       "error": "No branch found."
   }
}
FAIL
{
   "root": {
       "error": "Enter Company First"

   }
}

FAIL
{
   "root": {
       "error": "This API service is not available for you."
   }
}
FAIL
{
   "root": {
       "error": "inactive User "

   }
}
FAIL
{
   "root": {
       "error": "Incorrect username / password.."
   }
}
FAIL
{
   "root": {
       "error": "invalid parameter"
   }
}
Response codes
Code Description
Error codes
Code Name Description