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.
Create a Floor
This method is used to create a floor object. The body of the request contains a JSON payload defining the floor. This will create a draft floor. Floors may only be created on draft buildings.
X-Auth (see Security)
Required parameters are underlined.
The identifier of the venue that this floor belongs to.
The name of the floor.
The location of the image used in map displays of this floor. By convention, it should be of the format<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").
The level of this floor.
Describes whether this floor is outdoors.
The width of the floor.
The height of this floor.
The offset in the x-direction.
The offset in the y-direction.
By convention, a string which is a concatenation of the campus name, building name, and floor name separated by the '>' character.
The identifier of the building that this floor belongs to.
The maximum zoom level for this floor.
An object to help locate the floor properly on the map. It contains:
|scalePct||integer||The scale of the map. Valid range is 25-400 inclusive.|
POST the following request body to:
A successful response will have a 200 status code and a body containing the newly created floor's ID:
See Mapping API Response Handling for error payloads.
Example body of successful response:
ON THIS PAGE