McEasy - Public API Documentation

400

Bad Request

Invalid Request to Server. Make sure to double-checks all of the input data.

Endpoint	Method	Code	Description	Detail
/vehicles/{id}	GET	E-V1/1-2	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
/vehicles/{id}	GET	E-V1/1-3	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
/vehicles/	GET	E-V1/1-4	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-V1/1-5	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
		E-V1/1-6	No vehicle data returned.	Happens when the data client's requested are empty.
	POST	E-V1/2-2	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-V1/2-3	Device not found, invalid IMEI.	Happens when client try to add a new vehicle with unknown device.
		E-V1/2-4	License Plate is required.	Happens when try to add a new vehicle without license plate.
		E-V1/2-5	Vehicle Type ID is required.	Happens when try to add a new vehicle without vehicle type ID.
		E-V1/2-6	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-V1/2-7	Box Type does not exist.	Happens when try to add a new vehicle with unknown box type.
		E-V1/2-8	Thermo Type does not exist.	Happens when try to add a new vehicle with unknown thermo type.
		E-V1/2-9	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-V1/2-10	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
	PATCH	E-V1/3-3	Vehicle identifier (Vehicle ID, License Plate, or IMEI) is required.	Happens when try to update vehicle's odometer without vehicle identifier.
		E-V1/3-4	Only 1 vehicle identifier is accepted.	Happens when try to update vehicle's odometer with more than 1 vehicle identifier.
		E-V1/3-5	Odometer is required.	Happens when try to update update vehicle's without odometer.
		E-V1/3-6	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-V1/3-7	Vehicle is not found.	Happens when try to get Vehicle using License Plate.
		E-V1/3-8	Vehicle is not found.	Happens when try to get Vehicle using IMEI.
		E-V1/3-9	Vehicle is not found.	Happens when try to get Vehicle using Vehicle ID.
		E-V1/3-10	An error found after requesting data.	Happens when the input is not following its type.
		E-V1/3-11	Forbidden Vehicle accesss.	Happens when try to update Vehicle from another company.
		E-V1/3-12	An error found after requesting data.	Happens when the data client's requested are invalid.
/vehicles/statuses/	GET	E-V1/S1-2	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-V1/S1-3	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
		E-V1/S1-4	No vehicle status data returned.	Happens when the data client's requested are empty.
/vehicles/{id}/status	GET	E-V1/S2-2	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
/vehicles/{id}/status	GET	E-V1/S2-3	No vehicle status data returned.	Happens when the data client's requested are empty.
/trips/	GET	E-T1/1-2	Vehicle ID or Driver ID is required.	Happens when client trying to request data without Vehicle ID or Driver ID.
		E-T1/1-3	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-T1/1-4	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
/trips/{id}/detail	GET	E-T1/D1-2	Speed Limit should be a positive value.	Happens when client trying to request data with negative Speed Limit.
		E-T1/D1-3	Vehicle filter needs one of the following: Vehicle ID / License Plate / IMEI.	Happens when client trying to request data without any vehicle filters.
		E-T1/D1-4	Date Filter cannot be empty.	Happens when client trying to request data without any Date filters.
		E-T1/D1-5	Filter Date range exceeding the maximum of 7 days.	Happens when client trying to request data with more than 7 days.
		E-T1/D1-6	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-T1/D1-7	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
/trips/last/	GET	E-T1/L1-2	Vehicle ID is required.	Happens when client trying to request data without Vehicle ID.
		E-T1/L1-3	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-T1/L1-4	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
/trips/location/	POST	E-T1/L2-3	Gps Time is required	Happens because the Gps Time Input is required.
		E-T1/L2-4	Latitude is required.	Happens because the Latitude Input is required.
		E-T1/L2-5	Longitude is required.	Happens because the Longitude Input is required.
		E-T1/L2-6	Ignition is required.	Happens because the Ignition Input is required.
		E-T1/L2-7	Speed is required.	Happens because the Speed Input is required.
		E-T1/L2-8	Device not found, invalid IMEI	Happens because Device not found, invalid IMEI
		E-T1/L2-9	An error found after requesting data	Happens when the data client's requested are invalid.Error detail will be different each request.
/geofences/	GET	E-G1/1-2	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
	GET	E-G1/1-3	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
	POST	E-G1/2-2	Fence Name is required.	Happens when try to add a new geofence without fence name.
		E-G1/2-3	Type is required.	Happens when try to add a new geofence without type.
		E-G1/2-4	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-G1/2-5	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
/api-key/	GET	E-AK1/1-2	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-AK1/1-3	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
		E-AK1/1-4	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
/login/	POST	E-L1/1-2	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-L1/1-3	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
		E-L1/1-4	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-L1/1-5	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
/report/offline-history	GET	E-R1/OH1-2	Vehicle identifier (Vehicle ID, License Plate, or IMEI), start date, and end date are required.	Happens when try to retrieve gps offline history without vehicle identifier and date range.
		E-R1/OH1-3	Vehicle ID cannot be 0.	Happens when try to retrieve gps offline history with false vehicle ID.
		E-R1/OH1-4	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-R1/OH1-5	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
		E-R1/OH1-6	An error occurred when data not found	Happens when the input is not following its type.
		E-R1/OH1-7	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-R1/OH1-8	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
		E-R1/OH1-9	An error occurred when data not found	Happens when the input is not following its type.
/live-data/create_temp_live_view	POST	E-LD1/CTLV1-04	An error occured when licensePlates data type is invalid.	Happens when the input is not following its type.
		E-LD1/CTLV1-05	An error occured when pickedColumns data type is invalid.	Happens when the input is not following its type.
		E-LD1/CTLV1-06	An error occured when there are valid pickedColumns.	Happens when the input is not following its type.
		E-LD1/CTLV1-09	An error occurred while executing query / GraphQL validation failed.	Happens when the input is not following its type.
		E-LD1/CTLV1-11	An error occurred no license plates found.	Happens when one or more license plates not found.
/live-data/temp_live_view	GET	E-LD1/GTLV1-02	An error occured when parameters is invalid.	Happens when the input is not following its requirement.
		E-LD1/GTLV1-03	An error occured when parameters is invalid.	Happens when parameter expiredOnStartDate is provided but expiredOnEndDate is not or vice versa.
		E-LD1/GTLV1-06	An error occured when parameters is invalid.	Happens when vehicleIds parameter have invalid json.
/route-planning	GET	E-RP1/1-2	An error occured when parameters is invalid.	Happens when parameter status is not following its requirement.
		E-RP1/1-3	An error occured when parameters is invalid.	Happens when parameter status is not a valid status.
		E-RP1/1-4	An error occured when parameters is invalid.	Happens when parameter vehicle is not following its requirement.
		E-RP1/1-6	An error occurred while executing query / GraphQL validation failed.	Happens when try to retrieve vehicles data.
		E-RP1/1-7	An error occurred no vehicle found.	Happens when one or more vehicle ID not found.
		E-RP1/1-8	An error occurred no vehicle found.	Happens when parameter vehicle is not following its type.
		E-RP1/1-9	An error occurred while executing query / GraphQL validation failed.	Happens when try to retrieve route planning data.
	POST	E-RP1/2-2	One or more required parameter is empty	Happens when start schedule of route planning is bigger than current time
		E-RP1/2-3	Start Schedule Must Be Greater Than Now	Happens when start schedule of route planning is bigger than current time
		E-RP1/2-4	Route/Vehicle ID cannot be 0.	Happens when try to create route planning with false vehicle ID.
		E-RP1/2-5	Route/Vehicle ID is invalid.	Happens when try to create route planning with not-number ID
		E-RP1/2-7	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
		E-RP1/2-12	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
	PATCH	E-RP1/3-2	An error occured when there is no input data.	Happens when try to add a update Route Planning without input any data.
		E-RP1/3-3	An error occured when Route Planning ID data type is invalid.	Happens when the input is not following its type.
		E-RP1/3-4	An error occured when Route ID data type is invalid.	Happens when the input is not following its type.
		E-RP1/3-6	An error occured when Route is not found.	Happens when try to update Route Planning with unknown Route.
		E-RP1/3-7	An error occured when Vehicle ID data type is invalid.	Happens when the input is not following its type.
		E-RP1/3-9	An error occured when Vehicle is not found.	Happens when try to update Route Planning with unknown Vehicle.
		E-RP1/3-10	An error found after requesting data.	Happens when the input is not following its requirement.
		E-RP1/3-11	An error found after requesting data.	Happens when the Route Planning ID is not following its requirement.
		E-RP1/3-12	An error found when Route Planning is not found.	Happens when try to update unknown Route Planning.
		E-RP1/3-13	An error found when Route Planning status can not be updated.	Happens when the input is not following its requirement.
		E-RP1/3-15	An error found after requesting data.	Happens when the data requested are invalid.
/route-planning/{id}/status	PATCH	E-RP1/S1-2	Route Planning ID is required.	Happens when try to add a update Route Planning status without id or invalid.
		E-RP1/S1-3	Route Planning status is required.	Happens when try to update Route Planning status without status.
		E-RP1/S1-4	An error occured when input data is invalid.	Happens when input status is not following its requirement.
		E-RP1/S1-5	An error occurred after requesting data.	Happens when Route Planning ID input is invalid.
		E-RP1/S1-6	An error occurred when no Route Planning found.	Happens when Route Planning is not found.
		E-RP1/S1-7	An error occurred when status is invalid.	Happens when input status is not following its requirement.
		E-RP1/S1-8	An error occurred while executing query / GraphQL validation failed.	Happens when try to update Route Planning Status.
/route-ritage	GET	E-RT1/2-3	An error occured when there is no input data.	Happens when try to create Route Ritage without a name and departure route.
/route-ritage	GET	E-RT1/2-5	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
/route-ritage/{id}	PATCH	E-RT1/1-3	An error occured when invalid status input.	Happens when try to get Route Ritage with invalid status label.
		E-RT1/1-4	An error occured when routeId is not a number.	Happens when try to get Route Ritage with invalid routeId.
		E-RT1/1-6	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
	POST	E-RT1/2-3	An error occured when there is no input data.	Happens when try to create Route Ritage without a name and departure route.
	POST	E-RT1/2-5	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
	DELETE	E-RT1/5-4	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
/route-ritage/{id}/status	PATCH	E-RT2/4-2	An error occured when status is missing.	Happens when try to update Route Ritage Status without status.
		E-RT2/4-3	An error occured when invalid status input.	Happens when try to update Route Ritage Status with invalid status label.
		E-RT2/4-4	An error occured when ritageId is not a number.	Happens when try to update Route Ritage Status with invalid ritageId.
		E-RT2/4-6	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
		E-RT2/4-7	An error occured when input status is same as current route ritage status.	Happens when try to update Route Ritage Status with invalid status label.
		E-RT2/4-10	An error found after requesting data.	Happens when the data client's requested are invalid. Error detail will be different each request.
/setting/vehicleGroups	GET	E-S1/VG1-03	An error occured when trying to retrieve data.	Happens when try to retrieve data from Vehicle Group.
	POST	E-S1/VG2-02	Invalid Input	Some input data is invalid.
		E-S1/VG2-04	Vehicle not found.	Vehicle that will be added to Vehicle Group is not found.
		E-S1/VG2-05	An error occured when trying to retrieve data vehicle.	Happens when trying to retrieve vehicle datas for validation.
		E-S1/VG2-07	An error occured when trying to create data.	Happens when trying to create vehicle group.
	PATCH	E-S1/VG3-02	Invalid vehicle group id input type.	Id must be an integer and cannot be null.
		E-S1/VG3-03	Invalid Input	Some input data is invalid.
		E-S1/VG3-05	Vehicle Group not found.	Vehicle Group that will be updated is not found.
		E-S1/VG3-06	An error occured when trying to retrieve data vehicle group.	Happens when trying to retrieve vehicle group datas for validation.
		E-S1/VG3-08	Vehicle not found.	Vehicle that will be added to Vehicle Group is not found.
		E-S1/VG3-09	An error occured when trying to retrieve data vehicle.	Happens when trying to retrieve vehicle datas for validation.
		E-S1/VG3-11	An error occured when trying to update data.	Happens when trying to update vehicle group.
	DELETE	E-S1/VG4-02	Invalid vehicle group id input type.	Id must be an integer and cannot be null.
		E-S1/VG4-04	Vehicle Group not found.	Vehicle Group that will be updated is not found.
		E-S1/VG4-05	An error occured when trying to retrieve data vehicle group.	Happens when trying to retrieve vehicle group datas for validation.
		E-S1/VG4-08	An error occured when trying to delete data.	Happens when trying to delete vehicle group.

Endpoint	Method	Code	Description	Detail
ALL			Authentication token is required	Happens when client trying to request data without token.
/login/	POST	E-L1/1-6	Invalid API key.	Happens when client trying to login with invalid API Key.

Endpoint	Method	Code	Description	Detail
ALL			No header found	Happens when client trying to request data without header.
/login/	POST	E-L1/1-1	All credentials must be filled.	Happens when client trying to login without user credential and API key.
/api-key/	POST	E-AK1/1-1	Either authentication token or user credential is required.	Happens when client trying to request data without token or user credential.