AIairship
Regions

Region lookup

Changed on

Get details for a specific region.

get/api/regions/{region_id}

Request

Path parameters

region_idstring required
Example:7d4d9a5c-eff5-40f2-b648-4352c166e878

The region you want to look up.

Response

Returns OK for success.

okboolean

If true, indicates success.

Example response

{
  "ok": true,
  "region": {
    "beacons": [
      {
        "id": "2034071230471204710",
        "name": "Exhibit A"
      }
    ],
    "created_at": "2018-03-01T12:00:00",
    "name": "My Favorite Place",
    "region_id": "abe5deb3-00d0-446e-8c5d-94b6421a01e0",
    "source_info": {
      "region_id": "4BPSFLKJSDFLKJSDFLKJ",
      "source": "GIMBAL",
      "vendor_href": "https://manager.gimbal.com/api/2/places/4BPSFLKJSDFLKJSDFLKJ"
    },
    "updated_at": "2018-03-01T12:00:00"
  }
}

Changes

  • 3304568aaadcRevision changes
    • breaking

      added subschema #1: Polygon Geofence object subschema #2: Circle Geofence object subschema #3: Confidential Geofence object to the / response property oneOf list for the response status

    This list may be incomplete.