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 Floor

 

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

Method

PUT

URL

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

Headers

X-Auth (see Security)

Request Body

See Mapping API Architecture > PUT Methods & Partial Updates.

Parameter

Value

Description

venueGuid

string

The identifier of the venue that this floor belongs to.

name

string

The name of the floor.

originalMapUrl

string

The location of the image used in map displays of this floor. By convention, it should be of the format

http://lbs-<env>.s3.amazonaws.com/venues/<venueGuid>/maps/<floorId>.<suffix>, where <env> is "dev", "stage", or "prod", <venueGuid> and <floorId> are the identifiers of the venue and floor, and <suffix> is the extension type of the image file (e.g. ".jpg", ".png").

level

integer

The level of this floor.

isOutdoor

Boolean

Describes whether this floor is outdoors.

width

integer

The width of the floor.

height

integer

The height of this floor.

offsetX

integer

The offset in the x-direction.

offsetY

integer

The offset in the y-direction.

locationMapHierarchy

string

By convention, a string which is a concatenation of the campus name, building name, and floor name separated by the '>' character.

buildingId

integer

The identifier of the building that this floor belongs to.

maxZoomLevel

integer

The maximum zoom level for this floor.

referencePoints

object

An object to help locate the floor properly on the map. It contains:

  • location objects for the top left, top right, bottom left and bottom right latitude and longitude values
  • portal object containing top right and bottom left locations for use by the portal in fixating the floor on the display
  • rotation value in decimal degrees
scalePctintegerThe scale of the map. Valid range is 25-400 inclusive.
{
    "originalMapUrl": <string>,
    "isOutdoor": <Boolean>,
    "width": <integer>,
    "height": <integer>
}

Example Request

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

{
    "originalMapUrl": "http://image.com/level2_FINAL.pdf",
    "isOutdoor": true,
    "width": 200,
    "height": 100
}

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