Get Location Details

This API returns details on a particular location.

METHOD	GET
Request URI	<production url>/v1/locations/{id}
Sample Request URI	<production url/v1/locations/1000000076

Query Parameters

Parameter	Description	Required?	Filter Values
id	GE identifier for a location.	Yes	1000000076

Response Parameters

Parameter	Data Type	Required?	Description
coordinates	String	Yes	GPS coordinates identifying the location. Four coordinates should be provided for the location-uid.
city, state, country, zip code	String	No	Physical location information.
_links	String	Yes	self URL for this API
location-uid	String	Yes	A unique identifier established by a customer or external resource for a specific location within the monitored area. For example, 93d49017-19d0-416c-9a95-be0bee2a5ed9.
location-type	String	Yes	Type of specific location, per the list below: PARKING Parking location. PARKING_SPOT Demarcated parking location. PARKING_ZONE Non-demarcated parking location. CROSSWALK Pedestrian crosswalk. TRAFFIC_LANE Lane for moving vehicles. RETAIL-STORE Retail store. OTHERS Others or unknown location type.
assets	String	Yes	Information and links to the monitoring device and its output. coordinates GPS coordinates for the location. device-id A unique identifier established by a customer or external resource for the device monitoring the location. For example, HYP1037-77 to identify a camera. event-type Event type recorded by the device. PKIN = vehicle entering location. PKOUT = vehicle exiting location. SFIN = pedestrian entering location. SFOUT = pedestrian exiting location. TFEVT = traffic event at location. LIGHT_LEVEL = asset reports illuminance sensor events. OCCUPANCY = asset reports occupancy sensor events. TEMP = asset reports temperature sensor events. media-type Media output from the device. IMAGE = JPG, PNG, or GIF formats. VIDEO = MP4 format. AUDIO = MP3 or WAV formats. OTHERS = non-standard formats. device-type Type of device. NODE = parent asset. CAMERA = camera installed within the bounding box. MIC = audio device installed within the boundaries. ENV = environmental sensor installed within the boundaries. OTHERS = non-standard or unknown devices within the boundaries.

Sample Response

{
  "coordinates": {
    "P1": "32.711447,-117.157063",
    "P2": "32.711447,-117.156984",
    "P3": "32.711427,-117.156984",
    "P4": "32.711427,-117.157063"
  },
  "city": null,
  "state": null,
  "country": null,
  "zipcode": null,
  "_links": {
    "self": {
      "href": "http://<production url>/v1/locations/1000000076"
    }
  },
  "location-uid": "93d49017-19d0-416c-9a95-be0bee2a5ed9",
  "location-type": "PARKING_SPOT",
  "address": null,
  "_embedded": {
    "container": null,
    "locations": [],
    "assets": [
      {
        "coordinates": {
          "P1": "32.711421,-117.157264"
        },
        "_links": {
          "self": {
            "href": "http://<production url>/v1/assets/1000000026"
          },
          "search-media": {
            "href": "http://<production url>/v1/assets/1000000026/media{?media-types,start-ts,end-ts,page,size}",
            "templated": true
          },
          "search-events": {
            "href": "http://<production url>/v1/assets/1000000026/events{?event-types,start-ts,end-ts,size}",
            "templated": true
          },
          "live-events": {
            "href": "http://<production url>/v1/assets/1000000026/live-events{?event-types}",
            "templated": true
          }
        },
        "device-id": "HYP1037-77",
        "event-type": "PKOUT;PKIN;TFEVT",
        "media-type": "IMAGE",
        "device-type": "camera"
      }
    ]
  },
  "analytic-category": Future Feature
}