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 Point

 

This method is used to update an existing point.   Only draft points (i.e. points that belong to a draft floor) may be modified via this method.

Method

PUT

URL

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

Headers

X-Auth (see Security)

Request Body

See Mapping API Architecture > PUT Methods & Partial Updates.

Parameter

Value

Description

name

string

The name of the point.

poiType

integer

The type of point. See POI TYPES for named types and their associated integer values.

Default: 0

category

string

Describes the kind of point (e.g. "Exhibit", "Shop", "Facilities", etc.).

description

string

A description of this point.

isActive

Boolean

Describes whether the point is active (“true”) or inactive (“false”). A point is typically set to inactive to indicate that it is being edited or is no longer valid.

imageUrl

string

The URL of an image file associated with the point. This image is used by client applications to display banner images.

customIconImageUrl

string

The URL of a custom image to use when displaying an icon for this point. If there is no customImageIconUrl, a standard icon based on the poiType will be used.

x

integer

The x-location of this point.

y

integer

The y-location of this point.

isExit

Boolean

Indicates whether this point is an exit.

isAccessible

Boolean

Indicates whether this point is accessible.

portalId

string

A portal is a point providing access between floors, such as an elevator or stairway. A non-null portalId indicates that this point is a portal.

level

integer

The level of this point.

floorId

integer

The identifier of the floor that this point belongs to.

annotation

string

Information about this point, less than a full description.

zoomLevel

integer

The zoom level of this point.

maxZoomLevel

integer

The maximum zoom level of this point.

buildingId

integer

The identifier of the building that this point belongs to.

metaData

object

Extra data that can be stored with the point.

location

object

An object containing the latitude and longitude of the point, in decimal degrees.

name

string

The name of the point.

{
	"id": <integer>,
	"description": <string>,
	"isActive": <Boolean>
} 

Example Request

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

{
    "id": 78757,
    "description": "Zelda's been kidnapped... again.",
    "isActive": false
}

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