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 Segment

 

This method is used to update a segment.   Only draft segments (i.e. segments that belong to a draft floor) may be modified via this method.

Method

PUT

URL

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

Headers

X-Auth (see Security)

Request Body

See Mapping API Architecture > PUT Methods & Partial Updates.

Parameter

Value

Description

startPointId

integer

The identifier of the starting point of the segment.

endPointId

integer

The identifier of the ending point of the segment

floorId

integer

The identifier of the floor that the start and end points are on.

{
	"startPointId": <integer>,
	"endPointId": <integer>,
	"floorId": <integer> 
}

Example Request

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

{
	"startPointId": 78757,
	"endPointId": 78775,
	"floorId": 17 
}

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