Freeboard-SK API
DELETE
Clear - cancel Alarm.
{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id")require "http/client"
url = "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}DELETE /baseUrl/signalk/v2/api/alarms/:alarmType/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/signalk/v2/api/alarms/:alarmType/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('DELETE', '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id');
echo $response->getBody();setUrl('{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/signalk/v2/api/alarms/:alarmType/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/signalk/v2/api/alarms/:alarmType/:id') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/signalk/v2/api/alarms/:alarmType/:idhttp DELETE {{baseUrl}}/signalk/v2/api/alarms/:alarmType/:idwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/signalk/v2/api/alarms/:alarmType/:idimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Raise Alarm.
{{baseUrl}}/signalk/v2/api/alarms/:alarmType
BODY json
{
"message": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/signalk/v2/api/alarms/:alarmType");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"message\": \"Person overboard!\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/signalk/v2/api/alarms/:alarmType" {:content-type :json
:form-params {:message "Person overboard!"}})require "http/client"
url = "{{baseUrl}}/signalk/v2/api/alarms/:alarmType"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"message\": \"Person overboard!\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/signalk/v2/api/alarms/:alarmType"),
Content = new StringContent("{\n \"message\": \"Person overboard!\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/signalk/v2/api/alarms/:alarmType");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"message\": \"Person overboard!\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/signalk/v2/api/alarms/:alarmType"
payload := strings.NewReader("{\n \"message\": \"Person overboard!\"\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(res)
fmt.Println(string(body))
}POST /baseUrl/signalk/v2/api/alarms/:alarmType HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 36
{
"message": "Person overboard!"
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/signalk/v2/api/alarms/:alarmType")
.setHeader("content-type", "application/json")
.setBody("{\n \"message\": \"Person overboard!\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/signalk/v2/api/alarms/:alarmType"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"message\": \"Person overboard!\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"message\": \"Person overboard!\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/signalk/v2/api/alarms/:alarmType")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/signalk/v2/api/alarms/:alarmType")
.header("content-type", "application/json")
.body("{\n \"message\": \"Person overboard!\"\n}")
.asString(); const data = JSON.stringify({
message: 'Person overboard!'
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/signalk/v2/api/alarms/:alarmType');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/signalk/v2/api/alarms/:alarmType',
headers: {'content-type': 'application/json'},
data: {message: 'Person overboard!'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/signalk/v2/api/alarms/:alarmType';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"message":"Person overboard!"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/signalk/v2/api/alarms/:alarmType',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "message": "Person overboard!"\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"message\": \"Person overboard!\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/signalk/v2/api/alarms/:alarmType")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/signalk/v2/api/alarms/:alarmType',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({message: 'Person overboard!'}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/signalk/v2/api/alarms/:alarmType',
headers: {'content-type': 'application/json'},
body: {message: 'Person overboard!'},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/signalk/v2/api/alarms/:alarmType');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
message: 'Person overboard!'
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/signalk/v2/api/alarms/:alarmType',
headers: {'content-type': 'application/json'},
data: {message: 'Person overboard!'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/signalk/v2/api/alarms/:alarmType';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"message":"Person overboard!"}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"message": @"Person overboard!" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/signalk/v2/api/alarms/:alarmType"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/signalk/v2/api/alarms/:alarmType" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"message\": \"Person overboard!\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/signalk/v2/api/alarms/:alarmType",
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([
'message' => 'Person overboard!'
]),
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;
}request('POST', '{{baseUrl}}/signalk/v2/api/alarms/:alarmType', [
'body' => '{
"message": "Person overboard!"
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/signalk/v2/api/alarms/:alarmType');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'message' => 'Person overboard!'
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'message' => 'Person overboard!'
]));
$request->setRequestUrl('{{baseUrl}}/signalk/v2/api/alarms/:alarmType');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/signalk/v2/api/alarms/:alarmType' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"message": "Person overboard!"
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/signalk/v2/api/alarms/:alarmType' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"message": "Person overboard!"
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"message\": \"Person overboard!\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/signalk/v2/api/alarms/:alarmType", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/signalk/v2/api/alarms/:alarmType"
payload = { "message": "Person overboard!" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/signalk/v2/api/alarms/:alarmType"
payload <- "{\n \"message\": \"Person overboard!\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/signalk/v2/api/alarms/:alarmType")
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 \"message\": \"Person overboard!\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/signalk/v2/api/alarms/:alarmType') do |req|
req.body = "{\n \"message\": \"Person overboard!\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/signalk/v2/api/alarms/:alarmType";
let payload = json!({"message": "Person overboard!"});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/signalk/v2/api/alarms/:alarmType \
--header 'content-type: application/json' \
--data '{
"message": "Person overboard!"
}'echo '{
"message": "Person overboard!"
}' | \
http POST {{baseUrl}}/signalk/v2/api/alarms/:alarmType \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "message": "Person overboard!"\n}' \
--output-document \
- {{baseUrl}}/signalk/v2/api/alarms/:alarmTypeimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["message": "Person overboard!"] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/signalk/v2/api/alarms/:alarmType")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Silence Alarm.
{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence")require "http/client"
url = "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence"
response = HTTP::Client.post url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/signalk/v2/api/alarms/:alarmType/:id/silence HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence")
.post(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence")
.post(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/signalk/v2/api/alarms/:alarmType/:id/silence',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence');
echo $response->getBody();setUrl('{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence' -Method POST $response = Invoke-RestMethod -Uri '{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence' -Method POST import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/signalk/v2/api/alarms/:alarmType/:id/silence")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence"
response = requests.post(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/signalk/v2/api/alarms/:alarmType/:id/silence') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silencehttp POST {{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silencewget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silenceimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/signalk/v2/api/alarms/:alarmType/:id/silence")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
DELETE
Clear - cancel Area Alarm.
{{baseUrl}}/signalk/v2/api/alarms/area/:id
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/signalk/v2/api/alarms/area/:id");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/signalk/v2/api/alarms/area/:id")require "http/client"
url = "{{baseUrl}}/signalk/v2/api/alarms/area/:id"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/signalk/v2/api/alarms/area/:id"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/signalk/v2/api/alarms/area/:id");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/signalk/v2/api/alarms/area/:id"
req, _ := http.NewRequest("DELETE", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}DELETE /baseUrl/signalk/v2/api/alarms/area/:id HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/signalk/v2/api/alarms/area/:id")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/signalk/v2/api/alarms/area/:id"))
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/signalk/v2/api/alarms/area/:id")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/signalk/v2/api/alarms/area/:id")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/signalk/v2/api/alarms/area/:id');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/signalk/v2/api/alarms/area/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/signalk/v2/api/alarms/area/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/signalk/v2/api/alarms/area/:id',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/signalk/v2/api/alarms/area/:id")
.delete(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/signalk/v2/api/alarms/area/:id',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/signalk/v2/api/alarms/area/:id'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/signalk/v2/api/alarms/area/:id');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/signalk/v2/api/alarms/area/:id'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/signalk/v2/api/alarms/area/:id';
const options = {method: 'DELETE'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/signalk/v2/api/alarms/area/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/signalk/v2/api/alarms/area/:id" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/signalk/v2/api/alarms/area/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('DELETE', '{{baseUrl}}/signalk/v2/api/alarms/area/:id');
echo $response->getBody();setUrl('{{baseUrl}}/signalk/v2/api/alarms/area/:id');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/signalk/v2/api/alarms/area/:id');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/signalk/v2/api/alarms/area/:id' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/signalk/v2/api/alarms/area/:id' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/signalk/v2/api/alarms/area/:id")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/signalk/v2/api/alarms/area/:id"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/signalk/v2/api/alarms/area/:id"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/signalk/v2/api/alarms/area/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/signalk/v2/api/alarms/area/:id') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/signalk/v2/api/alarms/area/:id";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/signalk/v2/api/alarms/area/:idhttp DELETE {{baseUrl}}/signalk/v2/api/alarms/area/:idwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/signalk/v2/api/alarms/area/:idimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/signalk/v2/api/alarms/area/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Set Alarm area.
{{baseUrl}}/signalk/v2/api/alarms/area
BODY json
{
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/signalk/v2/api/alarms/area");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/signalk/v2/api/alarms/area" {:content-type :json
:form-params {:geometry ""
:trigger ""
:coords [{:latitude ""
:longitude ""}]
:center {}
:radius ""
:name ""}})require "http/client"
url = "{{baseUrl}}/signalk/v2/api/alarms/area"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/signalk/v2/api/alarms/area"),
Content = new StringContent("{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/signalk/v2/api/alarms/area");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/signalk/v2/api/alarms/area"
payload := strings.NewReader("{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\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(res)
fmt.Println(string(body))
}POST /baseUrl/signalk/v2/api/alarms/area HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 158
{
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/signalk/v2/api/alarms/area")
.setHeader("content-type", "application/json")
.setBody("{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/signalk/v2/api/alarms/area"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/signalk/v2/api/alarms/area")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/signalk/v2/api/alarms/area")
.header("content-type", "application/json")
.body("{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}")
.asString(); const data = JSON.stringify({
geometry: '',
trigger: '',
coords: [
{
latitude: '',
longitude: ''
}
],
center: {},
radius: '',
name: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/signalk/v2/api/alarms/area');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/signalk/v2/api/alarms/area',
headers: {'content-type': 'application/json'},
data: {
geometry: '',
trigger: '',
coords: [{latitude: '', longitude: ''}],
center: {},
radius: '',
name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/signalk/v2/api/alarms/area';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"geometry":"","trigger":"","coords":[{"latitude":"","longitude":""}],"center":{},"radius":"","name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/signalk/v2/api/alarms/area',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "geometry": "",\n "trigger": "",\n "coords": [\n {\n "latitude": "",\n "longitude": ""\n }\n ],\n "center": {},\n "radius": "",\n "name": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/signalk/v2/api/alarms/area")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/signalk/v2/api/alarms/area',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
geometry: '',
trigger: '',
coords: [{latitude: '', longitude: ''}],
center: {},
radius: '',
name: ''
}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/signalk/v2/api/alarms/area',
headers: {'content-type': 'application/json'},
body: {
geometry: '',
trigger: '',
coords: [{latitude: '', longitude: ''}],
center: {},
radius: '',
name: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/signalk/v2/api/alarms/area');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
geometry: '',
trigger: '',
coords: [
{
latitude: '',
longitude: ''
}
],
center: {},
radius: '',
name: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/signalk/v2/api/alarms/area',
headers: {'content-type': 'application/json'},
data: {
geometry: '',
trigger: '',
coords: [{latitude: '', longitude: ''}],
center: {},
radius: '',
name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/signalk/v2/api/alarms/area';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"geometry":"","trigger":"","coords":[{"latitude":"","longitude":""}],"center":{},"radius":"","name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"geometry": @"",
@"trigger": @"",
@"coords": @[ @{ @"latitude": @"", @"longitude": @"" } ],
@"center": @{ },
@"radius": @"",
@"name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/signalk/v2/api/alarms/area"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/signalk/v2/api/alarms/area" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/signalk/v2/api/alarms/area",
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([
'geometry' => '',
'trigger' => '',
'coords' => [
[
'latitude' => '',
'longitude' => ''
]
],
'center' => [
],
'radius' => '',
'name' => ''
]),
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;
}request('POST', '{{baseUrl}}/signalk/v2/api/alarms/area', [
'body' => '{
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/signalk/v2/api/alarms/area');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'geometry' => '',
'trigger' => '',
'coords' => [
[
'latitude' => '',
'longitude' => ''
]
],
'center' => [
],
'radius' => '',
'name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'geometry' => '',
'trigger' => '',
'coords' => [
[
'latitude' => '',
'longitude' => ''
]
],
'center' => [
],
'radius' => '',
'name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/signalk/v2/api/alarms/area');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/signalk/v2/api/alarms/area' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/signalk/v2/api/alarms/area' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/signalk/v2/api/alarms/area", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/signalk/v2/api/alarms/area"
payload = {
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/signalk/v2/api/alarms/area"
payload <- "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/signalk/v2/api/alarms/area")
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 \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/signalk/v2/api/alarms/area') do |req|
req.body = "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/signalk/v2/api/alarms/area";
let payload = json!({
"geometry": "",
"trigger": "",
"coords": (
json!({
"latitude": "",
"longitude": ""
})
),
"center": json!({}),
"radius": "",
"name": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/signalk/v2/api/alarms/area \
--header 'content-type: application/json' \
--data '{
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}'echo '{
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}' | \
http POST {{baseUrl}}/signalk/v2/api/alarms/area \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "geometry": "",\n "trigger": "",\n "coords": [\n {\n "latitude": "",\n "longitude": ""\n }\n ],\n "center": {},\n "radius": "",\n "name": ""\n}' \
--output-document \
- {{baseUrl}}/signalk/v2/api/alarms/areaimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"geometry": "",
"trigger": "",
"coords": [
[
"latitude": "",
"longitude": ""
]
],
"center": [],
"radius": "",
"name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/signalk/v2/api/alarms/area")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
POST
Silence Area Alarm.
{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence")require "http/client"
url = "{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence"
response = HTTP::Client.post url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/signalk/v2/api/alarms/area/:id/silence HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence")
.post(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence")
.post(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/signalk/v2/api/alarms/area/:id/silence',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence');
echo $response->getBody();setUrl('{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence' -Method POST $response = Invoke-RestMethod -Uri '{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence' -Method POST import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/signalk/v2/api/alarms/area/:id/silence")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence"
response = requests.post(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/signalk/v2/api/alarms/area/:id/silence') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/signalk/v2/api/alarms/area/:id/silencehttp POST {{baseUrl}}/signalk/v2/api/alarms/area/:id/silencewget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/signalk/v2/api/alarms/area/:id/silenceimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/signalk/v2/api/alarms/area/:id/silence")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
PUT
Update Alarm area OR Set the `Region` resource with the supplied identifier as the alarm area.
{{baseUrl}}/signalk/v2/api/alarms/area/:id
BODY json
{
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/signalk/v2/api/alarms/area/:id");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/signalk/v2/api/alarms/area/:id" {:content-type :json
:form-params {:geometry ""
:trigger ""
:coords [{:latitude ""
:longitude ""}]
:center {}
:radius ""
:name ""}})require "http/client"
url = "{{baseUrl}}/signalk/v2/api/alarms/area/:id"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/signalk/v2/api/alarms/area/:id"),
Content = new StringContent("{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/signalk/v2/api/alarms/area/:id");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/signalk/v2/api/alarms/area/:id"
payload := strings.NewReader("{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}")
req, _ := http.NewRequest("PUT", 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(res)
fmt.Println(string(body))
}PUT /baseUrl/signalk/v2/api/alarms/area/:id HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 158
{
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/signalk/v2/api/alarms/area/:id")
.setHeader("content-type", "application/json")
.setBody("{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/signalk/v2/api/alarms/area/:id"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/signalk/v2/api/alarms/area/:id")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/signalk/v2/api/alarms/area/:id")
.header("content-type", "application/json")
.body("{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}")
.asString(); const data = JSON.stringify({
geometry: '',
trigger: '',
coords: [
{
latitude: '',
longitude: ''
}
],
center: {},
radius: '',
name: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/signalk/v2/api/alarms/area/:id');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/signalk/v2/api/alarms/area/:id',
headers: {'content-type': 'application/json'},
data: {
geometry: '',
trigger: '',
coords: [{latitude: '', longitude: ''}],
center: {},
radius: '',
name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/signalk/v2/api/alarms/area/:id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"geometry":"","trigger":"","coords":[{"latitude":"","longitude":""}],"center":{},"radius":"","name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/signalk/v2/api/alarms/area/:id',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "geometry": "",\n "trigger": "",\n "coords": [\n {\n "latitude": "",\n "longitude": ""\n }\n ],\n "center": {},\n "radius": "",\n "name": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/signalk/v2/api/alarms/area/:id")
.put(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/signalk/v2/api/alarms/area/:id',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
geometry: '',
trigger: '',
coords: [{latitude: '', longitude: ''}],
center: {},
radius: '',
name: ''
}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/signalk/v2/api/alarms/area/:id',
headers: {'content-type': 'application/json'},
body: {
geometry: '',
trigger: '',
coords: [{latitude: '', longitude: ''}],
center: {},
radius: '',
name: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/signalk/v2/api/alarms/area/:id');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
geometry: '',
trigger: '',
coords: [
{
latitude: '',
longitude: ''
}
],
center: {},
radius: '',
name: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/signalk/v2/api/alarms/area/:id',
headers: {'content-type': 'application/json'},
data: {
geometry: '',
trigger: '',
coords: [{latitude: '', longitude: ''}],
center: {},
radius: '',
name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/signalk/v2/api/alarms/area/:id';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"geometry":"","trigger":"","coords":[{"latitude":"","longitude":""}],"center":{},"radius":"","name":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"geometry": @"",
@"trigger": @"",
@"coords": @[ @{ @"latitude": @"", @"longitude": @"" } ],
@"center": @{ },
@"radius": @"",
@"name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/signalk/v2/api/alarms/area/:id"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/signalk/v2/api/alarms/area/:id" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/signalk/v2/api/alarms/area/:id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'geometry' => '',
'trigger' => '',
'coords' => [
[
'latitude' => '',
'longitude' => ''
]
],
'center' => [
],
'radius' => '',
'name' => ''
]),
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;
}request('PUT', '{{baseUrl}}/signalk/v2/api/alarms/area/:id', [
'body' => '{
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/signalk/v2/api/alarms/area/:id');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'geometry' => '',
'trigger' => '',
'coords' => [
[
'latitude' => '',
'longitude' => ''
]
],
'center' => [
],
'radius' => '',
'name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'geometry' => '',
'trigger' => '',
'coords' => [
[
'latitude' => '',
'longitude' => ''
]
],
'center' => [
],
'radius' => '',
'name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/signalk/v2/api/alarms/area/:id');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/signalk/v2/api/alarms/area/:id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/signalk/v2/api/alarms/area/:id' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/signalk/v2/api/alarms/area/:id", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/signalk/v2/api/alarms/area/:id"
payload = {
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/signalk/v2/api/alarms/area/:id"
payload <- "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/signalk/v2/api/alarms/area/:id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/signalk/v2/api/alarms/area/:id') do |req|
req.body = "{\n \"geometry\": \"\",\n \"trigger\": \"\",\n \"coords\": [\n {\n \"latitude\": \"\",\n \"longitude\": \"\"\n }\n ],\n \"center\": {},\n \"radius\": \"\",\n \"name\": \"\"\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/signalk/v2/api/alarms/area/:id";
let payload = json!({
"geometry": "",
"trigger": "",
"coords": (
json!({
"latitude": "",
"longitude": ""
})
),
"center": json!({}),
"radius": "",
"name": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/signalk/v2/api/alarms/area/:id \
--header 'content-type: application/json' \
--data '{
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}'echo '{
"geometry": "",
"trigger": "",
"coords": [
{
"latitude": "",
"longitude": ""
}
],
"center": {},
"radius": "",
"name": ""
}' | \
http PUT {{baseUrl}}/signalk/v2/api/alarms/area/:id \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "geometry": "",\n "trigger": "",\n "coords": [\n {\n "latitude": "",\n "longitude": ""\n }\n ],\n "center": {},\n "radius": "",\n "name": ""\n}' \
--output-document \
- {{baseUrl}}/signalk/v2/api/alarms/area/:idimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"geometry": "",
"trigger": "",
"coords": [
[
"latitude": "",
"longitude": ""
]
],
"center": [],
"radius": "",
"name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/signalk/v2/api/alarms/area/:id")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()