Ana içeriğe atla
PATCH
/
v1
/
alarms
/
geometries
/
update
Alarm kaydını güncelle
curl --request PATCH \
  --url https://api.iklim.co/v1/alarms/geometries/update \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": {
      "type": "API_KEY",
      "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"
      ]
    }
  }
}
'
{
  "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": "******"
    },
    "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"
      ]
    }
  },
  "createdAt": "2025-01-01T10:15:30Z",
  "updatedAt": "2025-01-01T11:15:30Z",
  "warnings": [
    "warning-1",
    "warning-2"
  ]
}

Gövde

application/json

Kayıt gövdesi (sınır, webhook ve filtreler)

​
registrationId
string<uuid>

Kayıt UUID

Örnek:

"f7587d9e-2481-4b4c-818d-c8d1946851b7"

​
recipientId
string

Alıcı kimliği. Alıcı kimliği tekil ve US-ASCII karakter setine uygun olmalıdır.

Örnek:

"Recipient 1"

​
boundary
object

Alarm kayıt sınırı

Alarm koşulları için izlenecek coğrafi kapsamı tanımlar. Somut sınır türü type ayırt edici alanı ile seçilir; yalnızca seçilen alt türe ait alanlar gönderilmelidir.

  • ADMINISTRATIVE – il (cityId), ilçe (districtId) ve isteğe bağlı mahalle (neighborhoodId) ile tanımlanan idari sınır.
  • POLYGON – dış halka koordinatlarıyla (WGS84) tanımlanan serbest kapalı poligon.
  • H3INDEX – tek bir Uber H3 hücre adresiyle tanımlanan sınır.
​
webhook
object

Webhook yapılandırması

​
filter
object

Alarm filtreleri

Yanıt

İşlem başarılı

Kayıt cevabı (zaman damgaları ve uyarılar)

​
registrationId
string<uuid>

Kayıt UUID

Örnek:

"f7587d9e-2481-4b4c-818d-c8d1946851b7"

​
recipientId
string

Alıcı kimliği. Alıcı kimliği tekil ve US-ASCII karakter setine uygun olmalıdır.

Örnek:

"Recipient 1"

​
boundary
object

Alarm kayıt sınırı

Alarm koşulları için izlenecek coğrafi kapsamı tanımlar. Somut sınır türü type ayırt edici alanı ile seçilir; yalnızca seçilen alt türe ait alanlar gönderilmelidir.

  • ADMINISTRATIVE – il (cityId), ilçe (districtId) ve isteğe bağlı mahalle (neighborhoodId) ile tanımlanan idari sınır.
  • POLYGON – dış halka koordinatlarıyla (WGS84) tanımlanan serbest kapalı poligon.
  • H3INDEX – tek bir Uber H3 hücre adresiyle tanımlanan sınır.
​
webhook
object

Webhook yapılandırması

​
filter
object

Alarm filtreleri

​
createdAt
string<date-time>

Oluşturulma zamanı

Örnek:

"2025-01-01T10:15:30Z"

​
updatedAt
string<date-time>

Güncellenme zamanı

Örnek:

"2025-01-01T11:15:30Z"

​
warnings
string[]

Uyarılar

Örnek:
["warning-1", "warning-2"]