Skip to main content
POST
/
v1
/
alarms
/
geometries
/
page
List registrations (paged)
curl --request POST \
  --url https://api.iklim.co/v1/alarms/geometries/page \
  --header 'Content-Type: application/json' \
  --data '{
  "pageNumber": 0,
  "pageSize": 10,
  "filterByRecipientIds": [
    "Recipient1",
    "Recipient2"
  ],
  "filterByBoundary": {
    "type": "ADMINISTRATIVE",
    "cityId": 6,
    "districtId": 557,
    "neighborhoodId": 55766
  },
  "accountId": "1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0"
}'
{
  "registrations": [
    {
      "registrationId": "f7587d9e-2481-4b4c-818d-c8d1946851b7",
      "recipientId": "Recipient 1",
      "boundary": {
        "cityId": 6,
        "districtId": 557,
        "neighborhoodId": 55766
      },
      "webhook": {
        "accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1",
        "url": "https://api.customer.com/alerts/callback",
        "httpMethod": "POST",
        "contentType": "application/json",
        "authentication": {
          "username": "alert-user",
          "password": "******"
        },
        "deliveryPolicy": {
          "timeout": 5000,
          "maxRetries": 3,
          "retryDelay": 10
        }
      },
      "filter": {
        "lightning": {
          "type": "FLASH_CLOUD_TO_GROUND",
          "peakCurrent": -12.5,
          "inCloudHeight": 4500
        },
        "thunderstorm": {
          "intersectsAffectedPolygon": true,
          "intersectsCellPolygon": false,
          "severityThreshold": "MEDIUM",
          "speedThreshold": 20
        },
        "precipitation": {
          "types": [
            "RAIN",
            "SNOW"
          ],
          "intensity": 2
        }
      }
    }
  ],
  "totalRecords": 123,
  "pageNumber": 0,
  "pageSize": 10
}

Body

application/json

Pagination and filter parameters

pageNumber
integer

Page number (0-based)

Required range: x >= 0
Example:

0

pageSize
integer

Page size

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

10

filterByRecipientIds
string[]

Filter by recipient identifiers

{msg:swagger.schema.alarms.page-request.filter-by-recipient-ids}

Example:
["Recipient1", "Recipient2"]
filterByBoundary
object

Boundary definition Administrative boundary (city/district/neighbourhood)

  • Option 1
  • Option 2
  • Option 3
accountId
string<uuid>

Account UUID

Example:

"1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0"

Response

OK

Paged registrations result

registrations
object[]

List of registrations

totalRecords
integer

Total records

Example:

123

pageNumber
integer

Current page number

Example:

0

pageSize
integer

Page size

Example:

10