Get by recipient ID
curl --request GET \
--url https://api.iklim.co/v1/alarms/forecasts/get-by-recipient-id/{recipientId}import requests
url = "https://api.iklim.co/v1/alarms/forecasts/get-by-recipient-id/{recipientId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.iklim.co/v1/alarms/forecasts/get-by-recipient-id/{recipientId}', 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/forecasts/get-by-recipient-id/{recipientId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.iklim.co/v1/alarms/forecasts/get-by-recipient-id/{recipientId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.iklim.co/v1/alarms/forecasts/get-by-recipient-id/{recipientId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.iklim.co/v1/alarms/forecasts/get-by-recipient-id/{recipientId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"registrations": [
{
"registrationId": "f7587d9e-2481-4b4c-818d-c8d1946851b7",
"recipientId": "customer-system-001",
"boundary": {
"cityId": 6,
"districtId": 557
},
"forecastDays": 3,
"forecastAlarmDelivery": [
"MORNING",
"EVENING"
],
"webhook": {
"accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1",
"url": "https://api.customer.com/alerts/forecast-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": {
"precipitationThreshold": "MODERATE",
"snowFallThreshold": "LIGHT",
"windGustThreshold": "STRONG_WIND",
"hotTemperatureThreshold": "HOT_SNAP",
"coldTemperatureThreshold": "COLD_SNAP"
}
}
],
"totalRecords": 42,
"pageNumber": 0,
"pageSize": 20
}{
"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>"
]
}Get by recipient ID
Returns all forecast alarm registrations for a given recipient ID.
GET
/
v1
/
alarms
/
forecasts
/
get-by-recipient-id
/
{recipientId}
Get by recipient ID
curl --request GET \
--url https://api.iklim.co/v1/alarms/forecasts/get-by-recipient-id/{recipientId}import requests
url = "https://api.iklim.co/v1/alarms/forecasts/get-by-recipient-id/{recipientId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.iklim.co/v1/alarms/forecasts/get-by-recipient-id/{recipientId}', 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/forecasts/get-by-recipient-id/{recipientId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.iklim.co/v1/alarms/forecasts/get-by-recipient-id/{recipientId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.iklim.co/v1/alarms/forecasts/get-by-recipient-id/{recipientId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.iklim.co/v1/alarms/forecasts/get-by-recipient-id/{recipientId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"registrations": [
{
"registrationId": "f7587d9e-2481-4b4c-818d-c8d1946851b7",
"recipientId": "customer-system-001",
"boundary": {
"cityId": 6,
"districtId": 557
},
"forecastDays": 3,
"forecastAlarmDelivery": [
"MORNING",
"EVENING"
],
"webhook": {
"accountId": "2f04f1b5-1c0a-4c4e-b0a7-0ba6e9b7f2e1",
"url": "https://api.customer.com/alerts/forecast-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": {
"precipitationThreshold": "MODERATE",
"snowFallThreshold": "LIGHT",
"windGustThreshold": "STRONG_WIND",
"hotTemperatureThreshold": "HOT_SNAP",
"coldTemperatureThreshold": "COLD_SNAP"
}
}
],
"totalRecords": 42,
"pageNumber": 0,
"pageSize": 20
}{
"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>"
]
}Path Parameters
Recipient identifier
Response
OK
Paginated result set of forecast alarm registrations.
List of forecast alarm registrations on the current page.
Show child attributes
Show child attributes
Total number of matching registrations across all pages.
Example:
42
Zero-based index of the returned page.
Example:
0
Maximum number of registrations per page as originally requested.
Example:
20
⌘I