POI Visit Data

This API is used to get all the vehicle POI visited detailed status.

GEThttps://yourdomain.com/webservice?token=getPOIVisitData&username=XX&password=XX&format=XX&ProjectId=XX&restrict=XX&date=dd-MM-yyyy HH:mm:ss

Request Parameters

Parameter	Type	Value	Description
username	String		It is mandatory
password	String		It is Mandatory.
format	String		format of the response.It can be json or xml and is mandatory.
restrict	String	true	It is boolean.It can have true or false as value.It is not mandatory.
ProjectId	Integer		project id is not mandatory
date	String		date is of dd-MM-yyyy HH:mm:ss format and is not mandatory.

Description

Method Name

getPOIVisitData

URL

Json

webservice?token=getPOIVisitData&username=XXX&password=XXX&format=json&ProjectId=XXX&restrict=XXX&date=dd-MM-yyyy HH:mm:ss

XML

webservice?token=getPOIVisitData&username=XXX&password=XXX&format=xml&ProjectId=XXX&restrict=XXX&date=dd-MM-yyyy HH:mm:ss

Acceptance Criteria

username and password must be valid.
format is mandatory.It can be json or xml.
This API is not valid for Admin and Reseller.
If User set restrict false then admin and reseller will be able to run API.
Once you run API with current date as date parameter you are not able to get response for the next requests of that day with any date.

Response

Key	Format	Mandatory	Description
Vehicleid	Integer	yes	Vehicle Id
VehicleNo	String	yes	Vehicle Number
vehicletypename	String	yes	Vehicle Type
routename	String	yes	Vehicle Name
WardName	String	yes	Ward Name
zone	String	yes	City Name will display
PoiToBeServe	Integer	yes	Number of Point of interest or address data
ActualServerdPoi	Integer	yes	Visited POI count
Missed_Poi	Integer	yes	PoiToBeServe - ActualServerdPoi
%_Missed_Poi	String	yes	static value
binscollected	String	yes	static value
binstobecollected	String	yes	static value
TonePerDay	Float	yes	static value
date	String	yes	date of requested data
servebyothers	String	yes	static value
Status_Date	String	yes	static value
Total_Km	float	yes	Vehicle Travel Distance
vehiclestatus	String	yes	Vehicle Status
Schedule_Time	String	yes	static value
No_of_POIs_covered_early	String	yes	static value
No_of_POIs_covered_onTime	String	yes	static value
No_of_POIs_covered_late	String	yes	static value

Error Code	Status
0	FAIL
1	SUCCESS

Sample Response

SUCCESS

[
    {
        "Vehicleid": 163921,
        "VehicleNo": "XXXXXX",
        "vehicletypename": "Default",
        "routename": "XXXXXX",
        "WardName": "YYYYYY",
        "zone": "--",
        "PoiToBeServe": 0,
        "ActualServerdPoi": 0,
        "Missed_Poi": 0,
        "%_Missed_Poi": "0%",
        "binscollected": "0",
        "binstobecollected": "0",
        "TonePerDay": 0,
        "date": "2023-05-20T00:00:00",
        "servebyothers": "0",
        "Status_Date": "null",
        "Total_Km": 0,
        "vehiclestatus": "inactive",
        "Schedule_Time": "7 AM to 12 PM and 3 PM to 6 PM",
        "No_of_POIs_covered_early": "00",
        "No_of_POIs_covered_onTime": "00",
        "No_of_POIs_covered_late": "00"
    },
    {
        "Vehicleid": 162772,
        "VehicleNo": "XXXXXX",
        "vehicletypename": "XXXXX",
        "routename": "XXXXXX",
        "WardName": "Fuel",
        "zone": "--",
        "PoiToBeServe": 0,
        "ActualServerdPoi": 0,
        "Missed_Poi": 0,
        "%_Missed_Poi": "0%",
        "binscollected": "0",
        "binstobecollected": "0",
        "TonePerDay": 0,
        "date": "2023-05-20T00:00:00",
        "servebyothers": "0",
        "Status_Date": "null",
        "Total_Km": 0,
        "vehiclestatus": "inactive",
        "Schedule_Time": "7 AM to 12 PM and 3 PM to 6 PM",
        "No_of_POIs_covered_early": "00",
        "No_of_POIs_covered_onTime": "00",
        "No_of_POIs_covered_late": "00"
    }
]

FAIL

{
    "RESULT": "FAIL",
    "ERROR_MSG": "This service is not available for XXXXXUser please contact service provider "
}

FAIL

{
    "root": {
        "error": "Incorrect username / password.."
    }
}

FAIL

{
    "RESULT": "FAIL",
    "ERROR_MSG": "This service is not available for today."
}

FAIL

{
    "RESULT": "FAIL",
    "ERROR_MSG": "Password not found."
}

FAIL

{
    "RESULT": "FAIL",
    "ERROR_MSG": "UserName Not Found"
}

Response codes

Code	Description

Error codes

Code	Name	Description