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.

This method is used to retrieve an array of floors that satisfy search criteria.

Method

GET

URL

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

Headers

X-Auth (see Security)

Query Parameters

Required parameters are underlined. If buildingId is not provided, locationMapHierarchy and venueGuid must be provided.

Parameter

Value

Description

buildingId

integer

Return floors that belong to this building.

locationMapHierarchy

string

Return floors that have this locationMapHierarchy

venueGuid

string

Return floors that have this venueGuid.

draftStatusstringEither "LIVE" or "DRAFT". Defaults to "LIVE".

Example Query Fragment

{
	"buildingId": 6891
}  

URL-encoded, minified fragment:

%7B%0A%22buildingId%22%3A+6891%0A%7D

Example Request 

GET
http://map-api.phunware.com/v1.1/floors?%7B%0A%22buildingId%22%3A+6891%0A%7D 

Response

A successful response will have a 200 status code and a body containing an array of floors for that satisfy the query parameters: 

{
	"data":
	[
    	<floorobject1>,
    	<floorobject2>,
    	...
	]
} 

See Mapping API Response Handling for error payloads.

Example Response

Example body of a successful response (continues on next page):

{
    "data": 
	[
        {
            "id": 1,
            "name": "Level One",
            "originalMapUrl": "http://image.com/level1.pdf",
            "level": 1,
            "isOutdoor": false,
            "width": 100,
            "height": 200,
            "offsetX": 0,
            "offsetY": 0,
            "locationMapHierarchy": "somecampus>somebuilding>somefloor",
            "createdAt": "2013-09-03T13:32:55Z",
            "updatedAt": "2013-09-03T13:32:55Z",
            "buildingId": 6891,
            "resources": null,
            "venueGuid": "f0685279-7497-4d90-882e-12201e476b0e",
            "maxZoomLevel": -1,
            "referencePoints": 
			{
                "rotation": 214,
                "portal": 
				{
                    "topRight": 
					{
                        "latitude": 33.77403309960294,
                        "longitude": -84.32867120304763
                    },
                    "bottomLeft": 
					{
                        "latitude": 33.7740738782866,
                        "longitude": -84.32673443277963
                    }
                },
                "topLeft": 
				{
                    "latitude": 33.773309,
                    "longitude": -84.327331
                },
                "topRight": 
				{
                    "latitude": 33.774033,
                    "longitude": -84.328671
                },
                "bottomLeft": 
				{
                    "latitude": 33.774073,
                    "longitude": -84.326734
                },
                "bottomRight": 
				{
                    "latitude": 33.774797,
                    "longitude": -84.3280742
                }
            },
            "externalId": 1
        },
        {
            "id": 12,
            "name": "Level Two",
            "originalMapUrl": "http://image.com/level2.pdf",
            "level": 2,
            "isOutdoor": false,
            "width": 100,
            "height": 200,
            "offsetX": 0,
            "offsetY": 0,
            "locationMapHierarchy": "somecampus>somebuilding>somefloor",
            "createdAt": "2013-09-19T12:00:00Z",
            "updatedAt": "2013-09-19T13:00:00Z",
            "buildingId": 6891,
            "resources": null,
            "venueGuid": "00000000-1234-1234-abcd-123456789012",
            "maxZoomLevel": 3,
            "referencePoints": 
			{
                "portal": 
				{
                    "topRight": 
					{
                        "latitude": 33.77403309960294,
                        "longitude": -84.32867120304763
                    },
                    "bottomLeft": 
					{
                        "latitude": 33.7740738782866,
                        "longitude": -84.32673443277963
                    }
                },
                "rotation": 214,
                "topLeft": 
				{
                    "latitude": 33.773309,
                    "longitude": -84.327331
                },
                "topRight": 
				{
                    "latitude": 33.774033,
                    "longitude": -84.328671
                },
                "bottomLeft": 
				{
                    "latitude": 33.774073,
                    "longitude": -84.326734
                },
                "bottomRight": 
				{
                    "latitude": 33.774797,
                    "longitude": -84.3280742
                }
            },
            "externalId": 12
        }
    ]
} 

ON THIS PAGE

 

 

  • No labels