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.

Retrieve a Count of Points by Floor and/or Building

 

This method is used to retrieve the number of points on a floor that match search criteria.

Method

GET

URL

http://map-api.phunware.com/v1.1/points/count

Headers

X-Auth (see Security)

Query Parameters

Required parameters are underlined. While both "floorId" and "buildingId" are marked as required, either one is sufficient. 

Parameter

Value

Description

floorId

integer

Return points that are on this floor.

buildingId

integer

Return points that are in this building.

isActive

boolean

If omitted, get count of points that are either active or inactive.

If true, get count of points that are active.

If false, get count of points that are inactive.

poiOnlyBoolean
  • If true, returns only points of interest. 
  • If false, returns all points (including waypoints). 

Default value: false

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

Example Query Fragment

{
	"floorId": 17,
	"buildingId": 6891
} 

URL-encoded, minified fragment:

%7B%22floorId%22%3A17%2C%22buildingId%22%3A6891%7D 

Example Request

GET
http://map-api.phunware.com/v1.1/points/count?%7B%22floorId%22%3A1%2C%22buildingId%22%3A1%7D 

Response

A successful response will have a 200 status code and a body like the below:

{
    "data": 
	{
        "count": <integer>
    }
} 

See Mapping API Response Handling for error payloads.

Example Response

Example body of a successful response:

{
    "data": 
	{
        "count": 5
    }
} 

ON THIS PAGE

  • No labels