Locations

POST /locations

This endpoint allows you to create a new location. Support for Location-based camera grouping is only available in the professional and enterprise editions.

Request

Base URL
https://api.cxxx.eagleeyenetworks.com/api/v3.0
URL
https://api.cxxx.eagleeyenetworks.com/api/v3.0/locations
Auth
HTTP bearer

Request body

idstring

Unique identifier of the resource

namestring required

parentIdstring

Unique identifier of this location's parent location in the hierarchy

isDefaultboolean

Specifies if a new device should be automatically assigned to this location if not supplied

notesstring

Description for the location

childLocationCountinteger

The total count of direct children of the location

Example request

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "CF2 - Austin Office",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "address": {
    "country": "USA",
    "region": "Texas",
    "city": "Austin",
    "streetAddress": "4611 Bee Caves Rd",
    "streetAddress2": "SUITE 102",
    "postalCode": "78746"
  },
  "geometry": {
    "type": "MultiPolygon",
    "coordinates": [
      [
        [
          [
            40,
            40
          ],
          [
            20,
            45
          ],
          [
            45,
            30
          ],
          [
            40,
            40
          ]
        ]
      ],
      [
        [
          [
            20,
            35
          ],
          [
            10,
            30
          ],
          [
            10,
            10
          ],
          [
            30,
            5
          ],
          [
            45,
            20
          ],
          [
            20,
            35
          ]
        ],
        [
          [
            30,
            20
          ],
          [
            20,
            15
          ],
          [
            20,
            25
          ],
          [
            30,
            20
          ]
        ]
      ]
    ],
    "bbox": [
      -10,
      -10,
      10,
      10
    ]
  },
  "resourceCounts": {
    "cameras": 23,
    "bridges": 2,
    "speakers": 1,
    "users": 12,
    "multiCameras": 3
  }
}

Response

Location created