Get List of Locations

This API provides a list of sensor locations within a bounding box (bbox) that you define with GPS coordinates.

METHOD GET
Request URI {{metadataurl}}/v2/locations/search?bbox=<long,lat>&page=<int>&size=<int>&q=locationType:<locationType1>
Sample Request URI {{metadataurl}}/v2/locations/search?bbox=32.715675:-117.161230,32.708498:-117.151681&page=0&size=50&q=locationType:TRAFFIC_LANE;WALKWAY;PARKING_ZONE

Query Parameters

Parameter Description Required? Filter Values
bbox The bounded area for your search; establishes the periphery of a searchable area for assets and nodes, identified by GPS coordinates.

For more information, see the API Glossary for Intelligent Enterprises.

Yes bbox=x1:y1, x2:y2. Replace x1:y1, x2:y2 with GPS coordinates, similar to 32.715675:-117.161230, 32.708498:-117.151681. You can use Google Maps to obtain the latitude and longitude. To locate GPS coordinates for the area and identify the boundaries, place the cursor in the upper left location of the area, then right-click and select What’s here? to obtain the first set of coordinates. Right-click on the lower-right location and repeat this procedure to obtain the second set of coordinates.

q Identifies a "type" query. No Query to search by location type.
locationType Filter by type of location. No See the enumeration codes for locationType in the Glossary for Intelligent Enterprises.
locationUid A unique identifier established by a customer or external resource for a specific location within the monitored area. No For example, LOCATION-STG-323.
size Maximum number of records to return per page; if none specified, the default is used automatically. No Numerical value.
page Indicates the page number; default value is 0. No Numerical value.

Response Parameters

Parameter Data Type Description
locationUID String A unique identifier established by a customer or external resource for a specific location within the monitored area. For example, LOCATION-STG-323.
locationType String See the enumeration codes for locationType in the Glossary for Intelligent Enterprises.
parentLocationUid String The unique identifier assigned to the parent location comprising the locationUids within the monitored area.
coordinatesType String
GEO
: GEO indicates that the coordinate type uses GPS coordinates.
coordinates String The GPS coordinates (latitude, longitude) for the referenced asset (identified by assetUid), such as 32.711653,-117.157314 that identify the location of the camera.

Sample Response

{
  "content": [
    {
      "locationUid": "177-parkingzone",
      "locationType": "PARKING_ZONE",
      "parentLocationUid": null,
      "coordinatesType": "GEO",
      "coordinates": "30.328164456985096:-81.65958708005638,30.32812646376904:-81.65959816387478,30.328148376658532:-81.65970123011935,30.32818656444743:-81.6596900624812"
    },
    {
      "locationUid": "HYP1087-170-Lane1",
      "locationType": "TRAFFIC_LANE",
      "parentLocationUid": null,
      "coordinatesType": "GEO",
      "coordinates": "30.32815726241225:-81.65960375060847"
    },
    {
      "locationUid": "HYP1087-171-Lane2",
      "locationType": "TRAFFIC_LANE",
      "parentLocationUid": null,
      "coordinatesType": "GEO",
      "coordinates": "30.328135456985095:-81.65961066678872"
    },
    {
      "locationUid": "HYP1089-175-Lane1",
      "locationType": "TRAFFIC_LANE",
      "parentLocationUid": null,
      "coordinatesType": "GEO",
      "coordinates": "30.328151973944955:-81.65968247574844"
    },
    {
      "locationUid": "LOCATION-UNIQUE-ID",
      "locationType": "PARKING_ZONE",
      "parentLocationUid": null,
      "coordinatesType": "GEO",
      "coordinates": "30.328164456985096:-81.65958708005638,30.32812646376904:-81.65959816387478,30.328148376658532:-81.65970123011935,30.32818656444743:-81.6596900624812"
    }
  ],
  "last": true,
  "totalPages": 1,
  "totalElements": 5,
  "numberOfElements": 5,
  "first": true,
  "sort": null,
  "size": 50,
  "number": 0
}