List annotations

Request

Get all available annotations subject to filters.

Security

api_key

Query

cameraPositionIdstring, (uuid)

The ID of a camera position linked to the annotations.

organisationIdstring, (uuid)

The ID of the associated organisation.

siteIdstring, (uuid)

The ID of the associated site.

statestring

annotation state.

Enum:"active""deleted"

curl -i -X GET \
  'https://coreapi.hoxton.ai/_mock/v1/annotations?cameraPositionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&organisationId=497f6eca-6276-4993-bfeb-53cbbbba6f08&siteId=497f6eca-6276-4993-bfeb-53cbbbba6f08&state=active' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json

Array [

cameraPositionIdstring, (uuid)required

createdAtstring, (date-time)read-only

deletedAtstring or null, (date-time)read-only

idstring or null, (uuid)

kindstring

Enum:"polygon""multipolygon"

roiobject or nullrequired

statestring

Enum:"active""deleted"

]

Response

[
  {
    "cameraPositionId": "37eacd70-df6f-462c-b57e-ba61d0ee7150",
    "createdAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "kind": "polygon",
    "roi": {},
    "state": "active"
  }
]