AIairship
Regions

Region listing

Changed on

Get a paginated list regions. The result is an array of Region objects under the "regions" key.

get/api/regions

Request

Query parameters

limitinteger
Example:100

Determines the number of results per page. Defaults to 100, with a maximum of 1,000 regions per page. Setting a limit greater than 1,000 returns a 400 response.

startinteger
Example:1

A zero-based integer offset into the ordered list of regions, useful for addressing pages directly.

Response

Returns OK for success.

countinteger

The total number of regions returned.

next_pagestring url

There might be more than one page of results for this listing. Follow this URL if it is present to the next batch of results.

okboolean

Success.

Example response

{
  "next_page": "https://go.urbanairship.com/api/regions?limit=100&start=100",
  "regions": [
    {
      "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.