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 Collection of Routes
This method is used to retrieve an array of routes that satisfy search criteria.
X-Auth (see Security)
Required parameters are underlined. While floorId, startPointId and endPointId are marked as required, only one is necessary for a successful request.
The ID of the floor to get the routes for.
The ID of the starting point to match routes against.
The ID of the ending point to match routes against.
Specifies whether to return accessible routes only.
If true, full point data will be returned within the routes that are found. If false, only the IDs of the points will be included in the returned routes. This is for the convenience of callers that prefer a smaller payload in the response body.
Specifies the number of results to return. This is useful for pagination.
Default value: 10
Maximum value: 100
Specifies the number of results to offset. This is useful for pagination.
Default value: 0
|draftStatus||string||Either "LIVE" or "DRAFT". Defaults to "LIVE".|
Example Query Fragment
URL-encoded, minified fragment:
A successful response will have a 200 status code and a body containing an array of routes that satisfy the query parameters:
The "pagination" and "pages" elements of the response body provide information about the number of items found by the search, how many of those have been returned in the payload and whether there are any other pages of results.
If route generation is in progress, a 202 "Accepted" status code will be returned with an empty set of results to indicate that the resource is not currently available. Example response body:
If route generation fails, a 500-series status code will be returned. See Mapping API Response Handling for error payloads.
Example body of a successful response:
ON THIS PAGE