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 Point

 

This method is used to retrieve a point by point ID.

Method

GET

URL

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

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

draftStatus

string

Either "LIVE" or "DRAFT". Defaults to "LIVE".

Example Request

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

Response

A successful response will have a 200 status code and a body containing an object with point data:

{
    "id": <integer>,
    "name": <string>,
    "poiType": <integer>,
    "category": <string>,
    "description": <string>,
    "isActive": <Boolean>,
    "imageUrl": <string>,
    "customIconImageUrl": <string>,
    "x": <integer>,
    "y": <integer>,
    "isExit": <Boolean>,
    "isAccessible": <Boolean>,
    "portalId": <string>,
    "level": <integer>,
    "annotation": <string>,
    "zoomLevel": <integer>,
    "maxZoomLevel": <integer>,
    "floorId": <integer>,
    "buildingId": <integer>,
    "metaData": <object>,
    "createdAt": <string>,
    "updatedAt": <string>,
    "location": 
	{
        "latitude": <decimal>,
        "longitude": <decimal>
    },
    "externalId": <integer>
} 

See Mapping API Response Handling for error payloads.

Example Response

Example body of a successful response:

{
    "id": 78757,
    "name": "The Throne Room",
    "poiType": 2,
    "category": null,
    "description": "Where Zelda sits when not hostage elsewhere.",
    "isActive": true,
    "imageUrl": "http://www.image.com/point.png",
    "customIconImageUrl": "http://www.image.com/throne1.png",
    "x": 43,
    "y": 81,
    "isExit": true,
    "isAccessible": true,
    "portalId": null,
    "level": 1,
    "zoomLevel": 2,
    "maxZoomLevel": -1,
    "floorId": 17,
    "buildingId": 6891,
    "annotation": "exit from courtyard",
    "metaData": null,
    "createdAt": "2013-09-04T13:32:55Z",
    "updatedAt": "2013-09-04T13:32:55Z",
    "location": 
	{
        "latitude": 37.12345,
        "longitude": 97.01234
    },
    "externalId": 78757
} 

ON THIS PAGE

 

 

  • No labels