GetTrip API using driver_number

GetTrip API using driver_number

Clients call this API to get trip details for a trip by providing driver no in URL. All dates are given in UTC

API Endpoint:

Headers Parameters:

Field key

Data Type

Description

Example

Field key

Data Type

Description

Example

Authorization

string

JWT token required to authenticate API call.

Authorization: Bearer eyJhbGciOiJIUzI1Ni

Responses:

Status code 200 Created share trip link successfully

{ "success": true, "data": { "trip_id": 9424158, "feed_unique_id": null, "created_at": "2022-02-06 17:08:27", "lr_number": "", "parties": [ { "name": "Phoenix Pvt. Ltd.", "type": "consignor" } ], "vehicle": { "license_plate": "AP26XY1234" }, "last_known_location": { "point": { "latitude": 14.462778, "longitude": 79.994167 }, "address": "FX6W+X8J, Lakshmipuram, Nellore, Andhra Pradesh 524002, India", "recorded_at": "2022-02-07 09:52:48", "device": { "type": "SIM", "external_id": null } }, "origins": [ { "point": { "latitude": 14.432187, "longitude": 79.966687 }, "address": "MGB mall,Nellore, AP", "etd": null, "atd": null } ], "destinations": [ { "point": { "latitude": 17.686815, "longitude": 83.218483 }, "address": "Visakhapatnam, Andhra Pradesh, India", "distance_from_last_location": 616.737, "ata": null, "eta": "2022-02-08 22:36:47", "eta_updated_at": "2022-02-07 09:37:58" } ], "drivers": [ { "name": "Jack ryan", "contact": "8897814085" } ], "total_distance": 625.26, "start_time": null, "end_time": null, "close_time": null, "status": "Open", "status_code": 1, "location_source": "sim", "custom_params": {}, "is_consent_done": false, "primary_attributes": { "route_code": "Nellore-Vizag" }, "invoices": null, "share_url": "https://www.freighttiger.com/v5/shareTrip?shareKey=TRP-9cdad3f2-b5e9-4a9f-bcb9-e290de78df44" } }

Status code 422 Resource not found

{ "success": false, "message": [ "Trip Details for ID: 9424152434 does not exist" ] }

Status code 401 Bad Request - Auth failure

"UnAuthorized"

Success Response Schema:

{ "type": "object", "properties": { "success": { "type": "boolean", "description": "True indicates API returned data successfully" }, "data": { "type": "object", "description": "API Response", "properties": { "trip_id": { "type": "number", "description": "Trip ID" }, "feed_unique_id": { "type": "string", "description": "Unique Id for the Trip" }, "created_at": { "type": "string", "description": "Trip Creation Time (in UTC)" }, "lr_number": { "type": "string", "description": "LR Number" }, "vehicle": { "type": "object", "properties": { "license_plate": { "type": "string", "description": "Vehicle No" } } }, "last_known_location": { "type": "object", "description": "Last Known Location of Trip", "properties": { "point": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double", "description": "Latitude" }, "longitude": { "type": "number", "format": "double", "description": "Longitude" } } }, "address": { "type": "string", "description": "Address" }, "recorded_at": { "type": "string", "description": "Last Known Location recorded time" }, "device": { "type": "object", "properties": { "type": { "type": "string" }, "external_id": { "type": "string" } } } } }, "origins": { "type": "array", "description": "Origins of Trip", "items": { "properties": { "point": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double", "description": "Latitude" }, "longitude": { "type": "number", "format": "double", "description": "Longitude" } } }, "address": { "type": "string", "description": "Address" }, "atd": { "type": "string", "description": "Actual Time of Departure (in UTC)" } } } }, "destinations": { "type": "array", "description": "Destinations of Trip", "items": { "properties": { "point": { "type": "object", "properties": { "latitude": { "type": "number", "format": "double", "description": "Latitude" }, "longitude": { "type": "number", "format": "double", "description": "Longitude" } } }, "address": { "type": "string", "description": "Address" }, "ata": { "type": "string", "description": "Actual Time of Arrival (in UTC)" }, "distance_from_last_location": { "type": "number", "format": "double", "description": "Distance (in KM) of destination from Last Location" }, "eta": { "type": "string", "description": "Expected Time of Arrival (in UTC)" }, "eta_updated_at": { "type": "string", "description": "Last Time when ETA was Updated (in UTC)" } } } }, "drivers": { "type": "array", "description": "List of Drivers for the Trip", "items": { "properties": { "name": { "type": "string", "description": "Driver Name" }, "contact": { "type": "string", "description": "Driver Phone number" } } } }, "total_distance": { "type": "number", "format": "double", "description": "Total Distance of Trip" }, "start_time": { "type": "string", "description": "Actual Time of Departure of Trip (in UTC)" }, "end_time": { "type": "string", "description": "Actual Time of Arrival of Trip (in UTC)" }, "close_time": { "type": "string", "description": "Time when Trip was closed (in UTC)" }, "status": { "type": "string", "description": "Trip Status - Open/Closed" }, "status_code": { "type": "number", "description": "Status Code of trip (1/0) 1 for open, 0 for closed" }, "parties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } } } }, "custom_params": { "type": "object", "description": "Object contaning Custom Params of Trip" }, "is_consent_done": { "type": "boolean", "description": "In case vehicle consent status is 'Accepted' is_consent_done is true" }, "primary_attributes": { "type": "object", "description": "Object containing Primary Attributes of Trip" }, "invoices": { "type": "array", "description": "Array of object containing Invoice Details of Trip", "items": { "type": "object" } } } } } }

 

Post your questions in the comment box to get answers from the experts who watch this page.

For engineering support: visit FT Support