Skip to end of metadata
Go to start of metadata

This documentation is no longer actively supported and may be out of date. Going forward, please visit and bookmark our new site (https://docs.phunware.com/) for up-to-date documentation.

Retrieve a Route

 

This method is used to retrieve the points that define a route by route ID.

Method

GET

URL

http://map-api.phunware.com/v1.1/routes/[id]

Headers

X-Auth (see Security)

Query Parameters

None

Example Request

GET
http://map-api.phunware.com/v1.1/routes/10

Response

A successful response will have a 200 status code and a body containing an object with route data:

{
    "id": <integer>,
    "name": <string>,
    "startPointId": <integer>,
    "endPointId": <integer>,
    "isAccessible": <Boolean>,
    "pointIds": <string>,
    "status": <integer>,
    "floorId": <integer>,
    "createdAt": <string>,
    "updatedAt": <string>,
    "data": <array>,
    "isDirty": <Boolean>,
    "externalId": <integer>
}

See Mapping API Response Handling for error payloads. 

Example Response

Example body of a successful response:

{
    "id": 10,
    "name": "The Throne Room-STAIRS",
    "startPointId": 78757,
    "endPointId": 78759,
    "isAccessible": true,
    "pointIds": "78757,78758,78759",
    "status": 2,
    "floorId": 17,
    "createdAt": "2014-06-14T12:21:38Z",
    "updatedAt": null,
    "data": 
	[
        <object containing point ID 78757 data>, 
		<object containing point ID 78758 data>, 
		<object containing point ID 78759 data>
    ],
    "isDirty": null,
    "externalId": 10
} 

ON THIS PAGE

 

 

  • No labels