Ana içeriğe atla
POST
/
v1
/
alarms
/
points
/
page
Kayıtları sayfalı listele
curl --request POST \
  --url https://api.iklim.co/v1/alarms/points/page \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageNumber": 0,
  "pageSize": 10,
  "filterByRecipientIds": [
    "Receiver1",
    "Receiver2"
  ],
  "filterByPolygonIntersection": [
    [
      [
        32.85,
        39.95
      ],
      [
        32.86,
        39.95
      ],
      [
        32.86,
        39.96
      ],
      [
        32.85,
        39.96
      ],
      [
        32.85,
        39.95
      ]
    ]
  ],
  "accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1"
}
'
{ "registrations": [ { "registrationId": "f7587d9e-2481-4b4c-818d-c8d1946851b7", "recipientId": "Recipient1", "boundary": { "point": { "lat": 39.9208, "lng": 32.8541 }, "radius": 10000 }, "webhook": { "accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1", "url": "https://api.customer.com/alerts/callback", "httpMethod": "POST", "contentType": "application/json", "authentication": { "username": "alert-user", "password": "******" }, "requestHeaders": { "source": "iklim.co", "custom-header": "value" }, "deliveryPolicy": { "timeout": 60, "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": { "intensities": [ "LIGHT", "MODERATE" ] } } } ], "totalRecords": 128, "pageNumber": 0, "pageSize": 10 }

Gövde

application/json
pageNumber
integer<int32>

Sıfır tabanlı sayfa numarası

Gerekli aralık: x >= 0
Örnek:

0

pageSize
integer<int32>

Sayfa boyutu (1..100)

Gerekli aralık: 1 <= x <= 100
Örnek:

10

filterByRecipientIds
string[]

Yalnızca recipientId değeri bu listedekiler olan kayıtlar

Örnek:
["Receiver1", "Receiver2"]
filterByPolygonIntersection
number<double>[][]

Sınırı bu poligonla kesişen kayıtlar (GeoJSON halka sırası: [lon, lat])

Örnek:
[
  [
    [32.85, 39.95],
    [32.86, 39.95],
    [32.86, 39.96],
    [32.85, 39.96],
    [32.85, 39.95]
  ]
]
accountId
string<uuid>

Başkası adına sorgulamak için hesap UUID (sadece admin/operatör). Belirtilmezse çağıranın hesabı kullanılır.

Örnek:

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

Yanıt

Sayfalı kayıtlar başarıyla döndürüldü

registrations
object[]

Bu sayfaya ait kayıtlar

totalRecords
integer<int32>

Toplam eşleşen kayıt sayısı

Örnek:

128

pageNumber
integer<int32>

Dönen sayfa numarası

Örnek:

0

pageSize
integer<int32>

Dönen sayfa boyutu

Örnek:

10