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.

Update a Route

 

Deprecated.  This method is used to update an existing route , but it should be considered deprecated, since the typical use case is to generate routes via a POST on the …v1.1/routes/reset URL, which will eliminate existing routes and recalculate them.  Routes may only be modified via this method on draft floors.

Method

PUT

URL

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

Headers

X-Auth (see Security)

Request Body

See Mapping API Architecture > PUT Methods & Partial Updates.

Parameter

Value

Description

startPointId

integer

The ID of the starting point of the route.

endPointId

integer

The ID of the ending point of the route.

isAccessible

Boolean

Indicates whether this route is accessible.

pointIds

string

Comma-separated, ordered list of the IDs of the points comprising this route.

floorId

integer

The ID of the floor this route is associated with.

data

array

Array of point objects, in order, that comprise this route.

{
	"endPointId": <integer>,
	"pointIds": <string>,
	"data": <array>
} 

Example Request

PUT the following request body to: http://map-api.phunware.com/v1.1/routes/10

{
    "endPointId": 78758,
    "pointIds": "78757,78758",
    "data": 
	[
        78757,
        78758
    ]
} 

Response

A success response will return a 204 status code with no data in the body of the response. See Mapping API Response Handling for error payloads.

ON THIS PAGE

 

 

  • No labels