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": {
"cityId": 6,
"districtId": 557,
"neighborhoodId": 55766
},
"accountId": "1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0"
}
'import requests
url = "https://api.iklim.co/v1/alarms/geometries/page"
payload = {
"pageNumber": 0,
"pageSize": 10,
"filterByRecipientIds": ["Recipient1", "Recipient2"],
"filterByBoundary": {
"cityId": 6,
"districtId": 557,
"neighborhoodId": 55766
},
"accountId": "1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
pageNumber: 0,
pageSize: 10,
filterByRecipientIds: ['Recipient1', 'Recipient2'],
filterByBoundary: {cityId: 6, districtId: 557, neighborhoodId: 55766},
accountId: '1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0'
})
};
fetch('https://api.iklim.co/v1/alarms/geometries/page', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.iklim.co/v1/alarms/geometries/page",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pageNumber' => 0,
'pageSize' => 10,
'filterByRecipientIds' => [
'Recipient1',
'Recipient2'
],
'filterByBoundary' => [
'cityId' => 6,
'districtId' => 557,
'neighborhoodId' => 55766
],
'accountId' => '1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.iklim.co/v1/alarms/geometries/page"
payload := strings.NewReader("{\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"filterByRecipientIds\": [\n \"Recipient1\",\n \"Recipient2\"\n ],\n \"filterByBoundary\": {\n \"cityId\": 6,\n \"districtId\": 557,\n \"neighborhoodId\": 55766\n },\n \"accountId\": \"1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.iklim.co/v1/alarms/geometries/page")
.header("Content-Type", "application/json")
.body("{\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"filterByRecipientIds\": [\n \"Recipient1\",\n \"Recipient2\"\n ],\n \"filterByBoundary\": {\n \"cityId\": 6,\n \"districtId\": 557,\n \"neighborhoodId\": 55766\n },\n \"accountId\": \"1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.iklim.co/v1/alarms/geometries/page")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"filterByRecipientIds\": [\n \"Recipient1\",\n \"Recipient2\"\n ],\n \"filterByBoundary\": {\n \"cityId\": 6,\n \"districtId\": 557,\n \"neighborhoodId\": 55766\n },\n \"accountId\": \"1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0\"\n}"
response = http.request(request)
puts response.read_body{
"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": "******"
},
"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": 123,
"pageNumber": 0,
"pageSize": 10
}{
"timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
"status": "XXX",
"error": "Error Name",
"message": "Error Message",
"path": "/endpoint/uri/here",
"messages": [
"<string>"
]
}{
"timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
"status": "XXX",
"error": "Error Name",
"message": "Error Message",
"path": "/endpoint/uri/here",
"messages": [
"<string>"
]
}{
"timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
"status": "XXX",
"error": "Error Name",
"message": "Error Message",
"path": "/endpoint/uri/here",
"messages": [
"<string>"
]
}{
"timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
"status": "XXX",
"error": "Error Name",
"message": "Error Message",
"path": "/endpoint/uri/here",
"messages": [
"<string>"
]
}List registrations (paged)
Returns registrations with pagination and filters.
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": {
"cityId": 6,
"districtId": 557,
"neighborhoodId": 55766
},
"accountId": "1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0"
}
'import requests
url = "https://api.iklim.co/v1/alarms/geometries/page"
payload = {
"pageNumber": 0,
"pageSize": 10,
"filterByRecipientIds": ["Recipient1", "Recipient2"],
"filterByBoundary": {
"cityId": 6,
"districtId": 557,
"neighborhoodId": 55766
},
"accountId": "1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
pageNumber: 0,
pageSize: 10,
filterByRecipientIds: ['Recipient1', 'Recipient2'],
filterByBoundary: {cityId: 6, districtId: 557, neighborhoodId: 55766},
accountId: '1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0'
})
};
fetch('https://api.iklim.co/v1/alarms/geometries/page', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.iklim.co/v1/alarms/geometries/page",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pageNumber' => 0,
'pageSize' => 10,
'filterByRecipientIds' => [
'Recipient1',
'Recipient2'
],
'filterByBoundary' => [
'cityId' => 6,
'districtId' => 557,
'neighborhoodId' => 55766
],
'accountId' => '1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.iklim.co/v1/alarms/geometries/page"
payload := strings.NewReader("{\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"filterByRecipientIds\": [\n \"Recipient1\",\n \"Recipient2\"\n ],\n \"filterByBoundary\": {\n \"cityId\": 6,\n \"districtId\": 557,\n \"neighborhoodId\": 55766\n },\n \"accountId\": \"1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.iklim.co/v1/alarms/geometries/page")
.header("Content-Type", "application/json")
.body("{\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"filterByRecipientIds\": [\n \"Recipient1\",\n \"Recipient2\"\n ],\n \"filterByBoundary\": {\n \"cityId\": 6,\n \"districtId\": 557,\n \"neighborhoodId\": 55766\n },\n \"accountId\": \"1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.iklim.co/v1/alarms/geometries/page")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"pageNumber\": 0,\n \"pageSize\": 10,\n \"filterByRecipientIds\": [\n \"Recipient1\",\n \"Recipient2\"\n ],\n \"filterByBoundary\": {\n \"cityId\": 6,\n \"districtId\": 557,\n \"neighborhoodId\": 55766\n },\n \"accountId\": \"1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0\"\n}"
response = http.request(request)
puts response.read_body{
"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": "******"
},
"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": 123,
"pageNumber": 0,
"pageSize": 10
}{
"timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
"status": "XXX",
"error": "Error Name",
"message": "Error Message",
"path": "/endpoint/uri/here",
"messages": [
"<string>"
]
}{
"timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
"status": "XXX",
"error": "Error Name",
"message": "Error Message",
"path": "/endpoint/uri/here",
"messages": [
"<string>"
]
}{
"timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
"status": "XXX",
"error": "Error Name",
"message": "Error Message",
"path": "/endpoint/uri/here",
"messages": [
"<string>"
]
}{
"timestamp": "YYYY-mm-DDTHH:MM:SS.nnnnnnnnn",
"status": "XXX",
"error": "Error Name",
"message": "Error Message",
"path": "/endpoint/uri/here",
"messages": [
"<string>"
]
}Body
application/json
Paginated listing request for alarm registrations.
Page number (starts from 0)
Required range:
x >= 0Example:
0
Page size
Required range:
1 <= x <= 100Example:
10
Filter by Recipient Ids
Example:
["Recipient1", "Recipient2"]
Filter by Boundary
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Account UUID
Example:
"1c7f1d3d-7f06-4f40-8e9c-33b1c3f6c2e0"
⌘I