Skip to main content
POST
List point alarm registrations (paged)

Body

application/json
pageNumber
integer<int32>

Zero-based page number

Required range: x >= 0
Example:

0

pageSize
integer<int32>

Page size (1..100)

Required range: 1 <= x <= 100
Example:

10

filterByRecipientIds
string[]

Only registrations whose recipientId is in this list

Example:
filterByPolygonIntersection
number<double>[][]

Only registrations whose boundary intersects with this polygon (GeoJSON ring order: [lon, lat])

Example:
accountId
string<uuid>

Account UUID to query on behalf of (admin/operator only). If omitted, uses caller's account.

Example:

"2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1"

Response

Paged registrations returned successfully

registrations
object[]

Result registrations for this page

totalRecords
integer<int32>

Total number of matching registrations

Example:

128

pageNumber
integer<int32>

Returned page number

Example:

0

pageSize
integer<int32>

Returned page size

Example:

10