Skip to main content
POST
List registrations (paged)

Body

application/json

Paginated listing request for forecast alarm registrations.

pageNumber
integer<int32>

Zero-based page index.

Required range: x >= 0
Example:

0

pageSize
integer<int32>

Maximum number of registrations to return per page (1–100).

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

20

filterByRecipientIds
string[]

Restrict results to registrations with one of the given recipient identifiers.

Example:
filterByBoundary
object

Alarm registration boundary

Defines the geographic scope to monitor for forecast alarm conditions. The concrete boundary type is selected via the type discriminator field; supply only the fields that belong to the chosen subtype.

  • ADMINISTRATIVE – boundary identified by a city (cityId) and a district (districtId); both fields are required.
  • POINT – boundary defined by a single longitude/latitude coordinate (point). The alarm evaluates forecast data for the nearest forecast grid cell to that coordinate.
accountId
string<uuid>

Target account UUID; users with ADMIN or POWER_USER role may query registrations of other accounts.

Example:

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

Response

OK

Paginated result set of forecast alarm registrations.

registrations
object[]

List of forecast alarm registrations on the current page.

totalRecords
integer<int32>

Total number of matching registrations across all pages.

Example:

42

pageNumber
integer<int32>

Zero-based index of the returned page.

Example:

0

pageSize
integer<int32>

Maximum number of registrations per page as originally requested.

Example:

20