Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 1.65 KB

locations-geojson.md

File metadata and controls

66 lines (43 loc) · 1.65 KB

/trips/{tripId}/locations.geojson

Get the locations history from a specific trip as a Geojson LineString

Basics

[GET] https://{env}.xee.com/v3/trips/{tripId}/locations.geojson

You'll need the, trips_read and locations_read scope.

Secured by OAuth 2 access token.

Request

Environment

The env variable as the host of the route can be changed for testing purpose.

Value Comment
cloud production environment (real client data, Authorization needed)
sandbox sandbox environment (fake data, no Authorization needed)

Headers

Header name Header value Mandatory
Authorization Bearer with the OAuth2 access token YES

Url Parameters

Parameter name Parameter value Mandatory
tripId The id of the trip you are looking for the locations YES

Success Response

  • Status Code: 200
  • Body:
{
	"type": "LineString",
	"coordinates":[
		[3.0580485, 50.632244]
	]
}
Property Type Comment
type string The type of the Geojson object
coordinates array Array of Array of Points of the trip (longitude, latitude)

Errors

See how errors are formed in v3 Readme

Be aware of authentication errors

Reason Status Code Type Message Tip
The token does not have access to this trip 403 AUTHORIZATION_ERROR Token can't access this trip Make sure the trip belongs to the user you've got the token from
Trip does not exist 404 PARAMETERS_ERROR Trip not found Please check that the trip exists, looks like it does not