HERE Tracking
PUT
Creates an alias
{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId")
require "http/client"
url = "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/aliases/v2/:trackingId/:type/:externalId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId"))
.method("PUT", 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}}/aliases/v2/:trackingId/:type/:externalId")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId")
.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('PUT', '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId';
const options = {method: 'PUT'};
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}}/aliases/v2/:trackingId/:type/:externalId',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases/v2/:trackingId/:type/:externalId',
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: 'PUT',
url: '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId');
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}}/aliases/v2/:trackingId/:type/:externalId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId';
const options = {method: 'PUT'};
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}}/aliases/v2/:trackingId/:type/:externalId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/aliases/v2/:trackingId/:type/:externalId" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId');
echo $response->getBody();
setUrl('{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/aliases/v2/:trackingId/:type/:externalId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/aliases/v2/:trackingId/:type/:externalId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/aliases/v2/:trackingId/:type/:externalId
http PUT {{baseUrl}}/aliases/v2/:trackingId/:type/:externalId
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/aliases/v2/:trackingId/:type/:externalId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 409,
"details": {
"hereErrorCode": 404306
},
"error": "Conflict",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource already exists."
}
PUT
Creates multiple aliases for a device
{{baseUrl}}/aliases/v2/:trackingId/batch
BODY json
{
"aliases": {}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases/v2/:trackingId/batch");
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 \"aliases\": {}\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/aliases/v2/:trackingId/batch" {:content-type :json
:form-params {:aliases {}}})
require "http/client"
url = "{{baseUrl}}/aliases/v2/:trackingId/batch"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"aliases\": {}\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/aliases/v2/:trackingId/batch"),
Content = new StringContent("{\n \"aliases\": {}\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}}/aliases/v2/:trackingId/batch");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"aliases\": {}\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases/v2/:trackingId/batch"
payload := strings.NewReader("{\n \"aliases\": {}\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/aliases/v2/:trackingId/batch HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 19
{
"aliases": {}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/aliases/v2/:trackingId/batch")
.setHeader("content-type", "application/json")
.setBody("{\n \"aliases\": {}\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases/v2/:trackingId/batch"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"aliases\": {}\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 \"aliases\": {}\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/aliases/v2/:trackingId/batch")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/aliases/v2/:trackingId/batch")
.header("content-type", "application/json")
.body("{\n \"aliases\": {}\n}")
.asString();
const data = JSON.stringify({
aliases: {}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/aliases/v2/:trackingId/batch');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/aliases/v2/:trackingId/batch',
headers: {'content-type': 'application/json'},
data: {aliases: {}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases/v2/:trackingId/batch';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"aliases":{}}'
};
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}}/aliases/v2/:trackingId/batch',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "aliases": {}\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"aliases\": {}\n}")
val request = Request.Builder()
.url("{{baseUrl}}/aliases/v2/:trackingId/batch")
.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/aliases/v2/:trackingId/batch',
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({aliases: {}}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/aliases/v2/:trackingId/batch',
headers: {'content-type': 'application/json'},
body: {aliases: {}},
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}}/aliases/v2/:trackingId/batch');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
aliases: {}
});
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}}/aliases/v2/:trackingId/batch',
headers: {'content-type': 'application/json'},
data: {aliases: {}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases/v2/:trackingId/batch';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"aliases":{}}'
};
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 = @{ @"aliases": @{ } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/aliases/v2/:trackingId/batch"]
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}}/aliases/v2/:trackingId/batch" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"aliases\": {}\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases/v2/:trackingId/batch",
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([
'aliases' => [
]
]),
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}}/aliases/v2/:trackingId/batch', [
'body' => '{
"aliases": {}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/aliases/v2/:trackingId/batch');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'aliases' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'aliases' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/aliases/v2/:trackingId/batch');
$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}}/aliases/v2/:trackingId/batch' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"aliases": {}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases/v2/:trackingId/batch' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"aliases": {}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"aliases\": {}\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/aliases/v2/:trackingId/batch", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases/v2/:trackingId/batch"
payload = { "aliases": {} }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases/v2/:trackingId/batch"
payload <- "{\n \"aliases\": {}\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}}/aliases/v2/:trackingId/batch")
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 \"aliases\": {}\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/aliases/v2/:trackingId/batch') do |req|
req.body = "{\n \"aliases\": {}\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases/v2/:trackingId/batch";
let payload = json!({"aliases": json!({})});
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}}/aliases/v2/:trackingId/batch \
--header 'content-type: application/json' \
--data '{
"aliases": {}
}'
echo '{
"aliases": {}
}' | \
http PUT {{baseUrl}}/aliases/v2/:trackingId/batch \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "aliases": {}\n}' \
--output-document \
- {{baseUrl}}/aliases/v2/:trackingId/batch
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["aliases": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases/v2/:trackingId/batch")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 409,
"details": {
"hereErrorCode": 404306
},
"error": "Conflict",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource already exists."
}
DELETE
Deletes all aliases of a device
{{baseUrl}}/aliases/v2/:trackingId
HEADERS
x-confirm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases/v2/:trackingId");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-confirm: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/aliases/v2/:trackingId" {:headers {:x-confirm ""}})
require "http/client"
url = "{{baseUrl}}/aliases/v2/:trackingId"
headers = HTTP::Headers{
"x-confirm" => ""
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/aliases/v2/:trackingId"),
Headers =
{
{ "x-confirm", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases/v2/:trackingId");
var request = new RestRequest("", Method.Delete);
request.AddHeader("x-confirm", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases/v2/:trackingId"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-confirm", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/aliases/v2/:trackingId HTTP/1.1
X-Confirm:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/aliases/v2/:trackingId")
.setHeader("x-confirm", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases/v2/:trackingId"))
.header("x-confirm", "")
.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}}/aliases/v2/:trackingId")
.delete(null)
.addHeader("x-confirm", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/aliases/v2/:trackingId")
.header("x-confirm", "")
.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}}/aliases/v2/:trackingId');
xhr.setRequestHeader('x-confirm', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/aliases/v2/:trackingId',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases/v2/:trackingId';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
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}}/aliases/v2/:trackingId',
method: 'DELETE',
headers: {
'x-confirm': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/aliases/v2/:trackingId")
.delete(null)
.addHeader("x-confirm", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases/v2/:trackingId',
headers: {
'x-confirm': ''
}
};
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}}/aliases/v2/:trackingId',
headers: {'x-confirm': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/aliases/v2/:trackingId');
req.headers({
'x-confirm': ''
});
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}}/aliases/v2/:trackingId',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases/v2/:trackingId';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-confirm": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/aliases/v2/:trackingId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
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}}/aliases/v2/:trackingId" in
let headers = Header.add (Header.init ()) "x-confirm" "" in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases/v2/:trackingId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"x-confirm: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/aliases/v2/:trackingId', [
'headers' => [
'x-confirm' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/aliases/v2/:trackingId');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'x-confirm' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/aliases/v2/:trackingId');
$request->setRequestMethod('DELETE');
$request->setHeaders([
'x-confirm' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases/v2/:trackingId' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases/v2/:trackingId' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'x-confirm': "" }
conn.request("DELETE", "/baseUrl/aliases/v2/:trackingId", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases/v2/:trackingId"
headers = {"x-confirm": ""}
response = requests.delete(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases/v2/:trackingId"
response <- VERB("DELETE", url, add_headers('x-confirm' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases/v2/:trackingId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-confirm"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/aliases/v2/:trackingId') do |req|
req.headers['x-confirm'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases/v2/:trackingId";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-confirm", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/aliases/v2/:trackingId \
--header 'x-confirm: '
http DELETE {{baseUrl}}/aliases/v2/:trackingId \
x-confirm:''
wget --quiet \
--method DELETE \
--header 'x-confirm: ' \
--output-document \
- {{baseUrl}}/aliases/v2/:trackingId
import Foundation
let headers = ["x-confirm": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases/v2/:trackingId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Deletes all aliases of a specified type for a device
{{baseUrl}}/aliases/v2/:trackingId/:type
HEADERS
x-confirm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases/v2/:trackingId/:type");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-confirm: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/aliases/v2/:trackingId/:type" {:headers {:x-confirm ""}})
require "http/client"
url = "{{baseUrl}}/aliases/v2/:trackingId/:type"
headers = HTTP::Headers{
"x-confirm" => ""
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/aliases/v2/:trackingId/:type"),
Headers =
{
{ "x-confirm", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases/v2/:trackingId/:type");
var request = new RestRequest("", Method.Delete);
request.AddHeader("x-confirm", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases/v2/:trackingId/:type"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-confirm", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/aliases/v2/:trackingId/:type HTTP/1.1
X-Confirm:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/aliases/v2/:trackingId/:type")
.setHeader("x-confirm", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases/v2/:trackingId/:type"))
.header("x-confirm", "")
.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}}/aliases/v2/:trackingId/:type")
.delete(null)
.addHeader("x-confirm", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/aliases/v2/:trackingId/:type")
.header("x-confirm", "")
.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}}/aliases/v2/:trackingId/:type');
xhr.setRequestHeader('x-confirm', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/aliases/v2/:trackingId/:type',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases/v2/:trackingId/:type';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
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}}/aliases/v2/:trackingId/:type',
method: 'DELETE',
headers: {
'x-confirm': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/aliases/v2/:trackingId/:type")
.delete(null)
.addHeader("x-confirm", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases/v2/:trackingId/:type',
headers: {
'x-confirm': ''
}
};
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}}/aliases/v2/:trackingId/:type',
headers: {'x-confirm': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/aliases/v2/:trackingId/:type');
req.headers({
'x-confirm': ''
});
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}}/aliases/v2/:trackingId/:type',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases/v2/:trackingId/:type';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-confirm": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/aliases/v2/:trackingId/:type"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
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}}/aliases/v2/:trackingId/:type" in
let headers = Header.add (Header.init ()) "x-confirm" "" in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases/v2/:trackingId/:type",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"x-confirm: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/aliases/v2/:trackingId/:type', [
'headers' => [
'x-confirm' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/aliases/v2/:trackingId/:type');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'x-confirm' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/aliases/v2/:trackingId/:type');
$request->setRequestMethod('DELETE');
$request->setHeaders([
'x-confirm' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases/v2/:trackingId/:type' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases/v2/:trackingId/:type' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'x-confirm': "" }
conn.request("DELETE", "/baseUrl/aliases/v2/:trackingId/:type", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases/v2/:trackingId/:type"
headers = {"x-confirm": ""}
response = requests.delete(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases/v2/:trackingId/:type"
response <- VERB("DELETE", url, add_headers('x-confirm' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases/v2/:trackingId/:type")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-confirm"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/aliases/v2/:trackingId/:type') do |req|
req.headers['x-confirm'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases/v2/:trackingId/:type";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-confirm", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/aliases/v2/:trackingId/:type \
--header 'x-confirm: '
http DELETE {{baseUrl}}/aliases/v2/:trackingId/:type \
x-confirm:''
wget --quiet \
--method DELETE \
--header 'x-confirm: ' \
--output-document \
- {{baseUrl}}/aliases/v2/:trackingId/:type
import Foundation
let headers = ["x-confirm": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases/v2/:trackingId/:type")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Deletes an alias
{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId")
require "http/client"
url = "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId"
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/aliases/v2/:trackingId/:type/:externalId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId"))
.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}}/aliases/v2/:trackingId/:type/:externalId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId")
.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}}/aliases/v2/:trackingId/:type/:externalId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId';
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}}/aliases/v2/:trackingId/:type/:externalId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases/v2/:trackingId/:type/:externalId',
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}}/aliases/v2/:trackingId/:type/:externalId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId');
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}}/aliases/v2/:trackingId/:type/:externalId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId';
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}}/aliases/v2/:trackingId/:type/:externalId"]
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}}/aliases/v2/:trackingId/:type/:externalId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId",
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}}/aliases/v2/:trackingId/:type/:externalId');
echo $response->getBody();
setUrl('{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/aliases/v2/:trackingId/:type/:externalId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/aliases/v2/:trackingId/:type/:externalId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId";
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}}/aliases/v2/:trackingId/:type/:externalId
http DELETE {{baseUrl}}/aliases/v2/:trackingId/:type/:externalId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/aliases/v2/:trackingId/:type/:externalId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases/v2/:trackingId/:type/:externalId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets all aliases of a device
{{baseUrl}}/aliases/v2/:trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases/v2/:trackingId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/aliases/v2/:trackingId")
require "http/client"
url = "{{baseUrl}}/aliases/v2/:trackingId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/aliases/v2/:trackingId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases/v2/:trackingId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases/v2/:trackingId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/aliases/v2/:trackingId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/aliases/v2/:trackingId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases/v2/:trackingId"))
.method("GET", 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}}/aliases/v2/:trackingId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/aliases/v2/:trackingId")
.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('GET', '{{baseUrl}}/aliases/v2/:trackingId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/aliases/v2/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases/v2/:trackingId';
const options = {method: 'GET'};
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}}/aliases/v2/:trackingId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/aliases/v2/:trackingId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases/v2/:trackingId',
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: 'GET', url: '{{baseUrl}}/aliases/v2/:trackingId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/aliases/v2/:trackingId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/aliases/v2/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases/v2/:trackingId';
const options = {method: 'GET'};
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}}/aliases/v2/:trackingId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/aliases/v2/:trackingId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases/v2/:trackingId",
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;
}
request('GET', '{{baseUrl}}/aliases/v2/:trackingId');
echo $response->getBody();
setUrl('{{baseUrl}}/aliases/v2/:trackingId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/aliases/v2/:trackingId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases/v2/:trackingId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases/v2/:trackingId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/aliases/v2/:trackingId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases/v2/:trackingId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases/v2/:trackingId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases/v2/:trackingId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/aliases/v2/:trackingId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases/v2/:trackingId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/aliases/v2/:trackingId
http GET {{baseUrl}}/aliases/v2/:trackingId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/aliases/v2/:trackingId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases/v2/:trackingId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"cargoId": [
"123-456"
],
"engines": [
"de7a0e9a-2e86-11e8-b20f-6c400892e894",
"dfee3968-2e86-11e8-b4e0-6c400892e894"
]
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets all aliases of a specified type for a device
{{baseUrl}}/aliases/v2/:trackingId/:type
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases/v2/:trackingId/:type");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/aliases/v2/:trackingId/:type")
require "http/client"
url = "{{baseUrl}}/aliases/v2/:trackingId/:type"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/aliases/v2/:trackingId/:type"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases/v2/:trackingId/:type");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases/v2/:trackingId/:type"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/aliases/v2/:trackingId/:type HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/aliases/v2/:trackingId/:type")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases/v2/:trackingId/:type"))
.method("GET", 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}}/aliases/v2/:trackingId/:type")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/aliases/v2/:trackingId/:type")
.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('GET', '{{baseUrl}}/aliases/v2/:trackingId/:type');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/aliases/v2/:trackingId/:type'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases/v2/:trackingId/:type';
const options = {method: 'GET'};
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}}/aliases/v2/:trackingId/:type',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/aliases/v2/:trackingId/:type")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases/v2/:trackingId/:type',
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: 'GET', url: '{{baseUrl}}/aliases/v2/:trackingId/:type'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/aliases/v2/:trackingId/:type');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/aliases/v2/:trackingId/:type'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases/v2/:trackingId/:type';
const options = {method: 'GET'};
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}}/aliases/v2/:trackingId/:type"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/aliases/v2/:trackingId/:type" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases/v2/:trackingId/:type",
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;
}
request('GET', '{{baseUrl}}/aliases/v2/:trackingId/:type');
echo $response->getBody();
setUrl('{{baseUrl}}/aliases/v2/:trackingId/:type');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/aliases/v2/:trackingId/:type');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases/v2/:trackingId/:type' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases/v2/:trackingId/:type' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/aliases/v2/:trackingId/:type")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases/v2/:trackingId/:type"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases/v2/:trackingId/:type"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases/v2/:trackingId/:type")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/aliases/v2/:trackingId/:type') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases/v2/:trackingId/:type";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/aliases/v2/:trackingId/:type
http GET {{baseUrl}}/aliases/v2/:trackingId/:type
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/aliases/v2/:trackingId/:type
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases/v2/:trackingId/:type")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"cargoId": [
"123-456"
]
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets all aliases
{{baseUrl}}/aliases/v2
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases/v2");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/aliases/v2")
require "http/client"
url = "{{baseUrl}}/aliases/v2"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/aliases/v2"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases/v2");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases/v2"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/aliases/v2 HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/aliases/v2")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases/v2"))
.method("GET", 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}}/aliases/v2")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/aliases/v2")
.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('GET', '{{baseUrl}}/aliases/v2');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/aliases/v2'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases/v2';
const options = {method: 'GET'};
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}}/aliases/v2',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/aliases/v2")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases/v2',
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: 'GET', url: '{{baseUrl}}/aliases/v2'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/aliases/v2');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/aliases/v2'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases/v2';
const options = {method: 'GET'};
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}}/aliases/v2"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/aliases/v2" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases/v2",
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;
}
request('GET', '{{baseUrl}}/aliases/v2');
echo $response->getBody();
setUrl('{{baseUrl}}/aliases/v2');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/aliases/v2');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases/v2' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases/v2' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/aliases/v2")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases/v2"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases/v2"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases/v2")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/aliases/v2') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases/v2";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/aliases/v2
http GET {{baseUrl}}/aliases/v2
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/aliases/v2
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases/v2")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": [
{
"aliases": {
"cargoId": [
"123-456"
],
"engines": [
"de7a0e9a-2e86-11e8-b20f-6c400892e894",
"dfee3968-2e86-11e8-b4e0-6c400892e894"
]
},
"trackingId": "HERE-c47c0d1d-89fd-4961-b341-3eb109f58d19"
},
{
"aliases": {
"engines": [
"5219bfc6-9779-4901-922a-e53a7c01037e"
]
},
"trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
}
]
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets service health
{{baseUrl}}/aliases/v2/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases/v2/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/aliases/v2/health")
require "http/client"
url = "{{baseUrl}}/aliases/v2/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/aliases/v2/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases/v2/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases/v2/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/aliases/v2/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/aliases/v2/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases/v2/health"))
.method("GET", 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}}/aliases/v2/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/aliases/v2/health")
.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('GET', '{{baseUrl}}/aliases/v2/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/aliases/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases/v2/health';
const options = {method: 'GET'};
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}}/aliases/v2/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/aliases/v2/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases/v2/health',
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: 'GET', url: '{{baseUrl}}/aliases/v2/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/aliases/v2/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/aliases/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases/v2/health';
const options = {method: 'GET'};
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}}/aliases/v2/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/aliases/v2/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases/v2/health",
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;
}
request('GET', '{{baseUrl}}/aliases/v2/health');
echo $response->getBody();
setUrl('{{baseUrl}}/aliases/v2/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/aliases/v2/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases/v2/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases/v2/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/aliases/v2/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases/v2/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases/v2/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases/v2/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/aliases/v2/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases/v2/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/aliases/v2/health
http GET {{baseUrl}}/aliases/v2/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/aliases/v2/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases/v2/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version
{{baseUrl}}/aliases/v2/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases/v2/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/aliases/v2/version")
require "http/client"
url = "{{baseUrl}}/aliases/v2/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/aliases/v2/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases/v2/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases/v2/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/aliases/v2/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/aliases/v2/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases/v2/version"))
.method("GET", 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}}/aliases/v2/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/aliases/v2/version")
.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('GET', '{{baseUrl}}/aliases/v2/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/aliases/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases/v2/version';
const options = {method: 'GET'};
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}}/aliases/v2/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/aliases/v2/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases/v2/version',
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: 'GET', url: '{{baseUrl}}/aliases/v2/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/aliases/v2/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/aliases/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases/v2/version';
const options = {method: 'GET'};
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}}/aliases/v2/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/aliases/v2/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases/v2/version",
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;
}
request('GET', '{{baseUrl}}/aliases/v2/version');
echo $response->getBody();
setUrl('{{baseUrl}}/aliases/v2/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/aliases/v2/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases/v2/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases/v2/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/aliases/v2/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases/v2/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases/v2/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases/v2/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/aliases/v2/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases/v2/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/aliases/v2/version
http GET {{baseUrl}}/aliases/v2/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/aliases/v2/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases/v2/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets the tracking ID associated with an alias
{{baseUrl}}/aliases/v2/trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/aliases/v2/trackingId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/aliases/v2/trackingId")
require "http/client"
url = "{{baseUrl}}/aliases/v2/trackingId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/aliases/v2/trackingId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/aliases/v2/trackingId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/aliases/v2/trackingId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/aliases/v2/trackingId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/aliases/v2/trackingId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/aliases/v2/trackingId"))
.method("GET", 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}}/aliases/v2/trackingId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/aliases/v2/trackingId")
.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('GET', '{{baseUrl}}/aliases/v2/trackingId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/aliases/v2/trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/aliases/v2/trackingId';
const options = {method: 'GET'};
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}}/aliases/v2/trackingId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/aliases/v2/trackingId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/aliases/v2/trackingId',
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: 'GET', url: '{{baseUrl}}/aliases/v2/trackingId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/aliases/v2/trackingId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/aliases/v2/trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/aliases/v2/trackingId';
const options = {method: 'GET'};
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}}/aliases/v2/trackingId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/aliases/v2/trackingId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/aliases/v2/trackingId",
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;
}
request('GET', '{{baseUrl}}/aliases/v2/trackingId');
echo $response->getBody();
setUrl('{{baseUrl}}/aliases/v2/trackingId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/aliases/v2/trackingId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/aliases/v2/trackingId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/aliases/v2/trackingId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/aliases/v2/trackingId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/aliases/v2/trackingId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/aliases/v2/trackingId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/aliases/v2/trackingId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/aliases/v2/trackingId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/aliases/v2/trackingId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/aliases/v2/trackingId
http GET {{baseUrl}}/aliases/v2/trackingId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/aliases/v2/trackingId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/aliases/v2/trackingId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
PUT
Associates a device to a geofence
{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId")
require "http/client"
url = "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/associations/v3/:trackingId/geofences/:geofenceId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId"))
.method("PUT", 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}}/associations/v3/:trackingId/geofences/:geofenceId")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId")
.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('PUT', '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId';
const options = {method: 'PUT'};
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}}/associations/v3/:trackingId/geofences/:geofenceId',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/associations/v3/:trackingId/geofences/:geofenceId',
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: 'PUT',
url: '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId');
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}}/associations/v3/:trackingId/geofences/:geofenceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId';
const options = {method: 'PUT'};
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}}/associations/v3/:trackingId/geofences/:geofenceId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/associations/v3/:trackingId/geofences/:geofenceId" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId');
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/associations/v3/:trackingId/geofences/:geofenceId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/associations/v3/:trackingId/geofences/:geofenceId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId
http PUT {{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
PUT
Associates a device to a rule
{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId")
require "http/client"
url = "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/associations/v3/:trackingId/rules/:ruleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId"))
.method("PUT", 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}}/associations/v3/:trackingId/rules/:ruleId")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId")
.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('PUT', '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId';
const options = {method: 'PUT'};
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}}/associations/v3/:trackingId/rules/:ruleId',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/associations/v3/:trackingId/rules/:ruleId',
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: 'PUT',
url: '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId');
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}}/associations/v3/:trackingId/rules/:ruleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId';
const options = {method: 'PUT'};
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}}/associations/v3/:trackingId/rules/:ruleId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/associations/v3/:trackingId/rules/:ruleId" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId');
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/associations/v3/:trackingId/rules/:ruleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/associations/v3/:trackingId/rules/:ruleId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/associations/v3/:trackingId/rules/:ruleId
http PUT {{baseUrl}}/associations/v3/:trackingId/rules/:ruleId
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/associations/v3/:trackingId/rules/:ruleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
PUT
Associates a device with a sensor rule
{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId")
require "http/client"
url = "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/associations/v3/:trackingId/sensors/:sensorRuleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId"))
.method("PUT", 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}}/associations/v3/:trackingId/sensors/:sensorRuleId")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId")
.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('PUT', '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId';
const options = {method: 'PUT'};
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}}/associations/v3/:trackingId/sensors/:sensorRuleId',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/associations/v3/:trackingId/sensors/:sensorRuleId',
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: 'PUT',
url: '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId');
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}}/associations/v3/:trackingId/sensors/:sensorRuleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId';
const options = {method: 'PUT'};
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}}/associations/v3/:trackingId/sensors/:sensorRuleId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/associations/v3/:trackingId/sensors/:sensorRuleId" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId');
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/associations/v3/:trackingId/sensors/:sensorRuleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/associations/v3/:trackingId/sensors/:sensorRuleId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId
http PUT {{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
POST
Associates rules with a device
{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate
BODY json
{
"geofenceIds": [],
"ruleIds": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate");
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 \"geofenceIds\": [],\n \"ruleIds\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate" {:content-type :json
:form-params {:geofenceIds []
:ruleIds []}})
require "http/client"
url = "{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate"),
Content = new StringContent("{\n \"geofenceIds\": [],\n \"ruleIds\": []\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}}/associations/v3/devices/:trackingId/batchCreate");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate"
payload := strings.NewReader("{\n \"geofenceIds\": [],\n \"ruleIds\": []\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/associations/v3/devices/:trackingId/batchCreate HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 40
{
"geofenceIds": [],
"ruleIds": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate")
.setHeader("content-type", "application/json")
.setBody("{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"geofenceIds\": [],\n \"ruleIds\": []\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 \"geofenceIds\": [],\n \"ruleIds\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate")
.header("content-type", "application/json")
.body("{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}")
.asString();
const data = JSON.stringify({
geofenceIds: [],
ruleIds: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate',
headers: {'content-type': 'application/json'},
data: {geofenceIds: [], ruleIds: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"geofenceIds":[],"ruleIds":[]}'
};
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}}/associations/v3/devices/:trackingId/batchCreate',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "geofenceIds": [],\n "ruleIds": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate")
.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/associations/v3/devices/:trackingId/batchCreate',
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({geofenceIds: [], ruleIds: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate',
headers: {'content-type': 'application/json'},
body: {geofenceIds: [], ruleIds: []},
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}}/associations/v3/devices/:trackingId/batchCreate');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
geofenceIds: [],
ruleIds: []
});
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}}/associations/v3/devices/:trackingId/batchCreate',
headers: {'content-type': 'application/json'},
data: {geofenceIds: [], ruleIds: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"geofenceIds":[],"ruleIds":[]}'
};
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 = @{ @"geofenceIds": @[ ],
@"ruleIds": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate"]
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}}/associations/v3/devices/:trackingId/batchCreate" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate",
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([
'geofenceIds' => [
],
'ruleIds' => [
]
]),
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}}/associations/v3/devices/:trackingId/batchCreate', [
'body' => '{
"geofenceIds": [],
"ruleIds": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'geofenceIds' => [
],
'ruleIds' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'geofenceIds' => [
],
'ruleIds' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate');
$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}}/associations/v3/devices/:trackingId/batchCreate' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"geofenceIds": [],
"ruleIds": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"geofenceIds": [],
"ruleIds": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/associations/v3/devices/:trackingId/batchCreate", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate"
payload = {
"geofenceIds": [],
"ruleIds": []
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate"
payload <- "{\n \"geofenceIds\": [],\n \"ruleIds\": []\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}}/associations/v3/devices/:trackingId/batchCreate")
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 \"geofenceIds\": [],\n \"ruleIds\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/associations/v3/devices/:trackingId/batchCreate') do |req|
req.body = "{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate";
let payload = json!({
"geofenceIds": (),
"ruleIds": ()
});
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}}/associations/v3/devices/:trackingId/batchCreate \
--header 'content-type: application/json' \
--data '{
"geofenceIds": [],
"ruleIds": []
}'
echo '{
"geofenceIds": [],
"ruleIds": []
}' | \
http POST {{baseUrl}}/associations/v3/devices/:trackingId/batchCreate \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "geofenceIds": [],\n "ruleIds": []\n}' \
--output-document \
- {{baseUrl}}/associations/v3/devices/:trackingId/batchCreate
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"geofenceIds": [],
"ruleIds": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/devices/:trackingId/batchCreate")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
DELETE
Disassociates a device and a geofence
{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId")
require "http/client"
url = "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId"
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/associations/v3/:trackingId/geofences/:geofenceId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId"))
.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}}/associations/v3/:trackingId/geofences/:geofenceId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId")
.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}}/associations/v3/:trackingId/geofences/:geofenceId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId';
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}}/associations/v3/:trackingId/geofences/:geofenceId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/associations/v3/:trackingId/geofences/:geofenceId',
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}}/associations/v3/:trackingId/geofences/:geofenceId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId');
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}}/associations/v3/:trackingId/geofences/:geofenceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId';
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}}/associations/v3/:trackingId/geofences/:geofenceId"]
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}}/associations/v3/:trackingId/geofences/:geofenceId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId",
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}}/associations/v3/:trackingId/geofences/:geofenceId');
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/associations/v3/:trackingId/geofences/:geofenceId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/associations/v3/:trackingId/geofences/:geofenceId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId";
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}}/associations/v3/:trackingId/geofences/:geofenceId
http DELETE {{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/:trackingId/geofences/:geofenceId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Disassociates a device and a rule
{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId")
require "http/client"
url = "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId"
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/associations/v3/:trackingId/rules/:ruleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId"))
.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}}/associations/v3/:trackingId/rules/:ruleId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId")
.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}}/associations/v3/:trackingId/rules/:ruleId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId';
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}}/associations/v3/:trackingId/rules/:ruleId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/associations/v3/:trackingId/rules/:ruleId',
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}}/associations/v3/:trackingId/rules/:ruleId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId');
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}}/associations/v3/:trackingId/rules/:ruleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId';
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}}/associations/v3/:trackingId/rules/:ruleId"]
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}}/associations/v3/:trackingId/rules/:ruleId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId",
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}}/associations/v3/:trackingId/rules/:ruleId');
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/associations/v3/:trackingId/rules/:ruleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/associations/v3/:trackingId/rules/:ruleId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId";
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}}/associations/v3/:trackingId/rules/:ruleId
http DELETE {{baseUrl}}/associations/v3/:trackingId/rules/:ruleId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/associations/v3/:trackingId/rules/:ruleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/:trackingId/rules/:ruleId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Disassociates a device and a sensor rule
{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId")
require "http/client"
url = "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId"
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/associations/v3/:trackingId/sensors/:sensorRuleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId"))
.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}}/associations/v3/:trackingId/sensors/:sensorRuleId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId")
.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}}/associations/v3/:trackingId/sensors/:sensorRuleId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId';
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}}/associations/v3/:trackingId/sensors/:sensorRuleId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/associations/v3/:trackingId/sensors/:sensorRuleId',
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}}/associations/v3/:trackingId/sensors/:sensorRuleId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId');
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}}/associations/v3/:trackingId/sensors/:sensorRuleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId';
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}}/associations/v3/:trackingId/sensors/:sensorRuleId"]
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}}/associations/v3/:trackingId/sensors/:sensorRuleId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId",
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}}/associations/v3/:trackingId/sensors/:sensorRuleId');
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/associations/v3/:trackingId/sensors/:sensorRuleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/associations/v3/:trackingId/sensors/:sensorRuleId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId";
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}}/associations/v3/:trackingId/sensors/:sensorRuleId
http DELETE {{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/:trackingId/sensors/:sensorRuleId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
POST
Disassociates rules from a device
{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete
BODY json
{
"geofenceIds": [],
"ruleIds": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete");
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 \"geofenceIds\": [],\n \"ruleIds\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete" {:content-type :json
:form-params {:geofenceIds []
:ruleIds []}})
require "http/client"
url = "{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete"),
Content = new StringContent("{\n \"geofenceIds\": [],\n \"ruleIds\": []\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}}/associations/v3/devices/:trackingId/batchDelete");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete"
payload := strings.NewReader("{\n \"geofenceIds\": [],\n \"ruleIds\": []\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/associations/v3/devices/:trackingId/batchDelete HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 40
{
"geofenceIds": [],
"ruleIds": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete")
.setHeader("content-type", "application/json")
.setBody("{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"geofenceIds\": [],\n \"ruleIds\": []\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 \"geofenceIds\": [],\n \"ruleIds\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete")
.header("content-type", "application/json")
.body("{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}")
.asString();
const data = JSON.stringify({
geofenceIds: [],
ruleIds: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete',
headers: {'content-type': 'application/json'},
data: {geofenceIds: [], ruleIds: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"geofenceIds":[],"ruleIds":[]}'
};
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}}/associations/v3/devices/:trackingId/batchDelete',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "geofenceIds": [],\n "ruleIds": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete")
.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/associations/v3/devices/:trackingId/batchDelete',
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({geofenceIds: [], ruleIds: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete',
headers: {'content-type': 'application/json'},
body: {geofenceIds: [], ruleIds: []},
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}}/associations/v3/devices/:trackingId/batchDelete');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
geofenceIds: [],
ruleIds: []
});
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}}/associations/v3/devices/:trackingId/batchDelete',
headers: {'content-type': 'application/json'},
data: {geofenceIds: [], ruleIds: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"geofenceIds":[],"ruleIds":[]}'
};
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 = @{ @"geofenceIds": @[ ],
@"ruleIds": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete"]
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}}/associations/v3/devices/:trackingId/batchDelete" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete",
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([
'geofenceIds' => [
],
'ruleIds' => [
]
]),
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}}/associations/v3/devices/:trackingId/batchDelete', [
'body' => '{
"geofenceIds": [],
"ruleIds": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'geofenceIds' => [
],
'ruleIds' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'geofenceIds' => [
],
'ruleIds' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete');
$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}}/associations/v3/devices/:trackingId/batchDelete' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"geofenceIds": [],
"ruleIds": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"geofenceIds": [],
"ruleIds": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/associations/v3/devices/:trackingId/batchDelete", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete"
payload = {
"geofenceIds": [],
"ruleIds": []
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete"
payload <- "{\n \"geofenceIds\": [],\n \"ruleIds\": []\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}}/associations/v3/devices/:trackingId/batchDelete")
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 \"geofenceIds\": [],\n \"ruleIds\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/associations/v3/devices/:trackingId/batchDelete') do |req|
req.body = "{\n \"geofenceIds\": [],\n \"ruleIds\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete";
let payload = json!({
"geofenceIds": (),
"ruleIds": ()
});
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}}/associations/v3/devices/:trackingId/batchDelete \
--header 'content-type: application/json' \
--data '{
"geofenceIds": [],
"ruleIds": []
}'
echo '{
"geofenceIds": [],
"ruleIds": []
}' | \
http POST {{baseUrl}}/associations/v3/devices/:trackingId/batchDelete \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "geofenceIds": [],\n "ruleIds": []\n}' \
--output-document \
- {{baseUrl}}/associations/v3/devices/:trackingId/batchDelete
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"geofenceIds": [],
"ruleIds": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/devices/:trackingId/batchDelete")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets all devices associated with a geofence
{{baseUrl}}/associations/v3/geofences/:geofenceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/geofences/:geofenceId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/associations/v3/geofences/:geofenceId")
require "http/client"
url = "{{baseUrl}}/associations/v3/geofences/:geofenceId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/associations/v3/geofences/:geofenceId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/associations/v3/geofences/:geofenceId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/geofences/:geofenceId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/associations/v3/geofences/:geofenceId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/associations/v3/geofences/:geofenceId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/geofences/:geofenceId"))
.method("GET", 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}}/associations/v3/geofences/:geofenceId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/associations/v3/geofences/:geofenceId")
.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('GET', '{{baseUrl}}/associations/v3/geofences/:geofenceId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/associations/v3/geofences/:geofenceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/geofences/:geofenceId';
const options = {method: 'GET'};
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}}/associations/v3/geofences/:geofenceId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/geofences/:geofenceId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/associations/v3/geofences/:geofenceId',
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: 'GET',
url: '{{baseUrl}}/associations/v3/geofences/:geofenceId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/associations/v3/geofences/:geofenceId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/associations/v3/geofences/:geofenceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/geofences/:geofenceId';
const options = {method: 'GET'};
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}}/associations/v3/geofences/:geofenceId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/associations/v3/geofences/:geofenceId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/geofences/:geofenceId",
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;
}
request('GET', '{{baseUrl}}/associations/v3/geofences/:geofenceId');
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/geofences/:geofenceId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/associations/v3/geofences/:geofenceId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/associations/v3/geofences/:geofenceId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/geofences/:geofenceId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/associations/v3/geofences/:geofenceId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/geofences/:geofenceId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/geofences/:geofenceId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/associations/v3/geofences/:geofenceId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/associations/v3/geofences/:geofenceId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/geofences/:geofenceId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/associations/v3/geofences/:geofenceId
http GET {{baseUrl}}/associations/v3/geofences/:geofenceId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/associations/v3/geofences/:geofenceId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/geofences/:geofenceId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 2,
"data": [
{
"appId": "c2639c686251407a9052aaea824a1fb5",
"externalId": "TestDevice1",
"trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
},
{
"appId": "c2639c686251407a9052aaea824a1fc9",
"externalId": "TestDevice2",
"trackingId": "HERE-b0146d7b-2e46-4cee-bc71-6da03ba2da85"
}
],
"pageToken": "024ggjjea253d79fc"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets all devices associated with a rule
{{baseUrl}}/associations/v3/rules/:ruleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/rules/:ruleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/associations/v3/rules/:ruleId")
require "http/client"
url = "{{baseUrl}}/associations/v3/rules/:ruleId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/associations/v3/rules/:ruleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/associations/v3/rules/:ruleId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/rules/:ruleId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/associations/v3/rules/:ruleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/associations/v3/rules/:ruleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/rules/:ruleId"))
.method("GET", 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}}/associations/v3/rules/:ruleId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/associations/v3/rules/:ruleId")
.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('GET', '{{baseUrl}}/associations/v3/rules/:ruleId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/associations/v3/rules/:ruleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/rules/:ruleId';
const options = {method: 'GET'};
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}}/associations/v3/rules/:ruleId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/rules/:ruleId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/associations/v3/rules/:ruleId',
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: 'GET',
url: '{{baseUrl}}/associations/v3/rules/:ruleId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/associations/v3/rules/:ruleId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/associations/v3/rules/:ruleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/rules/:ruleId';
const options = {method: 'GET'};
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}}/associations/v3/rules/:ruleId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/associations/v3/rules/:ruleId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/rules/:ruleId",
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;
}
request('GET', '{{baseUrl}}/associations/v3/rules/:ruleId');
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/rules/:ruleId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/associations/v3/rules/:ruleId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/associations/v3/rules/:ruleId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/rules/:ruleId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/associations/v3/rules/:ruleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/rules/:ruleId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/rules/:ruleId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/associations/v3/rules/:ruleId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/associations/v3/rules/:ruleId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/rules/:ruleId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/associations/v3/rules/:ruleId
http GET {{baseUrl}}/associations/v3/rules/:ruleId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/associations/v3/rules/:ruleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/rules/:ruleId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 2,
"data": [
{
"appId": "c2639c686251407a9052aaea824a1fb5",
"externalId": "TestDevice1",
"trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
},
{
"appId": "c2639c686251407a9052aaea824a1fc9",
"externalId": "TestDevice2",
"trackingId": "HERE-b0146d7b-2e46-4cee-bc71-6da03ba2da85"
}
],
"pageToken": "024ggjjea253d79fc"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets all devices associated with a sensor rule
{{baseUrl}}/associations/v3/sensors/:sensorRuleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/sensors/:sensorRuleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/associations/v3/sensors/:sensorRuleId")
require "http/client"
url = "{{baseUrl}}/associations/v3/sensors/:sensorRuleId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/associations/v3/sensors/:sensorRuleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/associations/v3/sensors/:sensorRuleId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/sensors/:sensorRuleId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/associations/v3/sensors/:sensorRuleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/associations/v3/sensors/:sensorRuleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/sensors/:sensorRuleId"))
.method("GET", 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}}/associations/v3/sensors/:sensorRuleId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/associations/v3/sensors/:sensorRuleId")
.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('GET', '{{baseUrl}}/associations/v3/sensors/:sensorRuleId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/associations/v3/sensors/:sensorRuleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/sensors/:sensorRuleId';
const options = {method: 'GET'};
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}}/associations/v3/sensors/:sensorRuleId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/sensors/:sensorRuleId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/associations/v3/sensors/:sensorRuleId',
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: 'GET',
url: '{{baseUrl}}/associations/v3/sensors/:sensorRuleId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/associations/v3/sensors/:sensorRuleId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/associations/v3/sensors/:sensorRuleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/sensors/:sensorRuleId';
const options = {method: 'GET'};
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}}/associations/v3/sensors/:sensorRuleId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/associations/v3/sensors/:sensorRuleId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/sensors/:sensorRuleId",
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;
}
request('GET', '{{baseUrl}}/associations/v3/sensors/:sensorRuleId');
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/sensors/:sensorRuleId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/associations/v3/sensors/:sensorRuleId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/associations/v3/sensors/:sensorRuleId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/sensors/:sensorRuleId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/associations/v3/sensors/:sensorRuleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/sensors/:sensorRuleId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/sensors/:sensorRuleId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/associations/v3/sensors/:sensorRuleId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/associations/v3/sensors/:sensorRuleId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/sensors/:sensorRuleId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/associations/v3/sensors/:sensorRuleId
http GET {{baseUrl}}/associations/v3/sensors/:sensorRuleId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/associations/v3/sensors/:sensorRuleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/sensors/:sensorRuleId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 2,
"data": [
{
"appId": "c2639c686251407a9052aaea824a1fb5",
"externalId": "TestDevice1",
"trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
},
{
"appId": "c2639c686251407a9052aaea824a1fc9",
"externalId": "TestDevice2",
"trackingId": "HERE-b0146d7b-2e46-4cee-bc71-6da03ba2da85"
}
],
"pageToken": "024ggjjea253d79fc"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "The sensor rule ID was not found."
}
GET
Gets geofences associated with a device
{{baseUrl}}/associations/v3/:trackingId/geofences
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/:trackingId/geofences");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/associations/v3/:trackingId/geofences")
require "http/client"
url = "{{baseUrl}}/associations/v3/:trackingId/geofences"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/associations/v3/:trackingId/geofences"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/associations/v3/:trackingId/geofences");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/:trackingId/geofences"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/associations/v3/:trackingId/geofences HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/associations/v3/:trackingId/geofences")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/:trackingId/geofences"))
.method("GET", 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}}/associations/v3/:trackingId/geofences")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/associations/v3/:trackingId/geofences")
.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('GET', '{{baseUrl}}/associations/v3/:trackingId/geofences');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/associations/v3/:trackingId/geofences'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/:trackingId/geofences';
const options = {method: 'GET'};
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}}/associations/v3/:trackingId/geofences',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/:trackingId/geofences")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/associations/v3/:trackingId/geofences',
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: 'GET',
url: '{{baseUrl}}/associations/v3/:trackingId/geofences'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/associations/v3/:trackingId/geofences');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/associations/v3/:trackingId/geofences'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/:trackingId/geofences';
const options = {method: 'GET'};
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}}/associations/v3/:trackingId/geofences"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/associations/v3/:trackingId/geofences" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/:trackingId/geofences",
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;
}
request('GET', '{{baseUrl}}/associations/v3/:trackingId/geofences');
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/:trackingId/geofences');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/associations/v3/:trackingId/geofences');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/associations/v3/:trackingId/geofences' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/:trackingId/geofences' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/associations/v3/:trackingId/geofences")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/:trackingId/geofences"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/:trackingId/geofences"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/associations/v3/:trackingId/geofences")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/associations/v3/:trackingId/geofences') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/:trackingId/geofences";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/associations/v3/:trackingId/geofences
http GET {{baseUrl}}/associations/v3/:trackingId/geofences
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/associations/v3/:trackingId/geofences
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/:trackingId/geofences")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 2,
"data": [
{
"geofence": {
"definition": {
"points": [
{
"lat": 52.5308398,
"lng": 13.38490035
},
{
"lat": 52.5408398,
"lng": 14.38490035
},
{
"lat": 53.5308398,
"lng": 13.39490035
}
]
},
"type": "polygon"
},
"id": "d0c29690-5d26-4cf1-a37e-b7816e72cb99"
},
{
"geofence": {
"definition": {
"center": {
"lat": 52.5308398,
"lng": 13.38490035
},
"floor": {
"id": "DM_82228",
"name": "House 3"
},
"radius": 100
},
"description": "This is a circular geofence",
"name": "16fbc82c-88d1-4219-bfad-6e5de52688a2",
"type": "circle"
},
"id": "ff92eda0-3114-4640-b7e6-4ba641ae1124"
}
],
"pageToken": "027ffffea253d79fc"
}
RESPONSE HEADERS
Content-Type
application/octet-stream
RESPONSE BODY text
34 56 18 93 45 29 54 62 77 28 23 79 22
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "The trackingId was not found."
}
GET
Gets rules associated with a device
{{baseUrl}}/associations/v3/:trackingId/rules
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/:trackingId/rules");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/associations/v3/:trackingId/rules")
require "http/client"
url = "{{baseUrl}}/associations/v3/:trackingId/rules"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/associations/v3/:trackingId/rules"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/associations/v3/:trackingId/rules");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/:trackingId/rules"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/associations/v3/:trackingId/rules HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/associations/v3/:trackingId/rules")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/:trackingId/rules"))
.method("GET", 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}}/associations/v3/:trackingId/rules")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/associations/v3/:trackingId/rules")
.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('GET', '{{baseUrl}}/associations/v3/:trackingId/rules');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/associations/v3/:trackingId/rules'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/:trackingId/rules';
const options = {method: 'GET'};
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}}/associations/v3/:trackingId/rules',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/:trackingId/rules")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/associations/v3/:trackingId/rules',
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: 'GET',
url: '{{baseUrl}}/associations/v3/:trackingId/rules'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/associations/v3/:trackingId/rules');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/associations/v3/:trackingId/rules'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/:trackingId/rules';
const options = {method: 'GET'};
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}}/associations/v3/:trackingId/rules"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/associations/v3/:trackingId/rules" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/:trackingId/rules",
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;
}
request('GET', '{{baseUrl}}/associations/v3/:trackingId/rules');
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/:trackingId/rules');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/associations/v3/:trackingId/rules');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/associations/v3/:trackingId/rules' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/:trackingId/rules' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/associations/v3/:trackingId/rules")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/:trackingId/rules"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/:trackingId/rules"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/associations/v3/:trackingId/rules")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/associations/v3/:trackingId/rules') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/:trackingId/rules";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/associations/v3/:trackingId/rules
http GET {{baseUrl}}/associations/v3/:trackingId/rules
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/associations/v3/:trackingId/rules
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/:trackingId/rules")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 1,
"data": [
{
"rule": {
"threshold": {
"durationS": 3600
},
"type": "dwelling"
},
"ruleId": "f4c26630-5d26-4cd1-a57e-g7834e72cb99"
}
],
"pageToken": "024ggjjea253d79fc"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets sensor rules associated with a device
{{baseUrl}}/associations/v3/:trackingId/sensors
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/:trackingId/sensors");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/associations/v3/:trackingId/sensors")
require "http/client"
url = "{{baseUrl}}/associations/v3/:trackingId/sensors"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/associations/v3/:trackingId/sensors"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/associations/v3/:trackingId/sensors");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/:trackingId/sensors"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/associations/v3/:trackingId/sensors HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/associations/v3/:trackingId/sensors")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/:trackingId/sensors"))
.method("GET", 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}}/associations/v3/:trackingId/sensors")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/associations/v3/:trackingId/sensors")
.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('GET', '{{baseUrl}}/associations/v3/:trackingId/sensors');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/associations/v3/:trackingId/sensors'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/:trackingId/sensors';
const options = {method: 'GET'};
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}}/associations/v3/:trackingId/sensors',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/:trackingId/sensors")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/associations/v3/:trackingId/sensors',
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: 'GET',
url: '{{baseUrl}}/associations/v3/:trackingId/sensors'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/associations/v3/:trackingId/sensors');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/associations/v3/:trackingId/sensors'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/:trackingId/sensors';
const options = {method: 'GET'};
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}}/associations/v3/:trackingId/sensors"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/associations/v3/:trackingId/sensors" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/:trackingId/sensors",
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;
}
request('GET', '{{baseUrl}}/associations/v3/:trackingId/sensors');
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/:trackingId/sensors');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/associations/v3/:trackingId/sensors');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/associations/v3/:trackingId/sensors' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/:trackingId/sensors' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/associations/v3/:trackingId/sensors")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/:trackingId/sensors"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/:trackingId/sensors"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/associations/v3/:trackingId/sensors")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/associations/v3/:trackingId/sensors') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/:trackingId/sensors";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/associations/v3/:trackingId/sensors
http GET {{baseUrl}}/associations/v3/:trackingId/sensors
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/associations/v3/:trackingId/sensors
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/:trackingId/sensors")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 2,
"data": [
{
"id": "f4c26630-5d26-4cd1-a57e-g7834e72cb99",
"range": {
"begin": -20,
"end": 30
},
"type": "temperature"
},
{
"id": "j7c24430-5f26-4kd1-c58e-g7126e72ab33",
"range": {
"begin": 30,
"end": 80
},
"type": "pressure"
}
],
"pageToken": "024ggjjea253d79fc"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets service health (GET)
{{baseUrl}}/associations/v3/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/associations/v3/health")
require "http/client"
url = "{{baseUrl}}/associations/v3/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/associations/v3/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/associations/v3/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/associations/v3/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/associations/v3/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/health"))
.method("GET", 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}}/associations/v3/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/associations/v3/health")
.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('GET', '{{baseUrl}}/associations/v3/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/associations/v3/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/health';
const options = {method: 'GET'};
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}}/associations/v3/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/associations/v3/health',
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: 'GET', url: '{{baseUrl}}/associations/v3/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/associations/v3/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/associations/v3/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/health';
const options = {method: 'GET'};
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}}/associations/v3/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/associations/v3/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/health",
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;
}
request('GET', '{{baseUrl}}/associations/v3/health');
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/associations/v3/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/associations/v3/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/associations/v3/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/associations/v3/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/associations/v3/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/associations/v3/health
http GET {{baseUrl}}/associations/v3/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/associations/v3/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (GET)
{{baseUrl}}/associations/v3/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/associations/v3/version")
require "http/client"
url = "{{baseUrl}}/associations/v3/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/associations/v3/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/associations/v3/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/associations/v3/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/associations/v3/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/version"))
.method("GET", 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}}/associations/v3/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/associations/v3/version")
.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('GET', '{{baseUrl}}/associations/v3/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/associations/v3/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/version';
const options = {method: 'GET'};
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}}/associations/v3/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/associations/v3/version',
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: 'GET', url: '{{baseUrl}}/associations/v3/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/associations/v3/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/associations/v3/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/version';
const options = {method: 'GET'};
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}}/associations/v3/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/associations/v3/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/version",
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;
}
request('GET', '{{baseUrl}}/associations/v3/version');
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/associations/v3/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/associations/v3/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/associations/v3/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/associations/v3/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/associations/v3/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/associations/v3/version
http GET {{baseUrl}}/associations/v3/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/associations/v3/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
Updates rules associations for devices
{{baseUrl}}/associations/v3/devices/batchUpdate
BODY json
{
"newRules": {
"geofenceIds": [],
"ruleIds": []
},
"oldRules": {
"geofenceIds": [],
"ruleIds": []
},
"trackingIds": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/associations/v3/devices/batchUpdate");
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 \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/associations/v3/devices/batchUpdate" {:content-type :json
:form-params {:newRules {:geofenceIds []
:ruleIds []}
:oldRules {:geofenceIds []
:ruleIds []}
:trackingIds []}})
require "http/client"
url = "{{baseUrl}}/associations/v3/devices/batchUpdate"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/associations/v3/devices/batchUpdate"),
Content = new StringContent("{\n \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\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}}/associations/v3/devices/batchUpdate");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/associations/v3/devices/batchUpdate"
payload := strings.NewReader("{\n \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\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/associations/v3/devices/batchUpdate HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 147
{
"newRules": {
"geofenceIds": [],
"ruleIds": []
},
"oldRules": {
"geofenceIds": [],
"ruleIds": []
},
"trackingIds": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/associations/v3/devices/batchUpdate")
.setHeader("content-type", "application/json")
.setBody("{\n \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/associations/v3/devices/batchUpdate"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\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 \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/associations/v3/devices/batchUpdate")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/associations/v3/devices/batchUpdate")
.header("content-type", "application/json")
.body("{\n \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\n}")
.asString();
const data = JSON.stringify({
newRules: {
geofenceIds: [],
ruleIds: []
},
oldRules: {
geofenceIds: [],
ruleIds: []
},
trackingIds: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/associations/v3/devices/batchUpdate');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/associations/v3/devices/batchUpdate',
headers: {'content-type': 'application/json'},
data: {
newRules: {geofenceIds: [], ruleIds: []},
oldRules: {geofenceIds: [], ruleIds: []},
trackingIds: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/associations/v3/devices/batchUpdate';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"newRules":{"geofenceIds":[],"ruleIds":[]},"oldRules":{"geofenceIds":[],"ruleIds":[]},"trackingIds":[]}'
};
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}}/associations/v3/devices/batchUpdate',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "newRules": {\n "geofenceIds": [],\n "ruleIds": []\n },\n "oldRules": {\n "geofenceIds": [],\n "ruleIds": []\n },\n "trackingIds": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/associations/v3/devices/batchUpdate")
.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/associations/v3/devices/batchUpdate',
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({
newRules: {geofenceIds: [], ruleIds: []},
oldRules: {geofenceIds: [], ruleIds: []},
trackingIds: []
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/associations/v3/devices/batchUpdate',
headers: {'content-type': 'application/json'},
body: {
newRules: {geofenceIds: [], ruleIds: []},
oldRules: {geofenceIds: [], ruleIds: []},
trackingIds: []
},
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}}/associations/v3/devices/batchUpdate');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
newRules: {
geofenceIds: [],
ruleIds: []
},
oldRules: {
geofenceIds: [],
ruleIds: []
},
trackingIds: []
});
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}}/associations/v3/devices/batchUpdate',
headers: {'content-type': 'application/json'},
data: {
newRules: {geofenceIds: [], ruleIds: []},
oldRules: {geofenceIds: [], ruleIds: []},
trackingIds: []
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/associations/v3/devices/batchUpdate';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"newRules":{"geofenceIds":[],"ruleIds":[]},"oldRules":{"geofenceIds":[],"ruleIds":[]},"trackingIds":[]}'
};
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 = @{ @"newRules": @{ @"geofenceIds": @[ ], @"ruleIds": @[ ] },
@"oldRules": @{ @"geofenceIds": @[ ], @"ruleIds": @[ ] },
@"trackingIds": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/associations/v3/devices/batchUpdate"]
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}}/associations/v3/devices/batchUpdate" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/associations/v3/devices/batchUpdate",
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([
'newRules' => [
'geofenceIds' => [
],
'ruleIds' => [
]
],
'oldRules' => [
'geofenceIds' => [
],
'ruleIds' => [
]
],
'trackingIds' => [
]
]),
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}}/associations/v3/devices/batchUpdate', [
'body' => '{
"newRules": {
"geofenceIds": [],
"ruleIds": []
},
"oldRules": {
"geofenceIds": [],
"ruleIds": []
},
"trackingIds": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/associations/v3/devices/batchUpdate');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'newRules' => [
'geofenceIds' => [
],
'ruleIds' => [
]
],
'oldRules' => [
'geofenceIds' => [
],
'ruleIds' => [
]
],
'trackingIds' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'newRules' => [
'geofenceIds' => [
],
'ruleIds' => [
]
],
'oldRules' => [
'geofenceIds' => [
],
'ruleIds' => [
]
],
'trackingIds' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/associations/v3/devices/batchUpdate');
$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}}/associations/v3/devices/batchUpdate' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"newRules": {
"geofenceIds": [],
"ruleIds": []
},
"oldRules": {
"geofenceIds": [],
"ruleIds": []
},
"trackingIds": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/associations/v3/devices/batchUpdate' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"newRules": {
"geofenceIds": [],
"ruleIds": []
},
"oldRules": {
"geofenceIds": [],
"ruleIds": []
},
"trackingIds": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/associations/v3/devices/batchUpdate", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/associations/v3/devices/batchUpdate"
payload = {
"newRules": {
"geofenceIds": [],
"ruleIds": []
},
"oldRules": {
"geofenceIds": [],
"ruleIds": []
},
"trackingIds": []
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/associations/v3/devices/batchUpdate"
payload <- "{\n \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\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}}/associations/v3/devices/batchUpdate")
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 \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/associations/v3/devices/batchUpdate') do |req|
req.body = "{\n \"newRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"oldRules\": {\n \"geofenceIds\": [],\n \"ruleIds\": []\n },\n \"trackingIds\": []\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/associations/v3/devices/batchUpdate";
let payload = json!({
"newRules": json!({
"geofenceIds": (),
"ruleIds": ()
}),
"oldRules": json!({
"geofenceIds": (),
"ruleIds": ()
}),
"trackingIds": ()
});
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}}/associations/v3/devices/batchUpdate \
--header 'content-type: application/json' \
--data '{
"newRules": {
"geofenceIds": [],
"ruleIds": []
},
"oldRules": {
"geofenceIds": [],
"ruleIds": []
},
"trackingIds": []
}'
echo '{
"newRules": {
"geofenceIds": [],
"ruleIds": []
},
"oldRules": {
"geofenceIds": [],
"ruleIds": []
},
"trackingIds": []
}' | \
http PUT {{baseUrl}}/associations/v3/devices/batchUpdate \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "newRules": {\n "geofenceIds": [],\n "ruleIds": []\n },\n "oldRules": {\n "geofenceIds": [],\n "ruleIds": []\n },\n "trackingIds": []\n}' \
--output-document \
- {{baseUrl}}/associations/v3/devices/batchUpdate
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"newRules": [
"geofenceIds": [],
"ruleIds": []
],
"oldRules": [
"geofenceIds": [],
"ruleIds": []
],
"trackingIds": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/associations/v3/devices/batchUpdate")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets bulk upload results
{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results")
require "http/client"
url = "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/bulkjobs/v4/deviceUploads/:jobId/results HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results"))
.method("GET", 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}}/bulkjobs/v4/deviceUploads/:jobId/results")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results")
.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('GET', '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results';
const options = {method: 'GET'};
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}}/bulkjobs/v4/deviceUploads/:jobId/results',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/bulkjobs/v4/deviceUploads/:jobId/results',
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: 'GET',
url: '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results';
const options = {method: 'GET'};
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}}/bulkjobs/v4/deviceUploads/:jobId/results"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/bulkjobs/v4/deviceUploads/:jobId/results" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results",
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;
}
request('GET', '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results');
echo $response->getBody();
setUrl('{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/bulkjobs/v4/deviceUploads/:jobId/results")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/bulkjobs/v4/deviceUploads/:jobId/results') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results
http GET {{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/results")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 429,
"error": "Too Many Requests",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "Too Many Requests"
}
GET
Gets bulk upload status
{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status")
require "http/client"
url = "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/bulkjobs/v4/deviceUploads/:jobId/status HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status"))
.method("GET", 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}}/bulkjobs/v4/deviceUploads/:jobId/status")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status")
.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('GET', '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status';
const options = {method: 'GET'};
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}}/bulkjobs/v4/deviceUploads/:jobId/status',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/bulkjobs/v4/deviceUploads/:jobId/status',
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: 'GET',
url: '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status';
const options = {method: 'GET'};
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}}/bulkjobs/v4/deviceUploads/:jobId/status"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/bulkjobs/v4/deviceUploads/:jobId/status" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status",
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;
}
request('GET', '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status');
echo $response->getBody();
setUrl('{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/bulkjobs/v4/deviceUploads/:jobId/status")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/bulkjobs/v4/deviceUploads/:jobId/status') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status
http GET {{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId/status")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 429,
"error": "Too Many Requests",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "Too Many Requests"
}
GET
Gets service health (1)
{{baseUrl}}/bulkjobs/v4/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/bulkjobs/v4/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/bulkjobs/v4/health")
require "http/client"
url = "{{baseUrl}}/bulkjobs/v4/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/bulkjobs/v4/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/bulkjobs/v4/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/bulkjobs/v4/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/bulkjobs/v4/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/bulkjobs/v4/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/bulkjobs/v4/health"))
.method("GET", 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}}/bulkjobs/v4/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/bulkjobs/v4/health")
.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('GET', '{{baseUrl}}/bulkjobs/v4/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/bulkjobs/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/bulkjobs/v4/health';
const options = {method: 'GET'};
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}}/bulkjobs/v4/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/bulkjobs/v4/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/bulkjobs/v4/health',
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: 'GET', url: '{{baseUrl}}/bulkjobs/v4/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/bulkjobs/v4/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/bulkjobs/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/bulkjobs/v4/health';
const options = {method: 'GET'};
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}}/bulkjobs/v4/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/bulkjobs/v4/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/bulkjobs/v4/health",
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;
}
request('GET', '{{baseUrl}}/bulkjobs/v4/health');
echo $response->getBody();
setUrl('{{baseUrl}}/bulkjobs/v4/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/bulkjobs/v4/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/bulkjobs/v4/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/bulkjobs/v4/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/bulkjobs/v4/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/bulkjobs/v4/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/bulkjobs/v4/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/bulkjobs/v4/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/bulkjobs/v4/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/bulkjobs/v4/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/bulkjobs/v4/health
http GET {{baseUrl}}/bulkjobs/v4/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/bulkjobs/v4/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/bulkjobs/v4/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (1)
{{baseUrl}}/bulkjobs/v4/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/bulkjobs/v4/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/bulkjobs/v4/version")
require "http/client"
url = "{{baseUrl}}/bulkjobs/v4/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/bulkjobs/v4/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/bulkjobs/v4/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/bulkjobs/v4/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/bulkjobs/v4/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/bulkjobs/v4/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/bulkjobs/v4/version"))
.method("GET", 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}}/bulkjobs/v4/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/bulkjobs/v4/version")
.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('GET', '{{baseUrl}}/bulkjobs/v4/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/bulkjobs/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/bulkjobs/v4/version';
const options = {method: 'GET'};
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}}/bulkjobs/v4/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/bulkjobs/v4/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/bulkjobs/v4/version',
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: 'GET', url: '{{baseUrl}}/bulkjobs/v4/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/bulkjobs/v4/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/bulkjobs/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/bulkjobs/v4/version';
const options = {method: 'GET'};
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}}/bulkjobs/v4/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/bulkjobs/v4/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/bulkjobs/v4/version",
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;
}
request('GET', '{{baseUrl}}/bulkjobs/v4/version');
echo $response->getBody();
setUrl('{{baseUrl}}/bulkjobs/v4/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/bulkjobs/v4/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/bulkjobs/v4/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/bulkjobs/v4/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/bulkjobs/v4/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/bulkjobs/v4/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/bulkjobs/v4/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/bulkjobs/v4/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/bulkjobs/v4/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/bulkjobs/v4/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/bulkjobs/v4/version
http GET {{baseUrl}}/bulkjobs/v4/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/bulkjobs/v4/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/bulkjobs/v4/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets the bulk upload job IDs for a project
{{baseUrl}}/bulkjobs/v4/deviceUploads
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/bulkjobs/v4/deviceUploads");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/bulkjobs/v4/deviceUploads")
require "http/client"
url = "{{baseUrl}}/bulkjobs/v4/deviceUploads"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/bulkjobs/v4/deviceUploads"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/bulkjobs/v4/deviceUploads");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/bulkjobs/v4/deviceUploads"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/bulkjobs/v4/deviceUploads HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/bulkjobs/v4/deviceUploads")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/bulkjobs/v4/deviceUploads"))
.method("GET", 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}}/bulkjobs/v4/deviceUploads")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/bulkjobs/v4/deviceUploads")
.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('GET', '{{baseUrl}}/bulkjobs/v4/deviceUploads');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/bulkjobs/v4/deviceUploads'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/bulkjobs/v4/deviceUploads';
const options = {method: 'GET'};
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}}/bulkjobs/v4/deviceUploads',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/bulkjobs/v4/deviceUploads")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/bulkjobs/v4/deviceUploads',
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: 'GET', url: '{{baseUrl}}/bulkjobs/v4/deviceUploads'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/bulkjobs/v4/deviceUploads');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/bulkjobs/v4/deviceUploads'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/bulkjobs/v4/deviceUploads';
const options = {method: 'GET'};
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}}/bulkjobs/v4/deviceUploads"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/bulkjobs/v4/deviceUploads" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/bulkjobs/v4/deviceUploads",
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;
}
request('GET', '{{baseUrl}}/bulkjobs/v4/deviceUploads');
echo $response->getBody();
setUrl('{{baseUrl}}/bulkjobs/v4/deviceUploads');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/bulkjobs/v4/deviceUploads');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/bulkjobs/v4/deviceUploads' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/bulkjobs/v4/deviceUploads' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/bulkjobs/v4/deviceUploads")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/bulkjobs/v4/deviceUploads"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/bulkjobs/v4/deviceUploads"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/bulkjobs/v4/deviceUploads")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/bulkjobs/v4/deviceUploads') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/bulkjobs/v4/deviceUploads";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/bulkjobs/v4/deviceUploads
http GET {{baseUrl}}/bulkjobs/v4/deviceUploads
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/bulkjobs/v4/deviceUploads
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/bulkjobs/v4/deviceUploads")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 429,
"error": "Too Many Requests",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "Too Many Requests"
}
POST
Starts bulk upload
{{baseUrl}}/bulkjobs/v4/deviceUploads
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/bulkjobs/v4/deviceUploads");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/bulkjobs/v4/deviceUploads")
require "http/client"
url = "{{baseUrl}}/bulkjobs/v4/deviceUploads"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/bulkjobs/v4/deviceUploads"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/bulkjobs/v4/deviceUploads");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/bulkjobs/v4/deviceUploads"
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/bulkjobs/v4/deviceUploads HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/bulkjobs/v4/deviceUploads")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/bulkjobs/v4/deviceUploads"))
.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}}/bulkjobs/v4/deviceUploads")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/bulkjobs/v4/deviceUploads")
.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}}/bulkjobs/v4/deviceUploads');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/bulkjobs/v4/deviceUploads'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/bulkjobs/v4/deviceUploads';
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}}/bulkjobs/v4/deviceUploads',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/bulkjobs/v4/deviceUploads")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/bulkjobs/v4/deviceUploads',
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}}/bulkjobs/v4/deviceUploads'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/bulkjobs/v4/deviceUploads');
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}}/bulkjobs/v4/deviceUploads'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/bulkjobs/v4/deviceUploads';
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}}/bulkjobs/v4/deviceUploads"]
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}}/bulkjobs/v4/deviceUploads" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/bulkjobs/v4/deviceUploads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/bulkjobs/v4/deviceUploads');
echo $response->getBody();
setUrl('{{baseUrl}}/bulkjobs/v4/deviceUploads');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/bulkjobs/v4/deviceUploads');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/bulkjobs/v4/deviceUploads' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/bulkjobs/v4/deviceUploads' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/bulkjobs/v4/deviceUploads", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/bulkjobs/v4/deviceUploads"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/bulkjobs/v4/deviceUploads"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/bulkjobs/v4/deviceUploads")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/bulkjobs/v4/deviceUploads') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/bulkjobs/v4/deviceUploads";
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}}/bulkjobs/v4/deviceUploads
http POST {{baseUrl}}/bulkjobs/v4/deviceUploads
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/bulkjobs/v4/deviceUploads
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/bulkjobs/v4/deviceUploads")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 412,
"details": {
"hereErrorCode": 412306
},
"error": "Precondition Failed",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The server does not meet one of the preconditions that the requester put on the request."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 429,
"error": "Too Many Requests",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "Too Many Requests"
}
PATCH
Updates bulk upload job status
{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId
BODY json
{
"action": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId");
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 \"action\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId" {:content-type :json
:form-params {:action ""}})
require "http/client"
url = "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"action\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId"),
Content = new StringContent("{\n \"action\": \"\"\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}}/bulkjobs/v4/deviceUploads/:jobId");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"action\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId"
payload := strings.NewReader("{\n \"action\": \"\"\n}")
req, _ := http.NewRequest("PATCH", 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))
}
PATCH /baseUrl/bulkjobs/v4/deviceUploads/:jobId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 18
{
"action": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId")
.setHeader("content-type", "application/json")
.setBody("{\n \"action\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"action\": \"\"\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 \"action\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId")
.header("content-type", "application/json")
.body("{\n \"action\": \"\"\n}")
.asString();
const data = JSON.stringify({
action: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId',
headers: {'content-type': 'application/json'},
data: {action: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"action":""}'
};
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}}/bulkjobs/v4/deviceUploads/:jobId',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "action": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"action\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/bulkjobs/v4/deviceUploads/:jobId',
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({action: ''}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId',
headers: {'content-type': 'application/json'},
body: {action: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
action: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId',
headers: {'content-type': 'application/json'},
data: {action: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"action":""}'
};
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 = @{ @"action": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[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}}/bulkjobs/v4/deviceUploads/:jobId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"action\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'action' => ''
]),
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('PATCH', '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId', [
'body' => '{
"action": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'action' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'action' => ''
]));
$request->setRequestUrl('{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId');
$request->setRequestMethod('PATCH');
$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}}/bulkjobs/v4/deviceUploads/:jobId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"action": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"action": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"action\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/bulkjobs/v4/deviceUploads/:jobId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId"
payload = { "action": "" }
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId"
payload <- "{\n \"action\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"action\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/bulkjobs/v4/deviceUploads/:jobId') do |req|
req.body = "{\n \"action\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId";
let payload = json!({"action": ""});
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("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId \
--header 'content-type: application/json' \
--data '{
"action": ""
}'
echo '{
"action": ""
}' | \
http PATCH {{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "action": ""\n}' \
--output-document \
- {{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["action": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/bulkjobs/v4/deviceUploads/:jobId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 412,
"details": {
"hereErrorCode": 412306
},
"error": "Precondition Failed",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The server does not meet one of the preconditions that the requester put on the request."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 429,
"error": "Too Many Requests",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "Too Many Requests"
}
POST
Adds external devices to a connector
{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices
QUERY PARAMS
connectorId
BODY json
[
{
"enabled": false,
"externalDeviceId": "",
"externalDeviceInfo": {}
}
]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices");
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 {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\n]");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices" {:content-type :json
:form-params [{:enabled false
:externalDeviceId ""
:externalDeviceInfo {}}]})
require "http/client"
url = "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "[\n {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\n]"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices"),
Content = new StringContent("[\n {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\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}}/c2c/v4/connectors/:connectorId/ext-devices");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "[\n {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\n]", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices"
payload := strings.NewReader("[\n {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\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/c2c/v4/connectors/:connectorId/ext-devices HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 90
[
{
"enabled": false,
"externalDeviceId": "",
"externalDeviceInfo": {}
}
]
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices")
.setHeader("content-type", "application/json")
.setBody("[\n {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\n]")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("[\n {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\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 {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\n]");
Request request = new Request.Builder()
.url("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices")
.header("content-type", "application/json")
.body("[\n {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\n]")
.asString();
const data = JSON.stringify([
{
enabled: false,
externalDeviceId: '',
externalDeviceInfo: {}
}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices',
headers: {'content-type': 'application/json'},
data: [{enabled: false, externalDeviceId: '', externalDeviceInfo: {}}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '[{"enabled":false,"externalDeviceId":"","externalDeviceInfo":{}}]'
};
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}}/c2c/v4/connectors/:connectorId/ext-devices',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '[\n {\n "enabled": false,\n "externalDeviceId": "",\n "externalDeviceInfo": {}\n }\n]'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "[\n {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\n]")
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices")
.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/c2c/v4/connectors/:connectorId/ext-devices',
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([{enabled: false, externalDeviceId: '', externalDeviceInfo: {}}]));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices',
headers: {'content-type': 'application/json'},
body: [{enabled: false, externalDeviceId: '', externalDeviceInfo: {}}],
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}}/c2c/v4/connectors/:connectorId/ext-devices');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send([
{
enabled: false,
externalDeviceId: '',
externalDeviceInfo: {}
}
]);
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}}/c2c/v4/connectors/:connectorId/ext-devices',
headers: {'content-type': 'application/json'},
data: [{enabled: false, externalDeviceId: '', externalDeviceInfo: {}}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '[{"enabled":false,"externalDeviceId":"","externalDeviceInfo":{}}]'
};
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 = @[ @{ @"enabled": @NO, @"externalDeviceId": @"", @"externalDeviceInfo": @{ } } ];
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices"]
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}}/c2c/v4/connectors/:connectorId/ext-devices" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "[\n {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\n]" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices",
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([
[
'enabled' => null,
'externalDeviceId' => '',
'externalDeviceInfo' => [
]
]
]),
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}}/c2c/v4/connectors/:connectorId/ext-devices', [
'body' => '[
{
"enabled": false,
"externalDeviceId": "",
"externalDeviceInfo": {}
}
]',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
[
'enabled' => null,
'externalDeviceId' => '',
'externalDeviceInfo' => [
]
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
[
'enabled' => null,
'externalDeviceId' => '',
'externalDeviceInfo' => [
]
]
]));
$request->setRequestUrl('{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices');
$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}}/c2c/v4/connectors/:connectorId/ext-devices' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{
"enabled": false,
"externalDeviceId": "",
"externalDeviceInfo": {}
}
]'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{
"enabled": false,
"externalDeviceId": "",
"externalDeviceInfo": {}
}
]'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "[\n {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\n]"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/c2c/v4/connectors/:connectorId/ext-devices", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices"
payload = [
{
"enabled": False,
"externalDeviceId": "",
"externalDeviceInfo": {}
}
]
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices"
payload <- "[\n {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\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}}/c2c/v4/connectors/:connectorId/ext-devices")
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 {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\n]"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/c2c/v4/connectors/:connectorId/ext-devices') do |req|
req.body = "[\n {\n \"enabled\": false,\n \"externalDeviceId\": \"\",\n \"externalDeviceInfo\": {}\n }\n]"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices";
let payload = (
json!({
"enabled": false,
"externalDeviceId": "",
"externalDeviceInfo": json!({})
})
);
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}}/c2c/v4/connectors/:connectorId/ext-devices \
--header 'content-type: application/json' \
--data '[
{
"enabled": false,
"externalDeviceId": "",
"externalDeviceInfo": {}
}
]'
echo '[
{
"enabled": false,
"externalDeviceId": "",
"externalDeviceInfo": {}
}
]' | \
http POST {{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '[\n {\n "enabled": false,\n "externalDeviceId": "",\n "externalDeviceInfo": {}\n }\n]' \
--output-document \
- {{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
[
"enabled": false,
"externalDeviceId": "",
"externalDeviceInfo": []
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
POST
Creates a connector
{{baseUrl}}/c2c/v4/connectors
BODY json
{
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/connectors");
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 \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/c2c/v4/connectors" {:content-type :json
:form-params {:description ""
:driverId ""
:enabled false
:externalCloudInfo {}
:name ""
:refreshIntervalS 0}})
require "http/client"
url = "{{baseUrl}}/c2c/v4/connectors"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/connectors"),
Content = new StringContent("{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\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}}/c2c/v4/connectors");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/connectors"
payload := strings.NewReader("{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\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/c2c/v4/connectors HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 127
{
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/c2c/v4/connectors")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/connectors"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\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 \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/c2c/v4/connectors")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/c2c/v4/connectors")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}")
.asString();
const data = JSON.stringify({
description: '',
driverId: '',
enabled: false,
externalCloudInfo: {},
name: '',
refreshIntervalS: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/c2c/v4/connectors');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/c2c/v4/connectors',
headers: {'content-type': 'application/json'},
data: {
description: '',
driverId: '',
enabled: false,
externalCloudInfo: {},
name: '',
refreshIntervalS: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/connectors';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"description":"","driverId":"","enabled":false,"externalCloudInfo":{},"name":"","refreshIntervalS":0}'
};
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}}/c2c/v4/connectors',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\n "driverId": "",\n "enabled": false,\n "externalCloudInfo": {},\n "name": "",\n "refreshIntervalS": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/connectors")
.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/c2c/v4/connectors',
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({
description: '',
driverId: '',
enabled: false,
externalCloudInfo: {},
name: '',
refreshIntervalS: 0
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/c2c/v4/connectors',
headers: {'content-type': 'application/json'},
body: {
description: '',
driverId: '',
enabled: false,
externalCloudInfo: {},
name: '',
refreshIntervalS: 0
},
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}}/c2c/v4/connectors');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
driverId: '',
enabled: false,
externalCloudInfo: {},
name: '',
refreshIntervalS: 0
});
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}}/c2c/v4/connectors',
headers: {'content-type': 'application/json'},
data: {
description: '',
driverId: '',
enabled: false,
externalCloudInfo: {},
name: '',
refreshIntervalS: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/connectors';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"description":"","driverId":"","enabled":false,"externalCloudInfo":{},"name":"","refreshIntervalS":0}'
};
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 = @{ @"description": @"",
@"driverId": @"",
@"enabled": @NO,
@"externalCloudInfo": @{ },
@"name": @"",
@"refreshIntervalS": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/c2c/v4/connectors"]
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}}/c2c/v4/connectors" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/connectors",
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([
'description' => '',
'driverId' => '',
'enabled' => null,
'externalCloudInfo' => [
],
'name' => '',
'refreshIntervalS' => 0
]),
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}}/c2c/v4/connectors', [
'body' => '{
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/connectors');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'driverId' => '',
'enabled' => null,
'externalCloudInfo' => [
],
'name' => '',
'refreshIntervalS' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'driverId' => '',
'enabled' => null,
'externalCloudInfo' => [
],
'name' => '',
'refreshIntervalS' => 0
]));
$request->setRequestUrl('{{baseUrl}}/c2c/v4/connectors');
$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}}/c2c/v4/connectors' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/connectors' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/c2c/v4/connectors", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/connectors"
payload = {
"description": "",
"driverId": "",
"enabled": False,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/connectors"
payload <- "{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\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}}/c2c/v4/connectors")
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 \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/c2c/v4/connectors') do |req|
req.body = "{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/connectors";
let payload = json!({
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": json!({}),
"name": "",
"refreshIntervalS": 0
});
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}}/c2c/v4/connectors \
--header 'content-type: application/json' \
--data '{
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}'
echo '{
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}' | \
http POST {{baseUrl}}/c2c/v4/connectors \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "driverId": "",\n "enabled": false,\n "externalCloudInfo": {},\n "name": "",\n "refreshIntervalS": 0\n}' \
--output-document \
- {{baseUrl}}/c2c/v4/connectors
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": [],
"name": "",
"refreshIntervalS": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/connectors")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 409,
"details": {
"hereErrorCode": 404306
},
"error": "Conflict",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource already exists."
}
DELETE
Deletes a connector
{{baseUrl}}/c2c/v4/connectors/:connectorId
QUERY PARAMS
connectorId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/connectors/:connectorId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/c2c/v4/connectors/:connectorId")
require "http/client"
url = "{{baseUrl}}/c2c/v4/connectors/:connectorId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/connectors/:connectorId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/c2c/v4/connectors/:connectorId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/connectors/:connectorId"
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/c2c/v4/connectors/:connectorId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/c2c/v4/connectors/:connectorId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/connectors/:connectorId"))
.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}}/c2c/v4/connectors/:connectorId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/c2c/v4/connectors/:connectorId")
.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}}/c2c/v4/connectors/:connectorId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/c2c/v4/connectors/:connectorId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/connectors/:connectorId';
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}}/c2c/v4/connectors/:connectorId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/connectors/:connectorId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/c2c/v4/connectors/:connectorId',
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}}/c2c/v4/connectors/:connectorId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/c2c/v4/connectors/:connectorId');
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}}/c2c/v4/connectors/:connectorId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/connectors/:connectorId';
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}}/c2c/v4/connectors/:connectorId"]
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}}/c2c/v4/connectors/:connectorId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/connectors/:connectorId",
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}}/c2c/v4/connectors/:connectorId');
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/connectors/:connectorId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/c2c/v4/connectors/:connectorId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/c2c/v4/connectors/:connectorId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/connectors/:connectorId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/c2c/v4/connectors/:connectorId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/connectors/:connectorId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/connectors/:connectorId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/c2c/v4/connectors/:connectorId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/c2c/v4/connectors/:connectorId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/connectors/:connectorId";
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}}/c2c/v4/connectors/:connectorId
http DELETE {{baseUrl}}/c2c/v4/connectors/:connectorId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/c2c/v4/connectors/:connectorId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/connectors/:connectorId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 412,
"details": {
"hereErrorCode": 412306
},
"error": "Precondition Failed",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The server does not meet one of the preconditions that the requester put on the request."
}
GET
Gets a connector info
{{baseUrl}}/c2c/v4/connectors/:connectorId
QUERY PARAMS
connectorId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/connectors/:connectorId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/c2c/v4/connectors/:connectorId")
require "http/client"
url = "{{baseUrl}}/c2c/v4/connectors/:connectorId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/connectors/:connectorId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/c2c/v4/connectors/:connectorId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/connectors/:connectorId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/c2c/v4/connectors/:connectorId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/c2c/v4/connectors/:connectorId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/connectors/:connectorId"))
.method("GET", 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}}/c2c/v4/connectors/:connectorId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/c2c/v4/connectors/:connectorId")
.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('GET', '{{baseUrl}}/c2c/v4/connectors/:connectorId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/c2c/v4/connectors/:connectorId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/connectors/:connectorId';
const options = {method: 'GET'};
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}}/c2c/v4/connectors/:connectorId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/connectors/:connectorId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/c2c/v4/connectors/:connectorId',
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: 'GET',
url: '{{baseUrl}}/c2c/v4/connectors/:connectorId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/c2c/v4/connectors/:connectorId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/c2c/v4/connectors/:connectorId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/connectors/:connectorId';
const options = {method: 'GET'};
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}}/c2c/v4/connectors/:connectorId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/c2c/v4/connectors/:connectorId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/connectors/:connectorId",
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;
}
request('GET', '{{baseUrl}}/c2c/v4/connectors/:connectorId');
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/connectors/:connectorId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/c2c/v4/connectors/:connectorId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/c2c/v4/connectors/:connectorId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/connectors/:connectorId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/c2c/v4/connectors/:connectorId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/connectors/:connectorId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/connectors/:connectorId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/c2c/v4/connectors/:connectorId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/c2c/v4/connectors/:connectorId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/connectors/:connectorId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/c2c/v4/connectors/:connectorId
http GET {{baseUrl}}/c2c/v4/connectors/:connectorId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/c2c/v4/connectors/:connectorId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/connectors/:connectorId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets a list of connectors
{{baseUrl}}/c2c/v4/connectors
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/connectors");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/c2c/v4/connectors")
require "http/client"
url = "{{baseUrl}}/c2c/v4/connectors"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/connectors"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/c2c/v4/connectors");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/connectors"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/c2c/v4/connectors HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/c2c/v4/connectors")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/connectors"))
.method("GET", 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}}/c2c/v4/connectors")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/c2c/v4/connectors")
.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('GET', '{{baseUrl}}/c2c/v4/connectors');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/c2c/v4/connectors'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/connectors';
const options = {method: 'GET'};
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}}/c2c/v4/connectors',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/connectors")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/c2c/v4/connectors',
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: 'GET', url: '{{baseUrl}}/c2c/v4/connectors'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/c2c/v4/connectors');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/c2c/v4/connectors'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/connectors';
const options = {method: 'GET'};
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}}/c2c/v4/connectors"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/c2c/v4/connectors" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/connectors",
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;
}
request('GET', '{{baseUrl}}/c2c/v4/connectors');
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/connectors');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/c2c/v4/connectors');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/c2c/v4/connectors' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/connectors' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/c2c/v4/connectors")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/connectors"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/connectors"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/c2c/v4/connectors")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/c2c/v4/connectors') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/connectors";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/c2c/v4/connectors
http GET {{baseUrl}}/c2c/v4/connectors
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/c2c/v4/connectors
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/connectors")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets a list of drivers
{{baseUrl}}/c2c/v4/drivers
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/drivers");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/c2c/v4/drivers")
require "http/client"
url = "{{baseUrl}}/c2c/v4/drivers"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/drivers"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/c2c/v4/drivers");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/drivers"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/c2c/v4/drivers HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/c2c/v4/drivers")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/drivers"))
.method("GET", 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}}/c2c/v4/drivers")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/c2c/v4/drivers")
.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('GET', '{{baseUrl}}/c2c/v4/drivers');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/c2c/v4/drivers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/drivers';
const options = {method: 'GET'};
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}}/c2c/v4/drivers',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/drivers")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/c2c/v4/drivers',
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: 'GET', url: '{{baseUrl}}/c2c/v4/drivers'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/c2c/v4/drivers');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/c2c/v4/drivers'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/drivers';
const options = {method: 'GET'};
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}}/c2c/v4/drivers"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/c2c/v4/drivers" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/drivers",
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;
}
request('GET', '{{baseUrl}}/c2c/v4/drivers');
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/drivers');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/c2c/v4/drivers');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/c2c/v4/drivers' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/drivers' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/c2c/v4/drivers")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/drivers"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/drivers"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/c2c/v4/drivers")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/c2c/v4/drivers') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/drivers";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/c2c/v4/drivers
http GET {{baseUrl}}/c2c/v4/drivers
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/c2c/v4/drivers
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/drivers")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"items": [
{
"autoProvisionCallbackDevices": true,
"driverId": "my-driver-1-id",
"driverSyncMethod": "pull",
"driverType": "internal",
"externalCloudInfoSchema": [
{}
],
"provider": "External Cloud 1",
"strategy": {
"managerId": "my-manager-1-id",
"name": "my-manager-1"
},
"version": 0
}
]
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets all external devices under a connector
{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices
QUERY PARAMS
connectorId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices")
require "http/client"
url = "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/c2c/v4/connectors/:connectorId/ext-devices HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices"))
.method("GET", 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}}/c2c/v4/connectors/:connectorId/ext-devices")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices")
.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('GET', '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices';
const options = {method: 'GET'};
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}}/c2c/v4/connectors/:connectorId/ext-devices',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/c2c/v4/connectors/:connectorId/ext-devices',
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: 'GET',
url: '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices';
const options = {method: 'GET'};
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}}/c2c/v4/connectors/:connectorId/ext-devices"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/c2c/v4/connectors/:connectorId/ext-devices" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices",
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;
}
request('GET', '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices');
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/c2c/v4/connectors/:connectorId/ext-devices")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/c2c/v4/connectors/:connectorId/ext-devices') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices
http GET {{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets connector identifiers for an external device
{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId
QUERY PARAMS
externalDeviceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId")
require "http/client"
url = "{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/c2c/v4/connectors/ext-devices/:externalDeviceId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId"))
.method("GET", 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}}/c2c/v4/connectors/ext-devices/:externalDeviceId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId")
.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('GET', '{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId';
const options = {method: 'GET'};
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}}/c2c/v4/connectors/ext-devices/:externalDeviceId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/c2c/v4/connectors/ext-devices/:externalDeviceId',
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: 'GET',
url: '{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId';
const options = {method: 'GET'};
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}}/c2c/v4/connectors/ext-devices/:externalDeviceId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/c2c/v4/connectors/ext-devices/:externalDeviceId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId",
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;
}
request('GET', '{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId');
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/c2c/v4/connectors/ext-devices/:externalDeviceId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/c2c/v4/connectors/ext-devices/:externalDeviceId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId
http GET {{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/connectors/ext-devices/:externalDeviceId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets service health (2)
{{baseUrl}}/c2c/v4/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/c2c/v4/health")
require "http/client"
url = "{{baseUrl}}/c2c/v4/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/c2c/v4/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/c2c/v4/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/c2c/v4/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/health"))
.method("GET", 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}}/c2c/v4/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/c2c/v4/health")
.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('GET', '{{baseUrl}}/c2c/v4/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/c2c/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/health';
const options = {method: 'GET'};
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}}/c2c/v4/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/c2c/v4/health',
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: 'GET', url: '{{baseUrl}}/c2c/v4/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/c2c/v4/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/c2c/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/health';
const options = {method: 'GET'};
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}}/c2c/v4/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/c2c/v4/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/health",
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;
}
request('GET', '{{baseUrl}}/c2c/v4/health');
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/c2c/v4/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/c2c/v4/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/c2c/v4/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/c2c/v4/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/c2c/v4/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/c2c/v4/health
http GET {{baseUrl}}/c2c/v4/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/c2c/v4/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (2)
{{baseUrl}}/c2c/v4/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/c2c/v4/version")
require "http/client"
url = "{{baseUrl}}/c2c/v4/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/c2c/v4/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/c2c/v4/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/c2c/v4/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/version"))
.method("GET", 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}}/c2c/v4/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/c2c/v4/version")
.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('GET', '{{baseUrl}}/c2c/v4/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/c2c/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/version';
const options = {method: 'GET'};
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}}/c2c/v4/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/c2c/v4/version',
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: 'GET', url: '{{baseUrl}}/c2c/v4/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/c2c/v4/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/c2c/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/version';
const options = {method: 'GET'};
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}}/c2c/v4/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/c2c/v4/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/version",
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;
}
request('GET', '{{baseUrl}}/c2c/v4/version');
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/c2c/v4/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/c2c/v4/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/c2c/v4/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/c2c/v4/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/c2c/v4/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/c2c/v4/version
http GET {{baseUrl}}/c2c/v4/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/c2c/v4/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
Receives external device update reports
{{baseUrl}}/c2c/v4/callback
QUERY PARAMS
apiKey
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/callback?apiKey=");
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, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/c2c/v4/callback" {:query-params {:apiKey ""}
:content-type :json})
require "http/client"
url = "{{baseUrl}}/c2c/v4/callback?apiKey="
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/callback?apiKey="),
Content = new StringContent("{}")
{
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}}/c2c/v4/callback?apiKey=");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/callback?apiKey="
payload := strings.NewReader("{}")
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/c2c/v4/callback?apiKey= HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/c2c/v4/callback?apiKey=")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/callback?apiKey="))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.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, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/c2c/v4/callback?apiKey=")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/c2c/v4/callback?apiKey=")
.header("content-type", "application/json")
.body("{}")
.asString();
const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/c2c/v4/callback?apiKey=');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/c2c/v4/callback',
params: {apiKey: ''},
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/callback?apiKey=';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
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}}/c2c/v4/callback?apiKey=',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/callback?apiKey=")
.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/c2c/v4/callback?apiKey=',
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({}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/c2c/v4/callback',
qs: {apiKey: ''},
headers: {'content-type': 'application/json'},
body: {},
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}}/c2c/v4/callback');
req.query({
apiKey: ''
});
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
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}}/c2c/v4/callback',
params: {apiKey: ''},
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/callback?apiKey=';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
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 = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/c2c/v4/callback?apiKey="]
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}}/c2c/v4/callback?apiKey=" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/callback?apiKey=",
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([
]),
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}}/c2c/v4/callback?apiKey=', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/callback');
$request->setMethod(HTTP_METH_POST);
$request->setQueryData([
'apiKey' => ''
]);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/c2c/v4/callback');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setQuery(new http\QueryString([
'apiKey' => ''
]));
$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}}/c2c/v4/callback?apiKey=' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/callback?apiKey=' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/c2c/v4/callback?apiKey=", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/callback"
querystring = {"apiKey":""}
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers, params=querystring)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/callback"
queryString <- list(apiKey = "")
payload <- "{}"
encode <- "json"
response <- VERB("POST", url, body = payload, query = queryString, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/c2c/v4/callback?apiKey=")
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 = "{}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/c2c/v4/callback') do |req|
req.params['apiKey'] = ''
req.body = "{}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/callback";
let querystring = [
("apiKey", ""),
];
let payload = json!({});
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)
.query(&querystring)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url '{{baseUrl}}/c2c/v4/callback?apiKey=' \
--header 'content-type: application/json' \
--data '{}'
echo '{}' | \
http POST '{{baseUrl}}/c2c/v4/callback?apiKey=' \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- '{{baseUrl}}/c2c/v4/callback?apiKey='
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/callback?apiKey=")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 501,
"details": {
"hereErrorCode": 501306
},
"error": "Not Implemented",
"id": "78fa16ca-6702-4cc7-90dd-29f60a6528d6",
"message": "This feature is not yet available."
}
DELETE
Removes a batch of external devices from a connector
{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch
QUERY PARAMS
connectorId
BODY json
{
"externalDeviceIds": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch");
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 \"externalDeviceIds\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch" {:content-type :json
:form-params {:externalDeviceIds []}})
require "http/client"
url = "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"externalDeviceIds\": []\n}"
response = HTTP::Client.delete url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch"),
Content = new StringContent("{\n \"externalDeviceIds\": []\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}}/c2c/v4/connectors/:connectorId/ext-devices-batch");
var request = new RestRequest("", Method.Delete);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"externalDeviceIds\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch"
payload := strings.NewReader("{\n \"externalDeviceIds\": []\n}")
req, _ := http.NewRequest("DELETE", 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))
}
DELETE /baseUrl/c2c/v4/connectors/:connectorId/ext-devices-batch HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 29
{
"externalDeviceIds": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch")
.setHeader("content-type", "application/json")
.setBody("{\n \"externalDeviceIds\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch"))
.header("content-type", "application/json")
.method("DELETE", HttpRequest.BodyPublishers.ofString("{\n \"externalDeviceIds\": []\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 \"externalDeviceIds\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch")
.delete(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch")
.header("content-type", "application/json")
.body("{\n \"externalDeviceIds\": []\n}")
.asString();
const data = JSON.stringify({
externalDeviceIds: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch',
headers: {'content-type': 'application/json'},
data: {externalDeviceIds: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch';
const options = {
method: 'DELETE',
headers: {'content-type': 'application/json'},
body: '{"externalDeviceIds":[]}'
};
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}}/c2c/v4/connectors/:connectorId/ext-devices-batch',
method: 'DELETE',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "externalDeviceIds": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"externalDeviceIds\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch")
.delete(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/c2c/v4/connectors/:connectorId/ext-devices-batch',
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({externalDeviceIds: []}));
req.end();
const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch',
headers: {'content-type': 'application/json'},
body: {externalDeviceIds: []},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
externalDeviceIds: []
});
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}}/c2c/v4/connectors/:connectorId/ext-devices-batch',
headers: {'content-type': 'application/json'},
data: {externalDeviceIds: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch';
const options = {
method: 'DELETE',
headers: {'content-type': 'application/json'},
body: '{"externalDeviceIds":[]}'
};
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 = @{ @"externalDeviceIds": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[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}}/c2c/v4/connectors/:connectorId/ext-devices-batch" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"externalDeviceIds\": []\n}" in
Client.call ~headers ~body `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'externalDeviceIds' => [
]
]),
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('DELETE', '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch', [
'body' => '{
"externalDeviceIds": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'externalDeviceIds' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'externalDeviceIds' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch');
$request->setRequestMethod('DELETE');
$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}}/c2c/v4/connectors/:connectorId/ext-devices-batch' -Method DELETE -Headers $headers -ContentType 'application/json' -Body '{
"externalDeviceIds": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch' -Method DELETE -Headers $headers -ContentType 'application/json' -Body '{
"externalDeviceIds": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"externalDeviceIds\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("DELETE", "/baseUrl/c2c/v4/connectors/:connectorId/ext-devices-batch", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch"
payload = { "externalDeviceIds": [] }
headers = {"content-type": "application/json"}
response = requests.delete(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch"
payload <- "{\n \"externalDeviceIds\": []\n}"
encode <- "json"
response <- VERB("DELETE", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"externalDeviceIds\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.delete('/baseUrl/c2c/v4/connectors/:connectorId/ext-devices-batch') do |req|
req.body = "{\n \"externalDeviceIds\": []\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch";
let payload = json!({"externalDeviceIds": ()});
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("DELETE").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch \
--header 'content-type: application/json' \
--data '{
"externalDeviceIds": []
}'
echo '{
"externalDeviceIds": []
}' | \
http DELETE {{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch \
content-type:application/json
wget --quiet \
--method DELETE \
--header 'content-type: application/json' \
--body-data '{\n "externalDeviceIds": []\n}' \
--output-document \
- {{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["externalDeviceIds": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices-batch")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Removes an external device from a connector
{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId
QUERY PARAMS
connectorId
externalDeviceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId")
require "http/client"
url = "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId"
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/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId"))
.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}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId")
.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}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId';
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}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId',
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}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId');
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}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId';
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}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId"]
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}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId",
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}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId');
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId";
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}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId
http DELETE {{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/connectors/:connectorId/ext-devices/:externalDeviceId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
PUT
Updates a connector info
{{baseUrl}}/c2c/v4/connectors/:connectorId
QUERY PARAMS
connectorId
BODY json
{
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/connectors/:connectorId");
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 \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/c2c/v4/connectors/:connectorId" {:content-type :json
:form-params {:description ""
:driverId ""
:enabled false
:externalCloudInfo {}
:name ""
:refreshIntervalS 0}})
require "http/client"
url = "{{baseUrl}}/c2c/v4/connectors/:connectorId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/connectors/:connectorId"),
Content = new StringContent("{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\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}}/c2c/v4/connectors/:connectorId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/connectors/:connectorId"
payload := strings.NewReader("{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\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/c2c/v4/connectors/:connectorId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 127
{
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/c2c/v4/connectors/:connectorId")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/connectors/:connectorId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\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 \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/c2c/v4/connectors/:connectorId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/c2c/v4/connectors/:connectorId")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}")
.asString();
const data = JSON.stringify({
description: '',
driverId: '',
enabled: false,
externalCloudInfo: {},
name: '',
refreshIntervalS: 0
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/c2c/v4/connectors/:connectorId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/c2c/v4/connectors/:connectorId',
headers: {'content-type': 'application/json'},
data: {
description: '',
driverId: '',
enabled: false,
externalCloudInfo: {},
name: '',
refreshIntervalS: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/connectors/:connectorId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"description":"","driverId":"","enabled":false,"externalCloudInfo":{},"name":"","refreshIntervalS":0}'
};
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}}/c2c/v4/connectors/:connectorId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\n "driverId": "",\n "enabled": false,\n "externalCloudInfo": {},\n "name": "",\n "refreshIntervalS": 0\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}")
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/connectors/:connectorId")
.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/c2c/v4/connectors/:connectorId',
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({
description: '',
driverId: '',
enabled: false,
externalCloudInfo: {},
name: '',
refreshIntervalS: 0
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/c2c/v4/connectors/:connectorId',
headers: {'content-type': 'application/json'},
body: {
description: '',
driverId: '',
enabled: false,
externalCloudInfo: {},
name: '',
refreshIntervalS: 0
},
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}}/c2c/v4/connectors/:connectorId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
driverId: '',
enabled: false,
externalCloudInfo: {},
name: '',
refreshIntervalS: 0
});
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}}/c2c/v4/connectors/:connectorId',
headers: {'content-type': 'application/json'},
data: {
description: '',
driverId: '',
enabled: false,
externalCloudInfo: {},
name: '',
refreshIntervalS: 0
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/connectors/:connectorId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"description":"","driverId":"","enabled":false,"externalCloudInfo":{},"name":"","refreshIntervalS":0}'
};
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 = @{ @"description": @"",
@"driverId": @"",
@"enabled": @NO,
@"externalCloudInfo": @{ },
@"name": @"",
@"refreshIntervalS": @0 };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/c2c/v4/connectors/:connectorId"]
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}}/c2c/v4/connectors/:connectorId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/connectors/:connectorId",
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([
'description' => '',
'driverId' => '',
'enabled' => null,
'externalCloudInfo' => [
],
'name' => '',
'refreshIntervalS' => 0
]),
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}}/c2c/v4/connectors/:connectorId', [
'body' => '{
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/connectors/:connectorId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'driverId' => '',
'enabled' => null,
'externalCloudInfo' => [
],
'name' => '',
'refreshIntervalS' => 0
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'driverId' => '',
'enabled' => null,
'externalCloudInfo' => [
],
'name' => '',
'refreshIntervalS' => 0
]));
$request->setRequestUrl('{{baseUrl}}/c2c/v4/connectors/:connectorId');
$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}}/c2c/v4/connectors/:connectorId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/connectors/:connectorId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/c2c/v4/connectors/:connectorId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/connectors/:connectorId"
payload = {
"description": "",
"driverId": "",
"enabled": False,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/connectors/:connectorId"
payload <- "{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\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}}/c2c/v4/connectors/:connectorId")
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 \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/c2c/v4/connectors/:connectorId') do |req|
req.body = "{\n \"description\": \"\",\n \"driverId\": \"\",\n \"enabled\": false,\n \"externalCloudInfo\": {},\n \"name\": \"\",\n \"refreshIntervalS\": 0\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/connectors/:connectorId";
let payload = json!({
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": json!({}),
"name": "",
"refreshIntervalS": 0
});
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}}/c2c/v4/connectors/:connectorId \
--header 'content-type: application/json' \
--data '{
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}'
echo '{
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": {},
"name": "",
"refreshIntervalS": 0
}' | \
http PUT {{baseUrl}}/c2c/v4/connectors/:connectorId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "driverId": "",\n "enabled": false,\n "externalCloudInfo": {},\n "name": "",\n "refreshIntervalS": 0\n}' \
--output-document \
- {{baseUrl}}/c2c/v4/connectors/:connectorId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"driverId": "",
"enabled": false,
"externalCloudInfo": [],
"name": "",
"refreshIntervalS": 0
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/connectors/:connectorId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
POST
Validate and verify external cloud credentials for driver
{{baseUrl}}/c2c/v4/drivers/:driverId/verify
QUERY PARAMS
driverId
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/c2c/v4/drivers/:driverId/verify");
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, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/c2c/v4/drivers/:driverId/verify" {:content-type :json})
require "http/client"
url = "{{baseUrl}}/c2c/v4/drivers/:driverId/verify"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/c2c/v4/drivers/:driverId/verify"),
Content = new StringContent("{}")
{
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}}/c2c/v4/drivers/:driverId/verify");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/c2c/v4/drivers/:driverId/verify"
payload := strings.NewReader("{}")
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/c2c/v4/drivers/:driverId/verify HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/c2c/v4/drivers/:driverId/verify")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/c2c/v4/drivers/:driverId/verify"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.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, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/c2c/v4/drivers/:driverId/verify")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/c2c/v4/drivers/:driverId/verify")
.header("content-type", "application/json")
.body("{}")
.asString();
const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/c2c/v4/drivers/:driverId/verify');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/c2c/v4/drivers/:driverId/verify',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/c2c/v4/drivers/:driverId/verify';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
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}}/c2c/v4/drivers/:driverId/verify',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/c2c/v4/drivers/:driverId/verify")
.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/c2c/v4/drivers/:driverId/verify',
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({}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/c2c/v4/drivers/:driverId/verify',
headers: {'content-type': 'application/json'},
body: {},
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}}/c2c/v4/drivers/:driverId/verify');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
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}}/c2c/v4/drivers/:driverId/verify',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/c2c/v4/drivers/:driverId/verify';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
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 = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/c2c/v4/drivers/:driverId/verify"]
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}}/c2c/v4/drivers/:driverId/verify" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/c2c/v4/drivers/:driverId/verify",
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([
]),
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}}/c2c/v4/drivers/:driverId/verify', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/c2c/v4/drivers/:driverId/verify');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/c2c/v4/drivers/:driverId/verify');
$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}}/c2c/v4/drivers/:driverId/verify' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/c2c/v4/drivers/:driverId/verify' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/c2c/v4/drivers/:driverId/verify", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/c2c/v4/drivers/:driverId/verify"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/c2c/v4/drivers/:driverId/verify"
payload <- "{}"
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}}/c2c/v4/drivers/:driverId/verify")
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 = "{}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/c2c/v4/drivers/:driverId/verify') do |req|
req.body = "{}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/c2c/v4/drivers/:driverId/verify";
let payload = json!({});
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}}/c2c/v4/drivers/:driverId/verify \
--header 'content-type: application/json' \
--data '{}'
echo '{}' | \
http POST {{baseUrl}}/c2c/v4/drivers/:driverId/verify \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/c2c/v4/drivers/:driverId/verify
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/c2c/v4/drivers/:driverId/verify")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 501,
"details": {
"hereErrorCode": 501306
},
"error": "Not Implemented",
"id": "78fa16ca-6702-4cc7-90dd-29f60a6528d6",
"message": "This feature is not yet available."
}
GET
Gets geofences associated with a device (GET)
{{baseUrl}}/device-associations/v2/:trackingId/geofences
QUERY PARAMS
trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/device-associations/v2/:trackingId/geofences");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/device-associations/v2/:trackingId/geofences")
require "http/client"
url = "{{baseUrl}}/device-associations/v2/:trackingId/geofences"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/device-associations/v2/:trackingId/geofences"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/device-associations/v2/:trackingId/geofences");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/device-associations/v2/:trackingId/geofences"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/device-associations/v2/:trackingId/geofences HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/device-associations/v2/:trackingId/geofences")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/device-associations/v2/:trackingId/geofences"))
.method("GET", 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}}/device-associations/v2/:trackingId/geofences")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/device-associations/v2/:trackingId/geofences")
.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('GET', '{{baseUrl}}/device-associations/v2/:trackingId/geofences');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/device-associations/v2/:trackingId/geofences'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/device-associations/v2/:trackingId/geofences';
const options = {method: 'GET'};
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}}/device-associations/v2/:trackingId/geofences',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/device-associations/v2/:trackingId/geofences")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/device-associations/v2/:trackingId/geofences',
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: 'GET',
url: '{{baseUrl}}/device-associations/v2/:trackingId/geofences'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/device-associations/v2/:trackingId/geofences');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/device-associations/v2/:trackingId/geofences'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/device-associations/v2/:trackingId/geofences';
const options = {method: 'GET'};
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}}/device-associations/v2/:trackingId/geofences"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/device-associations/v2/:trackingId/geofences" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/device-associations/v2/:trackingId/geofences",
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;
}
request('GET', '{{baseUrl}}/device-associations/v2/:trackingId/geofences');
echo $response->getBody();
setUrl('{{baseUrl}}/device-associations/v2/:trackingId/geofences');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/device-associations/v2/:trackingId/geofences');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/device-associations/v2/:trackingId/geofences' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/device-associations/v2/:trackingId/geofences' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/device-associations/v2/:trackingId/geofences")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/device-associations/v2/:trackingId/geofences"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/device-associations/v2/:trackingId/geofences"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/device-associations/v2/:trackingId/geofences")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/device-associations/v2/:trackingId/geofences') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/device-associations/v2/:trackingId/geofences";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/device-associations/v2/:trackingId/geofences
http GET {{baseUrl}}/device-associations/v2/:trackingId/geofences
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/device-associations/v2/:trackingId/geofences
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/device-associations/v2/:trackingId/geofences")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 2,
"data": [
{
"geofence": {
"definition": {
"points": [
{
"lat": 52.5308398,
"lng": 13.38490035
},
{
"lat": 52.5408398,
"lng": 14.38490035
},
{
"lat": 53.5308398,
"lng": 13.39490035
}
]
},
"type": "polygon"
},
"id": "d0c29690-5d26-4cf1-a37e-b7816e72cb99"
},
{
"geofence": {
"definition": {
"center": {
"lat": 52.5308398,
"lng": 13.38490035
},
"floor": {
"id": "DM_82228",
"name": "House 3"
},
"radius": 100
},
"description": "This is a circular geofence",
"name": "16fbc82c-88d1-4219-bfad-6e5de52688a2",
"type": "circle"
},
"id": "ff92eda0-3114-4640-b7e6-4ba641ae1124"
}
],
"pageToken": "027ffffea253d79fc"
}
RESPONSE HEADERS
Content-Type
application/octet-stream
RESPONSE BODY text
34 56 18 93 45 29 54 62 77 28 23 79 22
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "The trackingId was not found."
}
GET
Gets service health (3)
{{baseUrl}}/device-associations/v2/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/device-associations/v2/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/device-associations/v2/health")
require "http/client"
url = "{{baseUrl}}/device-associations/v2/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/device-associations/v2/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/device-associations/v2/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/device-associations/v2/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/device-associations/v2/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/device-associations/v2/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/device-associations/v2/health"))
.method("GET", 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}}/device-associations/v2/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/device-associations/v2/health")
.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('GET', '{{baseUrl}}/device-associations/v2/health');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/device-associations/v2/health'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/device-associations/v2/health';
const options = {method: 'GET'};
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}}/device-associations/v2/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/device-associations/v2/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/device-associations/v2/health',
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: 'GET',
url: '{{baseUrl}}/device-associations/v2/health'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/device-associations/v2/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/device-associations/v2/health'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/device-associations/v2/health';
const options = {method: 'GET'};
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}}/device-associations/v2/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/device-associations/v2/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/device-associations/v2/health",
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;
}
request('GET', '{{baseUrl}}/device-associations/v2/health');
echo $response->getBody();
setUrl('{{baseUrl}}/device-associations/v2/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/device-associations/v2/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/device-associations/v2/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/device-associations/v2/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/device-associations/v2/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/device-associations/v2/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/device-associations/v2/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/device-associations/v2/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/device-associations/v2/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/device-associations/v2/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/device-associations/v2/health
http GET {{baseUrl}}/device-associations/v2/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/device-associations/v2/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/device-associations/v2/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (3)
{{baseUrl}}/device-associations/v2/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/device-associations/v2/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/device-associations/v2/version")
require "http/client"
url = "{{baseUrl}}/device-associations/v2/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/device-associations/v2/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/device-associations/v2/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/device-associations/v2/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/device-associations/v2/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/device-associations/v2/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/device-associations/v2/version"))
.method("GET", 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}}/device-associations/v2/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/device-associations/v2/version")
.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('GET', '{{baseUrl}}/device-associations/v2/version');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/device-associations/v2/version'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/device-associations/v2/version';
const options = {method: 'GET'};
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}}/device-associations/v2/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/device-associations/v2/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/device-associations/v2/version',
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: 'GET',
url: '{{baseUrl}}/device-associations/v2/version'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/device-associations/v2/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/device-associations/v2/version'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/device-associations/v2/version';
const options = {method: 'GET'};
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}}/device-associations/v2/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/device-associations/v2/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/device-associations/v2/version",
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;
}
request('GET', '{{baseUrl}}/device-associations/v2/version');
echo $response->getBody();
setUrl('{{baseUrl}}/device-associations/v2/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/device-associations/v2/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/device-associations/v2/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/device-associations/v2/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/device-associations/v2/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/device-associations/v2/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/device-associations/v2/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/device-associations/v2/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/device-associations/v2/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/device-associations/v2/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/device-associations/v2/version
http GET {{baseUrl}}/device-associations/v2/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/device-associations/v2/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/device-associations/v2/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets event history for a device or a shipment
{{baseUrl}}/events/v3/:trackingId
QUERY PARAMS
trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/events/v3/:trackingId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/events/v3/:trackingId")
require "http/client"
url = "{{baseUrl}}/events/v3/:trackingId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/events/v3/:trackingId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/events/v3/:trackingId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/events/v3/:trackingId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/events/v3/:trackingId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/events/v3/:trackingId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/events/v3/:trackingId"))
.method("GET", 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}}/events/v3/:trackingId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/events/v3/:trackingId")
.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('GET', '{{baseUrl}}/events/v3/:trackingId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/events/v3/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/events/v3/:trackingId';
const options = {method: 'GET'};
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}}/events/v3/:trackingId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/events/v3/:trackingId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/events/v3/:trackingId',
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: 'GET', url: '{{baseUrl}}/events/v3/:trackingId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/events/v3/:trackingId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/events/v3/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/events/v3/:trackingId';
const options = {method: 'GET'};
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}}/events/v3/:trackingId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/events/v3/:trackingId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/events/v3/:trackingId",
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;
}
request('GET', '{{baseUrl}}/events/v3/:trackingId');
echo $response->getBody();
setUrl('{{baseUrl}}/events/v3/:trackingId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/events/v3/:trackingId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/events/v3/:trackingId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/events/v3/:trackingId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/events/v3/:trackingId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/events/v3/:trackingId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/events/v3/:trackingId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/events/v3/:trackingId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/events/v3/:trackingId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/events/v3/:trackingId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/events/v3/:trackingId
http GET {{baseUrl}}/events/v3/:trackingId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/events/v3/:trackingId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/events/v3/:trackingId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 1,
"data": [
{
"eventSource": "attach",
"eventType": "TRUE_TO_FALSE",
"initalState": false,
"ruleId": "e2f651ee-f196-4fa3-bf88-894dc131dea3",
"timestamp": 1499258057036,
"trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
}
],
"pageToken": "2lkjfdaoiekllldko=sdflkjdfasdi34"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets event history
{{baseUrl}}/events/v3
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/events/v3");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/events/v3")
require "http/client"
url = "{{baseUrl}}/events/v3"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/events/v3"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/events/v3");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/events/v3"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/events/v3 HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/events/v3")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/events/v3"))
.method("GET", 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}}/events/v3")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/events/v3")
.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('GET', '{{baseUrl}}/events/v3');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/events/v3'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/events/v3';
const options = {method: 'GET'};
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}}/events/v3',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/events/v3")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/events/v3',
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: 'GET', url: '{{baseUrl}}/events/v3'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/events/v3');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/events/v3'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/events/v3';
const options = {method: 'GET'};
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}}/events/v3"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/events/v3" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/events/v3",
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;
}
request('GET', '{{baseUrl}}/events/v3');
echo $response->getBody();
setUrl('{{baseUrl}}/events/v3');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/events/v3');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/events/v3' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/events/v3' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/events/v3")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/events/v3"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/events/v3"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/events/v3")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/events/v3') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/events/v3";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/events/v3
http GET {{baseUrl}}/events/v3
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/events/v3
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/events/v3")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 1,
"data": [
{
"eventSource": "attach",
"eventType": "TRUE_TO_FALSE",
"initalState": false,
"ruleId": "e2f651ee-f196-4fa3-bf88-894dc131dea3",
"timestamp": 1499258057036,
"trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
}
],
"pageToken": "2lkjfdaoiekllldko=sdflkjdfasdi34"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets service health (4)
{{baseUrl}}/events/v3/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/events/v3/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/events/v3/health")
require "http/client"
url = "{{baseUrl}}/events/v3/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/events/v3/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/events/v3/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/events/v3/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/events/v3/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/events/v3/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/events/v3/health"))
.method("GET", 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}}/events/v3/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/events/v3/health")
.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('GET', '{{baseUrl}}/events/v3/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/events/v3/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/events/v3/health';
const options = {method: 'GET'};
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}}/events/v3/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/events/v3/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/events/v3/health',
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: 'GET', url: '{{baseUrl}}/events/v3/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/events/v3/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/events/v3/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/events/v3/health';
const options = {method: 'GET'};
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}}/events/v3/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/events/v3/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/events/v3/health",
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;
}
request('GET', '{{baseUrl}}/events/v3/health');
echo $response->getBody();
setUrl('{{baseUrl}}/events/v3/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/events/v3/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/events/v3/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/events/v3/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/events/v3/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/events/v3/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/events/v3/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/events/v3/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/events/v3/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/events/v3/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/events/v3/health
http GET {{baseUrl}}/events/v3/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/events/v3/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/events/v3/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (4)
{{baseUrl}}/events/v3/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/events/v3/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/events/v3/version")
require "http/client"
url = "{{baseUrl}}/events/v3/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/events/v3/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/events/v3/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/events/v3/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/events/v3/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/events/v3/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/events/v3/version"))
.method("GET", 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}}/events/v3/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/events/v3/version")
.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('GET', '{{baseUrl}}/events/v3/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/events/v3/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/events/v3/version';
const options = {method: 'GET'};
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}}/events/v3/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/events/v3/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/events/v3/version',
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: 'GET', url: '{{baseUrl}}/events/v3/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/events/v3/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/events/v3/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/events/v3/version';
const options = {method: 'GET'};
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}}/events/v3/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/events/v3/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/events/v3/version",
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;
}
request('GET', '{{baseUrl}}/events/v3/version');
echo $response->getBody();
setUrl('{{baseUrl}}/events/v3/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/events/v3/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/events/v3/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/events/v3/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/events/v3/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/events/v3/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/events/v3/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/events/v3/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/events/v3/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/events/v3/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/events/v3/version
http GET {{baseUrl}}/events/v3/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/events/v3/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/events/v3/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets the event statuses
{{baseUrl}}/events/v3/statuses
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/events/v3/statuses");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/events/v3/statuses")
require "http/client"
url = "{{baseUrl}}/events/v3/statuses"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/events/v3/statuses"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/events/v3/statuses");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/events/v3/statuses"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/events/v3/statuses HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/events/v3/statuses")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/events/v3/statuses"))
.method("GET", 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}}/events/v3/statuses")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/events/v3/statuses")
.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('GET', '{{baseUrl}}/events/v3/statuses');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/events/v3/statuses'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/events/v3/statuses';
const options = {method: 'GET'};
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}}/events/v3/statuses',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/events/v3/statuses")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/events/v3/statuses',
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: 'GET', url: '{{baseUrl}}/events/v3/statuses'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/events/v3/statuses');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/events/v3/statuses'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/events/v3/statuses';
const options = {method: 'GET'};
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}}/events/v3/statuses"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/events/v3/statuses" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/events/v3/statuses",
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;
}
request('GET', '{{baseUrl}}/events/v3/statuses');
echo $response->getBody();
setUrl('{{baseUrl}}/events/v3/statuses');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/events/v3/statuses');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/events/v3/statuses' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/events/v3/statuses' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/events/v3/statuses")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/events/v3/statuses"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/events/v3/statuses"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/events/v3/statuses")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/events/v3/statuses') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/events/v3/statuses";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/events/v3/statuses
http GET {{baseUrl}}/events/v3/statuses
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/events/v3/statuses
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/events/v3/statuses")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 2,
"data": [
{
"eventSource": "attach",
"eventType": "TRUE_TO_FALSE",
"ruleId": "e2f651ee-f196-4fa3-bf88-894dc131dea3",
"timestamp": 1499258057036,
"trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
},
{
"eventSource": "geofence",
"eventType": "INSIDE_GEOFENCE",
"ruleId": "0d2c30d4-a827-4baf-931f-9b85c9b4e428",
"timestamp": 1499258500036,
"trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
}
],
"pageToken": "2lkjfdaoiekllldko=sdflkjdfasdi34"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets the number of devices and shipments in each event state
{{baseUrl}}/events/v3/statuses/deviceCounts
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/events/v3/statuses/deviceCounts");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/events/v3/statuses/deviceCounts")
require "http/client"
url = "{{baseUrl}}/events/v3/statuses/deviceCounts"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/events/v3/statuses/deviceCounts"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/events/v3/statuses/deviceCounts");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/events/v3/statuses/deviceCounts"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/events/v3/statuses/deviceCounts HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/events/v3/statuses/deviceCounts")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/events/v3/statuses/deviceCounts"))
.method("GET", 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}}/events/v3/statuses/deviceCounts")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/events/v3/statuses/deviceCounts")
.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('GET', '{{baseUrl}}/events/v3/statuses/deviceCounts');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/events/v3/statuses/deviceCounts'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/events/v3/statuses/deviceCounts';
const options = {method: 'GET'};
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}}/events/v3/statuses/deviceCounts',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/events/v3/statuses/deviceCounts")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/events/v3/statuses/deviceCounts',
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: 'GET',
url: '{{baseUrl}}/events/v3/statuses/deviceCounts'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/events/v3/statuses/deviceCounts');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/events/v3/statuses/deviceCounts'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/events/v3/statuses/deviceCounts';
const options = {method: 'GET'};
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}}/events/v3/statuses/deviceCounts"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/events/v3/statuses/deviceCounts" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/events/v3/statuses/deviceCounts",
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;
}
request('GET', '{{baseUrl}}/events/v3/statuses/deviceCounts');
echo $response->getBody();
setUrl('{{baseUrl}}/events/v3/statuses/deviceCounts');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/events/v3/statuses/deviceCounts');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/events/v3/statuses/deviceCounts' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/events/v3/statuses/deviceCounts' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/events/v3/statuses/deviceCounts")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/events/v3/statuses/deviceCounts"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/events/v3/statuses/deviceCounts"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/events/v3/statuses/deviceCounts")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/events/v3/statuses/deviceCounts') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/events/v3/statuses/deviceCounts";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/events/v3/statuses/deviceCounts
http GET {{baseUrl}}/events/v3/statuses/deviceCounts
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/events/v3/statuses/deviceCounts
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/events/v3/statuses/deviceCounts")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 3,
"data": [
{
"FALSE_TO_TRUE": 4,
"TRUE_TO_FALSE": 1,
"eventSource": "attach",
"ruleId": "e2f651ee-f196-4fa3-bf88-894dc131dea3",
"total": 5
},
{
"ABOVE_RANGE": 0,
"BELOW_RANGE": 1,
"IN_RANGE": 4,
"eventSource": "battery",
"ruleId": "4e74ad36-7dd3-459a-ace4-f8a7f1c6085d",
"total": 5
},
{
"DWELLING_ENDED": 5,
"DWELLING_STARTED": 2,
"eventSource": "dwelling",
"ruleId": "018eedc7-1b16-4233-80b1-2b13a307b4aa",
"total": 5
}
],
"pageToken": "sakuh8342jhe83290US87sdjhAS8we"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
PUT
Associates a device with a geofence
{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId")
require "http/client"
url = "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/geofence-associations/v2/:geofenceId/:trackingId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId"))
.method("PUT", 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}}/geofence-associations/v2/:geofenceId/:trackingId")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId")
.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('PUT', '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId';
const options = {method: 'PUT'};
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}}/geofence-associations/v2/:geofenceId/:trackingId',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofence-associations/v2/:geofenceId/:trackingId',
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: 'PUT',
url: '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId');
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}}/geofence-associations/v2/:geofenceId/:trackingId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId';
const options = {method: 'PUT'};
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}}/geofence-associations/v2/:geofenceId/:trackingId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/geofence-associations/v2/:geofenceId/:trackingId" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId');
echo $response->getBody();
setUrl('{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/geofence-associations/v2/:geofenceId/:trackingId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/geofence-associations/v2/:geofenceId/:trackingId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId
http PUT {{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Disassociates a device and a geofence (DELETE)
{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId")
require "http/client"
url = "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId"
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/geofence-associations/v2/:geofenceId/:trackingId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId"))
.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}}/geofence-associations/v2/:geofenceId/:trackingId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId")
.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}}/geofence-associations/v2/:geofenceId/:trackingId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId';
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}}/geofence-associations/v2/:geofenceId/:trackingId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofence-associations/v2/:geofenceId/:trackingId',
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}}/geofence-associations/v2/:geofenceId/:trackingId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId');
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}}/geofence-associations/v2/:geofenceId/:trackingId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId';
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}}/geofence-associations/v2/:geofenceId/:trackingId"]
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}}/geofence-associations/v2/:geofenceId/:trackingId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId",
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}}/geofence-associations/v2/:geofenceId/:trackingId');
echo $response->getBody();
setUrl('{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/geofence-associations/v2/:geofenceId/:trackingId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/geofence-associations/v2/:geofenceId/:trackingId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId";
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}}/geofence-associations/v2/:geofenceId/:trackingId
http DELETE {{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofence-associations/v2/:geofenceId/:trackingId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets all devices associated with a geofence (GET)
{{baseUrl}}/geofence-associations/v2/:geofenceId/devices
QUERY PARAMS
geofenceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofence-associations/v2/:geofenceId/devices");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/geofence-associations/v2/:geofenceId/devices")
require "http/client"
url = "{{baseUrl}}/geofence-associations/v2/:geofenceId/devices"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/geofence-associations/v2/:geofenceId/devices"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofence-associations/v2/:geofenceId/devices");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofence-associations/v2/:geofenceId/devices"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/geofence-associations/v2/:geofenceId/devices HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/geofence-associations/v2/:geofenceId/devices")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofence-associations/v2/:geofenceId/devices"))
.method("GET", 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}}/geofence-associations/v2/:geofenceId/devices")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/geofence-associations/v2/:geofenceId/devices")
.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('GET', '{{baseUrl}}/geofence-associations/v2/:geofenceId/devices');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/geofence-associations/v2/:geofenceId/devices'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofence-associations/v2/:geofenceId/devices';
const options = {method: 'GET'};
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}}/geofence-associations/v2/:geofenceId/devices',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofence-associations/v2/:geofenceId/devices")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofence-associations/v2/:geofenceId/devices',
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: 'GET',
url: '{{baseUrl}}/geofence-associations/v2/:geofenceId/devices'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/geofence-associations/v2/:geofenceId/devices');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/geofence-associations/v2/:geofenceId/devices'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofence-associations/v2/:geofenceId/devices';
const options = {method: 'GET'};
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}}/geofence-associations/v2/:geofenceId/devices"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/geofence-associations/v2/:geofenceId/devices" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofence-associations/v2/:geofenceId/devices",
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;
}
request('GET', '{{baseUrl}}/geofence-associations/v2/:geofenceId/devices');
echo $response->getBody();
setUrl('{{baseUrl}}/geofence-associations/v2/:geofenceId/devices');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofence-associations/v2/:geofenceId/devices');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofence-associations/v2/:geofenceId/devices' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofence-associations/v2/:geofenceId/devices' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/geofence-associations/v2/:geofenceId/devices")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofence-associations/v2/:geofenceId/devices"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofence-associations/v2/:geofenceId/devices"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofence-associations/v2/:geofenceId/devices")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/geofence-associations/v2/:geofenceId/devices') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofence-associations/v2/:geofenceId/devices";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/geofence-associations/v2/:geofenceId/devices
http GET {{baseUrl}}/geofence-associations/v2/:geofenceId/devices
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/geofence-associations/v2/:geofenceId/devices
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofence-associations/v2/:geofenceId/devices")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets service health (5)
{{baseUrl}}/geofence-associations/v2/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofence-associations/v2/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/geofence-associations/v2/health")
require "http/client"
url = "{{baseUrl}}/geofence-associations/v2/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/geofence-associations/v2/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofence-associations/v2/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofence-associations/v2/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/geofence-associations/v2/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/geofence-associations/v2/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofence-associations/v2/health"))
.method("GET", 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}}/geofence-associations/v2/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/geofence-associations/v2/health")
.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('GET', '{{baseUrl}}/geofence-associations/v2/health');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/geofence-associations/v2/health'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofence-associations/v2/health';
const options = {method: 'GET'};
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}}/geofence-associations/v2/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofence-associations/v2/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofence-associations/v2/health',
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: 'GET',
url: '{{baseUrl}}/geofence-associations/v2/health'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/geofence-associations/v2/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/geofence-associations/v2/health'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofence-associations/v2/health';
const options = {method: 'GET'};
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}}/geofence-associations/v2/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/geofence-associations/v2/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofence-associations/v2/health",
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;
}
request('GET', '{{baseUrl}}/geofence-associations/v2/health');
echo $response->getBody();
setUrl('{{baseUrl}}/geofence-associations/v2/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofence-associations/v2/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofence-associations/v2/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofence-associations/v2/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/geofence-associations/v2/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofence-associations/v2/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofence-associations/v2/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofence-associations/v2/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/geofence-associations/v2/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofence-associations/v2/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/geofence-associations/v2/health
http GET {{baseUrl}}/geofence-associations/v2/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/geofence-associations/v2/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofence-associations/v2/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (5)
{{baseUrl}}/geofence-associations/v2/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofence-associations/v2/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/geofence-associations/v2/version")
require "http/client"
url = "{{baseUrl}}/geofence-associations/v2/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/geofence-associations/v2/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofence-associations/v2/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofence-associations/v2/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/geofence-associations/v2/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/geofence-associations/v2/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofence-associations/v2/version"))
.method("GET", 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}}/geofence-associations/v2/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/geofence-associations/v2/version")
.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('GET', '{{baseUrl}}/geofence-associations/v2/version');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/geofence-associations/v2/version'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofence-associations/v2/version';
const options = {method: 'GET'};
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}}/geofence-associations/v2/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofence-associations/v2/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofence-associations/v2/version',
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: 'GET',
url: '{{baseUrl}}/geofence-associations/v2/version'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/geofence-associations/v2/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/geofence-associations/v2/version'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofence-associations/v2/version';
const options = {method: 'GET'};
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}}/geofence-associations/v2/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/geofence-associations/v2/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofence-associations/v2/version",
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;
}
request('GET', '{{baseUrl}}/geofence-associations/v2/version');
echo $response->getBody();
setUrl('{{baseUrl}}/geofence-associations/v2/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofence-associations/v2/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofence-associations/v2/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofence-associations/v2/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/geofence-associations/v2/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofence-associations/v2/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofence-associations/v2/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofence-associations/v2/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/geofence-associations/v2/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofence-associations/v2/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/geofence-associations/v2/version
http GET {{baseUrl}}/geofence-associations/v2/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/geofence-associations/v2/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofence-associations/v2/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
Checks if a POI geofence training is possible with the given parameters
{{baseUrl}}/geofences/v2/trainingTest
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofences/v2/trainingTest");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/geofences/v2/trainingTest")
require "http/client"
url = "{{baseUrl}}/geofences/v2/trainingTest"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/geofences/v2/trainingTest"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofences/v2/trainingTest");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofences/v2/trainingTest"
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/geofences/v2/trainingTest HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/geofences/v2/trainingTest")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofences/v2/trainingTest"))
.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}}/geofences/v2/trainingTest")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/geofences/v2/trainingTest")
.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}}/geofences/v2/trainingTest');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/geofences/v2/trainingTest'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofences/v2/trainingTest';
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}}/geofences/v2/trainingTest',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofences/v2/trainingTest")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofences/v2/trainingTest',
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}}/geofences/v2/trainingTest'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/geofences/v2/trainingTest');
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}}/geofences/v2/trainingTest'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofences/v2/trainingTest';
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}}/geofences/v2/trainingTest"]
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}}/geofences/v2/trainingTest" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofences/v2/trainingTest",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/geofences/v2/trainingTest');
echo $response->getBody();
setUrl('{{baseUrl}}/geofences/v2/trainingTest');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofences/v2/trainingTest');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofences/v2/trainingTest' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofences/v2/trainingTest' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/geofences/v2/trainingTest", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofences/v2/trainingTest"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofences/v2/trainingTest"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofences/v2/trainingTest")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/geofences/v2/trainingTest') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofences/v2/trainingTest";
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}}/geofences/v2/trainingTest
http POST {{baseUrl}}/geofences/v2/trainingTest
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/geofences/v2/trainingTest
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofences/v2/trainingTest")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 422,
"details": {
"hereErrorCode": 422306
},
"error": "Unprocessable Entity",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request was well-formed but was unable to be followed due to semantic errors."
}
POST
Creates a geofence
{{baseUrl}}/geofences/v2
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofences/v2");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/geofences/v2")
require "http/client"
url = "{{baseUrl}}/geofences/v2"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/geofences/v2"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofences/v2");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofences/v2"
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/geofences/v2 HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/geofences/v2")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofences/v2"))
.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}}/geofences/v2")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/geofences/v2")
.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}}/geofences/v2');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/geofences/v2'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofences/v2';
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}}/geofences/v2',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofences/v2")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofences/v2',
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}}/geofences/v2'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/geofences/v2');
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}}/geofences/v2'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofences/v2';
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}}/geofences/v2"]
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}}/geofences/v2" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofences/v2",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/geofences/v2');
echo $response->getBody();
setUrl('{{baseUrl}}/geofences/v2');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofences/v2');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofences/v2' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofences/v2' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/geofences/v2", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofences/v2"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofences/v2"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofences/v2")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/geofences/v2') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofences/v2";
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}}/geofences/v2
http POST {{baseUrl}}/geofences/v2
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/geofences/v2
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofences/v2")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"id": "0d994f31-ceea-42e4-96a5-4484585c3802"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
DELETE
Deletes a geofence
{{baseUrl}}/geofences/v2/:geofenceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofences/v2/:geofenceId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/geofences/v2/:geofenceId")
require "http/client"
url = "{{baseUrl}}/geofences/v2/:geofenceId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/geofences/v2/:geofenceId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofences/v2/:geofenceId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofences/v2/:geofenceId"
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/geofences/v2/:geofenceId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/geofences/v2/:geofenceId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofences/v2/:geofenceId"))
.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}}/geofences/v2/:geofenceId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/geofences/v2/:geofenceId")
.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}}/geofences/v2/:geofenceId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/geofences/v2/:geofenceId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofences/v2/:geofenceId';
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}}/geofences/v2/:geofenceId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofences/v2/:geofenceId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofences/v2/:geofenceId',
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}}/geofences/v2/:geofenceId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/geofences/v2/:geofenceId');
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}}/geofences/v2/:geofenceId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofences/v2/:geofenceId';
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}}/geofences/v2/:geofenceId"]
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}}/geofences/v2/:geofenceId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofences/v2/:geofenceId",
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}}/geofences/v2/:geofenceId');
echo $response->getBody();
setUrl('{{baseUrl}}/geofences/v2/:geofenceId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofences/v2/:geofenceId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofences/v2/:geofenceId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofences/v2/:geofenceId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/geofences/v2/:geofenceId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofences/v2/:geofenceId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofences/v2/:geofenceId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofences/v2/:geofenceId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/geofences/v2/:geofenceId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofences/v2/:geofenceId";
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}}/geofences/v2/:geofenceId
http DELETE {{baseUrl}}/geofences/v2/:geofenceId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/geofences/v2/:geofenceId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofences/v2/:geofenceId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "The Geofence ID was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 409,
"details": {
"hereErrorCode": 404306
},
"error": "Conflict",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource already exists."
}
DELETE
Deletes all geofences
{{baseUrl}}/geofences/v2
HEADERS
x-confirm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofences/v2");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-confirm: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/geofences/v2" {:headers {:x-confirm ""}})
require "http/client"
url = "{{baseUrl}}/geofences/v2"
headers = HTTP::Headers{
"x-confirm" => ""
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/geofences/v2"),
Headers =
{
{ "x-confirm", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofences/v2");
var request = new RestRequest("", Method.Delete);
request.AddHeader("x-confirm", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofences/v2"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-confirm", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/geofences/v2 HTTP/1.1
X-Confirm:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/geofences/v2")
.setHeader("x-confirm", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofences/v2"))
.header("x-confirm", "")
.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}}/geofences/v2")
.delete(null)
.addHeader("x-confirm", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/geofences/v2")
.header("x-confirm", "")
.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}}/geofences/v2');
xhr.setRequestHeader('x-confirm', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/geofences/v2',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofences/v2';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
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}}/geofences/v2',
method: 'DELETE',
headers: {
'x-confirm': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofences/v2")
.delete(null)
.addHeader("x-confirm", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofences/v2',
headers: {
'x-confirm': ''
}
};
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}}/geofences/v2',
headers: {'x-confirm': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/geofences/v2');
req.headers({
'x-confirm': ''
});
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}}/geofences/v2',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofences/v2';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-confirm": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/geofences/v2"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
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}}/geofences/v2" in
let headers = Header.add (Header.init ()) "x-confirm" "" in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofences/v2",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"x-confirm: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/geofences/v2', [
'headers' => [
'x-confirm' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/geofences/v2');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'x-confirm' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofences/v2');
$request->setRequestMethod('DELETE');
$request->setHeaders([
'x-confirm' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofences/v2' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofences/v2' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'x-confirm': "" }
conn.request("DELETE", "/baseUrl/geofences/v2", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofences/v2"
headers = {"x-confirm": ""}
response = requests.delete(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofences/v2"
response <- VERB("DELETE", url, add_headers('x-confirm' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofences/v2")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-confirm"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/geofences/v2') do |req|
req.headers['x-confirm'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofences/v2";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-confirm", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/geofences/v2 \
--header 'x-confirm: '
http DELETE {{baseUrl}}/geofences/v2 \
x-confirm:''
wget --quiet \
--method DELETE \
--header 'x-confirm: ' \
--output-document \
- {{baseUrl}}/geofences/v2
import Foundation
let headers = ["x-confirm": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofences/v2")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets a single geofence
{{baseUrl}}/geofences/v2/:geofenceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofences/v2/:geofenceId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/geofences/v2/:geofenceId")
require "http/client"
url = "{{baseUrl}}/geofences/v2/:geofenceId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/geofences/v2/:geofenceId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofences/v2/:geofenceId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofences/v2/:geofenceId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/geofences/v2/:geofenceId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/geofences/v2/:geofenceId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofences/v2/:geofenceId"))
.method("GET", 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}}/geofences/v2/:geofenceId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/geofences/v2/:geofenceId")
.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('GET', '{{baseUrl}}/geofences/v2/:geofenceId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/geofences/v2/:geofenceId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofences/v2/:geofenceId';
const options = {method: 'GET'};
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}}/geofences/v2/:geofenceId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofences/v2/:geofenceId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofences/v2/:geofenceId',
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: 'GET', url: '{{baseUrl}}/geofences/v2/:geofenceId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/geofences/v2/:geofenceId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/geofences/v2/:geofenceId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofences/v2/:geofenceId';
const options = {method: 'GET'};
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}}/geofences/v2/:geofenceId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/geofences/v2/:geofenceId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofences/v2/:geofenceId",
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;
}
request('GET', '{{baseUrl}}/geofences/v2/:geofenceId');
echo $response->getBody();
setUrl('{{baseUrl}}/geofences/v2/:geofenceId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofences/v2/:geofenceId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofences/v2/:geofenceId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofences/v2/:geofenceId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/geofences/v2/:geofenceId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofences/v2/:geofenceId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofences/v2/:geofenceId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofences/v2/:geofenceId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/geofences/v2/:geofenceId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofences/v2/:geofenceId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/geofences/v2/:geofenceId
http GET {{baseUrl}}/geofences/v2/:geofenceId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/geofences/v2/:geofenceId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofences/v2/:geofenceId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"geofence": {
"definition": {
"floor": {
"id": "DM_82228",
"level": 2,
"name": "House 3"
},
"points": [
{
"lat": 52.5308398,
"lng": 13.38490035
},
{
"lat": 52.5408398,
"lng": 14.38490035
},
{
"lat": 53.5308398,
"lng": 13.39490035
}
]
},
"type": "polygon"
},
"id": "d0c29690-5d26-4cf1-a37e-b7816e72cb99"
}
RESPONSE HEADERS
Content-Type
application/octet-stream
RESPONSE BODY text
34 56 18 93 45 29 54 62 77 28 23 79 22
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "The Geofence ID was not found."
}
GET
Gets all geofences
{{baseUrl}}/geofences/v2
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofences/v2");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/geofences/v2")
require "http/client"
url = "{{baseUrl}}/geofences/v2"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/geofences/v2"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofences/v2");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofences/v2"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/geofences/v2 HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/geofences/v2")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofences/v2"))
.method("GET", 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}}/geofences/v2")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/geofences/v2")
.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('GET', '{{baseUrl}}/geofences/v2');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/geofences/v2'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofences/v2';
const options = {method: 'GET'};
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}}/geofences/v2',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofences/v2")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofences/v2',
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: 'GET', url: '{{baseUrl}}/geofences/v2'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/geofences/v2');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/geofences/v2'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofences/v2';
const options = {method: 'GET'};
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}}/geofences/v2"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/geofences/v2" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofences/v2",
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;
}
request('GET', '{{baseUrl}}/geofences/v2');
echo $response->getBody();
setUrl('{{baseUrl}}/geofences/v2');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofences/v2');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofences/v2' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofences/v2' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/geofences/v2")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofences/v2"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofences/v2"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofences/v2")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/geofences/v2') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofences/v2";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/geofences/v2
http GET {{baseUrl}}/geofences/v2
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/geofences/v2
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofences/v2")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 2,
"data": [
{
"geofence": {
"definition": {
"points": [
{
"lat": 52.5308398,
"lng": 13.38490035
},
{
"lat": 52.5408398,
"lng": 14.38490035
},
{
"lat": 53.5308398,
"lng": 13.39490035
}
]
},
"type": "polygon"
},
"id": "d0c29690-5d26-4cf1-a37e-b7816e72cb99"
},
{
"geofence": {
"definition": {
"center": {
"lat": 52.5308398,
"lng": 13.38490035
},
"floor": {
"id": "DM_82228",
"name": "House 3"
},
"radius": 100
},
"description": "This is a circular geofence",
"name": "16fbc82c-88d1-4219-bfad-6e5de52688a2",
"type": "circle"
},
"id": "ff92eda0-3114-4640-b7e6-4ba641ae1124"
}
],
"pageToken": "027ffffea253d79fc"
}
RESPONSE HEADERS
Content-Type
application/octet-stream
RESPONSE BODY text
34 56 18 93 45 29 54 62 77 28 23 79 22
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets service health (6)
{{baseUrl}}/geofences/v2/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofences/v2/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/geofences/v2/health")
require "http/client"
url = "{{baseUrl}}/geofences/v2/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/geofences/v2/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofences/v2/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofences/v2/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/geofences/v2/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/geofences/v2/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofences/v2/health"))
.method("GET", 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}}/geofences/v2/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/geofences/v2/health")
.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('GET', '{{baseUrl}}/geofences/v2/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/geofences/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofences/v2/health';
const options = {method: 'GET'};
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}}/geofences/v2/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofences/v2/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofences/v2/health',
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: 'GET', url: '{{baseUrl}}/geofences/v2/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/geofences/v2/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/geofences/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofences/v2/health';
const options = {method: 'GET'};
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}}/geofences/v2/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/geofences/v2/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofences/v2/health",
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;
}
request('GET', '{{baseUrl}}/geofences/v2/health');
echo $response->getBody();
setUrl('{{baseUrl}}/geofences/v2/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofences/v2/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofences/v2/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofences/v2/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/geofences/v2/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofences/v2/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofences/v2/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofences/v2/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/geofences/v2/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofences/v2/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/geofences/v2/health
http GET {{baseUrl}}/geofences/v2/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/geofences/v2/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofences/v2/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (6)
{{baseUrl}}/geofences/v2/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofences/v2/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/geofences/v2/version")
require "http/client"
url = "{{baseUrl}}/geofences/v2/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/geofences/v2/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofences/v2/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofences/v2/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/geofences/v2/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/geofences/v2/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofences/v2/version"))
.method("GET", 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}}/geofences/v2/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/geofences/v2/version")
.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('GET', '{{baseUrl}}/geofences/v2/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/geofences/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofences/v2/version';
const options = {method: 'GET'};
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}}/geofences/v2/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofences/v2/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofences/v2/version',
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: 'GET', url: '{{baseUrl}}/geofences/v2/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/geofences/v2/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/geofences/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofences/v2/version';
const options = {method: 'GET'};
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}}/geofences/v2/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/geofences/v2/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofences/v2/version",
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;
}
request('GET', '{{baseUrl}}/geofences/v2/version');
echo $response->getBody();
setUrl('{{baseUrl}}/geofences/v2/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofences/v2/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofences/v2/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofences/v2/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/geofences/v2/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofences/v2/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofences/v2/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofences/v2/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/geofences/v2/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofences/v2/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/geofences/v2/version
http GET {{baseUrl}}/geofences/v2/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/geofences/v2/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofences/v2/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
Trains a POI geofence
{{baseUrl}}/geofences/v2/:geofenceId/poiTraining
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofences/v2/:geofenceId/poiTraining");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/geofences/v2/:geofenceId/poiTraining")
require "http/client"
url = "{{baseUrl}}/geofences/v2/:geofenceId/poiTraining"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/geofences/v2/:geofenceId/poiTraining"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofences/v2/:geofenceId/poiTraining");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofences/v2/:geofenceId/poiTraining"
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/geofences/v2/:geofenceId/poiTraining HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/geofences/v2/:geofenceId/poiTraining")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofences/v2/:geofenceId/poiTraining"))
.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}}/geofences/v2/:geofenceId/poiTraining")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/geofences/v2/:geofenceId/poiTraining")
.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}}/geofences/v2/:geofenceId/poiTraining');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/geofences/v2/:geofenceId/poiTraining'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofences/v2/:geofenceId/poiTraining';
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}}/geofences/v2/:geofenceId/poiTraining',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofences/v2/:geofenceId/poiTraining")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofences/v2/:geofenceId/poiTraining',
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}}/geofences/v2/:geofenceId/poiTraining'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/geofences/v2/:geofenceId/poiTraining');
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}}/geofences/v2/:geofenceId/poiTraining'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofences/v2/:geofenceId/poiTraining';
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}}/geofences/v2/:geofenceId/poiTraining"]
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}}/geofences/v2/:geofenceId/poiTraining" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofences/v2/:geofenceId/poiTraining",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/geofences/v2/:geofenceId/poiTraining');
echo $response->getBody();
setUrl('{{baseUrl}}/geofences/v2/:geofenceId/poiTraining');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofences/v2/:geofenceId/poiTraining');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofences/v2/:geofenceId/poiTraining' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofences/v2/:geofenceId/poiTraining' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/geofences/v2/:geofenceId/poiTraining", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofences/v2/:geofenceId/poiTraining"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofences/v2/:geofenceId/poiTraining"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofences/v2/:geofenceId/poiTraining")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/geofences/v2/:geofenceId/poiTraining') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofences/v2/:geofenceId/poiTraining";
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}}/geofences/v2/:geofenceId/poiTraining
http POST {{baseUrl}}/geofences/v2/:geofenceId/poiTraining
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/geofences/v2/:geofenceId/poiTraining
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofences/v2/:geofenceId/poiTraining")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 422,
"details": {
"hereErrorCode": 422306
},
"error": "Unprocessable Entity",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request was well-formed but was unable to be followed due to semantic errors."
}
PUT
Updates a single geofence
{{baseUrl}}/geofences/v2/:geofenceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/geofences/v2/:geofenceId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/geofences/v2/:geofenceId")
require "http/client"
url = "{{baseUrl}}/geofences/v2/:geofenceId"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/geofences/v2/:geofenceId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/geofences/v2/:geofenceId");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/geofences/v2/:geofenceId"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/geofences/v2/:geofenceId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/geofences/v2/:geofenceId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/geofences/v2/:geofenceId"))
.method("PUT", 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}}/geofences/v2/:geofenceId")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/geofences/v2/:geofenceId")
.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('PUT', '{{baseUrl}}/geofences/v2/:geofenceId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'PUT', url: '{{baseUrl}}/geofences/v2/:geofenceId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/geofences/v2/:geofenceId';
const options = {method: 'PUT'};
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}}/geofences/v2/:geofenceId',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/geofences/v2/:geofenceId")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/geofences/v2/:geofenceId',
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: 'PUT', url: '{{baseUrl}}/geofences/v2/:geofenceId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/geofences/v2/:geofenceId');
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}}/geofences/v2/:geofenceId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/geofences/v2/:geofenceId';
const options = {method: 'PUT'};
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}}/geofences/v2/:geofenceId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/geofences/v2/:geofenceId" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/geofences/v2/:geofenceId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/geofences/v2/:geofenceId');
echo $response->getBody();
setUrl('{{baseUrl}}/geofences/v2/:geofenceId');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/geofences/v2/:geofenceId');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/geofences/v2/:geofenceId' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/geofences/v2/:geofenceId' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("PUT", "/baseUrl/geofences/v2/:geofenceId", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/geofences/v2/:geofenceId"
payload = ""
response = requests.put(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/geofences/v2/:geofenceId"
payload <- ""
response <- VERB("PUT", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/geofences/v2/:geofenceId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/geofences/v2/:geofenceId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/geofences/v2/:geofenceId";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/geofences/v2/:geofenceId
http PUT {{baseUrl}}/geofences/v2/:geofenceId
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/geofences/v2/:geofenceId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/geofences/v2/:geofenceId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
RESPONSE HEADERS
Content-Type
application/octet-stream
RESPONSE BODY text
{
"response data as Protobuf binary, format as follows": "message GeofenceMsg {\n message GeofenceCircular {\n //Latitude value\n float lat = 1;\n //Longitude value\n float lng = 2;\n //Center radius value\n uint32 radius = 3;\n //Geofence ID\n string id = 4;\n }\n message GeofencePolygonal {\n //Latitude value array\n repeated float lat = 1;\n //Longitude value array\n repeated float lng = 2;\n //Geofence ID\n string id = 3;\n }\n //Circular geofence array\n repeated GeofenceCircular circulars = 1;\n //Polygonal geofence array\n repeated GeofencePolygonal polygonals = 2;\n //Page token\n string pageToken = 3;\n}\n"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "The Geofence ID was not found."
}
GET
Gets service health (22)
{{baseUrl}}/v2/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/v2/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/v2/health")
require "http/client"
url = "{{baseUrl}}/v2/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/v2/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/v2/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/v2/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/v2/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/v2/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/v2/health"))
.method("GET", 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}}/v2/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/v2/health")
.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('GET', '{{baseUrl}}/v2/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/v2/health';
const options = {method: 'GET'};
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}}/v2/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/v2/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/v2/health',
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: 'GET', url: '{{baseUrl}}/v2/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/v2/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/v2/health';
const options = {method: 'GET'};
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}}/v2/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/v2/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/v2/health",
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;
}
request('GET', '{{baseUrl}}/v2/health');
echo $response->getBody();
setUrl('{{baseUrl}}/v2/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/v2/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/v2/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/v2/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/v2/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/v2/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/v2/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/v2/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/v2/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/v2/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/v2/health
http GET {{baseUrl}}/v2/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/v2/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/v2/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service health (23)
{{baseUrl}}/v3/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/v3/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/v3/health")
require "http/client"
url = "{{baseUrl}}/v3/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/v3/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/v3/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/v3/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/v3/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/v3/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/v3/health"))
.method("GET", 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}}/v3/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/v3/health")
.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('GET', '{{baseUrl}}/v3/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/v3/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/v3/health';
const options = {method: 'GET'};
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}}/v3/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/v3/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/v3/health',
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: 'GET', url: '{{baseUrl}}/v3/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/v3/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/v3/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/v3/health';
const options = {method: 'GET'};
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}}/v3/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/v3/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/v3/health",
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;
}
request('GET', '{{baseUrl}}/v3/health');
echo $response->getBody();
setUrl('{{baseUrl}}/v3/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/v3/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/v3/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/v3/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/v3/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/v3/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/v3/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/v3/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/v3/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/v3/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/v3/health
http GET {{baseUrl}}/v3/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/v3/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/v3/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (22)
{{baseUrl}}/v2/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/v2/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/v2/version")
require "http/client"
url = "{{baseUrl}}/v2/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/v2/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/v2/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/v2/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/v2/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/v2/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/v2/version"))
.method("GET", 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}}/v2/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/v2/version")
.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('GET', '{{baseUrl}}/v2/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/v2/version';
const options = {method: 'GET'};
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}}/v2/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/v2/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/v2/version',
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: 'GET', url: '{{baseUrl}}/v2/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/v2/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/v2/version';
const options = {method: 'GET'};
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}}/v2/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/v2/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/v2/version",
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;
}
request('GET', '{{baseUrl}}/v2/version');
echo $response->getBody();
setUrl('{{baseUrl}}/v2/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/v2/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/v2/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/v2/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/v2/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/v2/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/v2/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/v2/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/v2/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/v2/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/v2/version
http GET {{baseUrl}}/v2/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/v2/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/v2/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (23)
{{baseUrl}}/v3/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/v3/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/v3/version")
require "http/client"
url = "{{baseUrl}}/v3/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/v3/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/v3/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/v3/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/v3/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/v3/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/v3/version"))
.method("GET", 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}}/v3/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/v3/version")
.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('GET', '{{baseUrl}}/v3/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/v3/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/v3/version';
const options = {method: 'GET'};
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}}/v3/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/v3/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/v3/version',
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: 'GET', url: '{{baseUrl}}/v3/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/v3/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/v3/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/v3/version';
const options = {method: 'GET'};
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}}/v3/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/v3/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/v3/version",
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;
}
request('GET', '{{baseUrl}}/v3/version');
echo $response->getBody();
setUrl('{{baseUrl}}/v3/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/v3/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/v3/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/v3/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/v3/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/v3/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/v3/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/v3/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/v3/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/v3/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/v3/version
http GET {{baseUrl}}/v3/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/v3/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/v3/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets the current timestamp
{{baseUrl}}/v2/timestamp
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/v2/timestamp");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/v2/timestamp")
require "http/client"
url = "{{baseUrl}}/v2/timestamp"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/v2/timestamp"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/v2/timestamp");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/v2/timestamp"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/v2/timestamp HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/v2/timestamp")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/v2/timestamp"))
.method("GET", 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}}/v2/timestamp")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/v2/timestamp")
.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('GET', '{{baseUrl}}/v2/timestamp');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/v2/timestamp'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/v2/timestamp';
const options = {method: 'GET'};
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}}/v2/timestamp',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/v2/timestamp")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/v2/timestamp',
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: 'GET', url: '{{baseUrl}}/v2/timestamp'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/v2/timestamp');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/v2/timestamp'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/v2/timestamp';
const options = {method: 'GET'};
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}}/v2/timestamp"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/v2/timestamp" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/v2/timestamp",
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;
}
request('GET', '{{baseUrl}}/v2/timestamp');
echo $response->getBody();
setUrl('{{baseUrl}}/v2/timestamp');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/v2/timestamp');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/v2/timestamp' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/v2/timestamp' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/v2/timestamp")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/v2/timestamp"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/v2/timestamp"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/v2/timestamp")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/v2/timestamp') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/v2/timestamp";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/v2/timestamp
http GET {{baseUrl}}/v2/timestamp
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/v2/timestamp
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/v2/timestamp")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
POST
Ingests data and receives a shadow
{{baseUrl}}/v2/
HEADERS
authorization
BODY json
[
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": {
"mcc": 0
},
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/v2/");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "authorization: ");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "[\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n]");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/v2/" {:headers {:authorization ""}
:content-type :json
:form-params [{:payload {}
:position {:accuracy ""
:alt ""
:altaccuracy ""
:confidence 0
:floor {:id ""
:level ""
:name ""}
:heading 0
:lat ""
:lng ""
:satellitecount 0
:speed 0
:timestamp 0
:type ""
:wlancount 0}
:scan {:bt [{:eddystoneId ""
:iBeaconId ""
:mac ""
:rss 0
:timestamp ""}]
:cdma [{:baselat ""
:baselng ""
:bsid 0
:channel 0
:nid 0
:nmr [{:bsid 0
:channel 0
:frequency 0
:pilotpower 0
:pnoffset 0}]
:pilotpower 0
:pnoffset 0
:rz 0
:sid 0
:timestamp ""}]
:country {:mcc 0}
:gps {:accuracy ""
:alt ""
:altaccuracy ""
:heading 0
:lat ""
:lng ""
:satellitecount 0
:speed 0
:timestamp 0}
:gsm [{:bcch 0
:bsic 0
:cid 0
:lac 0
:mcc 0
:mnc 0
:nmr [{:bcch 0
:bsic 0
:cid 0
:lac 0
:rxlevel 0}]
:rxlevel 0
:ta 0
:timestamp ""}]
:lte [{:cid 0
:earfcn 0
:mcc 0
:mnc 0
:nmr [{:cid 0
:earfcn 0
:pci 0
:rsrp 0
:rsrq ""}]
:pci 0
:rsrp 0
:rsrq ""
:ta 0
:tac 0
:timestamp ""}]
:tdscdma [{:cellparams 0
:cid 0
:lac 0
:mcc 0
:mnc 0
:nmr [{:cellparams 0
:cid 0
:pathloss 0
:rscp 0
:uarfcn 0}]
:pathloss 0
:rscp 0
:ta 0
:timestamp ""
:uarfcn 0}]
:wcdma [{:cid 0
:lac 0
:mcc 0
:mnc 0
:nmr [{:cid 0
:pathloss 0
:psc 0
:rscp 0
:uarfcndl 0}]
:pathloss 0
:psc 0
:rscp 0
:timestamp ""
:uarfcndl 0}]
:wlan [{:band ""
:mac ""
:powrx 0
:timestamp ""}]}
:system {:client {:accelerometerSensorRange []
:diagnosticscode ""
:diskquota ""
:firmware ""
:hasAccelerometerSensor false
:hasAttachSensor false
:hasHumiditySensor false
:hasNoBattery false
:hasPressureSensor false
:hasTamperSensor false
:hasTemperatureSensor false
:homenetwork [{:mcc 0
:mnc 0
:nid 0
:sid 0}]
:manufacturer ""
:model ""
:modules [{:firmwareVersion ""
:manufacturer ""
:model ""}]
:name ""
:platform ""
:version ""}
:iccid ""
:imsi ""
:mode ""
:phoneNumber ""
:reportedSensorData {:accelerationG ""
:batteryIsCharging false
:batteryLevel 0
:deviceIsAttached false
:deviceIsStationary false
:deviceIsTampered false
:pressureHpa ""
:relativeHumidity ""
:temperatureC ""
:tiltDegree ""}
:stateVersion 0}
:timestamp 0}]})
require "http/client"
url = "{{baseUrl}}/v2/"
headers = HTTP::Headers{
"authorization" => ""
"content-type" => "application/json"
}
reqBody = "[\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n]"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/v2/"),
Headers =
{
{ "authorization", "" },
},
Content = new StringContent("[\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\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}}/v2/");
var request = new RestRequest("", Method.Post);
request.AddHeader("authorization", "");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "[\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n]", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/v2/"
payload := strings.NewReader("[\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "")
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/v2/ HTTP/1.1
Authorization:
Content-Type: application/json
Host: example.com
Content-Length: 4518
[
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": {
"mcc": 0
},
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
]
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/v2/")
.setHeader("authorization", "")
.setHeader("content-type", "application/json")
.setBody("[\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n]")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/v2/"))
.header("authorization", "")
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("[\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\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 {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n]");
Request request = new Request.Builder()
.url("{{baseUrl}}/v2/")
.post(body)
.addHeader("authorization", "")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/v2/")
.header("authorization", "")
.header("content-type", "application/json")
.body("[\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n]")
.asString();
const data = JSON.stringify([
{
payload: {},
position: {
accuracy: '',
alt: '',
altaccuracy: '',
confidence: 0,
floor: {
id: '',
level: '',
name: ''
},
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0,
type: '',
wlancount: 0
},
scan: {
bt: [
{
eddystoneId: '',
iBeaconId: '',
mac: '',
rss: 0,
timestamp: ''
}
],
cdma: [
{
baselat: '',
baselng: '',
bsid: 0,
channel: 0,
nid: 0,
nmr: [
{
bsid: 0,
channel: 0,
frequency: 0,
pilotpower: 0,
pnoffset: 0
}
],
pilotpower: 0,
pnoffset: 0,
rz: 0,
sid: 0,
timestamp: ''
}
],
country: {
mcc: 0
},
gps: {
accuracy: '',
alt: '',
altaccuracy: '',
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0
},
gsm: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
rxlevel: 0
}
],
rxlevel: 0,
ta: 0,
timestamp: ''
}
],
lte: [
{
cid: 0,
earfcn: 0,
mcc: 0,
mnc: 0,
nmr: [
{
cid: 0,
earfcn: 0,
pci: 0,
rsrp: 0,
rsrq: ''
}
],
pci: 0,
rsrp: 0,
rsrq: '',
ta: 0,
tac: 0,
timestamp: ''
}
],
tdscdma: [
{
cellparams: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [
{
cellparams: 0,
cid: 0,
pathloss: 0,
rscp: 0,
uarfcn: 0
}
],
pathloss: 0,
rscp: 0,
ta: 0,
timestamp: '',
uarfcn: 0
}
],
wcdma: [
{
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [
{
cid: 0,
pathloss: 0,
psc: 0,
rscp: 0,
uarfcndl: 0
}
],
pathloss: 0,
psc: 0,
rscp: 0,
timestamp: '',
uarfcndl: 0
}
],
wlan: [
{
band: '',
mac: '',
powrx: 0,
timestamp: ''
}
]
},
system: {
client: {
accelerometerSensorRange: [],
diagnosticscode: '',
diskquota: '',
firmware: '',
hasAccelerometerSensor: false,
hasAttachSensor: false,
hasHumiditySensor: false,
hasNoBattery: false,
hasPressureSensor: false,
hasTamperSensor: false,
hasTemperatureSensor: false,
homenetwork: [
{
mcc: 0,
mnc: 0,
nid: 0,
sid: 0
}
],
manufacturer: '',
model: '',
modules: [
{
firmwareVersion: '',
manufacturer: '',
model: ''
}
],
name: '',
platform: '',
version: ''
},
iccid: '',
imsi: '',
mode: '',
phoneNumber: '',
reportedSensorData: {
accelerationG: '',
batteryIsCharging: false,
batteryLevel: 0,
deviceIsAttached: false,
deviceIsStationary: false,
deviceIsTampered: false,
pressureHpa: '',
relativeHumidity: '',
temperatureC: '',
tiltDegree: ''
},
stateVersion: 0
},
timestamp: 0
}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/v2/');
xhr.setRequestHeader('authorization', '');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/v2/',
headers: {authorization: '', 'content-type': 'application/json'},
data: [
{
payload: {},
position: {
accuracy: '',
alt: '',
altaccuracy: '',
confidence: 0,
floor: {id: '', level: '', name: ''},
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0,
type: '',
wlancount: 0
},
scan: {
bt: [{eddystoneId: '', iBeaconId: '', mac: '', rss: 0, timestamp: ''}],
cdma: [
{
baselat: '',
baselng: '',
bsid: 0,
channel: 0,
nid: 0,
nmr: [{bsid: 0, channel: 0, frequency: 0, pilotpower: 0, pnoffset: 0}],
pilotpower: 0,
pnoffset: 0,
rz: 0,
sid: 0,
timestamp: ''
}
],
country: {mcc: 0},
gps: {
accuracy: '',
alt: '',
altaccuracy: '',
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0
},
gsm: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{bcch: 0, bsic: 0, cid: 0, lac: 0, rxlevel: 0}],
rxlevel: 0,
ta: 0,
timestamp: ''
}
],
lte: [
{
cid: 0,
earfcn: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, earfcn: 0, pci: 0, rsrp: 0, rsrq: ''}],
pci: 0,
rsrp: 0,
rsrq: '',
ta: 0,
tac: 0,
timestamp: ''
}
],
tdscdma: [
{
cellparams: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cellparams: 0, cid: 0, pathloss: 0, rscp: 0, uarfcn: 0}],
pathloss: 0,
rscp: 0,
ta: 0,
timestamp: '',
uarfcn: 0
}
],
wcdma: [
{
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, pathloss: 0, psc: 0, rscp: 0, uarfcndl: 0}],
pathloss: 0,
psc: 0,
rscp: 0,
timestamp: '',
uarfcndl: 0
}
],
wlan: [{band: '', mac: '', powrx: 0, timestamp: ''}]
},
system: {
client: {
accelerometerSensorRange: [],
diagnosticscode: '',
diskquota: '',
firmware: '',
hasAccelerometerSensor: false,
hasAttachSensor: false,
hasHumiditySensor: false,
hasNoBattery: false,
hasPressureSensor: false,
hasTamperSensor: false,
hasTemperatureSensor: false,
homenetwork: [{mcc: 0, mnc: 0, nid: 0, sid: 0}],
manufacturer: '',
model: '',
modules: [{firmwareVersion: '', manufacturer: '', model: ''}],
name: '',
platform: '',
version: ''
},
iccid: '',
imsi: '',
mode: '',
phoneNumber: '',
reportedSensorData: {
accelerationG: '',
batteryIsCharging: false,
batteryLevel: 0,
deviceIsAttached: false,
deviceIsStationary: false,
deviceIsTampered: false,
pressureHpa: '',
relativeHumidity: '',
temperatureC: '',
tiltDegree: ''
},
stateVersion: 0
},
timestamp: 0
}
]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/v2/';
const options = {
method: 'POST',
headers: {authorization: '', 'content-type': 'application/json'},
body: '[{"payload":{},"position":{"accuracy":"","alt":"","altaccuracy":"","confidence":0,"floor":{"id":"","level":"","name":""},"heading":0,"lat":"","lng":"","satellitecount":0,"speed":0,"timestamp":0,"type":"","wlancount":0},"scan":{"bt":[{"eddystoneId":"","iBeaconId":"","mac":"","rss":0,"timestamp":""}],"cdma":[{"baselat":"","baselng":"","bsid":0,"channel":0,"nid":0,"nmr":[{"bsid":0,"channel":0,"frequency":0,"pilotpower":0,"pnoffset":0}],"pilotpower":0,"pnoffset":0,"rz":0,"sid":0,"timestamp":""}],"country":{"mcc":0},"gps":{"accuracy":"","alt":"","altaccuracy":"","heading":0,"lat":"","lng":"","satellitecount":0,"speed":0,"timestamp":0},"gsm":[{"bcch":0,"bsic":0,"cid":0,"lac":0,"mcc":0,"mnc":0,"nmr":[{"bcch":0,"bsic":0,"cid":0,"lac":0,"rxlevel":0}],"rxlevel":0,"ta":0,"timestamp":""}],"lte":[{"cid":0,"earfcn":0,"mcc":0,"mnc":0,"nmr":[{"cid":0,"earfcn":0,"pci":0,"rsrp":0,"rsrq":""}],"pci":0,"rsrp":0,"rsrq":"","ta":0,"tac":0,"timestamp":""}],"tdscdma":[{"cellparams":0,"cid":0,"lac":0,"mcc":0,"mnc":0,"nmr":[{"cellparams":0,"cid":0,"pathloss":0,"rscp":0,"uarfcn":0}],"pathloss":0,"rscp":0,"ta":0,"timestamp":"","uarfcn":0}],"wcdma":[{"cid":0,"lac":0,"mcc":0,"mnc":0,"nmr":[{"cid":0,"pathloss":0,"psc":0,"rscp":0,"uarfcndl":0}],"pathloss":0,"psc":0,"rscp":0,"timestamp":"","uarfcndl":0}],"wlan":[{"band":"","mac":"","powrx":0,"timestamp":""}]},"system":{"client":{"accelerometerSensorRange":[],"diagnosticscode":"","diskquota":"","firmware":"","hasAccelerometerSensor":false,"hasAttachSensor":false,"hasHumiditySensor":false,"hasNoBattery":false,"hasPressureSensor":false,"hasTamperSensor":false,"hasTemperatureSensor":false,"homenetwork":[{"mcc":0,"mnc":0,"nid":0,"sid":0}],"manufacturer":"","model":"","modules":[{"firmwareVersion":"","manufacturer":"","model":""}],"name":"","platform":"","version":""},"iccid":"","imsi":"","mode":"","phoneNumber":"","reportedSensorData":{"accelerationG":"","batteryIsCharging":false,"batteryLevel":0,"deviceIsAttached":false,"deviceIsStationary":false,"deviceIsTampered":false,"pressureHpa":"","relativeHumidity":"","temperatureC":"","tiltDegree":""},"stateVersion":0},"timestamp":0}]'
};
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}}/v2/',
method: 'POST',
headers: {
authorization: '',
'content-type': 'application/json'
},
processData: false,
data: '[\n {\n "payload": {},\n "position": {\n "accuracy": "",\n "alt": "",\n "altaccuracy": "",\n "confidence": 0,\n "floor": {\n "id": "",\n "level": "",\n "name": ""\n },\n "heading": 0,\n "lat": "",\n "lng": "",\n "satellitecount": 0,\n "speed": 0,\n "timestamp": 0,\n "type": "",\n "wlancount": 0\n },\n "scan": {\n "bt": [\n {\n "eddystoneId": "",\n "iBeaconId": "",\n "mac": "",\n "rss": 0,\n "timestamp": ""\n }\n ],\n "cdma": [\n {\n "baselat": "",\n "baselng": "",\n "bsid": 0,\n "channel": 0,\n "nid": 0,\n "nmr": [\n {\n "bsid": 0,\n "channel": 0,\n "frequency": 0,\n "pilotpower": 0,\n "pnoffset": 0\n }\n ],\n "pilotpower": 0,\n "pnoffset": 0,\n "rz": 0,\n "sid": 0,\n "timestamp": ""\n }\n ],\n "country": {\n "mcc": 0\n },\n "gps": {\n "accuracy": "",\n "alt": "",\n "altaccuracy": "",\n "heading": 0,\n "lat": "",\n "lng": "",\n "satellitecount": 0,\n "speed": 0,\n "timestamp": 0\n },\n "gsm": [\n {\n "bcch": 0,\n "bsic": 0,\n "cid": 0,\n "lac": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "bcch": 0,\n "bsic": 0,\n "cid": 0,\n "lac": 0,\n "rxlevel": 0\n }\n ],\n "rxlevel": 0,\n "ta": 0,\n "timestamp": ""\n }\n ],\n "lte": [\n {\n "cid": 0,\n "earfcn": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "cid": 0,\n "earfcn": 0,\n "pci": 0,\n "rsrp": 0,\n "rsrq": ""\n }\n ],\n "pci": 0,\n "rsrp": 0,\n "rsrq": "",\n "ta": 0,\n "tac": 0,\n "timestamp": ""\n }\n ],\n "tdscdma": [\n {\n "cellparams": 0,\n "cid": 0,\n "lac": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "cellparams": 0,\n "cid": 0,\n "pathloss": 0,\n "rscp": 0,\n "uarfcn": 0\n }\n ],\n "pathloss": 0,\n "rscp": 0,\n "ta": 0,\n "timestamp": "",\n "uarfcn": 0\n }\n ],\n "wcdma": [\n {\n "cid": 0,\n "lac": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "cid": 0,\n "pathloss": 0,\n "psc": 0,\n "rscp": 0,\n "uarfcndl": 0\n }\n ],\n "pathloss": 0,\n "psc": 0,\n "rscp": 0,\n "timestamp": "",\n "uarfcndl": 0\n }\n ],\n "wlan": [\n {\n "band": "",\n "mac": "",\n "powrx": 0,\n "timestamp": ""\n }\n ]\n },\n "system": {\n "client": {\n "accelerometerSensorRange": [],\n "diagnosticscode": "",\n "diskquota": "",\n "firmware": "",\n "hasAccelerometerSensor": false,\n "hasAttachSensor": false,\n "hasHumiditySensor": false,\n "hasNoBattery": false,\n "hasPressureSensor": false,\n "hasTamperSensor": false,\n "hasTemperatureSensor": false,\n "homenetwork": [\n {\n "mcc": 0,\n "mnc": 0,\n "nid": 0,\n "sid": 0\n }\n ],\n "manufacturer": "",\n "model": "",\n "modules": [\n {\n "firmwareVersion": "",\n "manufacturer": "",\n "model": ""\n }\n ],\n "name": "",\n "platform": "",\n "version": ""\n },\n "iccid": "",\n "imsi": "",\n "mode": "",\n "phoneNumber": "",\n "reportedSensorData": {\n "accelerationG": "",\n "batteryIsCharging": false,\n "batteryLevel": 0,\n "deviceIsAttached": false,\n "deviceIsStationary": false,\n "deviceIsTampered": false,\n "pressureHpa": "",\n "relativeHumidity": "",\n "temperatureC": "",\n "tiltDegree": ""\n },\n "stateVersion": 0\n },\n "timestamp": 0\n }\n]'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "[\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n]")
val request = Request.Builder()
.url("{{baseUrl}}/v2/")
.post(body)
.addHeader("authorization", "")
.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/v2/',
headers: {
authorization: '',
'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([
{
payload: {},
position: {
accuracy: '',
alt: '',
altaccuracy: '',
confidence: 0,
floor: {id: '', level: '', name: ''},
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0,
type: '',
wlancount: 0
},
scan: {
bt: [{eddystoneId: '', iBeaconId: '', mac: '', rss: 0, timestamp: ''}],
cdma: [
{
baselat: '',
baselng: '',
bsid: 0,
channel: 0,
nid: 0,
nmr: [{bsid: 0, channel: 0, frequency: 0, pilotpower: 0, pnoffset: 0}],
pilotpower: 0,
pnoffset: 0,
rz: 0,
sid: 0,
timestamp: ''
}
],
country: {mcc: 0},
gps: {
accuracy: '',
alt: '',
altaccuracy: '',
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0
},
gsm: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{bcch: 0, bsic: 0, cid: 0, lac: 0, rxlevel: 0}],
rxlevel: 0,
ta: 0,
timestamp: ''
}
],
lte: [
{
cid: 0,
earfcn: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, earfcn: 0, pci: 0, rsrp: 0, rsrq: ''}],
pci: 0,
rsrp: 0,
rsrq: '',
ta: 0,
tac: 0,
timestamp: ''
}
],
tdscdma: [
{
cellparams: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cellparams: 0, cid: 0, pathloss: 0, rscp: 0, uarfcn: 0}],
pathloss: 0,
rscp: 0,
ta: 0,
timestamp: '',
uarfcn: 0
}
],
wcdma: [
{
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, pathloss: 0, psc: 0, rscp: 0, uarfcndl: 0}],
pathloss: 0,
psc: 0,
rscp: 0,
timestamp: '',
uarfcndl: 0
}
],
wlan: [{band: '', mac: '', powrx: 0, timestamp: ''}]
},
system: {
client: {
accelerometerSensorRange: [],
diagnosticscode: '',
diskquota: '',
firmware: '',
hasAccelerometerSensor: false,
hasAttachSensor: false,
hasHumiditySensor: false,
hasNoBattery: false,
hasPressureSensor: false,
hasTamperSensor: false,
hasTemperatureSensor: false,
homenetwork: [{mcc: 0, mnc: 0, nid: 0, sid: 0}],
manufacturer: '',
model: '',
modules: [{firmwareVersion: '', manufacturer: '', model: ''}],
name: '',
platform: '',
version: ''
},
iccid: '',
imsi: '',
mode: '',
phoneNumber: '',
reportedSensorData: {
accelerationG: '',
batteryIsCharging: false,
batteryLevel: 0,
deviceIsAttached: false,
deviceIsStationary: false,
deviceIsTampered: false,
pressureHpa: '',
relativeHumidity: '',
temperatureC: '',
tiltDegree: ''
},
stateVersion: 0
},
timestamp: 0
}
]));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/v2/',
headers: {authorization: '', 'content-type': 'application/json'},
body: [
{
payload: {},
position: {
accuracy: '',
alt: '',
altaccuracy: '',
confidence: 0,
floor: {id: '', level: '', name: ''},
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0,
type: '',
wlancount: 0
},
scan: {
bt: [{eddystoneId: '', iBeaconId: '', mac: '', rss: 0, timestamp: ''}],
cdma: [
{
baselat: '',
baselng: '',
bsid: 0,
channel: 0,
nid: 0,
nmr: [{bsid: 0, channel: 0, frequency: 0, pilotpower: 0, pnoffset: 0}],
pilotpower: 0,
pnoffset: 0,
rz: 0,
sid: 0,
timestamp: ''
}
],
country: {mcc: 0},
gps: {
accuracy: '',
alt: '',
altaccuracy: '',
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0
},
gsm: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{bcch: 0, bsic: 0, cid: 0, lac: 0, rxlevel: 0}],
rxlevel: 0,
ta: 0,
timestamp: ''
}
],
lte: [
{
cid: 0,
earfcn: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, earfcn: 0, pci: 0, rsrp: 0, rsrq: ''}],
pci: 0,
rsrp: 0,
rsrq: '',
ta: 0,
tac: 0,
timestamp: ''
}
],
tdscdma: [
{
cellparams: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cellparams: 0, cid: 0, pathloss: 0, rscp: 0, uarfcn: 0}],
pathloss: 0,
rscp: 0,
ta: 0,
timestamp: '',
uarfcn: 0
}
],
wcdma: [
{
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, pathloss: 0, psc: 0, rscp: 0, uarfcndl: 0}],
pathloss: 0,
psc: 0,
rscp: 0,
timestamp: '',
uarfcndl: 0
}
],
wlan: [{band: '', mac: '', powrx: 0, timestamp: ''}]
},
system: {
client: {
accelerometerSensorRange: [],
diagnosticscode: '',
diskquota: '',
firmware: '',
hasAccelerometerSensor: false,
hasAttachSensor: false,
hasHumiditySensor: false,
hasNoBattery: false,
hasPressureSensor: false,
hasTamperSensor: false,
hasTemperatureSensor: false,
homenetwork: [{mcc: 0, mnc: 0, nid: 0, sid: 0}],
manufacturer: '',
model: '',
modules: [{firmwareVersion: '', manufacturer: '', model: ''}],
name: '',
platform: '',
version: ''
},
iccid: '',
imsi: '',
mode: '',
phoneNumber: '',
reportedSensorData: {
accelerationG: '',
batteryIsCharging: false,
batteryLevel: 0,
deviceIsAttached: false,
deviceIsStationary: false,
deviceIsTampered: false,
pressureHpa: '',
relativeHumidity: '',
temperatureC: '',
tiltDegree: ''
},
stateVersion: 0
},
timestamp: 0
}
],
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}}/v2/');
req.headers({
authorization: '',
'content-type': 'application/json'
});
req.type('json');
req.send([
{
payload: {},
position: {
accuracy: '',
alt: '',
altaccuracy: '',
confidence: 0,
floor: {
id: '',
level: '',
name: ''
},
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0,
type: '',
wlancount: 0
},
scan: {
bt: [
{
eddystoneId: '',
iBeaconId: '',
mac: '',
rss: 0,
timestamp: ''
}
],
cdma: [
{
baselat: '',
baselng: '',
bsid: 0,
channel: 0,
nid: 0,
nmr: [
{
bsid: 0,
channel: 0,
frequency: 0,
pilotpower: 0,
pnoffset: 0
}
],
pilotpower: 0,
pnoffset: 0,
rz: 0,
sid: 0,
timestamp: ''
}
],
country: {
mcc: 0
},
gps: {
accuracy: '',
alt: '',
altaccuracy: '',
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0
},
gsm: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
rxlevel: 0
}
],
rxlevel: 0,
ta: 0,
timestamp: ''
}
],
lte: [
{
cid: 0,
earfcn: 0,
mcc: 0,
mnc: 0,
nmr: [
{
cid: 0,
earfcn: 0,
pci: 0,
rsrp: 0,
rsrq: ''
}
],
pci: 0,
rsrp: 0,
rsrq: '',
ta: 0,
tac: 0,
timestamp: ''
}
],
tdscdma: [
{
cellparams: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [
{
cellparams: 0,
cid: 0,
pathloss: 0,
rscp: 0,
uarfcn: 0
}
],
pathloss: 0,
rscp: 0,
ta: 0,
timestamp: '',
uarfcn: 0
}
],
wcdma: [
{
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [
{
cid: 0,
pathloss: 0,
psc: 0,
rscp: 0,
uarfcndl: 0
}
],
pathloss: 0,
psc: 0,
rscp: 0,
timestamp: '',
uarfcndl: 0
}
],
wlan: [
{
band: '',
mac: '',
powrx: 0,
timestamp: ''
}
]
},
system: {
client: {
accelerometerSensorRange: [],
diagnosticscode: '',
diskquota: '',
firmware: '',
hasAccelerometerSensor: false,
hasAttachSensor: false,
hasHumiditySensor: false,
hasNoBattery: false,
hasPressureSensor: false,
hasTamperSensor: false,
hasTemperatureSensor: false,
homenetwork: [
{
mcc: 0,
mnc: 0,
nid: 0,
sid: 0
}
],
manufacturer: '',
model: '',
modules: [
{
firmwareVersion: '',
manufacturer: '',
model: ''
}
],
name: '',
platform: '',
version: ''
},
iccid: '',
imsi: '',
mode: '',
phoneNumber: '',
reportedSensorData: {
accelerationG: '',
batteryIsCharging: false,
batteryLevel: 0,
deviceIsAttached: false,
deviceIsStationary: false,
deviceIsTampered: false,
pressureHpa: '',
relativeHumidity: '',
temperatureC: '',
tiltDegree: ''
},
stateVersion: 0
},
timestamp: 0
}
]);
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}}/v2/',
headers: {authorization: '', 'content-type': 'application/json'},
data: [
{
payload: {},
position: {
accuracy: '',
alt: '',
altaccuracy: '',
confidence: 0,
floor: {id: '', level: '', name: ''},
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0,
type: '',
wlancount: 0
},
scan: {
bt: [{eddystoneId: '', iBeaconId: '', mac: '', rss: 0, timestamp: ''}],
cdma: [
{
baselat: '',
baselng: '',
bsid: 0,
channel: 0,
nid: 0,
nmr: [{bsid: 0, channel: 0, frequency: 0, pilotpower: 0, pnoffset: 0}],
pilotpower: 0,
pnoffset: 0,
rz: 0,
sid: 0,
timestamp: ''
}
],
country: {mcc: 0},
gps: {
accuracy: '',
alt: '',
altaccuracy: '',
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0
},
gsm: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{bcch: 0, bsic: 0, cid: 0, lac: 0, rxlevel: 0}],
rxlevel: 0,
ta: 0,
timestamp: ''
}
],
lte: [
{
cid: 0,
earfcn: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, earfcn: 0, pci: 0, rsrp: 0, rsrq: ''}],
pci: 0,
rsrp: 0,
rsrq: '',
ta: 0,
tac: 0,
timestamp: ''
}
],
tdscdma: [
{
cellparams: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cellparams: 0, cid: 0, pathloss: 0, rscp: 0, uarfcn: 0}],
pathloss: 0,
rscp: 0,
ta: 0,
timestamp: '',
uarfcn: 0
}
],
wcdma: [
{
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, pathloss: 0, psc: 0, rscp: 0, uarfcndl: 0}],
pathloss: 0,
psc: 0,
rscp: 0,
timestamp: '',
uarfcndl: 0
}
],
wlan: [{band: '', mac: '', powrx: 0, timestamp: ''}]
},
system: {
client: {
accelerometerSensorRange: [],
diagnosticscode: '',
diskquota: '',
firmware: '',
hasAccelerometerSensor: false,
hasAttachSensor: false,
hasHumiditySensor: false,
hasNoBattery: false,
hasPressureSensor: false,
hasTamperSensor: false,
hasTemperatureSensor: false,
homenetwork: [{mcc: 0, mnc: 0, nid: 0, sid: 0}],
manufacturer: '',
model: '',
modules: [{firmwareVersion: '', manufacturer: '', model: ''}],
name: '',
platform: '',
version: ''
},
iccid: '',
imsi: '',
mode: '',
phoneNumber: '',
reportedSensorData: {
accelerationG: '',
batteryIsCharging: false,
batteryLevel: 0,
deviceIsAttached: false,
deviceIsStationary: false,
deviceIsTampered: false,
pressureHpa: '',
relativeHumidity: '',
temperatureC: '',
tiltDegree: ''
},
stateVersion: 0
},
timestamp: 0
}
]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/v2/';
const options = {
method: 'POST',
headers: {authorization: '', 'content-type': 'application/json'},
body: '[{"payload":{},"position":{"accuracy":"","alt":"","altaccuracy":"","confidence":0,"floor":{"id":"","level":"","name":""},"heading":0,"lat":"","lng":"","satellitecount":0,"speed":0,"timestamp":0,"type":"","wlancount":0},"scan":{"bt":[{"eddystoneId":"","iBeaconId":"","mac":"","rss":0,"timestamp":""}],"cdma":[{"baselat":"","baselng":"","bsid":0,"channel":0,"nid":0,"nmr":[{"bsid":0,"channel":0,"frequency":0,"pilotpower":0,"pnoffset":0}],"pilotpower":0,"pnoffset":0,"rz":0,"sid":0,"timestamp":""}],"country":{"mcc":0},"gps":{"accuracy":"","alt":"","altaccuracy":"","heading":0,"lat":"","lng":"","satellitecount":0,"speed":0,"timestamp":0},"gsm":[{"bcch":0,"bsic":0,"cid":0,"lac":0,"mcc":0,"mnc":0,"nmr":[{"bcch":0,"bsic":0,"cid":0,"lac":0,"rxlevel":0}],"rxlevel":0,"ta":0,"timestamp":""}],"lte":[{"cid":0,"earfcn":0,"mcc":0,"mnc":0,"nmr":[{"cid":0,"earfcn":0,"pci":0,"rsrp":0,"rsrq":""}],"pci":0,"rsrp":0,"rsrq":"","ta":0,"tac":0,"timestamp":""}],"tdscdma":[{"cellparams":0,"cid":0,"lac":0,"mcc":0,"mnc":0,"nmr":[{"cellparams":0,"cid":0,"pathloss":0,"rscp":0,"uarfcn":0}],"pathloss":0,"rscp":0,"ta":0,"timestamp":"","uarfcn":0}],"wcdma":[{"cid":0,"lac":0,"mcc":0,"mnc":0,"nmr":[{"cid":0,"pathloss":0,"psc":0,"rscp":0,"uarfcndl":0}],"pathloss":0,"psc":0,"rscp":0,"timestamp":"","uarfcndl":0}],"wlan":[{"band":"","mac":"","powrx":0,"timestamp":""}]},"system":{"client":{"accelerometerSensorRange":[],"diagnosticscode":"","diskquota":"","firmware":"","hasAccelerometerSensor":false,"hasAttachSensor":false,"hasHumiditySensor":false,"hasNoBattery":false,"hasPressureSensor":false,"hasTamperSensor":false,"hasTemperatureSensor":false,"homenetwork":[{"mcc":0,"mnc":0,"nid":0,"sid":0}],"manufacturer":"","model":"","modules":[{"firmwareVersion":"","manufacturer":"","model":""}],"name":"","platform":"","version":""},"iccid":"","imsi":"","mode":"","phoneNumber":"","reportedSensorData":{"accelerationG":"","batteryIsCharging":false,"batteryLevel":0,"deviceIsAttached":false,"deviceIsStationary":false,"deviceIsTampered":false,"pressureHpa":"","relativeHumidity":"","temperatureC":"","tiltDegree":""},"stateVersion":0},"timestamp":0}]'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"authorization": @"",
@"content-type": @"application/json" };
NSDictionary *parameters = @[ @{ @"payload": @{ }, @"position": @{ @"accuracy": @"", @"alt": @"", @"altaccuracy": @"", @"confidence": @0, @"floor": @{ @"id": @"", @"level": @"", @"name": @"" }, @"heading": @0, @"lat": @"", @"lng": @"", @"satellitecount": @0, @"speed": @0, @"timestamp": @0, @"type": @"", @"wlancount": @0 }, @"scan": @{ @"bt": @[ @{ @"eddystoneId": @"", @"iBeaconId": @"", @"mac": @"", @"rss": @0, @"timestamp": @"" } ], @"cdma": @[ @{ @"baselat": @"", @"baselng": @"", @"bsid": @0, @"channel": @0, @"nid": @0, @"nmr": @[ @{ @"bsid": @0, @"channel": @0, @"frequency": @0, @"pilotpower": @0, @"pnoffset": @0 } ], @"pilotpower": @0, @"pnoffset": @0, @"rz": @0, @"sid": @0, @"timestamp": @"" } ], @"country": @{ @"mcc": @0 }, @"gps": @{ @"accuracy": @"", @"alt": @"", @"altaccuracy": @"", @"heading": @0, @"lat": @"", @"lng": @"", @"satellitecount": @0, @"speed": @0, @"timestamp": @0 }, @"gsm": @[ @{ @"bcch": @0, @"bsic": @0, @"cid": @0, @"lac": @0, @"mcc": @0, @"mnc": @0, @"nmr": @[ @{ @"bcch": @0, @"bsic": @0, @"cid": @0, @"lac": @0, @"rxlevel": @0 } ], @"rxlevel": @0, @"ta": @0, @"timestamp": @"" } ], @"lte": @[ @{ @"cid": @0, @"earfcn": @0, @"mcc": @0, @"mnc": @0, @"nmr": @[ @{ @"cid": @0, @"earfcn": @0, @"pci": @0, @"rsrp": @0, @"rsrq": @"" } ], @"pci": @0, @"rsrp": @0, @"rsrq": @"", @"ta": @0, @"tac": @0, @"timestamp": @"" } ], @"tdscdma": @[ @{ @"cellparams": @0, @"cid": @0, @"lac": @0, @"mcc": @0, @"mnc": @0, @"nmr": @[ @{ @"cellparams": @0, @"cid": @0, @"pathloss": @0, @"rscp": @0, @"uarfcn": @0 } ], @"pathloss": @0, @"rscp": @0, @"ta": @0, @"timestamp": @"", @"uarfcn": @0 } ], @"wcdma": @[ @{ @"cid": @0, @"lac": @0, @"mcc": @0, @"mnc": @0, @"nmr": @[ @{ @"cid": @0, @"pathloss": @0, @"psc": @0, @"rscp": @0, @"uarfcndl": @0 } ], @"pathloss": @0, @"psc": @0, @"rscp": @0, @"timestamp": @"", @"uarfcndl": @0 } ], @"wlan": @[ @{ @"band": @"", @"mac": @"", @"powrx": @0, @"timestamp": @"" } ] }, @"system": @{ @"client": @{ @"accelerometerSensorRange": @[ ], @"diagnosticscode": @"", @"diskquota": @"", @"firmware": @"", @"hasAccelerometerSensor": @NO, @"hasAttachSensor": @NO, @"hasHumiditySensor": @NO, @"hasNoBattery": @NO, @"hasPressureSensor": @NO, @"hasTamperSensor": @NO, @"hasTemperatureSensor": @NO, @"homenetwork": @[ @{ @"mcc": @0, @"mnc": @0, @"nid": @0, @"sid": @0 } ], @"manufacturer": @"", @"model": @"", @"modules": @[ @{ @"firmwareVersion": @"", @"manufacturer": @"", @"model": @"" } ], @"name": @"", @"platform": @"", @"version": @"" }, @"iccid": @"", @"imsi": @"", @"mode": @"", @"phoneNumber": @"", @"reportedSensorData": @{ @"accelerationG": @"", @"batteryIsCharging": @NO, @"batteryLevel": @0, @"deviceIsAttached": @NO, @"deviceIsStationary": @NO, @"deviceIsTampered": @NO, @"pressureHpa": @"", @"relativeHumidity": @"", @"temperatureC": @"", @"tiltDegree": @"" }, @"stateVersion": @0 }, @"timestamp": @0 } ];
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/v2/"]
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}}/v2/" in
let headers = Header.add_list (Header.init ()) [
("authorization", "");
("content-type", "application/json");
] in
let body = Cohttp_lwt_body.of_string "[\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n]" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/v2/",
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([
[
'payload' => [
],
'position' => [
'accuracy' => '',
'alt' => '',
'altaccuracy' => '',
'confidence' => 0,
'floor' => [
'id' => '',
'level' => '',
'name' => ''
],
'heading' => 0,
'lat' => '',
'lng' => '',
'satellitecount' => 0,
'speed' => 0,
'timestamp' => 0,
'type' => '',
'wlancount' => 0
],
'scan' => [
'bt' => [
[
'eddystoneId' => '',
'iBeaconId' => '',
'mac' => '',
'rss' => 0,
'timestamp' => ''
]
],
'cdma' => [
[
'baselat' => '',
'baselng' => '',
'bsid' => 0,
'channel' => 0,
'nid' => 0,
'nmr' => [
[
'bsid' => 0,
'channel' => 0,
'frequency' => 0,
'pilotpower' => 0,
'pnoffset' => 0
]
],
'pilotpower' => 0,
'pnoffset' => 0,
'rz' => 0,
'sid' => 0,
'timestamp' => ''
]
],
'country' => [
'mcc' => 0
],
'gps' => [
'accuracy' => '',
'alt' => '',
'altaccuracy' => '',
'heading' => 0,
'lat' => '',
'lng' => '',
'satellitecount' => 0,
'speed' => 0,
'timestamp' => 0
],
'gsm' => [
[
'bcch' => 0,
'bsic' => 0,
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'bcch' => 0,
'bsic' => 0,
'cid' => 0,
'lac' => 0,
'rxlevel' => 0
]
],
'rxlevel' => 0,
'ta' => 0,
'timestamp' => ''
]
],
'lte' => [
[
'cid' => 0,
'earfcn' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cid' => 0,
'earfcn' => 0,
'pci' => 0,
'rsrp' => 0,
'rsrq' => ''
]
],
'pci' => 0,
'rsrp' => 0,
'rsrq' => '',
'ta' => 0,
'tac' => 0,
'timestamp' => ''
]
],
'tdscdma' => [
[
'cellparams' => 0,
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cellparams' => 0,
'cid' => 0,
'pathloss' => 0,
'rscp' => 0,
'uarfcn' => 0
]
],
'pathloss' => 0,
'rscp' => 0,
'ta' => 0,
'timestamp' => '',
'uarfcn' => 0
]
],
'wcdma' => [
[
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cid' => 0,
'pathloss' => 0,
'psc' => 0,
'rscp' => 0,
'uarfcndl' => 0
]
],
'pathloss' => 0,
'psc' => 0,
'rscp' => 0,
'timestamp' => '',
'uarfcndl' => 0
]
],
'wlan' => [
[
'band' => '',
'mac' => '',
'powrx' => 0,
'timestamp' => ''
]
]
],
'system' => [
'client' => [
'accelerometerSensorRange' => [
],
'diagnosticscode' => '',
'diskquota' => '',
'firmware' => '',
'hasAccelerometerSensor' => null,
'hasAttachSensor' => null,
'hasHumiditySensor' => null,
'hasNoBattery' => null,
'hasPressureSensor' => null,
'hasTamperSensor' => null,
'hasTemperatureSensor' => null,
'homenetwork' => [
[
'mcc' => 0,
'mnc' => 0,
'nid' => 0,
'sid' => 0
]
],
'manufacturer' => '',
'model' => '',
'modules' => [
[
'firmwareVersion' => '',
'manufacturer' => '',
'model' => ''
]
],
'name' => '',
'platform' => '',
'version' => ''
],
'iccid' => '',
'imsi' => '',
'mode' => '',
'phoneNumber' => '',
'reportedSensorData' => [
'accelerationG' => '',
'batteryIsCharging' => null,
'batteryLevel' => 0,
'deviceIsAttached' => null,
'deviceIsStationary' => null,
'deviceIsTampered' => null,
'pressureHpa' => '',
'relativeHumidity' => '',
'temperatureC' => '',
'tiltDegree' => ''
],
'stateVersion' => 0
],
'timestamp' => 0
]
]),
CURLOPT_HTTPHEADER => [
"authorization: ",
"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}}/v2/', [
'body' => '[
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": {
"mcc": 0
},
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
]',
'headers' => [
'authorization' => '',
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/v2/');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'authorization' => '',
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
[
'payload' => [
],
'position' => [
'accuracy' => '',
'alt' => '',
'altaccuracy' => '',
'confidence' => 0,
'floor' => [
'id' => '',
'level' => '',
'name' => ''
],
'heading' => 0,
'lat' => '',
'lng' => '',
'satellitecount' => 0,
'speed' => 0,
'timestamp' => 0,
'type' => '',
'wlancount' => 0
],
'scan' => [
'bt' => [
[
'eddystoneId' => '',
'iBeaconId' => '',
'mac' => '',
'rss' => 0,
'timestamp' => ''
]
],
'cdma' => [
[
'baselat' => '',
'baselng' => '',
'bsid' => 0,
'channel' => 0,
'nid' => 0,
'nmr' => [
[
'bsid' => 0,
'channel' => 0,
'frequency' => 0,
'pilotpower' => 0,
'pnoffset' => 0
]
],
'pilotpower' => 0,
'pnoffset' => 0,
'rz' => 0,
'sid' => 0,
'timestamp' => ''
]
],
'country' => [
'mcc' => 0
],
'gps' => [
'accuracy' => '',
'alt' => '',
'altaccuracy' => '',
'heading' => 0,
'lat' => '',
'lng' => '',
'satellitecount' => 0,
'speed' => 0,
'timestamp' => 0
],
'gsm' => [
[
'bcch' => 0,
'bsic' => 0,
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'bcch' => 0,
'bsic' => 0,
'cid' => 0,
'lac' => 0,
'rxlevel' => 0
]
],
'rxlevel' => 0,
'ta' => 0,
'timestamp' => ''
]
],
'lte' => [
[
'cid' => 0,
'earfcn' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cid' => 0,
'earfcn' => 0,
'pci' => 0,
'rsrp' => 0,
'rsrq' => ''
]
],
'pci' => 0,
'rsrp' => 0,
'rsrq' => '',
'ta' => 0,
'tac' => 0,
'timestamp' => ''
]
],
'tdscdma' => [
[
'cellparams' => 0,
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cellparams' => 0,
'cid' => 0,
'pathloss' => 0,
'rscp' => 0,
'uarfcn' => 0
]
],
'pathloss' => 0,
'rscp' => 0,
'ta' => 0,
'timestamp' => '',
'uarfcn' => 0
]
],
'wcdma' => [
[
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cid' => 0,
'pathloss' => 0,
'psc' => 0,
'rscp' => 0,
'uarfcndl' => 0
]
],
'pathloss' => 0,
'psc' => 0,
'rscp' => 0,
'timestamp' => '',
'uarfcndl' => 0
]
],
'wlan' => [
[
'band' => '',
'mac' => '',
'powrx' => 0,
'timestamp' => ''
]
]
],
'system' => [
'client' => [
'accelerometerSensorRange' => [
],
'diagnosticscode' => '',
'diskquota' => '',
'firmware' => '',
'hasAccelerometerSensor' => null,
'hasAttachSensor' => null,
'hasHumiditySensor' => null,
'hasNoBattery' => null,
'hasPressureSensor' => null,
'hasTamperSensor' => null,
'hasTemperatureSensor' => null,
'homenetwork' => [
[
'mcc' => 0,
'mnc' => 0,
'nid' => 0,
'sid' => 0
]
],
'manufacturer' => '',
'model' => '',
'modules' => [
[
'firmwareVersion' => '',
'manufacturer' => '',
'model' => ''
]
],
'name' => '',
'platform' => '',
'version' => ''
],
'iccid' => '',
'imsi' => '',
'mode' => '',
'phoneNumber' => '',
'reportedSensorData' => [
'accelerationG' => '',
'batteryIsCharging' => null,
'batteryLevel' => 0,
'deviceIsAttached' => null,
'deviceIsStationary' => null,
'deviceIsTampered' => null,
'pressureHpa' => '',
'relativeHumidity' => '',
'temperatureC' => '',
'tiltDegree' => ''
],
'stateVersion' => 0
],
'timestamp' => 0
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
[
'payload' => [
],
'position' => [
'accuracy' => '',
'alt' => '',
'altaccuracy' => '',
'confidence' => 0,
'floor' => [
'id' => '',
'level' => '',
'name' => ''
],
'heading' => 0,
'lat' => '',
'lng' => '',
'satellitecount' => 0,
'speed' => 0,
'timestamp' => 0,
'type' => '',
'wlancount' => 0
],
'scan' => [
'bt' => [
[
'eddystoneId' => '',
'iBeaconId' => '',
'mac' => '',
'rss' => 0,
'timestamp' => ''
]
],
'cdma' => [
[
'baselat' => '',
'baselng' => '',
'bsid' => 0,
'channel' => 0,
'nid' => 0,
'nmr' => [
[
'bsid' => 0,
'channel' => 0,
'frequency' => 0,
'pilotpower' => 0,
'pnoffset' => 0
]
],
'pilotpower' => 0,
'pnoffset' => 0,
'rz' => 0,
'sid' => 0,
'timestamp' => ''
]
],
'country' => [
'mcc' => 0
],
'gps' => [
'accuracy' => '',
'alt' => '',
'altaccuracy' => '',
'heading' => 0,
'lat' => '',
'lng' => '',
'satellitecount' => 0,
'speed' => 0,
'timestamp' => 0
],
'gsm' => [
[
'bcch' => 0,
'bsic' => 0,
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'bcch' => 0,
'bsic' => 0,
'cid' => 0,
'lac' => 0,
'rxlevel' => 0
]
],
'rxlevel' => 0,
'ta' => 0,
'timestamp' => ''
]
],
'lte' => [
[
'cid' => 0,
'earfcn' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cid' => 0,
'earfcn' => 0,
'pci' => 0,
'rsrp' => 0,
'rsrq' => ''
]
],
'pci' => 0,
'rsrp' => 0,
'rsrq' => '',
'ta' => 0,
'tac' => 0,
'timestamp' => ''
]
],
'tdscdma' => [
[
'cellparams' => 0,
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cellparams' => 0,
'cid' => 0,
'pathloss' => 0,
'rscp' => 0,
'uarfcn' => 0
]
],
'pathloss' => 0,
'rscp' => 0,
'ta' => 0,
'timestamp' => '',
'uarfcn' => 0
]
],
'wcdma' => [
[
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cid' => 0,
'pathloss' => 0,
'psc' => 0,
'rscp' => 0,
'uarfcndl' => 0
]
],
'pathloss' => 0,
'psc' => 0,
'rscp' => 0,
'timestamp' => '',
'uarfcndl' => 0
]
],
'wlan' => [
[
'band' => '',
'mac' => '',
'powrx' => 0,
'timestamp' => ''
]
]
],
'system' => [
'client' => [
'accelerometerSensorRange' => [
],
'diagnosticscode' => '',
'diskquota' => '',
'firmware' => '',
'hasAccelerometerSensor' => null,
'hasAttachSensor' => null,
'hasHumiditySensor' => null,
'hasNoBattery' => null,
'hasPressureSensor' => null,
'hasTamperSensor' => null,
'hasTemperatureSensor' => null,
'homenetwork' => [
[
'mcc' => 0,
'mnc' => 0,
'nid' => 0,
'sid' => 0
]
],
'manufacturer' => '',
'model' => '',
'modules' => [
[
'firmwareVersion' => '',
'manufacturer' => '',
'model' => ''
]
],
'name' => '',
'platform' => '',
'version' => ''
],
'iccid' => '',
'imsi' => '',
'mode' => '',
'phoneNumber' => '',
'reportedSensorData' => [
'accelerationG' => '',
'batteryIsCharging' => null,
'batteryLevel' => 0,
'deviceIsAttached' => null,
'deviceIsStationary' => null,
'deviceIsTampered' => null,
'pressureHpa' => '',
'relativeHumidity' => '',
'temperatureC' => '',
'tiltDegree' => ''
],
'stateVersion' => 0
],
'timestamp' => 0
]
]));
$request->setRequestUrl('{{baseUrl}}/v2/');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'authorization' => '',
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("authorization", "")
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/v2/' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": {
"mcc": 0
},
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
]'
$headers=@{}
$headers.Add("authorization", "")
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/v2/' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": {
"mcc": 0
},
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
]'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "[\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n]"
headers = {
'authorization': "",
'content-type': "application/json"
}
conn.request("POST", "/baseUrl/v2/", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/v2/"
payload = [
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": { "mcc": 0 },
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": False,
"hasAttachSensor": False,
"hasHumiditySensor": False,
"hasNoBattery": False,
"hasPressureSensor": False,
"hasTamperSensor": False,
"hasTemperatureSensor": False,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": False,
"batteryLevel": 0,
"deviceIsAttached": False,
"deviceIsStationary": False,
"deviceIsTampered": False,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
]
headers = {
"authorization": "",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/v2/"
payload <- "[\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n]"
encode <- "json"
response <- VERB("POST", url, body = payload, add_headers('authorization' = ''), content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/v2/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = ''
request["content-type"] = 'application/json'
request.body = "[\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n]"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/v2/') do |req|
req.headers['authorization'] = ''
req.body = "[\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n]"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/v2/";
let payload = (
json!({
"payload": json!({}),
"position": json!({
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": json!({
"id": "",
"level": "",
"name": ""
}),
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
}),
"scan": json!({
"bt": (
json!({
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
})
),
"cdma": (
json!({
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": (
json!({
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
})
),
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
})
),
"country": json!({"mcc": 0}),
"gps": json!({
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
}),
"gsm": (
json!({
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": (
json!({
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
})
),
"rxlevel": 0,
"ta": 0,
"timestamp": ""
})
),
"lte": (
json!({
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": (
json!({
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
})
),
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
})
),
"tdscdma": (
json!({
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": (
json!({
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
})
),
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
})
),
"wcdma": (
json!({
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": (
json!({
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
})
),
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
})
),
"wlan": (
json!({
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
})
)
}),
"system": json!({
"client": json!({
"accelerometerSensorRange": (),
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": (
json!({
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
})
),
"manufacturer": "",
"model": "",
"modules": (
json!({
"firmwareVersion": "",
"manufacturer": "",
"model": ""
})
),
"name": "",
"platform": "",
"version": ""
}),
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": json!({
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
}),
"stateVersion": 0
}),
"timestamp": 0
})
);
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("authorization", "".parse().unwrap());
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}}/v2/ \
--header 'authorization: ' \
--header 'content-type: application/json' \
--data '[
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": {
"mcc": 0
},
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
]'
echo '[
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": {
"mcc": 0
},
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
]' | \
http POST {{baseUrl}}/v2/ \
authorization:'' \
content-type:application/json
wget --quiet \
--method POST \
--header 'authorization: ' \
--header 'content-type: application/json' \
--body-data '[\n {\n "payload": {},\n "position": {\n "accuracy": "",\n "alt": "",\n "altaccuracy": "",\n "confidence": 0,\n "floor": {\n "id": "",\n "level": "",\n "name": ""\n },\n "heading": 0,\n "lat": "",\n "lng": "",\n "satellitecount": 0,\n "speed": 0,\n "timestamp": 0,\n "type": "",\n "wlancount": 0\n },\n "scan": {\n "bt": [\n {\n "eddystoneId": "",\n "iBeaconId": "",\n "mac": "",\n "rss": 0,\n "timestamp": ""\n }\n ],\n "cdma": [\n {\n "baselat": "",\n "baselng": "",\n "bsid": 0,\n "channel": 0,\n "nid": 0,\n "nmr": [\n {\n "bsid": 0,\n "channel": 0,\n "frequency": 0,\n "pilotpower": 0,\n "pnoffset": 0\n }\n ],\n "pilotpower": 0,\n "pnoffset": 0,\n "rz": 0,\n "sid": 0,\n "timestamp": ""\n }\n ],\n "country": {\n "mcc": 0\n },\n "gps": {\n "accuracy": "",\n "alt": "",\n "altaccuracy": "",\n "heading": 0,\n "lat": "",\n "lng": "",\n "satellitecount": 0,\n "speed": 0,\n "timestamp": 0\n },\n "gsm": [\n {\n "bcch": 0,\n "bsic": 0,\n "cid": 0,\n "lac": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "bcch": 0,\n "bsic": 0,\n "cid": 0,\n "lac": 0,\n "rxlevel": 0\n }\n ],\n "rxlevel": 0,\n "ta": 0,\n "timestamp": ""\n }\n ],\n "lte": [\n {\n "cid": 0,\n "earfcn": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "cid": 0,\n "earfcn": 0,\n "pci": 0,\n "rsrp": 0,\n "rsrq": ""\n }\n ],\n "pci": 0,\n "rsrp": 0,\n "rsrq": "",\n "ta": 0,\n "tac": 0,\n "timestamp": ""\n }\n ],\n "tdscdma": [\n {\n "cellparams": 0,\n "cid": 0,\n "lac": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "cellparams": 0,\n "cid": 0,\n "pathloss": 0,\n "rscp": 0,\n "uarfcn": 0\n }\n ],\n "pathloss": 0,\n "rscp": 0,\n "ta": 0,\n "timestamp": "",\n "uarfcn": 0\n }\n ],\n "wcdma": [\n {\n "cid": 0,\n "lac": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "cid": 0,\n "pathloss": 0,\n "psc": 0,\n "rscp": 0,\n "uarfcndl": 0\n }\n ],\n "pathloss": 0,\n "psc": 0,\n "rscp": 0,\n "timestamp": "",\n "uarfcndl": 0\n }\n ],\n "wlan": [\n {\n "band": "",\n "mac": "",\n "powrx": 0,\n "timestamp": ""\n }\n ]\n },\n "system": {\n "client": {\n "accelerometerSensorRange": [],\n "diagnosticscode": "",\n "diskquota": "",\n "firmware": "",\n "hasAccelerometerSensor": false,\n "hasAttachSensor": false,\n "hasHumiditySensor": false,\n "hasNoBattery": false,\n "hasPressureSensor": false,\n "hasTamperSensor": false,\n "hasTemperatureSensor": false,\n "homenetwork": [\n {\n "mcc": 0,\n "mnc": 0,\n "nid": 0,\n "sid": 0\n }\n ],\n "manufacturer": "",\n "model": "",\n "modules": [\n {\n "firmwareVersion": "",\n "manufacturer": "",\n "model": ""\n }\n ],\n "name": "",\n "platform": "",\n "version": ""\n },\n "iccid": "",\n "imsi": "",\n "mode": "",\n "phoneNumber": "",\n "reportedSensorData": {\n "accelerationG": "",\n "batteryIsCharging": false,\n "batteryLevel": 0,\n "deviceIsAttached": false,\n "deviceIsStationary": false,\n "deviceIsTampered": false,\n "pressureHpa": "",\n "relativeHumidity": "",\n "temperatureC": "",\n "tiltDegree": ""\n },\n "stateVersion": 0\n },\n "timestamp": 0\n }\n]' \
--output-document \
- {{baseUrl}}/v2/
import Foundation
let headers = [
"authorization": "",
"content-type": "application/json"
]
let parameters = [
[
"payload": [],
"position": [
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": [
"id": "",
"level": "",
"name": ""
],
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
],
"scan": [
"bt": [
[
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
]
],
"cdma": [
[
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
[
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
]
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
]
],
"country": ["mcc": 0],
"gps": [
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
],
"gsm": [
[
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
[
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
]
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
]
],
"lte": [
[
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
[
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
]
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
]
],
"tdscdma": [
[
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
[
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
]
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
]
],
"wcdma": [
[
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
[
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
]
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
]
],
"wlan": [
[
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
]
]
],
"system": [
"client": [
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
[
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
]
],
"manufacturer": "",
"model": "",
"modules": [
[
"firmwareVersion": "",
"manufacturer": "",
"model": ""
]
],
"name": "",
"platform": "",
"version": ""
],
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": [
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
],
"stateVersion": 0
],
"timestamp": 0
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/v2/")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 413,
"details": {
"hereErrorCode": 413306
},
"error": "Payload Too Large",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request size exceeds the maximum size limit for payloads."
}
POST
Ingests data for a device and receives a shadow
{{baseUrl}}/v3/
HEADERS
authorization
BODY json
{
"appId": "",
"data": [
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": {
"mcc": 0
},
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
],
"id": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/v3/");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "authorization: ");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/v3/" {:headers {:authorization ""}
:content-type :json
:form-params {:appId ""
:data [{:payload {}
:position {:accuracy ""
:alt ""
:altaccuracy ""
:confidence 0
:floor {:id ""
:level ""
:name ""}
:heading 0
:lat ""
:lng ""
:satellitecount 0
:speed 0
:timestamp 0
:type ""
:wlancount 0}
:scan {:bt [{:eddystoneId ""
:iBeaconId ""
:mac ""
:rss 0
:timestamp ""}]
:cdma [{:baselat ""
:baselng ""
:bsid 0
:channel 0
:nid 0
:nmr [{:bsid 0
:channel 0
:frequency 0
:pilotpower 0
:pnoffset 0}]
:pilotpower 0
:pnoffset 0
:rz 0
:sid 0
:timestamp ""}]
:country {:mcc 0}
:gps {:accuracy ""
:alt ""
:altaccuracy ""
:heading 0
:lat ""
:lng ""
:satellitecount 0
:speed 0
:timestamp 0}
:gsm [{:bcch 0
:bsic 0
:cid 0
:lac 0
:mcc 0
:mnc 0
:nmr [{:bcch 0
:bsic 0
:cid 0
:lac 0
:rxlevel 0}]
:rxlevel 0
:ta 0
:timestamp ""}]
:lte [{:cid 0
:earfcn 0
:mcc 0
:mnc 0
:nmr [{:cid 0
:earfcn 0
:pci 0
:rsrp 0
:rsrq ""}]
:pci 0
:rsrp 0
:rsrq ""
:ta 0
:tac 0
:timestamp ""}]
:tdscdma [{:cellparams 0
:cid 0
:lac 0
:mcc 0
:mnc 0
:nmr [{:cellparams 0
:cid 0
:pathloss 0
:rscp 0
:uarfcn 0}]
:pathloss 0
:rscp 0
:ta 0
:timestamp ""
:uarfcn 0}]
:wcdma [{:cid 0
:lac 0
:mcc 0
:mnc 0
:nmr [{:cid 0
:pathloss 0
:psc 0
:rscp 0
:uarfcndl 0}]
:pathloss 0
:psc 0
:rscp 0
:timestamp ""
:uarfcndl 0}]
:wlan [{:band ""
:mac ""
:powrx 0
:timestamp ""}]}
:system {:client {:accelerometerSensorRange []
:diagnosticscode ""
:diskquota ""
:firmware ""
:hasAccelerometerSensor false
:hasAttachSensor false
:hasHumiditySensor false
:hasNoBattery false
:hasPressureSensor false
:hasTamperSensor false
:hasTemperatureSensor false
:homenetwork [{:mcc 0
:mnc 0
:nid 0
:sid 0}]
:manufacturer ""
:model ""
:modules [{:firmwareVersion ""
:manufacturer ""
:model ""}]
:name ""
:platform ""
:version ""}
:iccid ""
:imsi ""
:mode ""
:phoneNumber ""
:reportedSensorData {:accelerationG ""
:batteryIsCharging false
:batteryLevel 0
:deviceIsAttached false
:deviceIsStationary false
:deviceIsTampered false
:pressureHpa ""
:relativeHumidity ""
:temperatureC ""
:tiltDegree ""}
:stateVersion 0}
:timestamp 0}]
:id ""}})
require "http/client"
url = "{{baseUrl}}/v3/"
headers = HTTP::Headers{
"authorization" => ""
"content-type" => "application/json"
}
reqBody = "{\n \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/v3/"),
Headers =
{
{ "authorization", "" },
},
Content = new StringContent("{\n \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\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}}/v3/");
var request = new RestRequest("", Method.Post);
request.AddHeader("authorization", "");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/v3/"
payload := strings.NewReader("{\n \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "")
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/v3/ HTTP/1.1
Authorization:
Content-Type: application/json
Host: example.com
Content-Length: 5003
{
"appId": "",
"data": [
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": {
"mcc": 0
},
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
],
"id": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/v3/")
.setHeader("authorization", "")
.setHeader("content-type", "application/json")
.setBody("{\n \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/v3/"))
.header("authorization", "")
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\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 \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/v3/")
.post(body)
.addHeader("authorization", "")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/v3/")
.header("authorization", "")
.header("content-type", "application/json")
.body("{\n \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\n}")
.asString();
const data = JSON.stringify({
appId: '',
data: [
{
payload: {},
position: {
accuracy: '',
alt: '',
altaccuracy: '',
confidence: 0,
floor: {
id: '',
level: '',
name: ''
},
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0,
type: '',
wlancount: 0
},
scan: {
bt: [
{
eddystoneId: '',
iBeaconId: '',
mac: '',
rss: 0,
timestamp: ''
}
],
cdma: [
{
baselat: '',
baselng: '',
bsid: 0,
channel: 0,
nid: 0,
nmr: [
{
bsid: 0,
channel: 0,
frequency: 0,
pilotpower: 0,
pnoffset: 0
}
],
pilotpower: 0,
pnoffset: 0,
rz: 0,
sid: 0,
timestamp: ''
}
],
country: {
mcc: 0
},
gps: {
accuracy: '',
alt: '',
altaccuracy: '',
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0
},
gsm: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
rxlevel: 0
}
],
rxlevel: 0,
ta: 0,
timestamp: ''
}
],
lte: [
{
cid: 0,
earfcn: 0,
mcc: 0,
mnc: 0,
nmr: [
{
cid: 0,
earfcn: 0,
pci: 0,
rsrp: 0,
rsrq: ''
}
],
pci: 0,
rsrp: 0,
rsrq: '',
ta: 0,
tac: 0,
timestamp: ''
}
],
tdscdma: [
{
cellparams: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [
{
cellparams: 0,
cid: 0,
pathloss: 0,
rscp: 0,
uarfcn: 0
}
],
pathloss: 0,
rscp: 0,
ta: 0,
timestamp: '',
uarfcn: 0
}
],
wcdma: [
{
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [
{
cid: 0,
pathloss: 0,
psc: 0,
rscp: 0,
uarfcndl: 0
}
],
pathloss: 0,
psc: 0,
rscp: 0,
timestamp: '',
uarfcndl: 0
}
],
wlan: [
{
band: '',
mac: '',
powrx: 0,
timestamp: ''
}
]
},
system: {
client: {
accelerometerSensorRange: [],
diagnosticscode: '',
diskquota: '',
firmware: '',
hasAccelerometerSensor: false,
hasAttachSensor: false,
hasHumiditySensor: false,
hasNoBattery: false,
hasPressureSensor: false,
hasTamperSensor: false,
hasTemperatureSensor: false,
homenetwork: [
{
mcc: 0,
mnc: 0,
nid: 0,
sid: 0
}
],
manufacturer: '',
model: '',
modules: [
{
firmwareVersion: '',
manufacturer: '',
model: ''
}
],
name: '',
platform: '',
version: ''
},
iccid: '',
imsi: '',
mode: '',
phoneNumber: '',
reportedSensorData: {
accelerationG: '',
batteryIsCharging: false,
batteryLevel: 0,
deviceIsAttached: false,
deviceIsStationary: false,
deviceIsTampered: false,
pressureHpa: '',
relativeHumidity: '',
temperatureC: '',
tiltDegree: ''
},
stateVersion: 0
},
timestamp: 0
}
],
id: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/v3/');
xhr.setRequestHeader('authorization', '');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/v3/',
headers: {authorization: '', 'content-type': 'application/json'},
data: {
appId: '',
data: [
{
payload: {},
position: {
accuracy: '',
alt: '',
altaccuracy: '',
confidence: 0,
floor: {id: '', level: '', name: ''},
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0,
type: '',
wlancount: 0
},
scan: {
bt: [{eddystoneId: '', iBeaconId: '', mac: '', rss: 0, timestamp: ''}],
cdma: [
{
baselat: '',
baselng: '',
bsid: 0,
channel: 0,
nid: 0,
nmr: [{bsid: 0, channel: 0, frequency: 0, pilotpower: 0, pnoffset: 0}],
pilotpower: 0,
pnoffset: 0,
rz: 0,
sid: 0,
timestamp: ''
}
],
country: {mcc: 0},
gps: {
accuracy: '',
alt: '',
altaccuracy: '',
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0
},
gsm: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{bcch: 0, bsic: 0, cid: 0, lac: 0, rxlevel: 0}],
rxlevel: 0,
ta: 0,
timestamp: ''
}
],
lte: [
{
cid: 0,
earfcn: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, earfcn: 0, pci: 0, rsrp: 0, rsrq: ''}],
pci: 0,
rsrp: 0,
rsrq: '',
ta: 0,
tac: 0,
timestamp: ''
}
],
tdscdma: [
{
cellparams: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cellparams: 0, cid: 0, pathloss: 0, rscp: 0, uarfcn: 0}],
pathloss: 0,
rscp: 0,
ta: 0,
timestamp: '',
uarfcn: 0
}
],
wcdma: [
{
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, pathloss: 0, psc: 0, rscp: 0, uarfcndl: 0}],
pathloss: 0,
psc: 0,
rscp: 0,
timestamp: '',
uarfcndl: 0
}
],
wlan: [{band: '', mac: '', powrx: 0, timestamp: ''}]
},
system: {
client: {
accelerometerSensorRange: [],
diagnosticscode: '',
diskquota: '',
firmware: '',
hasAccelerometerSensor: false,
hasAttachSensor: false,
hasHumiditySensor: false,
hasNoBattery: false,
hasPressureSensor: false,
hasTamperSensor: false,
hasTemperatureSensor: false,
homenetwork: [{mcc: 0, mnc: 0, nid: 0, sid: 0}],
manufacturer: '',
model: '',
modules: [{firmwareVersion: '', manufacturer: '', model: ''}],
name: '',
platform: '',
version: ''
},
iccid: '',
imsi: '',
mode: '',
phoneNumber: '',
reportedSensorData: {
accelerationG: '',
batteryIsCharging: false,
batteryLevel: 0,
deviceIsAttached: false,
deviceIsStationary: false,
deviceIsTampered: false,
pressureHpa: '',
relativeHumidity: '',
temperatureC: '',
tiltDegree: ''
},
stateVersion: 0
},
timestamp: 0
}
],
id: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/v3/';
const options = {
method: 'POST',
headers: {authorization: '', 'content-type': 'application/json'},
body: '{"appId":"","data":[{"payload":{},"position":{"accuracy":"","alt":"","altaccuracy":"","confidence":0,"floor":{"id":"","level":"","name":""},"heading":0,"lat":"","lng":"","satellitecount":0,"speed":0,"timestamp":0,"type":"","wlancount":0},"scan":{"bt":[{"eddystoneId":"","iBeaconId":"","mac":"","rss":0,"timestamp":""}],"cdma":[{"baselat":"","baselng":"","bsid":0,"channel":0,"nid":0,"nmr":[{"bsid":0,"channel":0,"frequency":0,"pilotpower":0,"pnoffset":0}],"pilotpower":0,"pnoffset":0,"rz":0,"sid":0,"timestamp":""}],"country":{"mcc":0},"gps":{"accuracy":"","alt":"","altaccuracy":"","heading":0,"lat":"","lng":"","satellitecount":0,"speed":0,"timestamp":0},"gsm":[{"bcch":0,"bsic":0,"cid":0,"lac":0,"mcc":0,"mnc":0,"nmr":[{"bcch":0,"bsic":0,"cid":0,"lac":0,"rxlevel":0}],"rxlevel":0,"ta":0,"timestamp":""}],"lte":[{"cid":0,"earfcn":0,"mcc":0,"mnc":0,"nmr":[{"cid":0,"earfcn":0,"pci":0,"rsrp":0,"rsrq":""}],"pci":0,"rsrp":0,"rsrq":"","ta":0,"tac":0,"timestamp":""}],"tdscdma":[{"cellparams":0,"cid":0,"lac":0,"mcc":0,"mnc":0,"nmr":[{"cellparams":0,"cid":0,"pathloss":0,"rscp":0,"uarfcn":0}],"pathloss":0,"rscp":0,"ta":0,"timestamp":"","uarfcn":0}],"wcdma":[{"cid":0,"lac":0,"mcc":0,"mnc":0,"nmr":[{"cid":0,"pathloss":0,"psc":0,"rscp":0,"uarfcndl":0}],"pathloss":0,"psc":0,"rscp":0,"timestamp":"","uarfcndl":0}],"wlan":[{"band":"","mac":"","powrx":0,"timestamp":""}]},"system":{"client":{"accelerometerSensorRange":[],"diagnosticscode":"","diskquota":"","firmware":"","hasAccelerometerSensor":false,"hasAttachSensor":false,"hasHumiditySensor":false,"hasNoBattery":false,"hasPressureSensor":false,"hasTamperSensor":false,"hasTemperatureSensor":false,"homenetwork":[{"mcc":0,"mnc":0,"nid":0,"sid":0}],"manufacturer":"","model":"","modules":[{"firmwareVersion":"","manufacturer":"","model":""}],"name":"","platform":"","version":""},"iccid":"","imsi":"","mode":"","phoneNumber":"","reportedSensorData":{"accelerationG":"","batteryIsCharging":false,"batteryLevel":0,"deviceIsAttached":false,"deviceIsStationary":false,"deviceIsTampered":false,"pressureHpa":"","relativeHumidity":"","temperatureC":"","tiltDegree":""},"stateVersion":0},"timestamp":0}],"id":""}'
};
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}}/v3/',
method: 'POST',
headers: {
authorization: '',
'content-type': 'application/json'
},
processData: false,
data: '{\n "appId": "",\n "data": [\n {\n "payload": {},\n "position": {\n "accuracy": "",\n "alt": "",\n "altaccuracy": "",\n "confidence": 0,\n "floor": {\n "id": "",\n "level": "",\n "name": ""\n },\n "heading": 0,\n "lat": "",\n "lng": "",\n "satellitecount": 0,\n "speed": 0,\n "timestamp": 0,\n "type": "",\n "wlancount": 0\n },\n "scan": {\n "bt": [\n {\n "eddystoneId": "",\n "iBeaconId": "",\n "mac": "",\n "rss": 0,\n "timestamp": ""\n }\n ],\n "cdma": [\n {\n "baselat": "",\n "baselng": "",\n "bsid": 0,\n "channel": 0,\n "nid": 0,\n "nmr": [\n {\n "bsid": 0,\n "channel": 0,\n "frequency": 0,\n "pilotpower": 0,\n "pnoffset": 0\n }\n ],\n "pilotpower": 0,\n "pnoffset": 0,\n "rz": 0,\n "sid": 0,\n "timestamp": ""\n }\n ],\n "country": {\n "mcc": 0\n },\n "gps": {\n "accuracy": "",\n "alt": "",\n "altaccuracy": "",\n "heading": 0,\n "lat": "",\n "lng": "",\n "satellitecount": 0,\n "speed": 0,\n "timestamp": 0\n },\n "gsm": [\n {\n "bcch": 0,\n "bsic": 0,\n "cid": 0,\n "lac": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "bcch": 0,\n "bsic": 0,\n "cid": 0,\n "lac": 0,\n "rxlevel": 0\n }\n ],\n "rxlevel": 0,\n "ta": 0,\n "timestamp": ""\n }\n ],\n "lte": [\n {\n "cid": 0,\n "earfcn": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "cid": 0,\n "earfcn": 0,\n "pci": 0,\n "rsrp": 0,\n "rsrq": ""\n }\n ],\n "pci": 0,\n "rsrp": 0,\n "rsrq": "",\n "ta": 0,\n "tac": 0,\n "timestamp": ""\n }\n ],\n "tdscdma": [\n {\n "cellparams": 0,\n "cid": 0,\n "lac": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "cellparams": 0,\n "cid": 0,\n "pathloss": 0,\n "rscp": 0,\n "uarfcn": 0\n }\n ],\n "pathloss": 0,\n "rscp": 0,\n "ta": 0,\n "timestamp": "",\n "uarfcn": 0\n }\n ],\n "wcdma": [\n {\n "cid": 0,\n "lac": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "cid": 0,\n "pathloss": 0,\n "psc": 0,\n "rscp": 0,\n "uarfcndl": 0\n }\n ],\n "pathloss": 0,\n "psc": 0,\n "rscp": 0,\n "timestamp": "",\n "uarfcndl": 0\n }\n ],\n "wlan": [\n {\n "band": "",\n "mac": "",\n "powrx": 0,\n "timestamp": ""\n }\n ]\n },\n "system": {\n "client": {\n "accelerometerSensorRange": [],\n "diagnosticscode": "",\n "diskquota": "",\n "firmware": "",\n "hasAccelerometerSensor": false,\n "hasAttachSensor": false,\n "hasHumiditySensor": false,\n "hasNoBattery": false,\n "hasPressureSensor": false,\n "hasTamperSensor": false,\n "hasTemperatureSensor": false,\n "homenetwork": [\n {\n "mcc": 0,\n "mnc": 0,\n "nid": 0,\n "sid": 0\n }\n ],\n "manufacturer": "",\n "model": "",\n "modules": [\n {\n "firmwareVersion": "",\n "manufacturer": "",\n "model": ""\n }\n ],\n "name": "",\n "platform": "",\n "version": ""\n },\n "iccid": "",\n "imsi": "",\n "mode": "",\n "phoneNumber": "",\n "reportedSensorData": {\n "accelerationG": "",\n "batteryIsCharging": false,\n "batteryLevel": 0,\n "deviceIsAttached": false,\n "deviceIsStationary": false,\n "deviceIsTampered": false,\n "pressureHpa": "",\n "relativeHumidity": "",\n "temperatureC": "",\n "tiltDegree": ""\n },\n "stateVersion": 0\n },\n "timestamp": 0\n }\n ],\n "id": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/v3/")
.post(body)
.addHeader("authorization", "")
.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/v3/',
headers: {
authorization: '',
'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({
appId: '',
data: [
{
payload: {},
position: {
accuracy: '',
alt: '',
altaccuracy: '',
confidence: 0,
floor: {id: '', level: '', name: ''},
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0,
type: '',
wlancount: 0
},
scan: {
bt: [{eddystoneId: '', iBeaconId: '', mac: '', rss: 0, timestamp: ''}],
cdma: [
{
baselat: '',
baselng: '',
bsid: 0,
channel: 0,
nid: 0,
nmr: [{bsid: 0, channel: 0, frequency: 0, pilotpower: 0, pnoffset: 0}],
pilotpower: 0,
pnoffset: 0,
rz: 0,
sid: 0,
timestamp: ''
}
],
country: {mcc: 0},
gps: {
accuracy: '',
alt: '',
altaccuracy: '',
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0
},
gsm: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{bcch: 0, bsic: 0, cid: 0, lac: 0, rxlevel: 0}],
rxlevel: 0,
ta: 0,
timestamp: ''
}
],
lte: [
{
cid: 0,
earfcn: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, earfcn: 0, pci: 0, rsrp: 0, rsrq: ''}],
pci: 0,
rsrp: 0,
rsrq: '',
ta: 0,
tac: 0,
timestamp: ''
}
],
tdscdma: [
{
cellparams: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cellparams: 0, cid: 0, pathloss: 0, rscp: 0, uarfcn: 0}],
pathloss: 0,
rscp: 0,
ta: 0,
timestamp: '',
uarfcn: 0
}
],
wcdma: [
{
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, pathloss: 0, psc: 0, rscp: 0, uarfcndl: 0}],
pathloss: 0,
psc: 0,
rscp: 0,
timestamp: '',
uarfcndl: 0
}
],
wlan: [{band: '', mac: '', powrx: 0, timestamp: ''}]
},
system: {
client: {
accelerometerSensorRange: [],
diagnosticscode: '',
diskquota: '',
firmware: '',
hasAccelerometerSensor: false,
hasAttachSensor: false,
hasHumiditySensor: false,
hasNoBattery: false,
hasPressureSensor: false,
hasTamperSensor: false,
hasTemperatureSensor: false,
homenetwork: [{mcc: 0, mnc: 0, nid: 0, sid: 0}],
manufacturer: '',
model: '',
modules: [{firmwareVersion: '', manufacturer: '', model: ''}],
name: '',
platform: '',
version: ''
},
iccid: '',
imsi: '',
mode: '',
phoneNumber: '',
reportedSensorData: {
accelerationG: '',
batteryIsCharging: false,
batteryLevel: 0,
deviceIsAttached: false,
deviceIsStationary: false,
deviceIsTampered: false,
pressureHpa: '',
relativeHumidity: '',
temperatureC: '',
tiltDegree: ''
},
stateVersion: 0
},
timestamp: 0
}
],
id: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/v3/',
headers: {authorization: '', 'content-type': 'application/json'},
body: {
appId: '',
data: [
{
payload: {},
position: {
accuracy: '',
alt: '',
altaccuracy: '',
confidence: 0,
floor: {id: '', level: '', name: ''},
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0,
type: '',
wlancount: 0
},
scan: {
bt: [{eddystoneId: '', iBeaconId: '', mac: '', rss: 0, timestamp: ''}],
cdma: [
{
baselat: '',
baselng: '',
bsid: 0,
channel: 0,
nid: 0,
nmr: [{bsid: 0, channel: 0, frequency: 0, pilotpower: 0, pnoffset: 0}],
pilotpower: 0,
pnoffset: 0,
rz: 0,
sid: 0,
timestamp: ''
}
],
country: {mcc: 0},
gps: {
accuracy: '',
alt: '',
altaccuracy: '',
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0
},
gsm: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{bcch: 0, bsic: 0, cid: 0, lac: 0, rxlevel: 0}],
rxlevel: 0,
ta: 0,
timestamp: ''
}
],
lte: [
{
cid: 0,
earfcn: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, earfcn: 0, pci: 0, rsrp: 0, rsrq: ''}],
pci: 0,
rsrp: 0,
rsrq: '',
ta: 0,
tac: 0,
timestamp: ''
}
],
tdscdma: [
{
cellparams: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cellparams: 0, cid: 0, pathloss: 0, rscp: 0, uarfcn: 0}],
pathloss: 0,
rscp: 0,
ta: 0,
timestamp: '',
uarfcn: 0
}
],
wcdma: [
{
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, pathloss: 0, psc: 0, rscp: 0, uarfcndl: 0}],
pathloss: 0,
psc: 0,
rscp: 0,
timestamp: '',
uarfcndl: 0
}
],
wlan: [{band: '', mac: '', powrx: 0, timestamp: ''}]
},
system: {
client: {
accelerometerSensorRange: [],
diagnosticscode: '',
diskquota: '',
firmware: '',
hasAccelerometerSensor: false,
hasAttachSensor: false,
hasHumiditySensor: false,
hasNoBattery: false,
hasPressureSensor: false,
hasTamperSensor: false,
hasTemperatureSensor: false,
homenetwork: [{mcc: 0, mnc: 0, nid: 0, sid: 0}],
manufacturer: '',
model: '',
modules: [{firmwareVersion: '', manufacturer: '', model: ''}],
name: '',
platform: '',
version: ''
},
iccid: '',
imsi: '',
mode: '',
phoneNumber: '',
reportedSensorData: {
accelerationG: '',
batteryIsCharging: false,
batteryLevel: 0,
deviceIsAttached: false,
deviceIsStationary: false,
deviceIsTampered: false,
pressureHpa: '',
relativeHumidity: '',
temperatureC: '',
tiltDegree: ''
},
stateVersion: 0
},
timestamp: 0
}
],
id: ''
},
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}}/v3/');
req.headers({
authorization: '',
'content-type': 'application/json'
});
req.type('json');
req.send({
appId: '',
data: [
{
payload: {},
position: {
accuracy: '',
alt: '',
altaccuracy: '',
confidence: 0,
floor: {
id: '',
level: '',
name: ''
},
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0,
type: '',
wlancount: 0
},
scan: {
bt: [
{
eddystoneId: '',
iBeaconId: '',
mac: '',
rss: 0,
timestamp: ''
}
],
cdma: [
{
baselat: '',
baselng: '',
bsid: 0,
channel: 0,
nid: 0,
nmr: [
{
bsid: 0,
channel: 0,
frequency: 0,
pilotpower: 0,
pnoffset: 0
}
],
pilotpower: 0,
pnoffset: 0,
rz: 0,
sid: 0,
timestamp: ''
}
],
country: {
mcc: 0
},
gps: {
accuracy: '',
alt: '',
altaccuracy: '',
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0
},
gsm: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
rxlevel: 0
}
],
rxlevel: 0,
ta: 0,
timestamp: ''
}
],
lte: [
{
cid: 0,
earfcn: 0,
mcc: 0,
mnc: 0,
nmr: [
{
cid: 0,
earfcn: 0,
pci: 0,
rsrp: 0,
rsrq: ''
}
],
pci: 0,
rsrp: 0,
rsrq: '',
ta: 0,
tac: 0,
timestamp: ''
}
],
tdscdma: [
{
cellparams: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [
{
cellparams: 0,
cid: 0,
pathloss: 0,
rscp: 0,
uarfcn: 0
}
],
pathloss: 0,
rscp: 0,
ta: 0,
timestamp: '',
uarfcn: 0
}
],
wcdma: [
{
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [
{
cid: 0,
pathloss: 0,
psc: 0,
rscp: 0,
uarfcndl: 0
}
],
pathloss: 0,
psc: 0,
rscp: 0,
timestamp: '',
uarfcndl: 0
}
],
wlan: [
{
band: '',
mac: '',
powrx: 0,
timestamp: ''
}
]
},
system: {
client: {
accelerometerSensorRange: [],
diagnosticscode: '',
diskquota: '',
firmware: '',
hasAccelerometerSensor: false,
hasAttachSensor: false,
hasHumiditySensor: false,
hasNoBattery: false,
hasPressureSensor: false,
hasTamperSensor: false,
hasTemperatureSensor: false,
homenetwork: [
{
mcc: 0,
mnc: 0,
nid: 0,
sid: 0
}
],
manufacturer: '',
model: '',
modules: [
{
firmwareVersion: '',
manufacturer: '',
model: ''
}
],
name: '',
platform: '',
version: ''
},
iccid: '',
imsi: '',
mode: '',
phoneNumber: '',
reportedSensorData: {
accelerationG: '',
batteryIsCharging: false,
batteryLevel: 0,
deviceIsAttached: false,
deviceIsStationary: false,
deviceIsTampered: false,
pressureHpa: '',
relativeHumidity: '',
temperatureC: '',
tiltDegree: ''
},
stateVersion: 0
},
timestamp: 0
}
],
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: 'POST',
url: '{{baseUrl}}/v3/',
headers: {authorization: '', 'content-type': 'application/json'},
data: {
appId: '',
data: [
{
payload: {},
position: {
accuracy: '',
alt: '',
altaccuracy: '',
confidence: 0,
floor: {id: '', level: '', name: ''},
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0,
type: '',
wlancount: 0
},
scan: {
bt: [{eddystoneId: '', iBeaconId: '', mac: '', rss: 0, timestamp: ''}],
cdma: [
{
baselat: '',
baselng: '',
bsid: 0,
channel: 0,
nid: 0,
nmr: [{bsid: 0, channel: 0, frequency: 0, pilotpower: 0, pnoffset: 0}],
pilotpower: 0,
pnoffset: 0,
rz: 0,
sid: 0,
timestamp: ''
}
],
country: {mcc: 0},
gps: {
accuracy: '',
alt: '',
altaccuracy: '',
heading: 0,
lat: '',
lng: '',
satellitecount: 0,
speed: 0,
timestamp: 0
},
gsm: [
{
bcch: 0,
bsic: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{bcch: 0, bsic: 0, cid: 0, lac: 0, rxlevel: 0}],
rxlevel: 0,
ta: 0,
timestamp: ''
}
],
lte: [
{
cid: 0,
earfcn: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, earfcn: 0, pci: 0, rsrp: 0, rsrq: ''}],
pci: 0,
rsrp: 0,
rsrq: '',
ta: 0,
tac: 0,
timestamp: ''
}
],
tdscdma: [
{
cellparams: 0,
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cellparams: 0, cid: 0, pathloss: 0, rscp: 0, uarfcn: 0}],
pathloss: 0,
rscp: 0,
ta: 0,
timestamp: '',
uarfcn: 0
}
],
wcdma: [
{
cid: 0,
lac: 0,
mcc: 0,
mnc: 0,
nmr: [{cid: 0, pathloss: 0, psc: 0, rscp: 0, uarfcndl: 0}],
pathloss: 0,
psc: 0,
rscp: 0,
timestamp: '',
uarfcndl: 0
}
],
wlan: [{band: '', mac: '', powrx: 0, timestamp: ''}]
},
system: {
client: {
accelerometerSensorRange: [],
diagnosticscode: '',
diskquota: '',
firmware: '',
hasAccelerometerSensor: false,
hasAttachSensor: false,
hasHumiditySensor: false,
hasNoBattery: false,
hasPressureSensor: false,
hasTamperSensor: false,
hasTemperatureSensor: false,
homenetwork: [{mcc: 0, mnc: 0, nid: 0, sid: 0}],
manufacturer: '',
model: '',
modules: [{firmwareVersion: '', manufacturer: '', model: ''}],
name: '',
platform: '',
version: ''
},
iccid: '',
imsi: '',
mode: '',
phoneNumber: '',
reportedSensorData: {
accelerationG: '',
batteryIsCharging: false,
batteryLevel: 0,
deviceIsAttached: false,
deviceIsStationary: false,
deviceIsTampered: false,
pressureHpa: '',
relativeHumidity: '',
temperatureC: '',
tiltDegree: ''
},
stateVersion: 0
},
timestamp: 0
}
],
id: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/v3/';
const options = {
method: 'POST',
headers: {authorization: '', 'content-type': 'application/json'},
body: '{"appId":"","data":[{"payload":{},"position":{"accuracy":"","alt":"","altaccuracy":"","confidence":0,"floor":{"id":"","level":"","name":""},"heading":0,"lat":"","lng":"","satellitecount":0,"speed":0,"timestamp":0,"type":"","wlancount":0},"scan":{"bt":[{"eddystoneId":"","iBeaconId":"","mac":"","rss":0,"timestamp":""}],"cdma":[{"baselat":"","baselng":"","bsid":0,"channel":0,"nid":0,"nmr":[{"bsid":0,"channel":0,"frequency":0,"pilotpower":0,"pnoffset":0}],"pilotpower":0,"pnoffset":0,"rz":0,"sid":0,"timestamp":""}],"country":{"mcc":0},"gps":{"accuracy":"","alt":"","altaccuracy":"","heading":0,"lat":"","lng":"","satellitecount":0,"speed":0,"timestamp":0},"gsm":[{"bcch":0,"bsic":0,"cid":0,"lac":0,"mcc":0,"mnc":0,"nmr":[{"bcch":0,"bsic":0,"cid":0,"lac":0,"rxlevel":0}],"rxlevel":0,"ta":0,"timestamp":""}],"lte":[{"cid":0,"earfcn":0,"mcc":0,"mnc":0,"nmr":[{"cid":0,"earfcn":0,"pci":0,"rsrp":0,"rsrq":""}],"pci":0,"rsrp":0,"rsrq":"","ta":0,"tac":0,"timestamp":""}],"tdscdma":[{"cellparams":0,"cid":0,"lac":0,"mcc":0,"mnc":0,"nmr":[{"cellparams":0,"cid":0,"pathloss":0,"rscp":0,"uarfcn":0}],"pathloss":0,"rscp":0,"ta":0,"timestamp":"","uarfcn":0}],"wcdma":[{"cid":0,"lac":0,"mcc":0,"mnc":0,"nmr":[{"cid":0,"pathloss":0,"psc":0,"rscp":0,"uarfcndl":0}],"pathloss":0,"psc":0,"rscp":0,"timestamp":"","uarfcndl":0}],"wlan":[{"band":"","mac":"","powrx":0,"timestamp":""}]},"system":{"client":{"accelerometerSensorRange":[],"diagnosticscode":"","diskquota":"","firmware":"","hasAccelerometerSensor":false,"hasAttachSensor":false,"hasHumiditySensor":false,"hasNoBattery":false,"hasPressureSensor":false,"hasTamperSensor":false,"hasTemperatureSensor":false,"homenetwork":[{"mcc":0,"mnc":0,"nid":0,"sid":0}],"manufacturer":"","model":"","modules":[{"firmwareVersion":"","manufacturer":"","model":""}],"name":"","platform":"","version":""},"iccid":"","imsi":"","mode":"","phoneNumber":"","reportedSensorData":{"accelerationG":"","batteryIsCharging":false,"batteryLevel":0,"deviceIsAttached":false,"deviceIsStationary":false,"deviceIsTampered":false,"pressureHpa":"","relativeHumidity":"","temperatureC":"","tiltDegree":""},"stateVersion":0},"timestamp":0}],"id":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"authorization": @"",
@"content-type": @"application/json" };
NSDictionary *parameters = @{ @"appId": @"",
@"data": @[ @{ @"payload": @{ }, @"position": @{ @"accuracy": @"", @"alt": @"", @"altaccuracy": @"", @"confidence": @0, @"floor": @{ @"id": @"", @"level": @"", @"name": @"" }, @"heading": @0, @"lat": @"", @"lng": @"", @"satellitecount": @0, @"speed": @0, @"timestamp": @0, @"type": @"", @"wlancount": @0 }, @"scan": @{ @"bt": @[ @{ @"eddystoneId": @"", @"iBeaconId": @"", @"mac": @"", @"rss": @0, @"timestamp": @"" } ], @"cdma": @[ @{ @"baselat": @"", @"baselng": @"", @"bsid": @0, @"channel": @0, @"nid": @0, @"nmr": @[ @{ @"bsid": @0, @"channel": @0, @"frequency": @0, @"pilotpower": @0, @"pnoffset": @0 } ], @"pilotpower": @0, @"pnoffset": @0, @"rz": @0, @"sid": @0, @"timestamp": @"" } ], @"country": @{ @"mcc": @0 }, @"gps": @{ @"accuracy": @"", @"alt": @"", @"altaccuracy": @"", @"heading": @0, @"lat": @"", @"lng": @"", @"satellitecount": @0, @"speed": @0, @"timestamp": @0 }, @"gsm": @[ @{ @"bcch": @0, @"bsic": @0, @"cid": @0, @"lac": @0, @"mcc": @0, @"mnc": @0, @"nmr": @[ @{ @"bcch": @0, @"bsic": @0, @"cid": @0, @"lac": @0, @"rxlevel": @0 } ], @"rxlevel": @0, @"ta": @0, @"timestamp": @"" } ], @"lte": @[ @{ @"cid": @0, @"earfcn": @0, @"mcc": @0, @"mnc": @0, @"nmr": @[ @{ @"cid": @0, @"earfcn": @0, @"pci": @0, @"rsrp": @0, @"rsrq": @"" } ], @"pci": @0, @"rsrp": @0, @"rsrq": @"", @"ta": @0, @"tac": @0, @"timestamp": @"" } ], @"tdscdma": @[ @{ @"cellparams": @0, @"cid": @0, @"lac": @0, @"mcc": @0, @"mnc": @0, @"nmr": @[ @{ @"cellparams": @0, @"cid": @0, @"pathloss": @0, @"rscp": @0, @"uarfcn": @0 } ], @"pathloss": @0, @"rscp": @0, @"ta": @0, @"timestamp": @"", @"uarfcn": @0 } ], @"wcdma": @[ @{ @"cid": @0, @"lac": @0, @"mcc": @0, @"mnc": @0, @"nmr": @[ @{ @"cid": @0, @"pathloss": @0, @"psc": @0, @"rscp": @0, @"uarfcndl": @0 } ], @"pathloss": @0, @"psc": @0, @"rscp": @0, @"timestamp": @"", @"uarfcndl": @0 } ], @"wlan": @[ @{ @"band": @"", @"mac": @"", @"powrx": @0, @"timestamp": @"" } ] }, @"system": @{ @"client": @{ @"accelerometerSensorRange": @[ ], @"diagnosticscode": @"", @"diskquota": @"", @"firmware": @"", @"hasAccelerometerSensor": @NO, @"hasAttachSensor": @NO, @"hasHumiditySensor": @NO, @"hasNoBattery": @NO, @"hasPressureSensor": @NO, @"hasTamperSensor": @NO, @"hasTemperatureSensor": @NO, @"homenetwork": @[ @{ @"mcc": @0, @"mnc": @0, @"nid": @0, @"sid": @0 } ], @"manufacturer": @"", @"model": @"", @"modules": @[ @{ @"firmwareVersion": @"", @"manufacturer": @"", @"model": @"" } ], @"name": @"", @"platform": @"", @"version": @"" }, @"iccid": @"", @"imsi": @"", @"mode": @"", @"phoneNumber": @"", @"reportedSensorData": @{ @"accelerationG": @"", @"batteryIsCharging": @NO, @"batteryLevel": @0, @"deviceIsAttached": @NO, @"deviceIsStationary": @NO, @"deviceIsTampered": @NO, @"pressureHpa": @"", @"relativeHumidity": @"", @"temperatureC": @"", @"tiltDegree": @"" }, @"stateVersion": @0 }, @"timestamp": @0 } ],
@"id": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/v3/"]
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}}/v3/" in
let headers = Header.add_list (Header.init ()) [
("authorization", "");
("content-type", "application/json");
] in
let body = Cohttp_lwt_body.of_string "{\n \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/v3/",
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([
'appId' => '',
'data' => [
[
'payload' => [
],
'position' => [
'accuracy' => '',
'alt' => '',
'altaccuracy' => '',
'confidence' => 0,
'floor' => [
'id' => '',
'level' => '',
'name' => ''
],
'heading' => 0,
'lat' => '',
'lng' => '',
'satellitecount' => 0,
'speed' => 0,
'timestamp' => 0,
'type' => '',
'wlancount' => 0
],
'scan' => [
'bt' => [
[
'eddystoneId' => '',
'iBeaconId' => '',
'mac' => '',
'rss' => 0,
'timestamp' => ''
]
],
'cdma' => [
[
'baselat' => '',
'baselng' => '',
'bsid' => 0,
'channel' => 0,
'nid' => 0,
'nmr' => [
[
'bsid' => 0,
'channel' => 0,
'frequency' => 0,
'pilotpower' => 0,
'pnoffset' => 0
]
],
'pilotpower' => 0,
'pnoffset' => 0,
'rz' => 0,
'sid' => 0,
'timestamp' => ''
]
],
'country' => [
'mcc' => 0
],
'gps' => [
'accuracy' => '',
'alt' => '',
'altaccuracy' => '',
'heading' => 0,
'lat' => '',
'lng' => '',
'satellitecount' => 0,
'speed' => 0,
'timestamp' => 0
],
'gsm' => [
[
'bcch' => 0,
'bsic' => 0,
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'bcch' => 0,
'bsic' => 0,
'cid' => 0,
'lac' => 0,
'rxlevel' => 0
]
],
'rxlevel' => 0,
'ta' => 0,
'timestamp' => ''
]
],
'lte' => [
[
'cid' => 0,
'earfcn' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cid' => 0,
'earfcn' => 0,
'pci' => 0,
'rsrp' => 0,
'rsrq' => ''
]
],
'pci' => 0,
'rsrp' => 0,
'rsrq' => '',
'ta' => 0,
'tac' => 0,
'timestamp' => ''
]
],
'tdscdma' => [
[
'cellparams' => 0,
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cellparams' => 0,
'cid' => 0,
'pathloss' => 0,
'rscp' => 0,
'uarfcn' => 0
]
],
'pathloss' => 0,
'rscp' => 0,
'ta' => 0,
'timestamp' => '',
'uarfcn' => 0
]
],
'wcdma' => [
[
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cid' => 0,
'pathloss' => 0,
'psc' => 0,
'rscp' => 0,
'uarfcndl' => 0
]
],
'pathloss' => 0,
'psc' => 0,
'rscp' => 0,
'timestamp' => '',
'uarfcndl' => 0
]
],
'wlan' => [
[
'band' => '',
'mac' => '',
'powrx' => 0,
'timestamp' => ''
]
]
],
'system' => [
'client' => [
'accelerometerSensorRange' => [
],
'diagnosticscode' => '',
'diskquota' => '',
'firmware' => '',
'hasAccelerometerSensor' => null,
'hasAttachSensor' => null,
'hasHumiditySensor' => null,
'hasNoBattery' => null,
'hasPressureSensor' => null,
'hasTamperSensor' => null,
'hasTemperatureSensor' => null,
'homenetwork' => [
[
'mcc' => 0,
'mnc' => 0,
'nid' => 0,
'sid' => 0
]
],
'manufacturer' => '',
'model' => '',
'modules' => [
[
'firmwareVersion' => '',
'manufacturer' => '',
'model' => ''
]
],
'name' => '',
'platform' => '',
'version' => ''
],
'iccid' => '',
'imsi' => '',
'mode' => '',
'phoneNumber' => '',
'reportedSensorData' => [
'accelerationG' => '',
'batteryIsCharging' => null,
'batteryLevel' => 0,
'deviceIsAttached' => null,
'deviceIsStationary' => null,
'deviceIsTampered' => null,
'pressureHpa' => '',
'relativeHumidity' => '',
'temperatureC' => '',
'tiltDegree' => ''
],
'stateVersion' => 0
],
'timestamp' => 0
]
],
'id' => ''
]),
CURLOPT_HTTPHEADER => [
"authorization: ",
"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}}/v3/', [
'body' => '{
"appId": "",
"data": [
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": {
"mcc": 0
},
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
],
"id": ""
}',
'headers' => [
'authorization' => '',
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/v3/');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'authorization' => '',
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'appId' => '',
'data' => [
[
'payload' => [
],
'position' => [
'accuracy' => '',
'alt' => '',
'altaccuracy' => '',
'confidence' => 0,
'floor' => [
'id' => '',
'level' => '',
'name' => ''
],
'heading' => 0,
'lat' => '',
'lng' => '',
'satellitecount' => 0,
'speed' => 0,
'timestamp' => 0,
'type' => '',
'wlancount' => 0
],
'scan' => [
'bt' => [
[
'eddystoneId' => '',
'iBeaconId' => '',
'mac' => '',
'rss' => 0,
'timestamp' => ''
]
],
'cdma' => [
[
'baselat' => '',
'baselng' => '',
'bsid' => 0,
'channel' => 0,
'nid' => 0,
'nmr' => [
[
'bsid' => 0,
'channel' => 0,
'frequency' => 0,
'pilotpower' => 0,
'pnoffset' => 0
]
],
'pilotpower' => 0,
'pnoffset' => 0,
'rz' => 0,
'sid' => 0,
'timestamp' => ''
]
],
'country' => [
'mcc' => 0
],
'gps' => [
'accuracy' => '',
'alt' => '',
'altaccuracy' => '',
'heading' => 0,
'lat' => '',
'lng' => '',
'satellitecount' => 0,
'speed' => 0,
'timestamp' => 0
],
'gsm' => [
[
'bcch' => 0,
'bsic' => 0,
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'bcch' => 0,
'bsic' => 0,
'cid' => 0,
'lac' => 0,
'rxlevel' => 0
]
],
'rxlevel' => 0,
'ta' => 0,
'timestamp' => ''
]
],
'lte' => [
[
'cid' => 0,
'earfcn' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cid' => 0,
'earfcn' => 0,
'pci' => 0,
'rsrp' => 0,
'rsrq' => ''
]
],
'pci' => 0,
'rsrp' => 0,
'rsrq' => '',
'ta' => 0,
'tac' => 0,
'timestamp' => ''
]
],
'tdscdma' => [
[
'cellparams' => 0,
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cellparams' => 0,
'cid' => 0,
'pathloss' => 0,
'rscp' => 0,
'uarfcn' => 0
]
],
'pathloss' => 0,
'rscp' => 0,
'ta' => 0,
'timestamp' => '',
'uarfcn' => 0
]
],
'wcdma' => [
[
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cid' => 0,
'pathloss' => 0,
'psc' => 0,
'rscp' => 0,
'uarfcndl' => 0
]
],
'pathloss' => 0,
'psc' => 0,
'rscp' => 0,
'timestamp' => '',
'uarfcndl' => 0
]
],
'wlan' => [
[
'band' => '',
'mac' => '',
'powrx' => 0,
'timestamp' => ''
]
]
],
'system' => [
'client' => [
'accelerometerSensorRange' => [
],
'diagnosticscode' => '',
'diskquota' => '',
'firmware' => '',
'hasAccelerometerSensor' => null,
'hasAttachSensor' => null,
'hasHumiditySensor' => null,
'hasNoBattery' => null,
'hasPressureSensor' => null,
'hasTamperSensor' => null,
'hasTemperatureSensor' => null,
'homenetwork' => [
[
'mcc' => 0,
'mnc' => 0,
'nid' => 0,
'sid' => 0
]
],
'manufacturer' => '',
'model' => '',
'modules' => [
[
'firmwareVersion' => '',
'manufacturer' => '',
'model' => ''
]
],
'name' => '',
'platform' => '',
'version' => ''
],
'iccid' => '',
'imsi' => '',
'mode' => '',
'phoneNumber' => '',
'reportedSensorData' => [
'accelerationG' => '',
'batteryIsCharging' => null,
'batteryLevel' => 0,
'deviceIsAttached' => null,
'deviceIsStationary' => null,
'deviceIsTampered' => null,
'pressureHpa' => '',
'relativeHumidity' => '',
'temperatureC' => '',
'tiltDegree' => ''
],
'stateVersion' => 0
],
'timestamp' => 0
]
],
'id' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'appId' => '',
'data' => [
[
'payload' => [
],
'position' => [
'accuracy' => '',
'alt' => '',
'altaccuracy' => '',
'confidence' => 0,
'floor' => [
'id' => '',
'level' => '',
'name' => ''
],
'heading' => 0,
'lat' => '',
'lng' => '',
'satellitecount' => 0,
'speed' => 0,
'timestamp' => 0,
'type' => '',
'wlancount' => 0
],
'scan' => [
'bt' => [
[
'eddystoneId' => '',
'iBeaconId' => '',
'mac' => '',
'rss' => 0,
'timestamp' => ''
]
],
'cdma' => [
[
'baselat' => '',
'baselng' => '',
'bsid' => 0,
'channel' => 0,
'nid' => 0,
'nmr' => [
[
'bsid' => 0,
'channel' => 0,
'frequency' => 0,
'pilotpower' => 0,
'pnoffset' => 0
]
],
'pilotpower' => 0,
'pnoffset' => 0,
'rz' => 0,
'sid' => 0,
'timestamp' => ''
]
],
'country' => [
'mcc' => 0
],
'gps' => [
'accuracy' => '',
'alt' => '',
'altaccuracy' => '',
'heading' => 0,
'lat' => '',
'lng' => '',
'satellitecount' => 0,
'speed' => 0,
'timestamp' => 0
],
'gsm' => [
[
'bcch' => 0,
'bsic' => 0,
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'bcch' => 0,
'bsic' => 0,
'cid' => 0,
'lac' => 0,
'rxlevel' => 0
]
],
'rxlevel' => 0,
'ta' => 0,
'timestamp' => ''
]
],
'lte' => [
[
'cid' => 0,
'earfcn' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cid' => 0,
'earfcn' => 0,
'pci' => 0,
'rsrp' => 0,
'rsrq' => ''
]
],
'pci' => 0,
'rsrp' => 0,
'rsrq' => '',
'ta' => 0,
'tac' => 0,
'timestamp' => ''
]
],
'tdscdma' => [
[
'cellparams' => 0,
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cellparams' => 0,
'cid' => 0,
'pathloss' => 0,
'rscp' => 0,
'uarfcn' => 0
]
],
'pathloss' => 0,
'rscp' => 0,
'ta' => 0,
'timestamp' => '',
'uarfcn' => 0
]
],
'wcdma' => [
[
'cid' => 0,
'lac' => 0,
'mcc' => 0,
'mnc' => 0,
'nmr' => [
[
'cid' => 0,
'pathloss' => 0,
'psc' => 0,
'rscp' => 0,
'uarfcndl' => 0
]
],
'pathloss' => 0,
'psc' => 0,
'rscp' => 0,
'timestamp' => '',
'uarfcndl' => 0
]
],
'wlan' => [
[
'band' => '',
'mac' => '',
'powrx' => 0,
'timestamp' => ''
]
]
],
'system' => [
'client' => [
'accelerometerSensorRange' => [
],
'diagnosticscode' => '',
'diskquota' => '',
'firmware' => '',
'hasAccelerometerSensor' => null,
'hasAttachSensor' => null,
'hasHumiditySensor' => null,
'hasNoBattery' => null,
'hasPressureSensor' => null,
'hasTamperSensor' => null,
'hasTemperatureSensor' => null,
'homenetwork' => [
[
'mcc' => 0,
'mnc' => 0,
'nid' => 0,
'sid' => 0
]
],
'manufacturer' => '',
'model' => '',
'modules' => [
[
'firmwareVersion' => '',
'manufacturer' => '',
'model' => ''
]
],
'name' => '',
'platform' => '',
'version' => ''
],
'iccid' => '',
'imsi' => '',
'mode' => '',
'phoneNumber' => '',
'reportedSensorData' => [
'accelerationG' => '',
'batteryIsCharging' => null,
'batteryLevel' => 0,
'deviceIsAttached' => null,
'deviceIsStationary' => null,
'deviceIsTampered' => null,
'pressureHpa' => '',
'relativeHumidity' => '',
'temperatureC' => '',
'tiltDegree' => ''
],
'stateVersion' => 0
],
'timestamp' => 0
]
],
'id' => ''
]));
$request->setRequestUrl('{{baseUrl}}/v3/');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'authorization' => '',
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("authorization", "")
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/v3/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"appId": "",
"data": [
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": {
"mcc": 0
},
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
],
"id": ""
}'
$headers=@{}
$headers.Add("authorization", "")
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/v3/' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"appId": "",
"data": [
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": {
"mcc": 0
},
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
],
"id": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\n}"
headers = {
'authorization': "",
'content-type': "application/json"
}
conn.request("POST", "/baseUrl/v3/", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/v3/"
payload = {
"appId": "",
"data": [
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": { "mcc": 0 },
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": False,
"hasAttachSensor": False,
"hasHumiditySensor": False,
"hasNoBattery": False,
"hasPressureSensor": False,
"hasTamperSensor": False,
"hasTemperatureSensor": False,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": False,
"batteryLevel": 0,
"deviceIsAttached": False,
"deviceIsStationary": False,
"deviceIsTampered": False,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
],
"id": ""
}
headers = {
"authorization": "",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/v3/"
payload <- "{\n \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, add_headers('authorization' = ''), content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/v3/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = ''
request["content-type"] = 'application/json'
request.body = "{\n \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/v3/') do |req|
req.headers['authorization'] = ''
req.body = "{\n \"appId\": \"\",\n \"data\": [\n {\n \"payload\": {},\n \"position\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"confidence\": 0,\n \"floor\": {\n \"id\": \"\",\n \"level\": \"\",\n \"name\": \"\"\n },\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0,\n \"type\": \"\",\n \"wlancount\": 0\n },\n \"scan\": {\n \"bt\": [\n {\n \"eddystoneId\": \"\",\n \"iBeaconId\": \"\",\n \"mac\": \"\",\n \"rss\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"cdma\": [\n {\n \"baselat\": \"\",\n \"baselng\": \"\",\n \"bsid\": 0,\n \"channel\": 0,\n \"nid\": 0,\n \"nmr\": [\n {\n \"bsid\": 0,\n \"channel\": 0,\n \"frequency\": 0,\n \"pilotpower\": 0,\n \"pnoffset\": 0\n }\n ],\n \"pilotpower\": 0,\n \"pnoffset\": 0,\n \"rz\": 0,\n \"sid\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"country\": {\n \"mcc\": 0\n },\n \"gps\": {\n \"accuracy\": \"\",\n \"alt\": \"\",\n \"altaccuracy\": \"\",\n \"heading\": 0,\n \"lat\": \"\",\n \"lng\": \"\",\n \"satellitecount\": 0,\n \"speed\": 0,\n \"timestamp\": 0\n },\n \"gsm\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"bcch\": 0,\n \"bsic\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"rxlevel\": 0\n }\n ],\n \"rxlevel\": 0,\n \"ta\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"lte\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"earfcn\": 0,\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\"\n }\n ],\n \"pci\": 0,\n \"rsrp\": 0,\n \"rsrq\": \"\",\n \"ta\": 0,\n \"tac\": 0,\n \"timestamp\": \"\"\n }\n ],\n \"tdscdma\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cellparams\": 0,\n \"cid\": 0,\n \"pathloss\": 0,\n \"rscp\": 0,\n \"uarfcn\": 0\n }\n ],\n \"pathloss\": 0,\n \"rscp\": 0,\n \"ta\": 0,\n \"timestamp\": \"\",\n \"uarfcn\": 0\n }\n ],\n \"wcdma\": [\n {\n \"cid\": 0,\n \"lac\": 0,\n \"mcc\": 0,\n \"mnc\": 0,\n \"nmr\": [\n {\n \"cid\": 0,\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"uarfcndl\": 0\n }\n ],\n \"pathloss\": 0,\n \"psc\": 0,\n \"rscp\": 0,\n \"timestamp\": \"\",\n \"uarfcndl\": 0\n }\n ],\n \"wlan\": [\n {\n \"band\": \"\",\n \"mac\": \"\",\n \"powrx\": 0,\n \"timestamp\": \"\"\n }\n ]\n },\n \"system\": {\n \"client\": {\n \"accelerometerSensorRange\": [],\n \"diagnosticscode\": \"\",\n \"diskquota\": \"\",\n \"firmware\": \"\",\n \"hasAccelerometerSensor\": false,\n \"hasAttachSensor\": false,\n \"hasHumiditySensor\": false,\n \"hasNoBattery\": false,\n \"hasPressureSensor\": false,\n \"hasTamperSensor\": false,\n \"hasTemperatureSensor\": false,\n \"homenetwork\": [\n {\n \"mcc\": 0,\n \"mnc\": 0,\n \"nid\": 0,\n \"sid\": 0\n }\n ],\n \"manufacturer\": \"\",\n \"model\": \"\",\n \"modules\": [\n {\n \"firmwareVersion\": \"\",\n \"manufacturer\": \"\",\n \"model\": \"\"\n }\n ],\n \"name\": \"\",\n \"platform\": \"\",\n \"version\": \"\"\n },\n \"iccid\": \"\",\n \"imsi\": \"\",\n \"mode\": \"\",\n \"phoneNumber\": \"\",\n \"reportedSensorData\": {\n \"accelerationG\": \"\",\n \"batteryIsCharging\": false,\n \"batteryLevel\": 0,\n \"deviceIsAttached\": false,\n \"deviceIsStationary\": false,\n \"deviceIsTampered\": false,\n \"pressureHpa\": \"\",\n \"relativeHumidity\": \"\",\n \"temperatureC\": \"\",\n \"tiltDegree\": \"\"\n },\n \"stateVersion\": 0\n },\n \"timestamp\": 0\n }\n ],\n \"id\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/v3/";
let payload = json!({
"appId": "",
"data": (
json!({
"payload": json!({}),
"position": json!({
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": json!({
"id": "",
"level": "",
"name": ""
}),
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
}),
"scan": json!({
"bt": (
json!({
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
})
),
"cdma": (
json!({
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": (
json!({
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
})
),
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
})
),
"country": json!({"mcc": 0}),
"gps": json!({
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
}),
"gsm": (
json!({
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": (
json!({
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
})
),
"rxlevel": 0,
"ta": 0,
"timestamp": ""
})
),
"lte": (
json!({
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": (
json!({
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
})
),
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
})
),
"tdscdma": (
json!({
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": (
json!({
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
})
),
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
})
),
"wcdma": (
json!({
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": (
json!({
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
})
),
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
})
),
"wlan": (
json!({
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
})
)
}),
"system": json!({
"client": json!({
"accelerometerSensorRange": (),
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": (
json!({
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
})
),
"manufacturer": "",
"model": "",
"modules": (
json!({
"firmwareVersion": "",
"manufacturer": "",
"model": ""
})
),
"name": "",
"platform": "",
"version": ""
}),
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": json!({
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
}),
"stateVersion": 0
}),
"timestamp": 0
})
),
"id": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("authorization", "".parse().unwrap());
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}}/v3/ \
--header 'authorization: ' \
--header 'content-type: application/json' \
--data '{
"appId": "",
"data": [
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": {
"mcc": 0
},
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
],
"id": ""
}'
echo '{
"appId": "",
"data": [
{
"payload": {},
"position": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": {
"id": "",
"level": "",
"name": ""
},
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
},
"scan": {
"bt": [
{
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
}
],
"cdma": [
{
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
{
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
}
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
}
],
"country": {
"mcc": 0
},
"gps": {
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
},
"gsm": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
}
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
}
],
"lte": [
{
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
}
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
}
],
"tdscdma": [
{
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
}
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
}
],
"wcdma": [
{
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
{
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
}
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
}
],
"wlan": [
{
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
}
]
},
"system": {
"client": {
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
{
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
}
],
"manufacturer": "",
"model": "",
"modules": [
{
"firmwareVersion": "",
"manufacturer": "",
"model": ""
}
],
"name": "",
"platform": "",
"version": ""
},
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": {
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
},
"stateVersion": 0
},
"timestamp": 0
}
],
"id": ""
}' | \
http POST {{baseUrl}}/v3/ \
authorization:'' \
content-type:application/json
wget --quiet \
--method POST \
--header 'authorization: ' \
--header 'content-type: application/json' \
--body-data '{\n "appId": "",\n "data": [\n {\n "payload": {},\n "position": {\n "accuracy": "",\n "alt": "",\n "altaccuracy": "",\n "confidence": 0,\n "floor": {\n "id": "",\n "level": "",\n "name": ""\n },\n "heading": 0,\n "lat": "",\n "lng": "",\n "satellitecount": 0,\n "speed": 0,\n "timestamp": 0,\n "type": "",\n "wlancount": 0\n },\n "scan": {\n "bt": [\n {\n "eddystoneId": "",\n "iBeaconId": "",\n "mac": "",\n "rss": 0,\n "timestamp": ""\n }\n ],\n "cdma": [\n {\n "baselat": "",\n "baselng": "",\n "bsid": 0,\n "channel": 0,\n "nid": 0,\n "nmr": [\n {\n "bsid": 0,\n "channel": 0,\n "frequency": 0,\n "pilotpower": 0,\n "pnoffset": 0\n }\n ],\n "pilotpower": 0,\n "pnoffset": 0,\n "rz": 0,\n "sid": 0,\n "timestamp": ""\n }\n ],\n "country": {\n "mcc": 0\n },\n "gps": {\n "accuracy": "",\n "alt": "",\n "altaccuracy": "",\n "heading": 0,\n "lat": "",\n "lng": "",\n "satellitecount": 0,\n "speed": 0,\n "timestamp": 0\n },\n "gsm": [\n {\n "bcch": 0,\n "bsic": 0,\n "cid": 0,\n "lac": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "bcch": 0,\n "bsic": 0,\n "cid": 0,\n "lac": 0,\n "rxlevel": 0\n }\n ],\n "rxlevel": 0,\n "ta": 0,\n "timestamp": ""\n }\n ],\n "lte": [\n {\n "cid": 0,\n "earfcn": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "cid": 0,\n "earfcn": 0,\n "pci": 0,\n "rsrp": 0,\n "rsrq": ""\n }\n ],\n "pci": 0,\n "rsrp": 0,\n "rsrq": "",\n "ta": 0,\n "tac": 0,\n "timestamp": ""\n }\n ],\n "tdscdma": [\n {\n "cellparams": 0,\n "cid": 0,\n "lac": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "cellparams": 0,\n "cid": 0,\n "pathloss": 0,\n "rscp": 0,\n "uarfcn": 0\n }\n ],\n "pathloss": 0,\n "rscp": 0,\n "ta": 0,\n "timestamp": "",\n "uarfcn": 0\n }\n ],\n "wcdma": [\n {\n "cid": 0,\n "lac": 0,\n "mcc": 0,\n "mnc": 0,\n "nmr": [\n {\n "cid": 0,\n "pathloss": 0,\n "psc": 0,\n "rscp": 0,\n "uarfcndl": 0\n }\n ],\n "pathloss": 0,\n "psc": 0,\n "rscp": 0,\n "timestamp": "",\n "uarfcndl": 0\n }\n ],\n "wlan": [\n {\n "band": "",\n "mac": "",\n "powrx": 0,\n "timestamp": ""\n }\n ]\n },\n "system": {\n "client": {\n "accelerometerSensorRange": [],\n "diagnosticscode": "",\n "diskquota": "",\n "firmware": "",\n "hasAccelerometerSensor": false,\n "hasAttachSensor": false,\n "hasHumiditySensor": false,\n "hasNoBattery": false,\n "hasPressureSensor": false,\n "hasTamperSensor": false,\n "hasTemperatureSensor": false,\n "homenetwork": [\n {\n "mcc": 0,\n "mnc": 0,\n "nid": 0,\n "sid": 0\n }\n ],\n "manufacturer": "",\n "model": "",\n "modules": [\n {\n "firmwareVersion": "",\n "manufacturer": "",\n "model": ""\n }\n ],\n "name": "",\n "platform": "",\n "version": ""\n },\n "iccid": "",\n "imsi": "",\n "mode": "",\n "phoneNumber": "",\n "reportedSensorData": {\n "accelerationG": "",\n "batteryIsCharging": false,\n "batteryLevel": 0,\n "deviceIsAttached": false,\n "deviceIsStationary": false,\n "deviceIsTampered": false,\n "pressureHpa": "",\n "relativeHumidity": "",\n "temperatureC": "",\n "tiltDegree": ""\n },\n "stateVersion": 0\n },\n "timestamp": 0\n }\n ],\n "id": ""\n}' \
--output-document \
- {{baseUrl}}/v3/
import Foundation
let headers = [
"authorization": "",
"content-type": "application/json"
]
let parameters = [
"appId": "",
"data": [
[
"payload": [],
"position": [
"accuracy": "",
"alt": "",
"altaccuracy": "",
"confidence": 0,
"floor": [
"id": "",
"level": "",
"name": ""
],
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0,
"type": "",
"wlancount": 0
],
"scan": [
"bt": [
[
"eddystoneId": "",
"iBeaconId": "",
"mac": "",
"rss": 0,
"timestamp": ""
]
],
"cdma": [
[
"baselat": "",
"baselng": "",
"bsid": 0,
"channel": 0,
"nid": 0,
"nmr": [
[
"bsid": 0,
"channel": 0,
"frequency": 0,
"pilotpower": 0,
"pnoffset": 0
]
],
"pilotpower": 0,
"pnoffset": 0,
"rz": 0,
"sid": 0,
"timestamp": ""
]
],
"country": ["mcc": 0],
"gps": [
"accuracy": "",
"alt": "",
"altaccuracy": "",
"heading": 0,
"lat": "",
"lng": "",
"satellitecount": 0,
"speed": 0,
"timestamp": 0
],
"gsm": [
[
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
[
"bcch": 0,
"bsic": 0,
"cid": 0,
"lac": 0,
"rxlevel": 0
]
],
"rxlevel": 0,
"ta": 0,
"timestamp": ""
]
],
"lte": [
[
"cid": 0,
"earfcn": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
[
"cid": 0,
"earfcn": 0,
"pci": 0,
"rsrp": 0,
"rsrq": ""
]
],
"pci": 0,
"rsrp": 0,
"rsrq": "",
"ta": 0,
"tac": 0,
"timestamp": ""
]
],
"tdscdma": [
[
"cellparams": 0,
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
[
"cellparams": 0,
"cid": 0,
"pathloss": 0,
"rscp": 0,
"uarfcn": 0
]
],
"pathloss": 0,
"rscp": 0,
"ta": 0,
"timestamp": "",
"uarfcn": 0
]
],
"wcdma": [
[
"cid": 0,
"lac": 0,
"mcc": 0,
"mnc": 0,
"nmr": [
[
"cid": 0,
"pathloss": 0,
"psc": 0,
"rscp": 0,
"uarfcndl": 0
]
],
"pathloss": 0,
"psc": 0,
"rscp": 0,
"timestamp": "",
"uarfcndl": 0
]
],
"wlan": [
[
"band": "",
"mac": "",
"powrx": 0,
"timestamp": ""
]
]
],
"system": [
"client": [
"accelerometerSensorRange": [],
"diagnosticscode": "",
"diskquota": "",
"firmware": "",
"hasAccelerometerSensor": false,
"hasAttachSensor": false,
"hasHumiditySensor": false,
"hasNoBattery": false,
"hasPressureSensor": false,
"hasTamperSensor": false,
"hasTemperatureSensor": false,
"homenetwork": [
[
"mcc": 0,
"mnc": 0,
"nid": 0,
"sid": 0
]
],
"manufacturer": "",
"model": "",
"modules": [
[
"firmwareVersion": "",
"manufacturer": "",
"model": ""
]
],
"name": "",
"platform": "",
"version": ""
],
"iccid": "",
"imsi": "",
"mode": "",
"phoneNumber": "",
"reportedSensorData": [
"accelerationG": "",
"batteryIsCharging": false,
"batteryLevel": 0,
"deviceIsAttached": false,
"deviceIsStationary": false,
"deviceIsTampered": false,
"pressureHpa": "",
"relativeHumidity": "",
"temperatureC": "",
"tiltDegree": ""
],
"stateVersion": 0
],
"timestamp": 0
]
],
"id": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/v3/")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 413,
"details": {
"hereErrorCode": 413306
},
"error": "Payload Too Large",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request size exceeds the maximum size limit for payloads."
}
POST
Ingests data for multiple devices
{{baseUrl}}/v3/batch
HEADERS
authorization
BODY json
{
"appId": "",
"data": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/v3/batch");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "authorization: ");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"appId\": \"\",\n \"data\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/v3/batch" {:headers {:authorization ""}
:content-type :json
:form-params {:appId ""
:data []}})
require "http/client"
url = "{{baseUrl}}/v3/batch"
headers = HTTP::Headers{
"authorization" => ""
"content-type" => "application/json"
}
reqBody = "{\n \"appId\": \"\",\n \"data\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/v3/batch"),
Headers =
{
{ "authorization", "" },
},
Content = new StringContent("{\n \"appId\": \"\",\n \"data\": []\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}}/v3/batch");
var request = new RestRequest("", Method.Post);
request.AddHeader("authorization", "");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"appId\": \"\",\n \"data\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/v3/batch"
payload := strings.NewReader("{\n \"appId\": \"\",\n \"data\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("authorization", "")
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/v3/batch HTTP/1.1
Authorization:
Content-Type: application/json
Host: example.com
Content-Length: 31
{
"appId": "",
"data": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/v3/batch")
.setHeader("authorization", "")
.setHeader("content-type", "application/json")
.setBody("{\n \"appId\": \"\",\n \"data\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/v3/batch"))
.header("authorization", "")
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"appId\": \"\",\n \"data\": []\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 \"appId\": \"\",\n \"data\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/v3/batch")
.post(body)
.addHeader("authorization", "")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/v3/batch")
.header("authorization", "")
.header("content-type", "application/json")
.body("{\n \"appId\": \"\",\n \"data\": []\n}")
.asString();
const data = JSON.stringify({
appId: '',
data: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/v3/batch');
xhr.setRequestHeader('authorization', '');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/v3/batch',
headers: {authorization: '', 'content-type': 'application/json'},
data: {appId: '', data: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/v3/batch';
const options = {
method: 'POST',
headers: {authorization: '', 'content-type': 'application/json'},
body: '{"appId":"","data":[]}'
};
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}}/v3/batch',
method: 'POST',
headers: {
authorization: '',
'content-type': 'application/json'
},
processData: false,
data: '{\n "appId": "",\n "data": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"appId\": \"\",\n \"data\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/v3/batch")
.post(body)
.addHeader("authorization", "")
.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/v3/batch',
headers: {
authorization: '',
'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({appId: '', data: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/v3/batch',
headers: {authorization: '', 'content-type': 'application/json'},
body: {appId: '', data: []},
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}}/v3/batch');
req.headers({
authorization: '',
'content-type': 'application/json'
});
req.type('json');
req.send({
appId: '',
data: []
});
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}}/v3/batch',
headers: {authorization: '', 'content-type': 'application/json'},
data: {appId: '', data: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/v3/batch';
const options = {
method: 'POST',
headers: {authorization: '', 'content-type': 'application/json'},
body: '{"appId":"","data":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"authorization": @"",
@"content-type": @"application/json" };
NSDictionary *parameters = @{ @"appId": @"",
@"data": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/v3/batch"]
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}}/v3/batch" in
let headers = Header.add_list (Header.init ()) [
("authorization", "");
("content-type", "application/json");
] in
let body = Cohttp_lwt_body.of_string "{\n \"appId\": \"\",\n \"data\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/v3/batch",
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([
'appId' => '',
'data' => [
]
]),
CURLOPT_HTTPHEADER => [
"authorization: ",
"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}}/v3/batch', [
'body' => '{
"appId": "",
"data": []
}',
'headers' => [
'authorization' => '',
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/v3/batch');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'authorization' => '',
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'appId' => '',
'data' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'appId' => '',
'data' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/v3/batch');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'authorization' => '',
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("authorization", "")
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/v3/batch' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"appId": "",
"data": []
}'
$headers=@{}
$headers.Add("authorization", "")
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/v3/batch' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"appId": "",
"data": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"appId\": \"\",\n \"data\": []\n}"
headers = {
'authorization': "",
'content-type': "application/json"
}
conn.request("POST", "/baseUrl/v3/batch", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/v3/batch"
payload = {
"appId": "",
"data": []
}
headers = {
"authorization": "",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/v3/batch"
payload <- "{\n \"appId\": \"\",\n \"data\": []\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, add_headers('authorization' = ''), content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/v3/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = ''
request["content-type"] = 'application/json'
request.body = "{\n \"appId\": \"\",\n \"data\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/v3/batch') do |req|
req.headers['authorization'] = ''
req.body = "{\n \"appId\": \"\",\n \"data\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/v3/batch";
let payload = json!({
"appId": "",
"data": ()
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("authorization", "".parse().unwrap());
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}}/v3/batch \
--header 'authorization: ' \
--header 'content-type: application/json' \
--data '{
"appId": "",
"data": []
}'
echo '{
"appId": "",
"data": []
}' | \
http POST {{baseUrl}}/v3/batch \
authorization:'' \
content-type:application/json
wget --quiet \
--method POST \
--header 'authorization: ' \
--header 'content-type: application/json' \
--body-data '{\n "appId": "",\n "data": []\n}' \
--output-document \
- {{baseUrl}}/v3/batch
import Foundation
let headers = [
"authorization": "",
"content-type": "application/json"
]
let parameters = [
"appId": "",
"data": []
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/v3/batch")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 413,
"details": {
"hereErrorCode": 413306
},
"error": "Payload Too Large",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request size exceeds the maximum size limit for payloads."
}
POST
Requests a token for a registered device
{{baseUrl}}/v2/token
HEADERS
authorization
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/v2/token");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "authorization: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/v2/token" {:headers {:authorization ""}})
require "http/client"
url = "{{baseUrl}}/v2/token"
headers = HTTP::Headers{
"authorization" => ""
}
response = HTTP::Client.post url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/v2/token"),
Headers =
{
{ "authorization", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/v2/token");
var request = new RestRequest("", Method.Post);
request.AddHeader("authorization", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/v2/token"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("authorization", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
POST /baseUrl/v2/token HTTP/1.1
Authorization:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/v2/token")
.setHeader("authorization", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/v2/token"))
.header("authorization", "")
.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}}/v2/token")
.post(null)
.addHeader("authorization", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/v2/token")
.header("authorization", "")
.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}}/v2/token');
xhr.setRequestHeader('authorization', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/v2/token',
headers: {authorization: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/v2/token';
const options = {method: 'POST', headers: {authorization: ''}};
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}}/v2/token',
method: 'POST',
headers: {
authorization: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/v2/token")
.post(null)
.addHeader("authorization", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/v2/token',
headers: {
authorization: ''
}
};
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}}/v2/token',
headers: {authorization: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/v2/token');
req.headers({
authorization: ''
});
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}}/v2/token',
headers: {authorization: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/v2/token';
const options = {method: 'POST', headers: {authorization: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"authorization": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/v2/token"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
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}}/v2/token" in
let headers = Header.add (Header.init ()) "authorization" "" in
Client.call ~headers `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/v2/token",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"authorization: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/v2/token', [
'headers' => [
'authorization' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/v2/token');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'authorization' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/v2/token');
$request->setRequestMethod('POST');
$request->setHeaders([
'authorization' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("authorization", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/v2/token' -Method POST -Headers $headers
$headers=@{}
$headers.Add("authorization", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/v2/token' -Method POST -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'authorization': "" }
conn.request("POST", "/baseUrl/v2/token", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/v2/token"
headers = {"authorization": ""}
response = requests.post(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/v2/token"
response <- VERB("POST", url, add_headers('authorization' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/v2/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["authorization"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/v2/token') do |req|
req.headers['authorization'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/v2/token";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("authorization", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/v2/token \
--header 'authorization: '
http POST {{baseUrl}}/v2/token \
authorization:''
wget --quiet \
--method POST \
--header 'authorization: ' \
--output-document \
- {{baseUrl}}/v2/token
import Foundation
let headers = ["authorization": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/v2/token")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"accessToken": "h1.ySDEpBjW2fXM0Nk1IyBohA.6YOv1MfQUd1K7MCg9elZrrVTT5fKfqYECYUrD7Y77d-p9KqIZrVfjpIrkMqVC9MmfUILOm7xk7VuhCH59o0oLJCl6M8Q8cGHTKVrPcpqiEzUQKs7pSZXxVbIui0O5caUgJ3GHrS1X4aZQuB1KSsngvWMcIz0M0a4g4x8bICUHNRbISbQOWNTc7CcxRIJegIlj24dUawrhtnuQh50JUUY2pHYpSh_t8R0AVkm8JO-WEtWW3SZiLa30IR0gz2121vlRjdNolnJYsuJzHoaEKEkrMj9ffybtcBVWo9dkY1qmDQ-DRg_loVenJK45kjHJijkQ902r_vhH8jtoXTrZ1RBFHuZtwLW8xXBw70BCWPu4OYGgthjaq61mpE8iP1s7MG7gbAiW_S249aaoWMUxQN6djw8cNoTP6YPM-ivSieRMxwPl56mhRQ5GRjQa8AYkuOvoCFg-LCMIxTYhrDZM4HFWQ.duHFPjvWUQbdArCL5CU7bTowK5fD07ro83r6CRWjuB_1TK2VyO1lvfNFZIZePWLyTlN0y9uqD7Uro6t87h_a0zfpeU8_529KrB9vgpcBARF5LGBo8Rh7y2islYxCGJ2pAxHADtxkfiZ8TCoEatg0F3jkeggOl8YUFkeaI2g7WtnhZwrXBwW9QizQH3EM_Djnu66-kv_aM-uddpzZJJ7CmrJiwhucaEJeYRDSpuzzZWT6_NwBg6_xLjyseCv5AGs8EmsuStCFP0Ey7UDIqo9V2RA9uDP64Q0mvEw3EUTHmJGHF_8E2s4iIpjKJCvUGsGYAy8XrjeW10EBAMkfrn6cwA",
"expiresIn": 86399
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "Invalid Authorization, the request lacks valid authentication credentials for the target resource."
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"error": "No license found for the given deviceId.",
"id": "e69ce7d3-82f2-43cd-95b4-4402f98c9a61"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 412,
"error": "Device has not been claimed.",
"id": "e69ce7d3-82f2-43cd-95b4-4402f98c9a61"
}
PUT
Creates a label for a resource
{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value")
require "http/client"
url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/labels/v4/:resourceType/:resourceId/:key/:value HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value"))
.method("PUT", 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}}/labels/v4/:resourceType/:resourceId/:key/:value")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value")
.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('PUT', '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value';
const options = {method: 'PUT'};
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}}/labels/v4/:resourceType/:resourceId/:key/:value',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/labels/v4/:resourceType/:resourceId/:key/:value',
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: 'PUT',
url: '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value');
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}}/labels/v4/:resourceType/:resourceId/:key/:value'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value';
const options = {method: 'PUT'};
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}}/labels/v4/:resourceType/:resourceId/:key/:value"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/labels/v4/:resourceType/:resourceId/:key/:value" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value');
echo $response->getBody();
setUrl('{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/labels/v4/:resourceType/:resourceId/:key/:value")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/labels/v4/:resourceType/:resourceId/:key/:value') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value
http PUT {{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 409,
"details": {
"hereErrorCode": 404306
},
"error": "Conflict",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource already exists."
}
PUT
Creates a set of labels for a resource
{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch
BODY json
{
"labels": {}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch");
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 \"labels\": {}\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch" {:content-type :json
:form-params {:labels {}}})
require "http/client"
url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"labels\": {}\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch"),
Content = new StringContent("{\n \"labels\": {}\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}}/labels/v4/:resourceType/:resourceId/batch");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"labels\": {}\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch"
payload := strings.NewReader("{\n \"labels\": {}\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/labels/v4/:resourceType/:resourceId/batch HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 18
{
"labels": {}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch")
.setHeader("content-type", "application/json")
.setBody("{\n \"labels\": {}\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"labels\": {}\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 \"labels\": {}\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch")
.header("content-type", "application/json")
.body("{\n \"labels\": {}\n}")
.asString();
const data = JSON.stringify({
labels: {}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch',
headers: {'content-type': 'application/json'},
data: {labels: {}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"labels":{}}'
};
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}}/labels/v4/:resourceType/:resourceId/batch',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "labels": {}\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"labels\": {}\n}")
val request = Request.Builder()
.url("{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch")
.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/labels/v4/:resourceType/:resourceId/batch',
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({labels: {}}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch',
headers: {'content-type': 'application/json'},
body: {labels: {}},
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}}/labels/v4/:resourceType/:resourceId/batch');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
labels: {}
});
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}}/labels/v4/:resourceType/:resourceId/batch',
headers: {'content-type': 'application/json'},
data: {labels: {}}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"labels":{}}'
};
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 = @{ @"labels": @{ } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch"]
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}}/labels/v4/:resourceType/:resourceId/batch" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"labels\": {}\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch",
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([
'labels' => [
]
]),
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}}/labels/v4/:resourceType/:resourceId/batch', [
'body' => '{
"labels": {}
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'labels' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'labels' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch');
$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}}/labels/v4/:resourceType/:resourceId/batch' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"labels": {}
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"labels": {}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"labels\": {}\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/labels/v4/:resourceType/:resourceId/batch", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch"
payload = { "labels": {} }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch"
payload <- "{\n \"labels\": {}\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}}/labels/v4/:resourceType/:resourceId/batch")
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 \"labels\": {}\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/labels/v4/:resourceType/:resourceId/batch') do |req|
req.body = "{\n \"labels\": {}\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch";
let payload = json!({"labels": json!({})});
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}}/labels/v4/:resourceType/:resourceId/batch \
--header 'content-type: application/json' \
--data '{
"labels": {}
}'
echo '{
"labels": {}
}' | \
http PUT {{baseUrl}}/labels/v4/:resourceType/:resourceId/batch \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "labels": {}\n}' \
--output-document \
- {{baseUrl}}/labels/v4/:resourceType/:resourceId/batch
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["labels": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/labels/v4/:resourceType/:resourceId/batch")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 409,
"details": {
"hereErrorCode": 404306
},
"error": "Conflict",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource already exists."
}
DELETE
Deletes a label of a resource
{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value")
require "http/client"
url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value"
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/labels/v4/:resourceType/:resourceId/:key/:value HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value"))
.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}}/labels/v4/:resourceType/:resourceId/:key/:value")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value")
.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}}/labels/v4/:resourceType/:resourceId/:key/:value');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value';
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}}/labels/v4/:resourceType/:resourceId/:key/:value',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/labels/v4/:resourceType/:resourceId/:key/:value',
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}}/labels/v4/:resourceType/:resourceId/:key/:value'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value');
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}}/labels/v4/:resourceType/:resourceId/:key/:value'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value';
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}}/labels/v4/:resourceType/:resourceId/:key/:value"]
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}}/labels/v4/:resourceType/:resourceId/:key/:value" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value",
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}}/labels/v4/:resourceType/:resourceId/:key/:value');
echo $response->getBody();
setUrl('{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/labels/v4/:resourceType/:resourceId/:key/:value")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/labels/v4/:resourceType/:resourceId/:key/:value') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value";
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}}/labels/v4/:resourceType/:resourceId/:key/:value
http DELETE {{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key/:value")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Deletes all labels of a resource by a label key
{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key")
require "http/client"
url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key"
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/labels/v4/:resourceType/:resourceId/:key HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key"))
.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}}/labels/v4/:resourceType/:resourceId/:key")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key")
.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}}/labels/v4/:resourceType/:resourceId/:key');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key';
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}}/labels/v4/:resourceType/:resourceId/:key',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/labels/v4/:resourceType/:resourceId/:key',
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}}/labels/v4/:resourceType/:resourceId/:key'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key');
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}}/labels/v4/:resourceType/:resourceId/:key'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key';
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}}/labels/v4/:resourceType/:resourceId/:key"]
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}}/labels/v4/:resourceType/:resourceId/:key" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key",
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}}/labels/v4/:resourceType/:resourceId/:key');
echo $response->getBody();
setUrl('{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/labels/v4/:resourceType/:resourceId/:key")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/labels/v4/:resourceType/:resourceId/:key') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key";
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}}/labels/v4/:resourceType/:resourceId/:key
http DELETE {{baseUrl}}/labels/v4/:resourceType/:resourceId/:key
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/labels/v4/:resourceType/:resourceId/:key
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/labels/v4/:resourceType/:resourceId/:key")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Deletes all labels of a resource
{{baseUrl}}/labels/v4/:resourceType/:resourceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/labels/v4/:resourceType/:resourceId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/labels/v4/:resourceType/:resourceId")
require "http/client"
url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/labels/v4/:resourceType/:resourceId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/labels/v4/:resourceType/:resourceId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/labels/v4/:resourceType/:resourceId"
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/labels/v4/:resourceType/:resourceId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/labels/v4/:resourceType/:resourceId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/labels/v4/:resourceType/:resourceId"))
.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}}/labels/v4/:resourceType/:resourceId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/labels/v4/:resourceType/:resourceId")
.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}}/labels/v4/:resourceType/:resourceId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/labels/v4/:resourceType/:resourceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/labels/v4/:resourceType/:resourceId';
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}}/labels/v4/:resourceType/:resourceId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/labels/v4/:resourceType/:resourceId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/labels/v4/:resourceType/:resourceId',
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}}/labels/v4/:resourceType/:resourceId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/labels/v4/:resourceType/:resourceId');
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}}/labels/v4/:resourceType/:resourceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/labels/v4/:resourceType/:resourceId';
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}}/labels/v4/:resourceType/:resourceId"]
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}}/labels/v4/:resourceType/:resourceId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/labels/v4/:resourceType/:resourceId",
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}}/labels/v4/:resourceType/:resourceId');
echo $response->getBody();
setUrl('{{baseUrl}}/labels/v4/:resourceType/:resourceId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/labels/v4/:resourceType/:resourceId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/labels/v4/:resourceType/:resourceId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/labels/v4/:resourceType/:resourceId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/labels/v4/:resourceType/:resourceId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/labels/v4/:resourceType/:resourceId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/labels/v4/:resourceType/:resourceId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/labels/v4/:resourceType/:resourceId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId";
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}}/labels/v4/:resourceType/:resourceId
http DELETE {{baseUrl}}/labels/v4/:resourceType/:resourceId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/labels/v4/:resourceType/:resourceId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/labels/v4/:resourceType/:resourceId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets all label keys of a resource type
{{baseUrl}}/labels/v4/:resourceType/keys
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/labels/v4/:resourceType/keys");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/labels/v4/:resourceType/keys")
require "http/client"
url = "{{baseUrl}}/labels/v4/:resourceType/keys"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/labels/v4/:resourceType/keys"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/labels/v4/:resourceType/keys");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/labels/v4/:resourceType/keys"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/labels/v4/:resourceType/keys HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/labels/v4/:resourceType/keys")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/labels/v4/:resourceType/keys"))
.method("GET", 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}}/labels/v4/:resourceType/keys")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/labels/v4/:resourceType/keys")
.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('GET', '{{baseUrl}}/labels/v4/:resourceType/keys');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/labels/v4/:resourceType/keys'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/labels/v4/:resourceType/keys';
const options = {method: 'GET'};
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}}/labels/v4/:resourceType/keys',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/labels/v4/:resourceType/keys")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/labels/v4/:resourceType/keys',
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: 'GET', url: '{{baseUrl}}/labels/v4/:resourceType/keys'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/labels/v4/:resourceType/keys');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/labels/v4/:resourceType/keys'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/labels/v4/:resourceType/keys';
const options = {method: 'GET'};
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}}/labels/v4/:resourceType/keys"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/labels/v4/:resourceType/keys" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/labels/v4/:resourceType/keys",
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;
}
request('GET', '{{baseUrl}}/labels/v4/:resourceType/keys');
echo $response->getBody();
setUrl('{{baseUrl}}/labels/v4/:resourceType/keys');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/labels/v4/:resourceType/keys');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/labels/v4/:resourceType/keys' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/labels/v4/:resourceType/keys' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/labels/v4/:resourceType/keys")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/labels/v4/:resourceType/keys"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/labels/v4/:resourceType/keys"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/labels/v4/:resourceType/keys")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/labels/v4/:resourceType/keys') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/labels/v4/:resourceType/keys";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/labels/v4/:resourceType/keys
http GET {{baseUrl}}/labels/v4/:resourceType/keys
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/labels/v4/:resourceType/keys
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/labels/v4/:resourceType/keys")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"keys": [
"priority",
"group",
"..."
]
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets all labels of a resource type
{{baseUrl}}/labels/v4/:resourceType
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/labels/v4/:resourceType");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/labels/v4/:resourceType")
require "http/client"
url = "{{baseUrl}}/labels/v4/:resourceType"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/labels/v4/:resourceType"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/labels/v4/:resourceType");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/labels/v4/:resourceType"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/labels/v4/:resourceType HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/labels/v4/:resourceType")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/labels/v4/:resourceType"))
.method("GET", 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}}/labels/v4/:resourceType")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/labels/v4/:resourceType")
.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('GET', '{{baseUrl}}/labels/v4/:resourceType');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/labels/v4/:resourceType'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/labels/v4/:resourceType';
const options = {method: 'GET'};
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}}/labels/v4/:resourceType',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/labels/v4/:resourceType")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/labels/v4/:resourceType',
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: 'GET', url: '{{baseUrl}}/labels/v4/:resourceType'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/labels/v4/:resourceType');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/labels/v4/:resourceType'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/labels/v4/:resourceType';
const options = {method: 'GET'};
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}}/labels/v4/:resourceType"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/labels/v4/:resourceType" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/labels/v4/:resourceType",
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;
}
request('GET', '{{baseUrl}}/labels/v4/:resourceType');
echo $response->getBody();
setUrl('{{baseUrl}}/labels/v4/:resourceType');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/labels/v4/:resourceType');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/labels/v4/:resourceType' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/labels/v4/:resourceType' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/labels/v4/:resourceType")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/labels/v4/:resourceType"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/labels/v4/:resourceType"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/labels/v4/:resourceType")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/labels/v4/:resourceType') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/labels/v4/:resourceType";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/labels/v4/:resourceType
http GET {{baseUrl}}/labels/v4/:resourceType
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/labels/v4/:resourceType
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/labels/v4/:resourceType")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 2,
"items": [
{
"labels": {
"group": [
"group1"
],
"priority": [
"high"
]
},
"resourceId": "HERE-c47c0d1d-89fd-4961-b341-3eb109f58d19",
"resourceType": "device"
},
{
"labels": {
"group": [
"group1",
"group2"
],
"priority": [
"high"
]
},
"resourceId": "HERE-a89uo64n-fd45-0956-g452-4g6w908um5r4",
"resourceType": "device"
}
],
"limit": 100,
"nextPageToken": "823aabbea253d56fa"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets all labels of a resource
{{baseUrl}}/labels/v4/:resourceType/:resourceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/labels/v4/:resourceType/:resourceId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/labels/v4/:resourceType/:resourceId")
require "http/client"
url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/labels/v4/:resourceType/:resourceId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/labels/v4/:resourceType/:resourceId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/labels/v4/:resourceType/:resourceId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/labels/v4/:resourceType/:resourceId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/labels/v4/:resourceType/:resourceId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/labels/v4/:resourceType/:resourceId"))
.method("GET", 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}}/labels/v4/:resourceType/:resourceId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/labels/v4/:resourceType/:resourceId")
.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('GET', '{{baseUrl}}/labels/v4/:resourceType/:resourceId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/labels/v4/:resourceType/:resourceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/labels/v4/:resourceType/:resourceId';
const options = {method: 'GET'};
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}}/labels/v4/:resourceType/:resourceId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/labels/v4/:resourceType/:resourceId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/labels/v4/:resourceType/:resourceId',
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: 'GET',
url: '{{baseUrl}}/labels/v4/:resourceType/:resourceId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/labels/v4/:resourceType/:resourceId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/labels/v4/:resourceType/:resourceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/labels/v4/:resourceType/:resourceId';
const options = {method: 'GET'};
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}}/labels/v4/:resourceType/:resourceId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/labels/v4/:resourceType/:resourceId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/labels/v4/:resourceType/:resourceId",
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;
}
request('GET', '{{baseUrl}}/labels/v4/:resourceType/:resourceId');
echo $response->getBody();
setUrl('{{baseUrl}}/labels/v4/:resourceType/:resourceId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/labels/v4/:resourceType/:resourceId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/labels/v4/:resourceType/:resourceId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/labels/v4/:resourceType/:resourceId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/labels/v4/:resourceType/:resourceId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/labels/v4/:resourceType/:resourceId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/labels/v4/:resourceType/:resourceId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/labels/v4/:resourceType/:resourceId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/labels/v4/:resourceType/:resourceId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/labels/v4/:resourceType/:resourceId
http GET {{baseUrl}}/labels/v4/:resourceType/:resourceId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/labels/v4/:resourceType/:resourceId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/labels/v4/:resourceType/:resourceId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"labels": {
"group": [
"group1"
],
"priority": [
"high"
]
},
"resourceId": "HERE-c47c0d1d-89fd-4961-b341-3eb109f58d19",
"resourceType": "device"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets all values of a label
{{baseUrl}}/labels/v4/:resourceType/keys/:key/values
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/labels/v4/:resourceType/keys/:key/values");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/labels/v4/:resourceType/keys/:key/values")
require "http/client"
url = "{{baseUrl}}/labels/v4/:resourceType/keys/:key/values"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/labels/v4/:resourceType/keys/:key/values"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/labels/v4/:resourceType/keys/:key/values");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/labels/v4/:resourceType/keys/:key/values"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/labels/v4/:resourceType/keys/:key/values HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/labels/v4/:resourceType/keys/:key/values")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/labels/v4/:resourceType/keys/:key/values"))
.method("GET", 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}}/labels/v4/:resourceType/keys/:key/values")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/labels/v4/:resourceType/keys/:key/values")
.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('GET', '{{baseUrl}}/labels/v4/:resourceType/keys/:key/values');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/labels/v4/:resourceType/keys/:key/values'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/labels/v4/:resourceType/keys/:key/values';
const options = {method: 'GET'};
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}}/labels/v4/:resourceType/keys/:key/values',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/labels/v4/:resourceType/keys/:key/values")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/labels/v4/:resourceType/keys/:key/values',
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: 'GET',
url: '{{baseUrl}}/labels/v4/:resourceType/keys/:key/values'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/labels/v4/:resourceType/keys/:key/values');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/labels/v4/:resourceType/keys/:key/values'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/labels/v4/:resourceType/keys/:key/values';
const options = {method: 'GET'};
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}}/labels/v4/:resourceType/keys/:key/values"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/labels/v4/:resourceType/keys/:key/values" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/labels/v4/:resourceType/keys/:key/values",
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;
}
request('GET', '{{baseUrl}}/labels/v4/:resourceType/keys/:key/values');
echo $response->getBody();
setUrl('{{baseUrl}}/labels/v4/:resourceType/keys/:key/values');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/labels/v4/:resourceType/keys/:key/values');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/labels/v4/:resourceType/keys/:key/values' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/labels/v4/:resourceType/keys/:key/values' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/labels/v4/:resourceType/keys/:key/values")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/labels/v4/:resourceType/keys/:key/values"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/labels/v4/:resourceType/keys/:key/values"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/labels/v4/:resourceType/keys/:key/values")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/labels/v4/:resourceType/keys/:key/values') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/labels/v4/:resourceType/keys/:key/values";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/labels/v4/:resourceType/keys/:key/values
http GET {{baseUrl}}/labels/v4/:resourceType/keys/:key/values
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/labels/v4/:resourceType/keys/:key/values
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/labels/v4/:resourceType/keys/:key/values")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"values": [
"high",
"group1",
"..."
]
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets service health (7)
{{baseUrl}}/labels/v4/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/labels/v4/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/labels/v4/health")
require "http/client"
url = "{{baseUrl}}/labels/v4/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/labels/v4/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/labels/v4/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/labels/v4/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/labels/v4/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/labels/v4/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/labels/v4/health"))
.method("GET", 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}}/labels/v4/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/labels/v4/health")
.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('GET', '{{baseUrl}}/labels/v4/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/labels/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/labels/v4/health';
const options = {method: 'GET'};
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}}/labels/v4/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/labels/v4/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/labels/v4/health',
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: 'GET', url: '{{baseUrl}}/labels/v4/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/labels/v4/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/labels/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/labels/v4/health';
const options = {method: 'GET'};
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}}/labels/v4/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/labels/v4/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/labels/v4/health",
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;
}
request('GET', '{{baseUrl}}/labels/v4/health');
echo $response->getBody();
setUrl('{{baseUrl}}/labels/v4/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/labels/v4/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/labels/v4/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/labels/v4/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/labels/v4/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/labels/v4/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/labels/v4/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/labels/v4/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/labels/v4/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/labels/v4/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/labels/v4/health
http GET {{baseUrl}}/labels/v4/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/labels/v4/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/labels/v4/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (7)
{{baseUrl}}/labels/v4/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/labels/v4/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/labels/v4/version")
require "http/client"
url = "{{baseUrl}}/labels/v4/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/labels/v4/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/labels/v4/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/labels/v4/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/labels/v4/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/labels/v4/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/labels/v4/version"))
.method("GET", 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}}/labels/v4/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/labels/v4/version")
.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('GET', '{{baseUrl}}/labels/v4/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/labels/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/labels/v4/version';
const options = {method: 'GET'};
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}}/labels/v4/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/labels/v4/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/labels/v4/version',
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: 'GET', url: '{{baseUrl}}/labels/v4/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/labels/v4/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/labels/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/labels/v4/version';
const options = {method: 'GET'};
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}}/labels/v4/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/labels/v4/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/labels/v4/version",
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;
}
request('GET', '{{baseUrl}}/labels/v4/version');
echo $response->getBody();
setUrl('{{baseUrl}}/labels/v4/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/labels/v4/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/labels/v4/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/labels/v4/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/labels/v4/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/labels/v4/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/labels/v4/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/labels/v4/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/labels/v4/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/labels/v4/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/labels/v4/version
http GET {{baseUrl}}/labels/v4/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/labels/v4/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/labels/v4/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
Completes data upload
{{baseUrl}}/largedata/v4/:dataId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/largedata/v4/:dataId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/largedata/v4/:dataId")
require "http/client"
url = "{{baseUrl}}/largedata/v4/:dataId"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/largedata/v4/:dataId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/largedata/v4/:dataId");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/largedata/v4/:dataId"
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/largedata/v4/:dataId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/largedata/v4/:dataId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/largedata/v4/:dataId"))
.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}}/largedata/v4/:dataId")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/largedata/v4/:dataId")
.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}}/largedata/v4/:dataId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/largedata/v4/:dataId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/largedata/v4/:dataId';
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}}/largedata/v4/:dataId',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/largedata/v4/:dataId")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/largedata/v4/:dataId',
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}}/largedata/v4/:dataId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/largedata/v4/:dataId');
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}}/largedata/v4/:dataId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/largedata/v4/:dataId';
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}}/largedata/v4/:dataId"]
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}}/largedata/v4/:dataId" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/largedata/v4/:dataId",
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}}/largedata/v4/:dataId');
echo $response->getBody();
setUrl('{{baseUrl}}/largedata/v4/:dataId');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/largedata/v4/:dataId');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/largedata/v4/:dataId' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/largedata/v4/:dataId' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/largedata/v4/:dataId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/largedata/v4/:dataId"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/largedata/v4/:dataId"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/largedata/v4/:dataId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/largedata/v4/:dataId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/largedata/v4/:dataId";
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}}/largedata/v4/:dataId
http POST {{baseUrl}}/largedata/v4/:dataId
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/largedata/v4/:dataId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/largedata/v4/:dataId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
POST
Creates a new data upload
{{baseUrl}}/largedata/v4
BODY json
{
"description": "",
"name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/largedata/v4");
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 \"description\": \"\",\n \"name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/largedata/v4" {:content-type :json
:form-params {:description ""
:name ""}})
require "http/client"
url = "{{baseUrl}}/largedata/v4"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"name\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/largedata/v4"),
Content = new StringContent("{\n \"description\": \"\",\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}}/largedata/v4");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/largedata/v4"
payload := strings.NewReader("{\n \"description\": \"\",\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/largedata/v4 HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 37
{
"description": "",
"name": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/largedata/v4")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/largedata/v4"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\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 \"description\": \"\",\n \"name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/largedata/v4")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/largedata/v4")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"name\": \"\"\n}")
.asString();
const data = JSON.stringify({
description: '',
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}}/largedata/v4');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/largedata/v4',
headers: {'content-type': 'application/json'},
data: {description: '', name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/largedata/v4';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"description":"","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}}/largedata/v4',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\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 \"description\": \"\",\n \"name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/largedata/v4")
.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/largedata/v4',
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({description: '', name: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/largedata/v4',
headers: {'content-type': 'application/json'},
body: {description: '', 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}}/largedata/v4');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
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}}/largedata/v4',
headers: {'content-type': 'application/json'},
data: {description: '', name: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/largedata/v4';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"description":"","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 = @{ @"description": @"",
@"name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/largedata/v4"]
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}}/largedata/v4" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"name\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/largedata/v4",
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([
'description' => '',
'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}}/largedata/v4', [
'body' => '{
"description": "",
"name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/largedata/v4');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/largedata/v4');
$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}}/largedata/v4' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"name": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/largedata/v4' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"name": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/largedata/v4", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/largedata/v4"
payload = {
"description": "",
"name": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/largedata/v4"
payload <- "{\n \"description\": \"\",\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}}/largedata/v4")
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 \"description\": \"\",\n \"name\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/largedata/v4') do |req|
req.body = "{\n \"description\": \"\",\n \"name\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/largedata/v4";
let payload = json!({
"description": "",
"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}}/largedata/v4 \
--header 'content-type: application/json' \
--data '{
"description": "",
"name": ""
}'
echo '{
"description": "",
"name": ""
}' | \
http POST {{baseUrl}}/largedata/v4 \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "name": ""\n}' \
--output-document \
- {{baseUrl}}/largedata/v4
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/largedata/v4")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"dataId": "DATA-08343421-e2d6-4abe-8e9a-adeb5361e991"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Deletes large data
{{baseUrl}}/largedata/v4/:dataId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/largedata/v4/:dataId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/largedata/v4/:dataId")
require "http/client"
url = "{{baseUrl}}/largedata/v4/:dataId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/largedata/v4/:dataId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/largedata/v4/:dataId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/largedata/v4/:dataId"
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/largedata/v4/:dataId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/largedata/v4/:dataId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/largedata/v4/:dataId"))
.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}}/largedata/v4/:dataId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/largedata/v4/:dataId")
.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}}/largedata/v4/:dataId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/largedata/v4/:dataId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/largedata/v4/:dataId';
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}}/largedata/v4/:dataId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/largedata/v4/:dataId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/largedata/v4/:dataId',
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}}/largedata/v4/:dataId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/largedata/v4/:dataId');
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}}/largedata/v4/:dataId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/largedata/v4/:dataId';
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}}/largedata/v4/:dataId"]
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}}/largedata/v4/:dataId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/largedata/v4/:dataId",
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}}/largedata/v4/:dataId');
echo $response->getBody();
setUrl('{{baseUrl}}/largedata/v4/:dataId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/largedata/v4/:dataId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/largedata/v4/:dataId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/largedata/v4/:dataId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/largedata/v4/:dataId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/largedata/v4/:dataId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/largedata/v4/:dataId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/largedata/v4/:dataId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/largedata/v4/:dataId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/largedata/v4/:dataId";
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}}/largedata/v4/:dataId
http DELETE {{baseUrl}}/largedata/v4/:dataId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/largedata/v4/:dataId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/largedata/v4/:dataId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets large data object
{{baseUrl}}/largedata/v4/:dataId/data
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/largedata/v4/:dataId/data");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/largedata/v4/:dataId/data")
require "http/client"
url = "{{baseUrl}}/largedata/v4/:dataId/data"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/largedata/v4/:dataId/data"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/largedata/v4/:dataId/data");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/largedata/v4/:dataId/data"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/largedata/v4/:dataId/data HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/largedata/v4/:dataId/data")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/largedata/v4/:dataId/data"))
.method("GET", 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}}/largedata/v4/:dataId/data")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/largedata/v4/:dataId/data")
.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('GET', '{{baseUrl}}/largedata/v4/:dataId/data');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/largedata/v4/:dataId/data'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/largedata/v4/:dataId/data';
const options = {method: 'GET'};
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}}/largedata/v4/:dataId/data',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/largedata/v4/:dataId/data")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/largedata/v4/:dataId/data',
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: 'GET', url: '{{baseUrl}}/largedata/v4/:dataId/data'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/largedata/v4/:dataId/data');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/largedata/v4/:dataId/data'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/largedata/v4/:dataId/data';
const options = {method: 'GET'};
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}}/largedata/v4/:dataId/data"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/largedata/v4/:dataId/data" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/largedata/v4/:dataId/data",
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;
}
request('GET', '{{baseUrl}}/largedata/v4/:dataId/data');
echo $response->getBody();
setUrl('{{baseUrl}}/largedata/v4/:dataId/data');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/largedata/v4/:dataId/data');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/largedata/v4/:dataId/data' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/largedata/v4/:dataId/data' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/largedata/v4/:dataId/data")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/largedata/v4/:dataId/data"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/largedata/v4/:dataId/data"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/largedata/v4/:dataId/data")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/largedata/v4/:dataId/data') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/largedata/v4/:dataId/data";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/largedata/v4/:dataId/data
http GET {{baseUrl}}/largedata/v4/:dataId/data
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/largedata/v4/:dataId/data
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/largedata/v4/:dataId/data")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets metadata for a large data object
{{baseUrl}}/largedata/v4/:dataId/metadata
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/largedata/v4/:dataId/metadata");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/largedata/v4/:dataId/metadata")
require "http/client"
url = "{{baseUrl}}/largedata/v4/:dataId/metadata"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/largedata/v4/:dataId/metadata"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/largedata/v4/:dataId/metadata");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/largedata/v4/:dataId/metadata"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/largedata/v4/:dataId/metadata HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/largedata/v4/:dataId/metadata")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/largedata/v4/:dataId/metadata"))
.method("GET", 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}}/largedata/v4/:dataId/metadata")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/largedata/v4/:dataId/metadata")
.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('GET', '{{baseUrl}}/largedata/v4/:dataId/metadata');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/largedata/v4/:dataId/metadata'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/largedata/v4/:dataId/metadata';
const options = {method: 'GET'};
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}}/largedata/v4/:dataId/metadata',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/largedata/v4/:dataId/metadata")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/largedata/v4/:dataId/metadata',
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: 'GET',
url: '{{baseUrl}}/largedata/v4/:dataId/metadata'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/largedata/v4/:dataId/metadata');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/largedata/v4/:dataId/metadata'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/largedata/v4/:dataId/metadata';
const options = {method: 'GET'};
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}}/largedata/v4/:dataId/metadata"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/largedata/v4/:dataId/metadata" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/largedata/v4/:dataId/metadata",
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;
}
request('GET', '{{baseUrl}}/largedata/v4/:dataId/metadata');
echo $response->getBody();
setUrl('{{baseUrl}}/largedata/v4/:dataId/metadata');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/largedata/v4/:dataId/metadata');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/largedata/v4/:dataId/metadata' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/largedata/v4/:dataId/metadata' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/largedata/v4/:dataId/metadata")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/largedata/v4/:dataId/metadata"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/largedata/v4/:dataId/metadata"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/largedata/v4/:dataId/metadata")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/largedata/v4/:dataId/metadata') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/largedata/v4/:dataId/metadata";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/largedata/v4/:dataId/metadata
http GET {{baseUrl}}/largedata/v4/:dataId/metadata
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/largedata/v4/:dataId/metadata
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/largedata/v4/:dataId/metadata")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"completedAt": "2021-05-28T12:10:00Z",
"createdAt": "2021-05-28T11:40:00Z",
"dataId": "DATA-08343421-e2d6-4abe-8e9a-adeb5361e991",
"description": "Description for my large data",
"name": "My large data",
"numberOfParts": 5,
"size": 10000,
"status": "completed",
"trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets metadata listing for all large data for a device
{{baseUrl}}/largedata/v4/devices/:trackingId/metadata
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/largedata/v4/devices/:trackingId/metadata");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/largedata/v4/devices/:trackingId/metadata")
require "http/client"
url = "{{baseUrl}}/largedata/v4/devices/:trackingId/metadata"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/largedata/v4/devices/:trackingId/metadata"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/largedata/v4/devices/:trackingId/metadata");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/largedata/v4/devices/:trackingId/metadata"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/largedata/v4/devices/:trackingId/metadata HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/largedata/v4/devices/:trackingId/metadata")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/largedata/v4/devices/:trackingId/metadata"))
.method("GET", 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}}/largedata/v4/devices/:trackingId/metadata")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/largedata/v4/devices/:trackingId/metadata")
.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('GET', '{{baseUrl}}/largedata/v4/devices/:trackingId/metadata');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/largedata/v4/devices/:trackingId/metadata'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/largedata/v4/devices/:trackingId/metadata';
const options = {method: 'GET'};
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}}/largedata/v4/devices/:trackingId/metadata',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/largedata/v4/devices/:trackingId/metadata")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/largedata/v4/devices/:trackingId/metadata',
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: 'GET',
url: '{{baseUrl}}/largedata/v4/devices/:trackingId/metadata'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/largedata/v4/devices/:trackingId/metadata');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/largedata/v4/devices/:trackingId/metadata'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/largedata/v4/devices/:trackingId/metadata';
const options = {method: 'GET'};
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}}/largedata/v4/devices/:trackingId/metadata"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/largedata/v4/devices/:trackingId/metadata" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/largedata/v4/devices/:trackingId/metadata",
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;
}
request('GET', '{{baseUrl}}/largedata/v4/devices/:trackingId/metadata');
echo $response->getBody();
setUrl('{{baseUrl}}/largedata/v4/devices/:trackingId/metadata');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/largedata/v4/devices/:trackingId/metadata');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/largedata/v4/devices/:trackingId/metadata' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/largedata/v4/devices/:trackingId/metadata' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/largedata/v4/devices/:trackingId/metadata")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/largedata/v4/devices/:trackingId/metadata"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/largedata/v4/devices/:trackingId/metadata"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/largedata/v4/devices/:trackingId/metadata")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/largedata/v4/devices/:trackingId/metadata') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/largedata/v4/devices/:trackingId/metadata";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/largedata/v4/devices/:trackingId/metadata
http GET {{baseUrl}}/largedata/v4/devices/:trackingId/metadata
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/largedata/v4/devices/:trackingId/metadata
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/largedata/v4/devices/:trackingId/metadata")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"items": [
{
"completedAt": "2021-05-28T12:10:00Z",
"createdAt": "2021-05-28T11:40:00Z",
"dataId": "DATA-08343421-e2d6-4abe-8e9a-adeb5361e991",
"description": "Description for my large data",
"name": "My large data",
"numberOfParts": 5,
"size": 10000,
"status": "completed",
"trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d"
}
]
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets parts information listing for a large data object
{{baseUrl}}/largedata/v4/:dataId/parts
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/largedata/v4/:dataId/parts");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/largedata/v4/:dataId/parts")
require "http/client"
url = "{{baseUrl}}/largedata/v4/:dataId/parts"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/largedata/v4/:dataId/parts"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/largedata/v4/:dataId/parts");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/largedata/v4/:dataId/parts"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/largedata/v4/:dataId/parts HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/largedata/v4/:dataId/parts")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/largedata/v4/:dataId/parts"))
.method("GET", 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}}/largedata/v4/:dataId/parts")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/largedata/v4/:dataId/parts")
.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('GET', '{{baseUrl}}/largedata/v4/:dataId/parts');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/largedata/v4/:dataId/parts'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/largedata/v4/:dataId/parts';
const options = {method: 'GET'};
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}}/largedata/v4/:dataId/parts',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/largedata/v4/:dataId/parts")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/largedata/v4/:dataId/parts',
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: 'GET', url: '{{baseUrl}}/largedata/v4/:dataId/parts'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/largedata/v4/:dataId/parts');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/largedata/v4/:dataId/parts'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/largedata/v4/:dataId/parts';
const options = {method: 'GET'};
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}}/largedata/v4/:dataId/parts"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/largedata/v4/:dataId/parts" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/largedata/v4/:dataId/parts",
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;
}
request('GET', '{{baseUrl}}/largedata/v4/:dataId/parts');
echo $response->getBody();
setUrl('{{baseUrl}}/largedata/v4/:dataId/parts');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/largedata/v4/:dataId/parts');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/largedata/v4/:dataId/parts' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/largedata/v4/:dataId/parts' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/largedata/v4/:dataId/parts")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/largedata/v4/:dataId/parts"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/largedata/v4/:dataId/parts"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/largedata/v4/:dataId/parts")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/largedata/v4/:dataId/parts') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/largedata/v4/:dataId/parts";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/largedata/v4/:dataId/parts
http GET {{baseUrl}}/largedata/v4/:dataId/parts
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/largedata/v4/:dataId/parts
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/largedata/v4/:dataId/parts")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"items": [
{
"md5": "b026324c6904b2a9cb4b88d6d61c81d1",
"partNumber": 1,
"size": 1,
"status": "completed"
}
]
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets service health (8)
{{baseUrl}}/largedata/v4/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/largedata/v4/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/largedata/v4/health")
require "http/client"
url = "{{baseUrl}}/largedata/v4/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/largedata/v4/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/largedata/v4/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/largedata/v4/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/largedata/v4/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/largedata/v4/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/largedata/v4/health"))
.method("GET", 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}}/largedata/v4/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/largedata/v4/health")
.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('GET', '{{baseUrl}}/largedata/v4/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/largedata/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/largedata/v4/health';
const options = {method: 'GET'};
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}}/largedata/v4/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/largedata/v4/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/largedata/v4/health',
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: 'GET', url: '{{baseUrl}}/largedata/v4/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/largedata/v4/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/largedata/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/largedata/v4/health';
const options = {method: 'GET'};
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}}/largedata/v4/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/largedata/v4/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/largedata/v4/health",
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;
}
request('GET', '{{baseUrl}}/largedata/v4/health');
echo $response->getBody();
setUrl('{{baseUrl}}/largedata/v4/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/largedata/v4/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/largedata/v4/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/largedata/v4/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/largedata/v4/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/largedata/v4/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/largedata/v4/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/largedata/v4/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/largedata/v4/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/largedata/v4/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/largedata/v4/health
http GET {{baseUrl}}/largedata/v4/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/largedata/v4/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/largedata/v4/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (8)
{{baseUrl}}/largedata/v4/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/largedata/v4/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/largedata/v4/version")
require "http/client"
url = "{{baseUrl}}/largedata/v4/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/largedata/v4/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/largedata/v4/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/largedata/v4/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/largedata/v4/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/largedata/v4/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/largedata/v4/version"))
.method("GET", 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}}/largedata/v4/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/largedata/v4/version")
.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('GET', '{{baseUrl}}/largedata/v4/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/largedata/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/largedata/v4/version';
const options = {method: 'GET'};
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}}/largedata/v4/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/largedata/v4/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/largedata/v4/version',
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: 'GET', url: '{{baseUrl}}/largedata/v4/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/largedata/v4/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/largedata/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/largedata/v4/version';
const options = {method: 'GET'};
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}}/largedata/v4/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/largedata/v4/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/largedata/v4/version",
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;
}
request('GET', '{{baseUrl}}/largedata/v4/version');
echo $response->getBody();
setUrl('{{baseUrl}}/largedata/v4/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/largedata/v4/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/largedata/v4/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/largedata/v4/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/largedata/v4/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/largedata/v4/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/largedata/v4/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/largedata/v4/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/largedata/v4/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/largedata/v4/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/largedata/v4/version
http GET {{baseUrl}}/largedata/v4/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/largedata/v4/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/largedata/v4/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
Uploads a part of a large data
{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber")
require "http/client"
url = "{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/largedata/v4/:dataId/parts/:partNumber HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber"))
.method("PUT", 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}}/largedata/v4/:dataId/parts/:partNumber")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber")
.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('PUT', '{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber';
const options = {method: 'PUT'};
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}}/largedata/v4/:dataId/parts/:partNumber',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/largedata/v4/:dataId/parts/:partNumber',
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: 'PUT',
url: '{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber');
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}}/largedata/v4/:dataId/parts/:partNumber'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber';
const options = {method: 'PUT'};
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}}/largedata/v4/:dataId/parts/:partNumber"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/largedata/v4/:dataId/parts/:partNumber" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber');
echo $response->getBody();
setUrl('{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/largedata/v4/:dataId/parts/:partNumber")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber"
response = requests.put(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/largedata/v4/:dataId/parts/:partNumber') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/largedata/v4/:dataId/parts/:partNumber
http PUT {{baseUrl}}/largedata/v4/:dataId/parts/:partNumber
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/largedata/v4/:dataId/parts/:partNumber
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/largedata/v4/:dataId/parts/:partNumber")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 409,
"details": {
"hereErrorCode": 404306
},
"error": "Conflict",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource already exists."
}
POST
Creates a location
{{baseUrl}}/locations/v4
BODY json
{
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/locations/v4");
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 \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/locations/v4" {:content-type :json
:form-params {:address {:city ""
:country ""
:postalCode ""
:state ""
:street ""}
:description ""
:externalLocationId ""
:geofenceId ""
:location {:lat ""
:lng ""}
:name ""}})
require "http/client"
url = "{{baseUrl}}/locations/v4"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/locations/v4"),
Content = new StringContent("{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\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}}/locations/v4");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/locations/v4"
payload := strings.NewReader("{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\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/locations/v4 HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 246
{
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/locations/v4")
.setHeader("content-type", "application/json")
.setBody("{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/locations/v4"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\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 \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/locations/v4")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/locations/v4")
.header("content-type", "application/json")
.body("{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}")
.asString();
const data = JSON.stringify({
address: {
city: '',
country: '',
postalCode: '',
state: '',
street: ''
},
description: '',
externalLocationId: '',
geofenceId: '',
location: {
lat: '',
lng: ''
},
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}}/locations/v4');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/locations/v4',
headers: {'content-type': 'application/json'},
data: {
address: {city: '', country: '', postalCode: '', state: '', street: ''},
description: '',
externalLocationId: '',
geofenceId: '',
location: {lat: '', lng: ''},
name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/locations/v4';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"address":{"city":"","country":"","postalCode":"","state":"","street":""},"description":"","externalLocationId":"","geofenceId":"","location":{"lat":"","lng":""},"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}}/locations/v4',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "address": {\n "city": "",\n "country": "",\n "postalCode": "",\n "state": "",\n "street": ""\n },\n "description": "",\n "externalLocationId": "",\n "geofenceId": "",\n "location": {\n "lat": "",\n "lng": ""\n },\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 \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/locations/v4")
.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/locations/v4',
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({
address: {city: '', country: '', postalCode: '', state: '', street: ''},
description: '',
externalLocationId: '',
geofenceId: '',
location: {lat: '', lng: ''},
name: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/locations/v4',
headers: {'content-type': 'application/json'},
body: {
address: {city: '', country: '', postalCode: '', state: '', street: ''},
description: '',
externalLocationId: '',
geofenceId: '',
location: {lat: '', lng: ''},
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}}/locations/v4');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
address: {
city: '',
country: '',
postalCode: '',
state: '',
street: ''
},
description: '',
externalLocationId: '',
geofenceId: '',
location: {
lat: '',
lng: ''
},
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}}/locations/v4',
headers: {'content-type': 'application/json'},
data: {
address: {city: '', country: '', postalCode: '', state: '', street: ''},
description: '',
externalLocationId: '',
geofenceId: '',
location: {lat: '', lng: ''},
name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/locations/v4';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"address":{"city":"","country":"","postalCode":"","state":"","street":""},"description":"","externalLocationId":"","geofenceId":"","location":{"lat":"","lng":""},"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 = @{ @"address": @{ @"city": @"", @"country": @"", @"postalCode": @"", @"state": @"", @"street": @"" },
@"description": @"",
@"externalLocationId": @"",
@"geofenceId": @"",
@"location": @{ @"lat": @"", @"lng": @"" },
@"name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/locations/v4"]
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}}/locations/v4" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/locations/v4",
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([
'address' => [
'city' => '',
'country' => '',
'postalCode' => '',
'state' => '',
'street' => ''
],
'description' => '',
'externalLocationId' => '',
'geofenceId' => '',
'location' => [
'lat' => '',
'lng' => ''
],
'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}}/locations/v4', [
'body' => '{
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/locations/v4');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'address' => [
'city' => '',
'country' => '',
'postalCode' => '',
'state' => '',
'street' => ''
],
'description' => '',
'externalLocationId' => '',
'geofenceId' => '',
'location' => [
'lat' => '',
'lng' => ''
],
'name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'address' => [
'city' => '',
'country' => '',
'postalCode' => '',
'state' => '',
'street' => ''
],
'description' => '',
'externalLocationId' => '',
'geofenceId' => '',
'location' => [
'lat' => '',
'lng' => ''
],
'name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/locations/v4');
$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}}/locations/v4' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/locations/v4' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/locations/v4", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/locations/v4"
payload = {
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/locations/v4"
payload <- "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\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}}/locations/v4")
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 \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/locations/v4') do |req|
req.body = "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/locations/v4";
let payload = json!({
"address": json!({
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
}),
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": json!({
"lat": "",
"lng": ""
}),
"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}}/locations/v4 \
--header 'content-type: application/json' \
--data '{
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}'
echo '{
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}' | \
http POST {{baseUrl}}/locations/v4 \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "address": {\n "city": "",\n "country": "",\n "postalCode": "",\n "state": "",\n "street": ""\n },\n "description": "",\n "externalLocationId": "",\n "geofenceId": "",\n "location": {\n "lat": "",\n "lng": ""\n },\n "name": ""\n}' \
--output-document \
- {{baseUrl}}/locations/v4
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"address": [
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
],
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": [
"lat": "",
"lng": ""
],
"name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/locations/v4")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
DELETE
Deletes a location
{{baseUrl}}/locations/v4/:locationId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/locations/v4/:locationId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/locations/v4/:locationId")
require "http/client"
url = "{{baseUrl}}/locations/v4/:locationId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/locations/v4/:locationId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/locations/v4/:locationId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/locations/v4/:locationId"
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/locations/v4/:locationId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/locations/v4/:locationId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/locations/v4/:locationId"))
.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}}/locations/v4/:locationId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/locations/v4/:locationId")
.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}}/locations/v4/:locationId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/locations/v4/:locationId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/locations/v4/:locationId';
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}}/locations/v4/:locationId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/locations/v4/:locationId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/locations/v4/:locationId',
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}}/locations/v4/:locationId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/locations/v4/:locationId');
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}}/locations/v4/:locationId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/locations/v4/:locationId';
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}}/locations/v4/:locationId"]
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}}/locations/v4/:locationId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/locations/v4/:locationId",
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}}/locations/v4/:locationId');
echo $response->getBody();
setUrl('{{baseUrl}}/locations/v4/:locationId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/locations/v4/:locationId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/locations/v4/:locationId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/locations/v4/:locationId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/locations/v4/:locationId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/locations/v4/:locationId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/locations/v4/:locationId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/locations/v4/:locationId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/locations/v4/:locationId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/locations/v4/:locationId";
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}}/locations/v4/:locationId
http DELETE {{baseUrl}}/locations/v4/:locationId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/locations/v4/:locationId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/locations/v4/:locationId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Deletes all locations
{{baseUrl}}/locations/v4
HEADERS
x-confirm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/locations/v4");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-confirm: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/locations/v4" {:headers {:x-confirm ""}})
require "http/client"
url = "{{baseUrl}}/locations/v4"
headers = HTTP::Headers{
"x-confirm" => ""
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/locations/v4"),
Headers =
{
{ "x-confirm", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/locations/v4");
var request = new RestRequest("", Method.Delete);
request.AddHeader("x-confirm", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/locations/v4"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-confirm", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/locations/v4 HTTP/1.1
X-Confirm:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/locations/v4")
.setHeader("x-confirm", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/locations/v4"))
.header("x-confirm", "")
.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}}/locations/v4")
.delete(null)
.addHeader("x-confirm", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/locations/v4")
.header("x-confirm", "")
.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}}/locations/v4');
xhr.setRequestHeader('x-confirm', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/locations/v4',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/locations/v4';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
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}}/locations/v4',
method: 'DELETE',
headers: {
'x-confirm': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/locations/v4")
.delete(null)
.addHeader("x-confirm", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/locations/v4',
headers: {
'x-confirm': ''
}
};
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}}/locations/v4',
headers: {'x-confirm': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/locations/v4');
req.headers({
'x-confirm': ''
});
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}}/locations/v4',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/locations/v4';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-confirm": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/locations/v4"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
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}}/locations/v4" in
let headers = Header.add (Header.init ()) "x-confirm" "" in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/locations/v4",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"x-confirm: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/locations/v4', [
'headers' => [
'x-confirm' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/locations/v4');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'x-confirm' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/locations/v4');
$request->setRequestMethod('DELETE');
$request->setHeaders([
'x-confirm' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/locations/v4' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/locations/v4' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'x-confirm': "" }
conn.request("DELETE", "/baseUrl/locations/v4", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/locations/v4"
headers = {"x-confirm": ""}
response = requests.delete(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/locations/v4"
response <- VERB("DELETE", url, add_headers('x-confirm' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/locations/v4")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-confirm"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/locations/v4') do |req|
req.headers['x-confirm'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/locations/v4";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-confirm", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/locations/v4 \
--header 'x-confirm: '
http DELETE {{baseUrl}}/locations/v4 \
x-confirm:''
wget --quiet \
--method DELETE \
--header 'x-confirm: ' \
--output-document \
- {{baseUrl}}/locations/v4
import Foundation
let headers = ["x-confirm": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/locations/v4")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets a location details
{{baseUrl}}/locations/v4/:locationId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/locations/v4/:locationId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/locations/v4/:locationId")
require "http/client"
url = "{{baseUrl}}/locations/v4/:locationId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/locations/v4/:locationId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/locations/v4/:locationId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/locations/v4/:locationId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/locations/v4/:locationId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/locations/v4/:locationId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/locations/v4/:locationId"))
.method("GET", 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}}/locations/v4/:locationId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/locations/v4/:locationId")
.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('GET', '{{baseUrl}}/locations/v4/:locationId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/locations/v4/:locationId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/locations/v4/:locationId';
const options = {method: 'GET'};
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}}/locations/v4/:locationId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/locations/v4/:locationId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/locations/v4/:locationId',
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: 'GET', url: '{{baseUrl}}/locations/v4/:locationId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/locations/v4/:locationId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/locations/v4/:locationId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/locations/v4/:locationId';
const options = {method: 'GET'};
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}}/locations/v4/:locationId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/locations/v4/:locationId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/locations/v4/:locationId",
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;
}
request('GET', '{{baseUrl}}/locations/v4/:locationId');
echo $response->getBody();
setUrl('{{baseUrl}}/locations/v4/:locationId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/locations/v4/:locationId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/locations/v4/:locationId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/locations/v4/:locationId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/locations/v4/:locationId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/locations/v4/:locationId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/locations/v4/:locationId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/locations/v4/:locationId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/locations/v4/:locationId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/locations/v4/:locationId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/locations/v4/:locationId
http GET {{baseUrl}}/locations/v4/:locationId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/locations/v4/:locationId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/locations/v4/:locationId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Rostock Port Hafenbecken C",
"geofenceId": "57713e50-194e-4803-8ca6-1e794e916094",
"location": {
"lat": 54.155147,
"lng": 12.12204
},
"locationId": "LOC-61a3fba0-cb44-405f-816c-c2aec73a1add",
"name": "Rostock Port"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets all locations
{{baseUrl}}/locations/v4
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/locations/v4");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/locations/v4")
require "http/client"
url = "{{baseUrl}}/locations/v4"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/locations/v4"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/locations/v4");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/locations/v4"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/locations/v4 HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/locations/v4")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/locations/v4"))
.method("GET", 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}}/locations/v4")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/locations/v4")
.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('GET', '{{baseUrl}}/locations/v4');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/locations/v4'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/locations/v4';
const options = {method: 'GET'};
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}}/locations/v4',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/locations/v4")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/locations/v4',
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: 'GET', url: '{{baseUrl}}/locations/v4'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/locations/v4');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/locations/v4'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/locations/v4';
const options = {method: 'GET'};
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}}/locations/v4"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/locations/v4" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/locations/v4",
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;
}
request('GET', '{{baseUrl}}/locations/v4');
echo $response->getBody();
setUrl('{{baseUrl}}/locations/v4');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/locations/v4');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/locations/v4' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/locations/v4' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/locations/v4")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/locations/v4"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/locations/v4"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/locations/v4")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/locations/v4') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/locations/v4";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/locations/v4
http GET {{baseUrl}}/locations/v4
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/locations/v4
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/locations/v4")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"items": [
{
"description": "Rostock Port Hafenbecken C",
"geofenceId": "57713e50-194e-4803-8ca6-1e794e916094",
"location": {
"lat": 54.155147,
"lng": 12.12204
},
"locationId": "LOC-61a3fba0-cb44-405f-816c-c2aec73a1add",
"name": "Rostock Port"
}
]
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets service health (9)
{{baseUrl}}/locations/v4/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/locations/v4/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/locations/v4/health")
require "http/client"
url = "{{baseUrl}}/locations/v4/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/locations/v4/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/locations/v4/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/locations/v4/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/locations/v4/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/locations/v4/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/locations/v4/health"))
.method("GET", 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}}/locations/v4/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/locations/v4/health")
.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('GET', '{{baseUrl}}/locations/v4/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/locations/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/locations/v4/health';
const options = {method: 'GET'};
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}}/locations/v4/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/locations/v4/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/locations/v4/health',
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: 'GET', url: '{{baseUrl}}/locations/v4/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/locations/v4/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/locations/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/locations/v4/health';
const options = {method: 'GET'};
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}}/locations/v4/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/locations/v4/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/locations/v4/health",
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;
}
request('GET', '{{baseUrl}}/locations/v4/health');
echo $response->getBody();
setUrl('{{baseUrl}}/locations/v4/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/locations/v4/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/locations/v4/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/locations/v4/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/locations/v4/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/locations/v4/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/locations/v4/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/locations/v4/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/locations/v4/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/locations/v4/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/locations/v4/health
http GET {{baseUrl}}/locations/v4/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/locations/v4/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/locations/v4/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (9)
{{baseUrl}}/locations/v4/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/locations/v4/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/locations/v4/version")
require "http/client"
url = "{{baseUrl}}/locations/v4/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/locations/v4/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/locations/v4/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/locations/v4/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/locations/v4/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/locations/v4/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/locations/v4/version"))
.method("GET", 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}}/locations/v4/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/locations/v4/version")
.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('GET', '{{baseUrl}}/locations/v4/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/locations/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/locations/v4/version';
const options = {method: 'GET'};
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}}/locations/v4/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/locations/v4/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/locations/v4/version',
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: 'GET', url: '{{baseUrl}}/locations/v4/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/locations/v4/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/locations/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/locations/v4/version';
const options = {method: 'GET'};
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}}/locations/v4/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/locations/v4/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/locations/v4/version",
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;
}
request('GET', '{{baseUrl}}/locations/v4/version');
echo $response->getBody();
setUrl('{{baseUrl}}/locations/v4/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/locations/v4/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/locations/v4/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/locations/v4/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/locations/v4/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/locations/v4/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/locations/v4/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/locations/v4/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/locations/v4/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/locations/v4/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/locations/v4/version
http GET {{baseUrl}}/locations/v4/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/locations/v4/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/locations/v4/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
Updates a location details
{{baseUrl}}/locations/v4/:locationId
BODY json
{
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/locations/v4/:locationId");
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 \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/locations/v4/:locationId" {:content-type :json
:form-params {:address {:city ""
:country ""
:postalCode ""
:state ""
:street ""}
:description ""
:externalLocationId ""
:geofenceId ""
:location {:lat ""
:lng ""}
:name ""}})
require "http/client"
url = "{{baseUrl}}/locations/v4/:locationId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/locations/v4/:locationId"),
Content = new StringContent("{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\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}}/locations/v4/:locationId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/locations/v4/:locationId"
payload := strings.NewReader("{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\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/locations/v4/:locationId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 246
{
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/locations/v4/:locationId")
.setHeader("content-type", "application/json")
.setBody("{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/locations/v4/:locationId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\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 \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/locations/v4/:locationId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/locations/v4/:locationId")
.header("content-type", "application/json")
.body("{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}")
.asString();
const data = JSON.stringify({
address: {
city: '',
country: '',
postalCode: '',
state: '',
street: ''
},
description: '',
externalLocationId: '',
geofenceId: '',
location: {
lat: '',
lng: ''
},
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}}/locations/v4/:locationId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/locations/v4/:locationId',
headers: {'content-type': 'application/json'},
data: {
address: {city: '', country: '', postalCode: '', state: '', street: ''},
description: '',
externalLocationId: '',
geofenceId: '',
location: {lat: '', lng: ''},
name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/locations/v4/:locationId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"address":{"city":"","country":"","postalCode":"","state":"","street":""},"description":"","externalLocationId":"","geofenceId":"","location":{"lat":"","lng":""},"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}}/locations/v4/:locationId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "address": {\n "city": "",\n "country": "",\n "postalCode": "",\n "state": "",\n "street": ""\n },\n "description": "",\n "externalLocationId": "",\n "geofenceId": "",\n "location": {\n "lat": "",\n "lng": ""\n },\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 \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/locations/v4/:locationId")
.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/locations/v4/:locationId',
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({
address: {city: '', country: '', postalCode: '', state: '', street: ''},
description: '',
externalLocationId: '',
geofenceId: '',
location: {lat: '', lng: ''},
name: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/locations/v4/:locationId',
headers: {'content-type': 'application/json'},
body: {
address: {city: '', country: '', postalCode: '', state: '', street: ''},
description: '',
externalLocationId: '',
geofenceId: '',
location: {lat: '', lng: ''},
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}}/locations/v4/:locationId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
address: {
city: '',
country: '',
postalCode: '',
state: '',
street: ''
},
description: '',
externalLocationId: '',
geofenceId: '',
location: {
lat: '',
lng: ''
},
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}}/locations/v4/:locationId',
headers: {'content-type': 'application/json'},
data: {
address: {city: '', country: '', postalCode: '', state: '', street: ''},
description: '',
externalLocationId: '',
geofenceId: '',
location: {lat: '', lng: ''},
name: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/locations/v4/:locationId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"address":{"city":"","country":"","postalCode":"","state":"","street":""},"description":"","externalLocationId":"","geofenceId":"","location":{"lat":"","lng":""},"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 = @{ @"address": @{ @"city": @"", @"country": @"", @"postalCode": @"", @"state": @"", @"street": @"" },
@"description": @"",
@"externalLocationId": @"",
@"geofenceId": @"",
@"location": @{ @"lat": @"", @"lng": @"" },
@"name": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/locations/v4/:locationId"]
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}}/locations/v4/:locationId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/locations/v4/:locationId",
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([
'address' => [
'city' => '',
'country' => '',
'postalCode' => '',
'state' => '',
'street' => ''
],
'description' => '',
'externalLocationId' => '',
'geofenceId' => '',
'location' => [
'lat' => '',
'lng' => ''
],
'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}}/locations/v4/:locationId', [
'body' => '{
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/locations/v4/:locationId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'address' => [
'city' => '',
'country' => '',
'postalCode' => '',
'state' => '',
'street' => ''
],
'description' => '',
'externalLocationId' => '',
'geofenceId' => '',
'location' => [
'lat' => '',
'lng' => ''
],
'name' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'address' => [
'city' => '',
'country' => '',
'postalCode' => '',
'state' => '',
'street' => ''
],
'description' => '',
'externalLocationId' => '',
'geofenceId' => '',
'location' => [
'lat' => '',
'lng' => ''
],
'name' => ''
]));
$request->setRequestUrl('{{baseUrl}}/locations/v4/:locationId');
$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}}/locations/v4/:locationId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/locations/v4/:locationId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/locations/v4/:locationId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/locations/v4/:locationId"
payload = {
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/locations/v4/:locationId"
payload <- "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\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}}/locations/v4/:locationId")
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 \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/locations/v4/:locationId') do |req|
req.body = "{\n \"address\": {\n \"city\": \"\",\n \"country\": \"\",\n \"postalCode\": \"\",\n \"state\": \"\",\n \"street\": \"\"\n },\n \"description\": \"\",\n \"externalLocationId\": \"\",\n \"geofenceId\": \"\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/locations/v4/:locationId";
let payload = json!({
"address": json!({
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
}),
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": json!({
"lat": "",
"lng": ""
}),
"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}}/locations/v4/:locationId \
--header 'content-type: application/json' \
--data '{
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}'
echo '{
"address": {
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
},
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": {
"lat": "",
"lng": ""
},
"name": ""
}' | \
http PUT {{baseUrl}}/locations/v4/:locationId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "address": {\n "city": "",\n "country": "",\n "postalCode": "",\n "state": "",\n "street": ""\n },\n "description": "",\n "externalLocationId": "",\n "geofenceId": "",\n "location": {\n "lat": "",\n "lng": ""\n },\n "name": ""\n}' \
--output-document \
- {{baseUrl}}/locations/v4/:locationId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"address": [
"city": "",
"country": "",
"postalCode": "",
"state": "",
"street": ""
],
"description": "",
"externalLocationId": "",
"geofenceId": "",
"location": [
"lat": "",
"lng": ""
],
"name": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/locations/v4/:locationId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "Rostock Port Hafenbecken C",
"geofenceId": "57713e50-194e-4803-8ca6-1e794e916094",
"location": {
"lat": 54.155147,
"lng": 12.12204
},
"locationId": "LOC-61a3fba0-cb44-405f-816c-c2aec73a1add",
"name": "Rostock Port"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
PUT
Creates or updates metadata of a device or a shipment
{{baseUrl}}/metadata/v2/devices/:trackingId
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata/v2/devices/:trackingId");
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, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/metadata/v2/devices/:trackingId" {:content-type :json})
require "http/client"
url = "{{baseUrl}}/metadata/v2/devices/:trackingId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/metadata/v2/devices/:trackingId"),
Content = new StringContent("{}")
{
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}}/metadata/v2/devices/:trackingId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata/v2/devices/:trackingId"
payload := strings.NewReader("{}")
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/metadata/v2/devices/:trackingId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/metadata/v2/devices/:trackingId")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata/v2/devices/:trackingId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
.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, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/metadata/v2/devices/:trackingId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/metadata/v2/devices/:trackingId")
.header("content-type", "application/json")
.body("{}")
.asString();
const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/metadata/v2/devices/:trackingId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/metadata/v2/devices/:trackingId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata/v2/devices/:trackingId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
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}}/metadata/v2/devices/:trackingId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/metadata/v2/devices/:trackingId")
.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/metadata/v2/devices/:trackingId',
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({}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/metadata/v2/devices/:trackingId',
headers: {'content-type': 'application/json'},
body: {},
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}}/metadata/v2/devices/:trackingId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
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}}/metadata/v2/devices/:trackingId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata/v2/devices/:trackingId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
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 = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata/v2/devices/:trackingId"]
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}}/metadata/v2/devices/:trackingId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata/v2/devices/:trackingId",
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([
]),
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}}/metadata/v2/devices/:trackingId', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/metadata/v2/devices/:trackingId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/metadata/v2/devices/:trackingId');
$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}}/metadata/v2/devices/:trackingId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata/v2/devices/:trackingId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/metadata/v2/devices/:trackingId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata/v2/devices/:trackingId"
payload = {}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata/v2/devices/:trackingId"
payload <- "{}"
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}}/metadata/v2/devices/:trackingId")
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 = "{}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/metadata/v2/devices/:trackingId') do |req|
req.body = "{}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata/v2/devices/:trackingId";
let payload = json!({});
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}}/metadata/v2/devices/:trackingId \
--header 'content-type: application/json' \
--data '{}'
echo '{}' | \
http PUT {{baseUrl}}/metadata/v2/devices/:trackingId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/metadata/v2/devices/:trackingId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata/v2/devices/:trackingId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"priority": "high"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
PUT
Creates or updates metadata of a geofence
{{baseUrl}}/metadata/v2/geofences/:geofenceId
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata/v2/geofences/:geofenceId");
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, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/metadata/v2/geofences/:geofenceId" {:content-type :json})
require "http/client"
url = "{{baseUrl}}/metadata/v2/geofences/:geofenceId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/metadata/v2/geofences/:geofenceId"),
Content = new StringContent("{}")
{
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}}/metadata/v2/geofences/:geofenceId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata/v2/geofences/:geofenceId"
payload := strings.NewReader("{}")
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/metadata/v2/geofences/:geofenceId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/metadata/v2/geofences/:geofenceId")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata/v2/geofences/:geofenceId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
.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, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/metadata/v2/geofences/:geofenceId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/metadata/v2/geofences/:geofenceId")
.header("content-type", "application/json")
.body("{}")
.asString();
const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/metadata/v2/geofences/:geofenceId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/metadata/v2/geofences/:geofenceId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata/v2/geofences/:geofenceId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
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}}/metadata/v2/geofences/:geofenceId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/metadata/v2/geofences/:geofenceId")
.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/metadata/v2/geofences/:geofenceId',
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({}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/metadata/v2/geofences/:geofenceId',
headers: {'content-type': 'application/json'},
body: {},
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}}/metadata/v2/geofences/:geofenceId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
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}}/metadata/v2/geofences/:geofenceId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata/v2/geofences/:geofenceId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
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 = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata/v2/geofences/:geofenceId"]
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}}/metadata/v2/geofences/:geofenceId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata/v2/geofences/:geofenceId",
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([
]),
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}}/metadata/v2/geofences/:geofenceId', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/metadata/v2/geofences/:geofenceId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/metadata/v2/geofences/:geofenceId');
$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}}/metadata/v2/geofences/:geofenceId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata/v2/geofences/:geofenceId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/metadata/v2/geofences/:geofenceId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata/v2/geofences/:geofenceId"
payload = {}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata/v2/geofences/:geofenceId"
payload <- "{}"
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}}/metadata/v2/geofences/:geofenceId")
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 = "{}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/metadata/v2/geofences/:geofenceId') do |req|
req.body = "{}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata/v2/geofences/:geofenceId";
let payload = json!({});
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}}/metadata/v2/geofences/:geofenceId \
--header 'content-type: application/json' \
--data '{}'
echo '{}' | \
http PUT {{baseUrl}}/metadata/v2/geofences/:geofenceId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/metadata/v2/geofences/:geofenceId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata/v2/geofences/:geofenceId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"priority": "high"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
PUT
Creates or updates metadata of a sensor rule
{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId");
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, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId" {:content-type :json})
require "http/client"
url = "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"),
Content = new StringContent("{}")
{
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}}/metadata/v2/sensorRules/:sensorRuleId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"
payload := strings.NewReader("{}")
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/metadata/v2/sensorRules/:sensorRuleId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{}"))
.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, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")
.header("content-type", "application/json")
.body("{}")
.asString();
const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
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}}/metadata/v2/sensorRules/:sensorRuleId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")
.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/metadata/v2/sensorRules/:sensorRuleId',
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({}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId',
headers: {'content-type': 'application/json'},
body: {},
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}}/metadata/v2/sensorRules/:sensorRuleId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
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}}/metadata/v2/sensorRules/:sensorRuleId',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId';
const options = {method: 'PUT', headers: {'content-type': 'application/json'}, body: '{}'};
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 = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"]
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}}/metadata/v2/sensorRules/:sensorRuleId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId",
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([
]),
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}}/metadata/v2/sensorRules/:sensorRuleId', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId');
$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}}/metadata/v2/sensorRules/:sensorRuleId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/metadata/v2/sensorRules/:sensorRuleId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"
payload = {}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"
payload <- "{}"
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}}/metadata/v2/sensorRules/:sensorRuleId")
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 = "{}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/metadata/v2/sensorRules/:sensorRuleId') do |req|
req.body = "{}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId";
let payload = json!({});
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}}/metadata/v2/sensorRules/:sensorRuleId \
--header 'content-type: application/json' \
--data '{}'
echo '{}' | \
http PUT {{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"priority": "high"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Deletes all metadata of a device or a shipment
{{baseUrl}}/metadata/v2/devices/:trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata/v2/devices/:trackingId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/metadata/v2/devices/:trackingId")
require "http/client"
url = "{{baseUrl}}/metadata/v2/devices/:trackingId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/metadata/v2/devices/:trackingId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata/v2/devices/:trackingId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata/v2/devices/:trackingId"
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/metadata/v2/devices/:trackingId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/metadata/v2/devices/:trackingId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata/v2/devices/:trackingId"))
.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}}/metadata/v2/devices/:trackingId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/metadata/v2/devices/:trackingId")
.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}}/metadata/v2/devices/:trackingId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/metadata/v2/devices/:trackingId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata/v2/devices/:trackingId';
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}}/metadata/v2/devices/:trackingId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata/v2/devices/:trackingId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata/v2/devices/:trackingId',
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}}/metadata/v2/devices/:trackingId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/metadata/v2/devices/:trackingId');
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}}/metadata/v2/devices/:trackingId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata/v2/devices/:trackingId';
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}}/metadata/v2/devices/:trackingId"]
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}}/metadata/v2/devices/:trackingId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata/v2/devices/:trackingId",
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}}/metadata/v2/devices/:trackingId');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata/v2/devices/:trackingId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata/v2/devices/:trackingId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata/v2/devices/:trackingId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata/v2/devices/:trackingId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/metadata/v2/devices/:trackingId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata/v2/devices/:trackingId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata/v2/devices/:trackingId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata/v2/devices/:trackingId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/metadata/v2/devices/:trackingId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata/v2/devices/:trackingId";
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}}/metadata/v2/devices/:trackingId
http DELETE {{baseUrl}}/metadata/v2/devices/:trackingId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/metadata/v2/devices/:trackingId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata/v2/devices/:trackingId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Deletes all metadata of a geofence
{{baseUrl}}/metadata/v2/geofences/:geofenceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata/v2/geofences/:geofenceId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/metadata/v2/geofences/:geofenceId")
require "http/client"
url = "{{baseUrl}}/metadata/v2/geofences/:geofenceId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/metadata/v2/geofences/:geofenceId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata/v2/geofences/:geofenceId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata/v2/geofences/:geofenceId"
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/metadata/v2/geofences/:geofenceId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/metadata/v2/geofences/:geofenceId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata/v2/geofences/:geofenceId"))
.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}}/metadata/v2/geofences/:geofenceId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/metadata/v2/geofences/:geofenceId")
.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}}/metadata/v2/geofences/:geofenceId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/metadata/v2/geofences/:geofenceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata/v2/geofences/:geofenceId';
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}}/metadata/v2/geofences/:geofenceId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata/v2/geofences/:geofenceId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata/v2/geofences/:geofenceId',
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}}/metadata/v2/geofences/:geofenceId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/metadata/v2/geofences/:geofenceId');
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}}/metadata/v2/geofences/:geofenceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata/v2/geofences/:geofenceId';
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}}/metadata/v2/geofences/:geofenceId"]
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}}/metadata/v2/geofences/:geofenceId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata/v2/geofences/:geofenceId",
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}}/metadata/v2/geofences/:geofenceId');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata/v2/geofences/:geofenceId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata/v2/geofences/:geofenceId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata/v2/geofences/:geofenceId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata/v2/geofences/:geofenceId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/metadata/v2/geofences/:geofenceId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata/v2/geofences/:geofenceId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata/v2/geofences/:geofenceId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata/v2/geofences/:geofenceId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/metadata/v2/geofences/:geofenceId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata/v2/geofences/:geofenceId";
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}}/metadata/v2/geofences/:geofenceId
http DELETE {{baseUrl}}/metadata/v2/geofences/:geofenceId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/metadata/v2/geofences/:geofenceId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata/v2/geofences/:geofenceId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Deletes all metadata of a sensor rule
{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")
require "http/client"
url = "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"
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/metadata/v2/sensorRules/:sensorRuleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"))
.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}}/metadata/v2/sensorRules/:sensorRuleId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")
.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}}/metadata/v2/sensorRules/:sensorRuleId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId';
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}}/metadata/v2/sensorRules/:sensorRuleId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata/v2/sensorRules/:sensorRuleId',
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}}/metadata/v2/sensorRules/:sensorRuleId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId');
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}}/metadata/v2/sensorRules/:sensorRuleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId';
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}}/metadata/v2/sensorRules/:sensorRuleId"]
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}}/metadata/v2/sensorRules/:sensorRuleId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId",
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}}/metadata/v2/sensorRules/:sensorRuleId');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/metadata/v2/sensorRules/:sensorRuleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/metadata/v2/sensorRules/:sensorRuleId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId";
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}}/metadata/v2/sensorRules/:sensorRuleId
http DELETE {{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
POST
Gets a batch of metadata for multiple sensor rules
{{baseUrl}}/metadata/v2/sensorRules/batch
BODY json
[
{}
]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata/v2/sensorRules/batch");
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 {}\n]");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/metadata/v2/sensorRules/batch" {:content-type :json
:form-params [{}]})
require "http/client"
url = "{{baseUrl}}/metadata/v2/sensorRules/batch"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "[\n {}\n]"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/metadata/v2/sensorRules/batch"),
Content = new StringContent("[\n {}\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}}/metadata/v2/sensorRules/batch");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "[\n {}\n]", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata/v2/sensorRules/batch"
payload := strings.NewReader("[\n {}\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/metadata/v2/sensorRules/batch HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 8
[
{}
]
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/metadata/v2/sensorRules/batch")
.setHeader("content-type", "application/json")
.setBody("[\n {}\n]")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata/v2/sensorRules/batch"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("[\n {}\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 {}\n]");
Request request = new Request.Builder()
.url("{{baseUrl}}/metadata/v2/sensorRules/batch")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/metadata/v2/sensorRules/batch")
.header("content-type", "application/json")
.body("[\n {}\n]")
.asString();
const data = JSON.stringify([
{}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/metadata/v2/sensorRules/batch');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata/v2/sensorRules/batch',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata/v2/sensorRules/batch';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '[{}]'};
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}}/metadata/v2/sensorRules/batch',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '[\n {}\n]'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "[\n {}\n]")
val request = Request.Builder()
.url("{{baseUrl}}/metadata/v2/sensorRules/batch")
.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/metadata/v2/sensorRules/batch',
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([{}]));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata/v2/sensorRules/batch',
headers: {'content-type': 'application/json'},
body: [{}],
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}}/metadata/v2/sensorRules/batch');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send([
{}
]);
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}}/metadata/v2/sensorRules/batch',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata/v2/sensorRules/batch';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '[{}]'};
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 = @[ @{ } ];
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata/v2/sensorRules/batch"]
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}}/metadata/v2/sensorRules/batch" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "[\n {}\n]" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata/v2/sensorRules/batch",
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([
[
]
]),
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}}/metadata/v2/sensorRules/batch', [
'body' => '[
{}
]',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/metadata/v2/sensorRules/batch');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
[
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
[
]
]));
$request->setRequestUrl('{{baseUrl}}/metadata/v2/sensorRules/batch');
$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}}/metadata/v2/sensorRules/batch' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{}
]'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata/v2/sensorRules/batch' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{}
]'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "[\n {}\n]"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/metadata/v2/sensorRules/batch", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata/v2/sensorRules/batch"
payload = [{}]
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata/v2/sensorRules/batch"
payload <- "[\n {}\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}}/metadata/v2/sensorRules/batch")
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 {}\n]"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/metadata/v2/sensorRules/batch') do |req|
req.body = "[\n {}\n]"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata/v2/sensorRules/batch";
let payload = (json!({}));
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}}/metadata/v2/sensorRules/batch \
--header 'content-type: application/json' \
--data '[
{}
]'
echo '[
{}
]' | \
http POST {{baseUrl}}/metadata/v2/sensorRules/batch \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '[\n {}\n]' \
--output-document \
- {{baseUrl}}/metadata/v2/sensorRules/batch
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [[]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata/v2/sensorRules/batch")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 2,
"data": [
{
"data": {
"blob": "SEVSRSBUcmFja2luZw=="
},
"id": "3b10404d-4e9e-456b-b262-5e98dd39d9c3"
},
{
"data": {
"externalId": "EXT-1234"
},
"id": "3b10404d-4e9e-456b-b262-5e98dd39d9c3"
}
],
"pageToken": "018ffffea253d64ba"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
POST
Gets a batch of metadata of multiple devices or shipments
{{baseUrl}}/metadata/v2/devices/batch
BODY json
[
{}
]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata/v2/devices/batch");
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 {}\n]");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/metadata/v2/devices/batch" {:content-type :json
:form-params [{}]})
require "http/client"
url = "{{baseUrl}}/metadata/v2/devices/batch"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "[\n {}\n]"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/metadata/v2/devices/batch"),
Content = new StringContent("[\n {}\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}}/metadata/v2/devices/batch");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "[\n {}\n]", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata/v2/devices/batch"
payload := strings.NewReader("[\n {}\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/metadata/v2/devices/batch HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 8
[
{}
]
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/metadata/v2/devices/batch")
.setHeader("content-type", "application/json")
.setBody("[\n {}\n]")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata/v2/devices/batch"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("[\n {}\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 {}\n]");
Request request = new Request.Builder()
.url("{{baseUrl}}/metadata/v2/devices/batch")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/metadata/v2/devices/batch")
.header("content-type", "application/json")
.body("[\n {}\n]")
.asString();
const data = JSON.stringify([
{}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/metadata/v2/devices/batch');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata/v2/devices/batch',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata/v2/devices/batch';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '[{}]'};
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}}/metadata/v2/devices/batch',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '[\n {}\n]'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "[\n {}\n]")
val request = Request.Builder()
.url("{{baseUrl}}/metadata/v2/devices/batch")
.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/metadata/v2/devices/batch',
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([{}]));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata/v2/devices/batch',
headers: {'content-type': 'application/json'},
body: [{}],
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}}/metadata/v2/devices/batch');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send([
{}
]);
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}}/metadata/v2/devices/batch',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata/v2/devices/batch';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '[{}]'};
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 = @[ @{ } ];
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata/v2/devices/batch"]
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}}/metadata/v2/devices/batch" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "[\n {}\n]" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata/v2/devices/batch",
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([
[
]
]),
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}}/metadata/v2/devices/batch', [
'body' => '[
{}
]',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/metadata/v2/devices/batch');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
[
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
[
]
]));
$request->setRequestUrl('{{baseUrl}}/metadata/v2/devices/batch');
$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}}/metadata/v2/devices/batch' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{}
]'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata/v2/devices/batch' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{}
]'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "[\n {}\n]"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/metadata/v2/devices/batch", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata/v2/devices/batch"
payload = [{}]
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata/v2/devices/batch"
payload <- "[\n {}\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}}/metadata/v2/devices/batch")
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 {}\n]"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/metadata/v2/devices/batch') do |req|
req.body = "[\n {}\n]"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata/v2/devices/batch";
let payload = (json!({}));
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}}/metadata/v2/devices/batch \
--header 'content-type: application/json' \
--data '[
{}
]'
echo '[
{}
]' | \
http POST {{baseUrl}}/metadata/v2/devices/batch \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '[\n {}\n]' \
--output-document \
- {{baseUrl}}/metadata/v2/devices/batch
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [[]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata/v2/devices/batch")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
POST
Gets a batch of metadata of multiple geofences
{{baseUrl}}/metadata/v2/geofences/batch
BODY json
[
{}
]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata/v2/geofences/batch");
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 {}\n]");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/metadata/v2/geofences/batch" {:content-type :json
:form-params [{}]})
require "http/client"
url = "{{baseUrl}}/metadata/v2/geofences/batch"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "[\n {}\n]"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/metadata/v2/geofences/batch"),
Content = new StringContent("[\n {}\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}}/metadata/v2/geofences/batch");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "[\n {}\n]", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata/v2/geofences/batch"
payload := strings.NewReader("[\n {}\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/metadata/v2/geofences/batch HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 8
[
{}
]
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/metadata/v2/geofences/batch")
.setHeader("content-type", "application/json")
.setBody("[\n {}\n]")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata/v2/geofences/batch"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("[\n {}\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 {}\n]");
Request request = new Request.Builder()
.url("{{baseUrl}}/metadata/v2/geofences/batch")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/metadata/v2/geofences/batch")
.header("content-type", "application/json")
.body("[\n {}\n]")
.asString();
const data = JSON.stringify([
{}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/metadata/v2/geofences/batch');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata/v2/geofences/batch',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata/v2/geofences/batch';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '[{}]'};
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}}/metadata/v2/geofences/batch',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '[\n {}\n]'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "[\n {}\n]")
val request = Request.Builder()
.url("{{baseUrl}}/metadata/v2/geofences/batch")
.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/metadata/v2/geofences/batch',
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([{}]));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/metadata/v2/geofences/batch',
headers: {'content-type': 'application/json'},
body: [{}],
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}}/metadata/v2/geofences/batch');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send([
{}
]);
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}}/metadata/v2/geofences/batch',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata/v2/geofences/batch';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '[{}]'};
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 = @[ @{ } ];
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/metadata/v2/geofences/batch"]
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}}/metadata/v2/geofences/batch" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "[\n {}\n]" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata/v2/geofences/batch",
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([
[
]
]),
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}}/metadata/v2/geofences/batch', [
'body' => '[
{}
]',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/metadata/v2/geofences/batch');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
[
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
[
]
]));
$request->setRequestUrl('{{baseUrl}}/metadata/v2/geofences/batch');
$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}}/metadata/v2/geofences/batch' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{}
]'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata/v2/geofences/batch' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{}
]'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "[\n {}\n]"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/metadata/v2/geofences/batch", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata/v2/geofences/batch"
payload = [{}]
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata/v2/geofences/batch"
payload <- "[\n {}\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}}/metadata/v2/geofences/batch")
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 {}\n]"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/metadata/v2/geofences/batch') do |req|
req.body = "[\n {}\n]"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata/v2/geofences/batch";
let payload = (json!({}));
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}}/metadata/v2/geofences/batch \
--header 'content-type: application/json' \
--data '[
{}
]'
echo '[
{}
]' | \
http POST {{baseUrl}}/metadata/v2/geofences/batch \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '[\n {}\n]' \
--output-document \
- {{baseUrl}}/metadata/v2/geofences/batch
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [[]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata/v2/geofences/batch")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets metadata of a device or a shipment
{{baseUrl}}/metadata/v2/devices/:trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata/v2/devices/:trackingId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/metadata/v2/devices/:trackingId")
require "http/client"
url = "{{baseUrl}}/metadata/v2/devices/:trackingId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/metadata/v2/devices/:trackingId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata/v2/devices/:trackingId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata/v2/devices/:trackingId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/metadata/v2/devices/:trackingId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/metadata/v2/devices/:trackingId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata/v2/devices/:trackingId"))
.method("GET", 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}}/metadata/v2/devices/:trackingId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/metadata/v2/devices/:trackingId")
.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('GET', '{{baseUrl}}/metadata/v2/devices/:trackingId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/metadata/v2/devices/:trackingId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata/v2/devices/:trackingId';
const options = {method: 'GET'};
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}}/metadata/v2/devices/:trackingId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata/v2/devices/:trackingId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata/v2/devices/:trackingId',
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: 'GET',
url: '{{baseUrl}}/metadata/v2/devices/:trackingId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/metadata/v2/devices/:trackingId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/metadata/v2/devices/:trackingId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata/v2/devices/:trackingId';
const options = {method: 'GET'};
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}}/metadata/v2/devices/:trackingId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/metadata/v2/devices/:trackingId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata/v2/devices/:trackingId",
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;
}
request('GET', '{{baseUrl}}/metadata/v2/devices/:trackingId');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata/v2/devices/:trackingId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata/v2/devices/:trackingId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata/v2/devices/:trackingId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata/v2/devices/:trackingId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/metadata/v2/devices/:trackingId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata/v2/devices/:trackingId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata/v2/devices/:trackingId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata/v2/devices/:trackingId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/metadata/v2/devices/:trackingId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata/v2/devices/:trackingId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/metadata/v2/devices/:trackingId
http GET {{baseUrl}}/metadata/v2/devices/:trackingId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/metadata/v2/devices/:trackingId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata/v2/devices/:trackingId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"priority": "high"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets metadata of a geofence
{{baseUrl}}/metadata/v2/geofences/:geofenceId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata/v2/geofences/:geofenceId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/metadata/v2/geofences/:geofenceId")
require "http/client"
url = "{{baseUrl}}/metadata/v2/geofences/:geofenceId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/metadata/v2/geofences/:geofenceId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata/v2/geofences/:geofenceId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata/v2/geofences/:geofenceId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/metadata/v2/geofences/:geofenceId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/metadata/v2/geofences/:geofenceId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata/v2/geofences/:geofenceId"))
.method("GET", 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}}/metadata/v2/geofences/:geofenceId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/metadata/v2/geofences/:geofenceId")
.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('GET', '{{baseUrl}}/metadata/v2/geofences/:geofenceId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/metadata/v2/geofences/:geofenceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata/v2/geofences/:geofenceId';
const options = {method: 'GET'};
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}}/metadata/v2/geofences/:geofenceId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata/v2/geofences/:geofenceId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata/v2/geofences/:geofenceId',
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: 'GET',
url: '{{baseUrl}}/metadata/v2/geofences/:geofenceId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/metadata/v2/geofences/:geofenceId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/metadata/v2/geofences/:geofenceId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata/v2/geofences/:geofenceId';
const options = {method: 'GET'};
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}}/metadata/v2/geofences/:geofenceId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/metadata/v2/geofences/:geofenceId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata/v2/geofences/:geofenceId",
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;
}
request('GET', '{{baseUrl}}/metadata/v2/geofences/:geofenceId');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata/v2/geofences/:geofenceId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata/v2/geofences/:geofenceId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata/v2/geofences/:geofenceId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata/v2/geofences/:geofenceId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/metadata/v2/geofences/:geofenceId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata/v2/geofences/:geofenceId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata/v2/geofences/:geofenceId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata/v2/geofences/:geofenceId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/metadata/v2/geofences/:geofenceId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata/v2/geofences/:geofenceId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/metadata/v2/geofences/:geofenceId
http GET {{baseUrl}}/metadata/v2/geofences/:geofenceId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/metadata/v2/geofences/:geofenceId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata/v2/geofences/:geofenceId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"priority": "high"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets metadata of a sensor rule
{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")
require "http/client"
url = "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/metadata/v2/sensorRules/:sensorRuleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"))
.method("GET", 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}}/metadata/v2/sensorRules/:sensorRuleId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")
.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('GET', '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId';
const options = {method: 'GET'};
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}}/metadata/v2/sensorRules/:sensorRuleId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata/v2/sensorRules/:sensorRuleId',
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: 'GET',
url: '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId';
const options = {method: 'GET'};
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}}/metadata/v2/sensorRules/:sensorRuleId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/metadata/v2/sensorRules/:sensorRuleId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId",
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;
}
request('GET', '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/metadata/v2/sensorRules/:sensorRuleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/metadata/v2/sensorRules/:sensorRuleId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId
http GET {{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata/v2/sensorRules/:sensorRuleId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"data": {
"priority": "high"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets service health (10)
{{baseUrl}}/metadata/v2/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata/v2/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/metadata/v2/health")
require "http/client"
url = "{{baseUrl}}/metadata/v2/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/metadata/v2/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata/v2/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata/v2/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/metadata/v2/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/metadata/v2/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata/v2/health"))
.method("GET", 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}}/metadata/v2/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/metadata/v2/health")
.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('GET', '{{baseUrl}}/metadata/v2/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/metadata/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata/v2/health';
const options = {method: 'GET'};
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}}/metadata/v2/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata/v2/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata/v2/health',
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: 'GET', url: '{{baseUrl}}/metadata/v2/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/metadata/v2/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/metadata/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata/v2/health';
const options = {method: 'GET'};
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}}/metadata/v2/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/metadata/v2/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata/v2/health",
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;
}
request('GET', '{{baseUrl}}/metadata/v2/health');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata/v2/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata/v2/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata/v2/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata/v2/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/metadata/v2/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata/v2/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata/v2/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata/v2/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/metadata/v2/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata/v2/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/metadata/v2/health
http GET {{baseUrl}}/metadata/v2/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/metadata/v2/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata/v2/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (10)
{{baseUrl}}/metadata/v2/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/metadata/v2/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/metadata/v2/version")
require "http/client"
url = "{{baseUrl}}/metadata/v2/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/metadata/v2/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/metadata/v2/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/metadata/v2/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/metadata/v2/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/metadata/v2/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/metadata/v2/version"))
.method("GET", 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}}/metadata/v2/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/metadata/v2/version")
.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('GET', '{{baseUrl}}/metadata/v2/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/metadata/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/metadata/v2/version';
const options = {method: 'GET'};
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}}/metadata/v2/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/metadata/v2/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/metadata/v2/version',
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: 'GET', url: '{{baseUrl}}/metadata/v2/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/metadata/v2/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/metadata/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/metadata/v2/version';
const options = {method: 'GET'};
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}}/metadata/v2/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/metadata/v2/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/metadata/v2/version",
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;
}
request('GET', '{{baseUrl}}/metadata/v2/version');
echo $response->getBody();
setUrl('{{baseUrl}}/metadata/v2/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/metadata/v2/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/metadata/v2/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/metadata/v2/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/metadata/v2/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/metadata/v2/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/metadata/v2/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/metadata/v2/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/metadata/v2/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/metadata/v2/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/metadata/v2/version
http GET {{baseUrl}}/metadata/v2/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/metadata/v2/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/metadata/v2/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets a single notification channel information
{{baseUrl}}/notifications/v3/registration/:channelId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notifications/v3/registration/:channelId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/notifications/v3/registration/:channelId")
require "http/client"
url = "{{baseUrl}}/notifications/v3/registration/:channelId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/notifications/v3/registration/:channelId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notifications/v3/registration/:channelId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notifications/v3/registration/:channelId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/notifications/v3/registration/:channelId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/notifications/v3/registration/:channelId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notifications/v3/registration/:channelId"))
.method("GET", 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}}/notifications/v3/registration/:channelId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/notifications/v3/registration/:channelId")
.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('GET', '{{baseUrl}}/notifications/v3/registration/:channelId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/notifications/v3/registration/:channelId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notifications/v3/registration/:channelId';
const options = {method: 'GET'};
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}}/notifications/v3/registration/:channelId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notifications/v3/registration/:channelId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/notifications/v3/registration/:channelId',
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: 'GET',
url: '{{baseUrl}}/notifications/v3/registration/:channelId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/notifications/v3/registration/:channelId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/notifications/v3/registration/:channelId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notifications/v3/registration/:channelId';
const options = {method: 'GET'};
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}}/notifications/v3/registration/:channelId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/notifications/v3/registration/:channelId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notifications/v3/registration/:channelId",
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;
}
request('GET', '{{baseUrl}}/notifications/v3/registration/:channelId');
echo $response->getBody();
setUrl('{{baseUrl}}/notifications/v3/registration/:channelId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notifications/v3/registration/:channelId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notifications/v3/registration/:channelId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notifications/v3/registration/:channelId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/notifications/v3/registration/:channelId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notifications/v3/registration/:channelId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notifications/v3/registration/:channelId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notifications/v3/registration/:channelId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/notifications/v3/registration/:channelId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notifications/v3/registration/:channelId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/notifications/v3/registration/:channelId
http GET {{baseUrl}}/notifications/v3/registration/:channelId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/notifications/v3/registration/:channelId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notifications/v3/registration/:channelId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "The channel ID was not found."
}
GET
Gets all registered notification channels
{{baseUrl}}/notifications/v3/registrations
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notifications/v3/registrations");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/notifications/v3/registrations")
require "http/client"
url = "{{baseUrl}}/notifications/v3/registrations"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/notifications/v3/registrations"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notifications/v3/registrations");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notifications/v3/registrations"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/notifications/v3/registrations HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/notifications/v3/registrations")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notifications/v3/registrations"))
.method("GET", 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}}/notifications/v3/registrations")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/notifications/v3/registrations")
.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('GET', '{{baseUrl}}/notifications/v3/registrations');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/notifications/v3/registrations'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notifications/v3/registrations';
const options = {method: 'GET'};
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}}/notifications/v3/registrations',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notifications/v3/registrations")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/notifications/v3/registrations',
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: 'GET',
url: '{{baseUrl}}/notifications/v3/registrations'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/notifications/v3/registrations');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/notifications/v3/registrations'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notifications/v3/registrations';
const options = {method: 'GET'};
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}}/notifications/v3/registrations"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/notifications/v3/registrations" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notifications/v3/registrations",
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;
}
request('GET', '{{baseUrl}}/notifications/v3/registrations');
echo $response->getBody();
setUrl('{{baseUrl}}/notifications/v3/registrations');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notifications/v3/registrations');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notifications/v3/registrations' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notifications/v3/registrations' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/notifications/v3/registrations")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notifications/v3/registrations"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notifications/v3/registrations"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notifications/v3/registrations")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/notifications/v3/registrations') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notifications/v3/registrations";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/notifications/v3/registrations
http GET {{baseUrl}}/notifications/v3/registrations
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/notifications/v3/registrations
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notifications/v3/registrations")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 3,
"data": [
{
"channelId": "11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000",
"channelType": "webhook",
"url": "https://example.com/call/this/web/hook1"
},
{
"channelId": "97870f23-36cb-440f-96ef-38992d0b4ctd",
"channelType": "webhook",
"eventSource": "battery",
"eventType": "BELOW_RANGE",
"initialState": "false",
"ruleId": "a3f652bc-a456-7f12-cd11-123ah761yt41",
"url": "https://example.com/call/this/web/hook2"
},
{
"channelId": "b6b07cae-db4c-49c1-b353-93c8dfc09453",
"channelType": "email",
"emailBounce": "false",
"ruleId": "e0abbb7c-3bd7-4428-a576-7a9f347a82f3",
"userId": "HERE-f51801ff-61c9-45b7-8f04-ecc68b6a7959"
}
],
"pageToken": "1490376144514"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets service health (11)
{{baseUrl}}/notifications/v3/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notifications/v3/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/notifications/v3/health")
require "http/client"
url = "{{baseUrl}}/notifications/v3/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/notifications/v3/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notifications/v3/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notifications/v3/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/notifications/v3/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/notifications/v3/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notifications/v3/health"))
.method("GET", 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}}/notifications/v3/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/notifications/v3/health")
.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('GET', '{{baseUrl}}/notifications/v3/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/notifications/v3/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notifications/v3/health';
const options = {method: 'GET'};
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}}/notifications/v3/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notifications/v3/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/notifications/v3/health',
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: 'GET', url: '{{baseUrl}}/notifications/v3/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/notifications/v3/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/notifications/v3/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notifications/v3/health';
const options = {method: 'GET'};
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}}/notifications/v3/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/notifications/v3/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notifications/v3/health",
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;
}
request('GET', '{{baseUrl}}/notifications/v3/health');
echo $response->getBody();
setUrl('{{baseUrl}}/notifications/v3/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notifications/v3/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notifications/v3/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notifications/v3/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/notifications/v3/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notifications/v3/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notifications/v3/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notifications/v3/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/notifications/v3/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notifications/v3/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/notifications/v3/health
http GET {{baseUrl}}/notifications/v3/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/notifications/v3/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notifications/v3/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (11)
{{baseUrl}}/notifications/v3/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notifications/v3/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/notifications/v3/version")
require "http/client"
url = "{{baseUrl}}/notifications/v3/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/notifications/v3/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notifications/v3/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notifications/v3/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/notifications/v3/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/notifications/v3/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notifications/v3/version"))
.method("GET", 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}}/notifications/v3/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/notifications/v3/version")
.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('GET', '{{baseUrl}}/notifications/v3/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/notifications/v3/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notifications/v3/version';
const options = {method: 'GET'};
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}}/notifications/v3/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notifications/v3/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/notifications/v3/version',
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: 'GET', url: '{{baseUrl}}/notifications/v3/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/notifications/v3/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/notifications/v3/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notifications/v3/version';
const options = {method: 'GET'};
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}}/notifications/v3/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/notifications/v3/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notifications/v3/version",
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;
}
request('GET', '{{baseUrl}}/notifications/v3/version');
echo $response->getBody();
setUrl('{{baseUrl}}/notifications/v3/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notifications/v3/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notifications/v3/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notifications/v3/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/notifications/v3/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notifications/v3/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notifications/v3/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notifications/v3/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/notifications/v3/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notifications/v3/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/notifications/v3/version
http GET {{baseUrl}}/notifications/v3/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/notifications/v3/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notifications/v3/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
Registers for notifications
{{baseUrl}}/notifications/v3/registrations
BODY json
{
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notifications/v3/registrations");
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 \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/notifications/v3/registrations" {:content-type :json
:form-params {:channelType ""
:eventSource ""
:eventType ""
:initialState false
:ruleId ""
:url ""}})
require "http/client"
url = "{{baseUrl}}/notifications/v3/registrations"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/notifications/v3/registrations"),
Content = new StringContent("{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\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}}/notifications/v3/registrations");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notifications/v3/registrations"
payload := strings.NewReader("{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\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/notifications/v3/registrations HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 117
{
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/notifications/v3/registrations")
.setHeader("content-type", "application/json")
.setBody("{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notifications/v3/registrations"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\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 \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/notifications/v3/registrations")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/notifications/v3/registrations")
.header("content-type", "application/json")
.body("{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}")
.asString();
const data = JSON.stringify({
channelType: '',
eventSource: '',
eventType: '',
initialState: false,
ruleId: '',
url: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/notifications/v3/registrations');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/notifications/v3/registrations',
headers: {'content-type': 'application/json'},
data: {
channelType: '',
eventSource: '',
eventType: '',
initialState: false,
ruleId: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notifications/v3/registrations';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"channelType":"","eventSource":"","eventType":"","initialState":false,"ruleId":"","url":""}'
};
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}}/notifications/v3/registrations',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "channelType": "",\n "eventSource": "",\n "eventType": "",\n "initialState": false,\n "ruleId": "",\n "url": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/notifications/v3/registrations")
.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/notifications/v3/registrations',
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({
channelType: '',
eventSource: '',
eventType: '',
initialState: false,
ruleId: '',
url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/notifications/v3/registrations',
headers: {'content-type': 'application/json'},
body: {
channelType: '',
eventSource: '',
eventType: '',
initialState: false,
ruleId: '',
url: ''
},
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}}/notifications/v3/registrations');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
channelType: '',
eventSource: '',
eventType: '',
initialState: false,
ruleId: '',
url: ''
});
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}}/notifications/v3/registrations',
headers: {'content-type': 'application/json'},
data: {
channelType: '',
eventSource: '',
eventType: '',
initialState: false,
ruleId: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notifications/v3/registrations';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"channelType":"","eventSource":"","eventType":"","initialState":false,"ruleId":"","url":""}'
};
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 = @{ @"channelType": @"",
@"eventSource": @"",
@"eventType": @"",
@"initialState": @NO,
@"ruleId": @"",
@"url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notifications/v3/registrations"]
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}}/notifications/v3/registrations" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notifications/v3/registrations",
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([
'channelType' => '',
'eventSource' => '',
'eventType' => '',
'initialState' => null,
'ruleId' => '',
'url' => ''
]),
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}}/notifications/v3/registrations', [
'body' => '{
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/notifications/v3/registrations');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'channelType' => '',
'eventSource' => '',
'eventType' => '',
'initialState' => null,
'ruleId' => '',
'url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'channelType' => '',
'eventSource' => '',
'eventType' => '',
'initialState' => null,
'ruleId' => '',
'url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/notifications/v3/registrations');
$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}}/notifications/v3/registrations' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notifications/v3/registrations' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/notifications/v3/registrations", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notifications/v3/registrations"
payload = {
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": False,
"ruleId": "",
"url": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notifications/v3/registrations"
payload <- "{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\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}}/notifications/v3/registrations")
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 \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/notifications/v3/registrations') do |req|
req.body = "{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notifications/v3/registrations";
let payload = json!({
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
});
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}}/notifications/v3/registrations \
--header 'content-type: application/json' \
--data '{
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
}'
echo '{
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
}' | \
http POST {{baseUrl}}/notifications/v3/registrations \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "channelType": "",\n "eventSource": "",\n "eventType": "",\n "initialState": false,\n "ruleId": "",\n "url": ""\n}' \
--output-document \
- {{baseUrl}}/notifications/v3/registrations
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notifications/v3/registrations")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Unregisters from all notifications
{{baseUrl}}/notifications/v3/registrations
HEADERS
x-confirm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notifications/v3/registrations");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-confirm: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/notifications/v3/registrations" {:headers {:x-confirm ""}})
require "http/client"
url = "{{baseUrl}}/notifications/v3/registrations"
headers = HTTP::Headers{
"x-confirm" => ""
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/notifications/v3/registrations"),
Headers =
{
{ "x-confirm", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notifications/v3/registrations");
var request = new RestRequest("", Method.Delete);
request.AddHeader("x-confirm", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notifications/v3/registrations"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-confirm", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/notifications/v3/registrations HTTP/1.1
X-Confirm:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/notifications/v3/registrations")
.setHeader("x-confirm", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notifications/v3/registrations"))
.header("x-confirm", "")
.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}}/notifications/v3/registrations")
.delete(null)
.addHeader("x-confirm", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/notifications/v3/registrations")
.header("x-confirm", "")
.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}}/notifications/v3/registrations');
xhr.setRequestHeader('x-confirm', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/notifications/v3/registrations',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notifications/v3/registrations';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
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}}/notifications/v3/registrations',
method: 'DELETE',
headers: {
'x-confirm': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notifications/v3/registrations")
.delete(null)
.addHeader("x-confirm", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/notifications/v3/registrations',
headers: {
'x-confirm': ''
}
};
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}}/notifications/v3/registrations',
headers: {'x-confirm': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/notifications/v3/registrations');
req.headers({
'x-confirm': ''
});
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}}/notifications/v3/registrations',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notifications/v3/registrations';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-confirm": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notifications/v3/registrations"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
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}}/notifications/v3/registrations" in
let headers = Header.add (Header.init ()) "x-confirm" "" in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notifications/v3/registrations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"x-confirm: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/notifications/v3/registrations', [
'headers' => [
'x-confirm' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/notifications/v3/registrations');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'x-confirm' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notifications/v3/registrations');
$request->setRequestMethod('DELETE');
$request->setHeaders([
'x-confirm' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notifications/v3/registrations' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notifications/v3/registrations' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'x-confirm': "" }
conn.request("DELETE", "/baseUrl/notifications/v3/registrations", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notifications/v3/registrations"
headers = {"x-confirm": ""}
response = requests.delete(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notifications/v3/registrations"
response <- VERB("DELETE", url, add_headers('x-confirm' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notifications/v3/registrations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-confirm"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/notifications/v3/registrations') do |req|
req.headers['x-confirm'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notifications/v3/registrations";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-confirm", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/notifications/v3/registrations \
--header 'x-confirm: '
http DELETE {{baseUrl}}/notifications/v3/registrations \
x-confirm:''
wget --quiet \
--method DELETE \
--header 'x-confirm: ' \
--output-document \
- {{baseUrl}}/notifications/v3/registrations
import Foundation
let headers = ["x-confirm": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notifications/v3/registrations")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
DELETE
Unregisters from notifications
{{baseUrl}}/notifications/v3/registration/:channelId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notifications/v3/registration/:channelId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/notifications/v3/registration/:channelId")
require "http/client"
url = "{{baseUrl}}/notifications/v3/registration/:channelId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/notifications/v3/registration/:channelId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/notifications/v3/registration/:channelId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notifications/v3/registration/:channelId"
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/notifications/v3/registration/:channelId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/notifications/v3/registration/:channelId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notifications/v3/registration/:channelId"))
.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}}/notifications/v3/registration/:channelId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/notifications/v3/registration/:channelId")
.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}}/notifications/v3/registration/:channelId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/notifications/v3/registration/:channelId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notifications/v3/registration/:channelId';
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}}/notifications/v3/registration/:channelId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/notifications/v3/registration/:channelId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/notifications/v3/registration/:channelId',
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}}/notifications/v3/registration/:channelId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/notifications/v3/registration/:channelId');
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}}/notifications/v3/registration/:channelId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notifications/v3/registration/:channelId';
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}}/notifications/v3/registration/:channelId"]
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}}/notifications/v3/registration/:channelId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notifications/v3/registration/:channelId",
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}}/notifications/v3/registration/:channelId');
echo $response->getBody();
setUrl('{{baseUrl}}/notifications/v3/registration/:channelId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/notifications/v3/registration/:channelId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/notifications/v3/registration/:channelId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notifications/v3/registration/:channelId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/notifications/v3/registration/:channelId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notifications/v3/registration/:channelId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notifications/v3/registration/:channelId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/notifications/v3/registration/:channelId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/notifications/v3/registration/:channelId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notifications/v3/registration/:channelId";
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}}/notifications/v3/registration/:channelId
http DELETE {{baseUrl}}/notifications/v3/registration/:channelId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/notifications/v3/registration/:channelId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notifications/v3/registration/:channelId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "The channel ID was not found."
}
PUT
Updates a notification channel
{{baseUrl}}/notifications/v3/registration/:channelId
BODY json
{
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/notifications/v3/registration/:channelId");
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 \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/notifications/v3/registration/:channelId" {:content-type :json
:form-params {:channelType ""
:eventSource ""
:eventType ""
:initialState false
:ruleId ""
:url ""}})
require "http/client"
url = "{{baseUrl}}/notifications/v3/registration/:channelId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/notifications/v3/registration/:channelId"),
Content = new StringContent("{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\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}}/notifications/v3/registration/:channelId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/notifications/v3/registration/:channelId"
payload := strings.NewReader("{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\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/notifications/v3/registration/:channelId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 117
{
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/notifications/v3/registration/:channelId")
.setHeader("content-type", "application/json")
.setBody("{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/notifications/v3/registration/:channelId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\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 \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/notifications/v3/registration/:channelId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/notifications/v3/registration/:channelId")
.header("content-type", "application/json")
.body("{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}")
.asString();
const data = JSON.stringify({
channelType: '',
eventSource: '',
eventType: '',
initialState: false,
ruleId: '',
url: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/notifications/v3/registration/:channelId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/notifications/v3/registration/:channelId',
headers: {'content-type': 'application/json'},
data: {
channelType: '',
eventSource: '',
eventType: '',
initialState: false,
ruleId: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/notifications/v3/registration/:channelId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"channelType":"","eventSource":"","eventType":"","initialState":false,"ruleId":"","url":""}'
};
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}}/notifications/v3/registration/:channelId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "channelType": "",\n "eventSource": "",\n "eventType": "",\n "initialState": false,\n "ruleId": "",\n "url": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/notifications/v3/registration/:channelId")
.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/notifications/v3/registration/:channelId',
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({
channelType: '',
eventSource: '',
eventType: '',
initialState: false,
ruleId: '',
url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/notifications/v3/registration/:channelId',
headers: {'content-type': 'application/json'},
body: {
channelType: '',
eventSource: '',
eventType: '',
initialState: false,
ruleId: '',
url: ''
},
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}}/notifications/v3/registration/:channelId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
channelType: '',
eventSource: '',
eventType: '',
initialState: false,
ruleId: '',
url: ''
});
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}}/notifications/v3/registration/:channelId',
headers: {'content-type': 'application/json'},
data: {
channelType: '',
eventSource: '',
eventType: '',
initialState: false,
ruleId: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/notifications/v3/registration/:channelId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"channelType":"","eventSource":"","eventType":"","initialState":false,"ruleId":"","url":""}'
};
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 = @{ @"channelType": @"",
@"eventSource": @"",
@"eventType": @"",
@"initialState": @NO,
@"ruleId": @"",
@"url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/notifications/v3/registration/:channelId"]
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}}/notifications/v3/registration/:channelId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/notifications/v3/registration/:channelId",
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([
'channelType' => '',
'eventSource' => '',
'eventType' => '',
'initialState' => null,
'ruleId' => '',
'url' => ''
]),
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}}/notifications/v3/registration/:channelId', [
'body' => '{
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/notifications/v3/registration/:channelId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'channelType' => '',
'eventSource' => '',
'eventType' => '',
'initialState' => null,
'ruleId' => '',
'url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'channelType' => '',
'eventSource' => '',
'eventType' => '',
'initialState' => null,
'ruleId' => '',
'url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/notifications/v3/registration/:channelId');
$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}}/notifications/v3/registration/:channelId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/notifications/v3/registration/:channelId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/notifications/v3/registration/:channelId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/notifications/v3/registration/:channelId"
payload = {
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": False,
"ruleId": "",
"url": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/notifications/v3/registration/:channelId"
payload <- "{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\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}}/notifications/v3/registration/:channelId")
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 \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/notifications/v3/registration/:channelId') do |req|
req.body = "{\n \"channelType\": \"\",\n \"eventSource\": \"\",\n \"eventType\": \"\",\n \"initialState\": false,\n \"ruleId\": \"\",\n \"url\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/notifications/v3/registration/:channelId";
let payload = json!({
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
});
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}}/notifications/v3/registration/:channelId \
--header 'content-type: application/json' \
--data '{
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
}'
echo '{
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
}' | \
http PUT {{baseUrl}}/notifications/v3/registration/:channelId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "channelType": "",\n "eventSource": "",\n "eventType": "",\n "initialState": false,\n "ruleId": "",\n "url": ""\n}' \
--output-document \
- {{baseUrl}}/notifications/v3/registration/:channelId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"channelType": "",
"eventSource": "",
"eventType": "",
"initialState": false,
"ruleId": "",
"url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/notifications/v3/registration/:channelId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "The channel ID was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 409,
"details": {
"hereErrorCode": 404306
},
"error": "Conflict",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource already exists."
}
PUT
Claims a device
{{baseUrl}}/registry/v2/devices/:deviceOrExternalId
BODY json
{
"ownerAppId": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId");
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 \"ownerAppId\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId" {:content-type :json
:form-params {:ownerAppId ""}})
require "http/client"
url = "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"ownerAppId\": \"\"\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"),
Content = new StringContent("{\n \"ownerAppId\": \"\"\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}}/registry/v2/devices/:deviceOrExternalId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"ownerAppId\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"
payload := strings.NewReader("{\n \"ownerAppId\": \"\"\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/registry/v2/devices/:deviceOrExternalId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 22
{
"ownerAppId": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")
.setHeader("content-type", "application/json")
.setBody("{\n \"ownerAppId\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"ownerAppId\": \"\"\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 \"ownerAppId\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")
.header("content-type", "application/json")
.body("{\n \"ownerAppId\": \"\"\n}")
.asString();
const data = JSON.stringify({
ownerAppId: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId',
headers: {'content-type': 'application/json'},
data: {ownerAppId: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"ownerAppId":""}'
};
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}}/registry/v2/devices/:deviceOrExternalId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "ownerAppId": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"ownerAppId\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")
.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/registry/v2/devices/:deviceOrExternalId',
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({ownerAppId: ''}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId',
headers: {'content-type': 'application/json'},
body: {ownerAppId: ''},
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}}/registry/v2/devices/:deviceOrExternalId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
ownerAppId: ''
});
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}}/registry/v2/devices/:deviceOrExternalId',
headers: {'content-type': 'application/json'},
data: {ownerAppId: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"ownerAppId":""}'
};
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 = @{ @"ownerAppId": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"]
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}}/registry/v2/devices/:deviceOrExternalId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"ownerAppId\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v2/devices/:deviceOrExternalId",
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([
'ownerAppId' => ''
]),
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}}/registry/v2/devices/:deviceOrExternalId', [
'body' => '{
"ownerAppId": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v2/devices/:deviceOrExternalId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'ownerAppId' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'ownerAppId' => ''
]));
$request->setRequestUrl('{{baseUrl}}/registry/v2/devices/:deviceOrExternalId');
$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}}/registry/v2/devices/:deviceOrExternalId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"ownerAppId": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"ownerAppId": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"ownerAppId\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/registry/v2/devices/:deviceOrExternalId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"
payload = { "ownerAppId": "" }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"
payload <- "{\n \"ownerAppId\": \"\"\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}}/registry/v2/devices/:deviceOrExternalId")
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 \"ownerAppId\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/registry/v2/devices/:deviceOrExternalId') do |req|
req.body = "{\n \"ownerAppId\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId";
let payload = json!({"ownerAppId": ""});
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}}/registry/v2/devices/:deviceOrExternalId \
--header 'content-type: application/json' \
--data '{
"ownerAppId": ""
}'
echo '{
"ownerAppId": ""
}' | \
http PUT {{baseUrl}}/registry/v2/devices/:deviceOrExternalId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "ownerAppId": ""\n}' \
--output-document \
- {{baseUrl}}/registry/v2/devices/:deviceOrExternalId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["ownerAppId": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 409,
"details": {
"hereErrorCode": 404306
},
"error": "Conflict",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource already exists."
}
POST
Creates a license for a single physical device
{{baseUrl}}/registry/v2/:appId/one-device
QUERY PARAMS
appId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v2/:appId/one-device");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/registry/v2/:appId/one-device")
require "http/client"
url = "{{baseUrl}}/registry/v2/:appId/one-device"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/registry/v2/:appId/one-device"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/registry/v2/:appId/one-device");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v2/:appId/one-device"
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/registry/v2/:appId/one-device HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/registry/v2/:appId/one-device")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v2/:appId/one-device"))
.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}}/registry/v2/:appId/one-device")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/registry/v2/:appId/one-device")
.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}}/registry/v2/:appId/one-device');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/registry/v2/:appId/one-device'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v2/:appId/one-device';
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}}/registry/v2/:appId/one-device',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/registry/v2/:appId/one-device")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/registry/v2/:appId/one-device',
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}}/registry/v2/:appId/one-device'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/registry/v2/:appId/one-device');
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}}/registry/v2/:appId/one-device'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v2/:appId/one-device';
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}}/registry/v2/:appId/one-device"]
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}}/registry/v2/:appId/one-device" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v2/:appId/one-device",
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}}/registry/v2/:appId/one-device');
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v2/:appId/one-device');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/registry/v2/:appId/one-device');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/registry/v2/:appId/one-device' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v2/:appId/one-device' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/registry/v2/:appId/one-device")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v2/:appId/one-device"
response = requests.post(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v2/:appId/one-device"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/registry/v2/:appId/one-device")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/registry/v2/:appId/one-device') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v2/:appId/one-device";
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}}/registry/v2/:appId/one-device
http POST {{baseUrl}}/registry/v2/:appId/one-device
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/registry/v2/:appId/one-device
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v2/:appId/one-device")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"deviceId": "4cdafa38-fdf9-474c-8eb3-72ea276a163a",
"deviceSecret": "AGIhZGmU1jJS-H1ZfAZuh5U9cswyqquWVrbOKGwKN9s",
"trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "Invalid Authorization, the request lacks valid authentication credentials for the target resource."
}
]
POST
Creates licenses for multiple devices
{{baseUrl}}/registry/v2/:appId/devices
QUERY PARAMS
appId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v2/:appId/devices");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/registry/v2/:appId/devices")
require "http/client"
url = "{{baseUrl}}/registry/v2/:appId/devices"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/registry/v2/:appId/devices"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/registry/v2/:appId/devices");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v2/:appId/devices"
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/registry/v2/:appId/devices HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/registry/v2/:appId/devices")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v2/:appId/devices"))
.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}}/registry/v2/:appId/devices")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/registry/v2/:appId/devices")
.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}}/registry/v2/:appId/devices');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/registry/v2/:appId/devices'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v2/:appId/devices';
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}}/registry/v2/:appId/devices',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/registry/v2/:appId/devices")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/registry/v2/:appId/devices',
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}}/registry/v2/:appId/devices'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/registry/v2/:appId/devices');
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}}/registry/v2/:appId/devices'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v2/:appId/devices';
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}}/registry/v2/:appId/devices"]
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}}/registry/v2/:appId/devices" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v2/:appId/devices",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/registry/v2/:appId/devices');
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v2/:appId/devices');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/registry/v2/:appId/devices');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/registry/v2/:appId/devices' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v2/:appId/devices' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/registry/v2/:appId/devices", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v2/:appId/devices"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v2/:appId/devices"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/registry/v2/:appId/devices")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/registry/v2/:appId/devices') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v2/:appId/devices";
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}}/registry/v2/:appId/devices
http POST {{baseUrl}}/registry/v2/:appId/devices
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/registry/v2/:appId/devices
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v2/:appId/devices")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"jobId": "344a17a4-1b19-4420-bb6f-8400b87071fd"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "Invalid Authorization, the request lacks valid authentication credentials for the target resource."
}
]
DELETE
Deactivates a device.
{{baseUrl}}/registry/v2/devices/:deviceOrExternalId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")
require "http/client"
url = "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"
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/registry/v2/devices/:deviceOrExternalId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"))
.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}}/registry/v2/devices/:deviceOrExternalId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")
.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}}/registry/v2/devices/:deviceOrExternalId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId';
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}}/registry/v2/devices/:deviceOrExternalId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/registry/v2/devices/:deviceOrExternalId',
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}}/registry/v2/devices/:deviceOrExternalId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId');
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}}/registry/v2/devices/:deviceOrExternalId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId';
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}}/registry/v2/devices/:deviceOrExternalId"]
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}}/registry/v2/devices/:deviceOrExternalId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v2/devices/:deviceOrExternalId",
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}}/registry/v2/devices/:deviceOrExternalId');
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v2/devices/:deviceOrExternalId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/registry/v2/devices/:deviceOrExternalId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/registry/v2/devices/:deviceOrExternalId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/registry/v2/devices/:deviceOrExternalId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId";
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}}/registry/v2/devices/:deviceOrExternalId
http DELETE {{baseUrl}}/registry/v2/devices/:deviceOrExternalId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/registry/v2/devices/:deviceOrExternalId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets a list user projects along with the license information
{{baseUrl}}/registry/v2/licenses
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v2/licenses");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/registry/v2/licenses")
require "http/client"
url = "{{baseUrl}}/registry/v2/licenses"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/registry/v2/licenses"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/registry/v2/licenses");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v2/licenses"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/registry/v2/licenses HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/registry/v2/licenses")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v2/licenses"))
.method("GET", 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}}/registry/v2/licenses")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/registry/v2/licenses")
.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('GET', '{{baseUrl}}/registry/v2/licenses');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/registry/v2/licenses'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v2/licenses';
const options = {method: 'GET'};
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}}/registry/v2/licenses',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/registry/v2/licenses")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/registry/v2/licenses',
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: 'GET', url: '{{baseUrl}}/registry/v2/licenses'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/registry/v2/licenses');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/registry/v2/licenses'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v2/licenses';
const options = {method: 'GET'};
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}}/registry/v2/licenses"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/registry/v2/licenses" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v2/licenses",
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;
}
request('GET', '{{baseUrl}}/registry/v2/licenses');
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v2/licenses');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/registry/v2/licenses');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/registry/v2/licenses' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v2/licenses' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/registry/v2/licenses")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v2/licenses"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v2/licenses"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/registry/v2/licenses")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/registry/v2/licenses') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v2/licenses";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/registry/v2/licenses
http GET {{baseUrl}}/registry/v2/licenses
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/registry/v2/licenses
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v2/licenses")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets a number of device licenses provisioned by a user
{{baseUrl}}/registry/v2/:appId/licenseCount
QUERY PARAMS
appId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v2/:appId/licenseCount");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/registry/v2/:appId/licenseCount")
require "http/client"
url = "{{baseUrl}}/registry/v2/:appId/licenseCount"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/registry/v2/:appId/licenseCount"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/registry/v2/:appId/licenseCount");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v2/:appId/licenseCount"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/registry/v2/:appId/licenseCount HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/registry/v2/:appId/licenseCount")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v2/:appId/licenseCount"))
.method("GET", 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}}/registry/v2/:appId/licenseCount")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/registry/v2/:appId/licenseCount")
.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('GET', '{{baseUrl}}/registry/v2/:appId/licenseCount');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/registry/v2/:appId/licenseCount'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v2/:appId/licenseCount';
const options = {method: 'GET'};
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}}/registry/v2/:appId/licenseCount',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/registry/v2/:appId/licenseCount")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/registry/v2/:appId/licenseCount',
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: 'GET',
url: '{{baseUrl}}/registry/v2/:appId/licenseCount'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/registry/v2/:appId/licenseCount');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/registry/v2/:appId/licenseCount'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v2/:appId/licenseCount';
const options = {method: 'GET'};
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}}/registry/v2/:appId/licenseCount"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/registry/v2/:appId/licenseCount" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v2/:appId/licenseCount",
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;
}
request('GET', '{{baseUrl}}/registry/v2/:appId/licenseCount');
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v2/:appId/licenseCount');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/registry/v2/:appId/licenseCount');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/registry/v2/:appId/licenseCount' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v2/:appId/licenseCount' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/registry/v2/:appId/licenseCount")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v2/:appId/licenseCount"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v2/:appId/licenseCount"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/registry/v2/:appId/licenseCount")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/registry/v2/:appId/licenseCount') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v2/:appId/licenseCount";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/registry/v2/:appId/licenseCount
http GET {{baseUrl}}/registry/v2/:appId/licenseCount
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/registry/v2/:appId/licenseCount
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v2/:appId/licenseCount")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 1337,
"updatedAt": "2018-04-03T12:08:56.501Z"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "Invalid Authorization, the request lacks valid authentication credentials for the target resource."
}
]
POST
Gets all resources of a resource type
{{baseUrl}}/registry/v4/resources/:resourceType/find
BODY json
{
"filters": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v4/resources/:resourceType/find");
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 \"filters\": []\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/registry/v4/resources/:resourceType/find" {:content-type :json
:form-params {:filters []}})
require "http/client"
url = "{{baseUrl}}/registry/v4/resources/:resourceType/find"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"filters\": []\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/registry/v4/resources/:resourceType/find"),
Content = new StringContent("{\n \"filters\": []\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}}/registry/v4/resources/:resourceType/find");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"filters\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v4/resources/:resourceType/find"
payload := strings.NewReader("{\n \"filters\": []\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/registry/v4/resources/:resourceType/find HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 19
{
"filters": []
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/registry/v4/resources/:resourceType/find")
.setHeader("content-type", "application/json")
.setBody("{\n \"filters\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v4/resources/:resourceType/find"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"filters\": []\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 \"filters\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/registry/v4/resources/:resourceType/find")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/registry/v4/resources/:resourceType/find")
.header("content-type", "application/json")
.body("{\n \"filters\": []\n}")
.asString();
const data = JSON.stringify({
filters: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/registry/v4/resources/:resourceType/find');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/registry/v4/resources/:resourceType/find',
headers: {'content-type': 'application/json'},
data: {filters: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v4/resources/:resourceType/find';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"filters":[]}'
};
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}}/registry/v4/resources/:resourceType/find',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "filters": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"filters\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/registry/v4/resources/:resourceType/find")
.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/registry/v4/resources/:resourceType/find',
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({filters: []}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/registry/v4/resources/:resourceType/find',
headers: {'content-type': 'application/json'},
body: {filters: []},
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}}/registry/v4/resources/:resourceType/find');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
filters: []
});
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}}/registry/v4/resources/:resourceType/find',
headers: {'content-type': 'application/json'},
data: {filters: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v4/resources/:resourceType/find';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"filters":[]}'
};
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 = @{ @"filters": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/registry/v4/resources/:resourceType/find"]
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}}/registry/v4/resources/:resourceType/find" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"filters\": []\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v4/resources/:resourceType/find",
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([
'filters' => [
]
]),
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}}/registry/v4/resources/:resourceType/find', [
'body' => '{
"filters": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v4/resources/:resourceType/find');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'filters' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'filters' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/registry/v4/resources/:resourceType/find');
$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}}/registry/v4/resources/:resourceType/find' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"filters": []
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v4/resources/:resourceType/find' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"filters": []
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"filters\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/registry/v4/resources/:resourceType/find", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v4/resources/:resourceType/find"
payload = { "filters": [] }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v4/resources/:resourceType/find"
payload <- "{\n \"filters\": []\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}}/registry/v4/resources/:resourceType/find")
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 \"filters\": []\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/registry/v4/resources/:resourceType/find') do |req|
req.body = "{\n \"filters\": []\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v4/resources/:resourceType/find";
let payload = json!({"filters": ()});
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}}/registry/v4/resources/:resourceType/find \
--header 'content-type: application/json' \
--data '{
"filters": []
}'
echo '{
"filters": []
}' | \
http POST {{baseUrl}}/registry/v4/resources/:resourceType/find \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "filters": []\n}' \
--output-document \
- {{baseUrl}}/registry/v4/resources/:resourceType/find
import Foundation
let headers = ["content-type": "application/json"]
let parameters = ["filters": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v4/resources/:resourceType/find")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 3,
"items": [
{
"resourceId": "SHP-ee73df84-0ab1-40fd-aac1-c39deb943de9"
},
{
"resourceId": "SHP-ee73df84-0ab1-40fd-aac1-c39deb943df0"
},
{
"resourceId": "SHP-ee73df84-0ab1-40fd-aac1-c39deb943df1"
}
],
"limit": 3,
"nextPageToken": "skjfgWOF7162712JHAIW8FYBCASK!/EUQHSDkuhedf",
"total": 10
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 429,
"error": "Too Many Requests",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "Too Many Requests"
}
GET
Gets service health (12)
{{baseUrl}}/registry/v2/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v2/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/registry/v2/health")
require "http/client"
url = "{{baseUrl}}/registry/v2/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/registry/v2/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/registry/v2/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v2/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/registry/v2/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/registry/v2/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v2/health"))
.method("GET", 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}}/registry/v2/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/registry/v2/health")
.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('GET', '{{baseUrl}}/registry/v2/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/registry/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v2/health';
const options = {method: 'GET'};
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}}/registry/v2/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/registry/v2/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/registry/v2/health',
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: 'GET', url: '{{baseUrl}}/registry/v2/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/registry/v2/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/registry/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v2/health';
const options = {method: 'GET'};
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}}/registry/v2/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/registry/v2/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v2/health",
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;
}
request('GET', '{{baseUrl}}/registry/v2/health');
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v2/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/registry/v2/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/registry/v2/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v2/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/registry/v2/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v2/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v2/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/registry/v2/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/registry/v2/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v2/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/registry/v2/health
http GET {{baseUrl}}/registry/v2/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/registry/v2/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v2/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (12)
{{baseUrl}}/registry/v2/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v2/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/registry/v2/version")
require "http/client"
url = "{{baseUrl}}/registry/v2/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/registry/v2/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/registry/v2/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v2/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/registry/v2/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/registry/v2/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v2/version"))
.method("GET", 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}}/registry/v2/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/registry/v2/version")
.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('GET', '{{baseUrl}}/registry/v2/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/registry/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v2/version';
const options = {method: 'GET'};
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}}/registry/v2/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/registry/v2/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/registry/v2/version',
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: 'GET', url: '{{baseUrl}}/registry/v2/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/registry/v2/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/registry/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v2/version';
const options = {method: 'GET'};
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}}/registry/v2/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/registry/v2/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v2/version",
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;
}
request('GET', '{{baseUrl}}/registry/v2/version');
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v2/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/registry/v2/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/registry/v2/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v2/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/registry/v2/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v2/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v2/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/registry/v2/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/registry/v2/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v2/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/registry/v2/version
http GET {{baseUrl}}/registry/v2/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/registry/v2/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v2/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets the deviceId
{{baseUrl}}/registry/v2/:trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v2/:trackingId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/registry/v2/:trackingId")
require "http/client"
url = "{{baseUrl}}/registry/v2/:trackingId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/registry/v2/:trackingId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/registry/v2/:trackingId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v2/:trackingId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/registry/v2/:trackingId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/registry/v2/:trackingId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v2/:trackingId"))
.method("GET", 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}}/registry/v2/:trackingId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/registry/v2/:trackingId")
.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('GET', '{{baseUrl}}/registry/v2/:trackingId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/registry/v2/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v2/:trackingId';
const options = {method: 'GET'};
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}}/registry/v2/:trackingId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/registry/v2/:trackingId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/registry/v2/:trackingId',
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: 'GET', url: '{{baseUrl}}/registry/v2/:trackingId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/registry/v2/:trackingId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/registry/v2/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v2/:trackingId';
const options = {method: 'GET'};
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}}/registry/v2/:trackingId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/registry/v2/:trackingId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v2/:trackingId",
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;
}
request('GET', '{{baseUrl}}/registry/v2/:trackingId');
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v2/:trackingId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/registry/v2/:trackingId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/registry/v2/:trackingId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v2/:trackingId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/registry/v2/:trackingId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v2/:trackingId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v2/:trackingId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/registry/v2/:trackingId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/registry/v2/:trackingId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v2/:trackingId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/registry/v2/:trackingId
http GET {{baseUrl}}/registry/v2/:trackingId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/registry/v2/:trackingId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v2/:trackingId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets the multiple device license request job results
{{baseUrl}}/registry/v2/:jobId/results
QUERY PARAMS
jobId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v2/:jobId/results");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/registry/v2/:jobId/results")
require "http/client"
url = "{{baseUrl}}/registry/v2/:jobId/results"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/registry/v2/:jobId/results"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/registry/v2/:jobId/results");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v2/:jobId/results"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/registry/v2/:jobId/results HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/registry/v2/:jobId/results")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v2/:jobId/results"))
.method("GET", 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}}/registry/v2/:jobId/results")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/registry/v2/:jobId/results")
.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('GET', '{{baseUrl}}/registry/v2/:jobId/results');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/registry/v2/:jobId/results'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v2/:jobId/results';
const options = {method: 'GET'};
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}}/registry/v2/:jobId/results',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/registry/v2/:jobId/results")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/registry/v2/:jobId/results',
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: 'GET', url: '{{baseUrl}}/registry/v2/:jobId/results'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/registry/v2/:jobId/results');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/registry/v2/:jobId/results'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v2/:jobId/results';
const options = {method: 'GET'};
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}}/registry/v2/:jobId/results"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/registry/v2/:jobId/results" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v2/:jobId/results",
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;
}
request('GET', '{{baseUrl}}/registry/v2/:jobId/results');
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v2/:jobId/results');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/registry/v2/:jobId/results');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/registry/v2/:jobId/results' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v2/:jobId/results' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/registry/v2/:jobId/results")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v2/:jobId/results"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v2/:jobId/results"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/registry/v2/:jobId/results")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/registry/v2/:jobId/results') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v2/:jobId/results";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/registry/v2/:jobId/results
http GET {{baseUrl}}/registry/v2/:jobId/results
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/registry/v2/:jobId/results
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v2/:jobId/results")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 3,
"data": [
{
"deviceId": "d34d8c7f-6bd5-496a-adef-7bf2395aa456",
"deviceSecret": "qerjpsdujnewppqnqefvli"
},
{
"deviceId": "c6a22c91-c185-474c-9970-5eea445d92ac",
"deviceSecret": "xvbnm,do0e,md;ffgdsle,d"
}
],
"errors": [
{
"error": {
"code": 500,
"error": "Internal Server Error",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee"
},
"id": "my-device"
}
],
"pageToken": "027ffffea253d79fc"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "Invalid Authorization, the request lacks valid authentication credentials for the target resource."
}
]
GET
Gets the multiple device license request job status
{{baseUrl}}/registry/v2/:jobId/status
QUERY PARAMS
jobId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v2/:jobId/status");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/registry/v2/:jobId/status")
require "http/client"
url = "{{baseUrl}}/registry/v2/:jobId/status"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/registry/v2/:jobId/status"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/registry/v2/:jobId/status");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v2/:jobId/status"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/registry/v2/:jobId/status HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/registry/v2/:jobId/status")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v2/:jobId/status"))
.method("GET", 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}}/registry/v2/:jobId/status")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/registry/v2/:jobId/status")
.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('GET', '{{baseUrl}}/registry/v2/:jobId/status');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/registry/v2/:jobId/status'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v2/:jobId/status';
const options = {method: 'GET'};
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}}/registry/v2/:jobId/status',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/registry/v2/:jobId/status")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/registry/v2/:jobId/status',
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: 'GET', url: '{{baseUrl}}/registry/v2/:jobId/status'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/registry/v2/:jobId/status');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/registry/v2/:jobId/status'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v2/:jobId/status';
const options = {method: 'GET'};
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}}/registry/v2/:jobId/status"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/registry/v2/:jobId/status" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v2/:jobId/status",
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;
}
request('GET', '{{baseUrl}}/registry/v2/:jobId/status');
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v2/:jobId/status');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/registry/v2/:jobId/status');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/registry/v2/:jobId/status' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v2/:jobId/status' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/registry/v2/:jobId/status")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v2/:jobId/status"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v2/:jobId/status"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/registry/v2/:jobId/status")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/registry/v2/:jobId/status') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v2/:jobId/status";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/registry/v2/:jobId/status
http GET {{baseUrl}}/registry/v2/:jobId/status
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/registry/v2/:jobId/status
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v2/:jobId/status")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"percent": 10,
"status": "started"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "Invalid Authorization, the request lacks valid authentication credentials for the target resource."
}
]
GET
Gets the trackingId for a device
{{baseUrl}}/registry/v2/devices/:deviceOrExternalId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")
require "http/client"
url = "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/registry/v2/devices/:deviceOrExternalId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"))
.method("GET", 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}}/registry/v2/devices/:deviceOrExternalId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")
.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('GET', '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId';
const options = {method: 'GET'};
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}}/registry/v2/devices/:deviceOrExternalId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/registry/v2/devices/:deviceOrExternalId',
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: 'GET',
url: '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId';
const options = {method: 'GET'};
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}}/registry/v2/devices/:deviceOrExternalId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/registry/v2/devices/:deviceOrExternalId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v2/devices/:deviceOrExternalId",
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;
}
request('GET', '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId');
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v2/devices/:deviceOrExternalId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/registry/v2/devices/:deviceOrExternalId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v2/devices/:deviceOrExternalId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/registry/v2/devices/:deviceOrExternalId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/registry/v2/devices/:deviceOrExternalId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/registry/v2/devices/:deviceOrExternalId
http GET {{baseUrl}}/registry/v2/devices/:deviceOrExternalId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/registry/v2/devices/:deviceOrExternalId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v2/devices/:deviceOrExternalId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Lists all the devices provisioned by a user
{{baseUrl}}/registry/v2/:appId/devices
QUERY PARAMS
appId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v2/:appId/devices");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/registry/v2/:appId/devices")
require "http/client"
url = "{{baseUrl}}/registry/v2/:appId/devices"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/registry/v2/:appId/devices"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/registry/v2/:appId/devices");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v2/:appId/devices"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/registry/v2/:appId/devices HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/registry/v2/:appId/devices")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v2/:appId/devices"))
.method("GET", 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}}/registry/v2/:appId/devices")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/registry/v2/:appId/devices")
.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('GET', '{{baseUrl}}/registry/v2/:appId/devices');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/registry/v2/:appId/devices'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v2/:appId/devices';
const options = {method: 'GET'};
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}}/registry/v2/:appId/devices',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/registry/v2/:appId/devices")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/registry/v2/:appId/devices',
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: 'GET', url: '{{baseUrl}}/registry/v2/:appId/devices'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/registry/v2/:appId/devices');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/registry/v2/:appId/devices'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v2/:appId/devices';
const options = {method: 'GET'};
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}}/registry/v2/:appId/devices"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/registry/v2/:appId/devices" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v2/:appId/devices",
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;
}
request('GET', '{{baseUrl}}/registry/v2/:appId/devices');
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v2/:appId/devices');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/registry/v2/:appId/devices');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/registry/v2/:appId/devices' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v2/:appId/devices' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/registry/v2/:appId/devices")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v2/:appId/devices"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v2/:appId/devices"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/registry/v2/:appId/devices")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/registry/v2/:appId/devices') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v2/:appId/devices";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/registry/v2/:appId/devices
http GET {{baseUrl}}/registry/v2/:appId/devices
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/registry/v2/:appId/devices
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v2/:appId/devices")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 2,
"data": [
{
"deviceId": "d34d8c7f-6bd5-496a-adef-7bf2395aa456",
"timestamp": 1548143359339
},
{
"appId": "jJHUjhytyGJHJFtftgHG",
"deviceId": "VRDE-40e87f34-59b9-4bd9-827f-f8ff5a8210e8",
"externalId": "my-device-1",
"timestamp": 1548143359340
}
],
"pageToken": "027ffffea253d79fc"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
DELETE
Unclaims a device
{{baseUrl}}/registry/v2/:trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/registry/v2/:trackingId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/registry/v2/:trackingId")
require "http/client"
url = "{{baseUrl}}/registry/v2/:trackingId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/registry/v2/:trackingId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/registry/v2/:trackingId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/registry/v2/:trackingId"
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/registry/v2/:trackingId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/registry/v2/:trackingId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/registry/v2/:trackingId"))
.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}}/registry/v2/:trackingId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/registry/v2/:trackingId")
.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}}/registry/v2/:trackingId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/registry/v2/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/registry/v2/:trackingId';
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}}/registry/v2/:trackingId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/registry/v2/:trackingId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/registry/v2/:trackingId',
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}}/registry/v2/:trackingId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/registry/v2/:trackingId');
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}}/registry/v2/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/registry/v2/:trackingId';
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}}/registry/v2/:trackingId"]
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}}/registry/v2/:trackingId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/registry/v2/:trackingId",
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}}/registry/v2/:trackingId');
echo $response->getBody();
setUrl('{{baseUrl}}/registry/v2/:trackingId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/registry/v2/:trackingId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/registry/v2/:trackingId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/registry/v2/:trackingId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/registry/v2/:trackingId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/registry/v2/:trackingId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/registry/v2/:trackingId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/registry/v2/:trackingId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/registry/v2/:trackingId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/registry/v2/:trackingId";
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}}/registry/v2/:trackingId
http DELETE {{baseUrl}}/registry/v2/:trackingId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/registry/v2/:trackingId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/registry/v2/:trackingId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets reports
{{baseUrl}}/reports/v4/:reportId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/v4/:reportId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/reports/v4/:reportId")
require "http/client"
url = "{{baseUrl}}/reports/v4/:reportId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/reports/v4/:reportId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/v4/:reportId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/v4/:reportId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/reports/v4/:reportId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/reports/v4/:reportId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/v4/:reportId"))
.method("GET", 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}}/reports/v4/:reportId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/reports/v4/:reportId")
.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('GET', '{{baseUrl}}/reports/v4/:reportId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/reports/v4/:reportId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/v4/:reportId';
const options = {method: 'GET'};
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}}/reports/v4/:reportId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/reports/v4/:reportId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/v4/:reportId',
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: 'GET', url: '{{baseUrl}}/reports/v4/:reportId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/reports/v4/:reportId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/reports/v4/:reportId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/v4/:reportId';
const options = {method: 'GET'};
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}}/reports/v4/:reportId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/reports/v4/:reportId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/v4/:reportId",
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;
}
request('GET', '{{baseUrl}}/reports/v4/:reportId');
echo $response->getBody();
setUrl('{{baseUrl}}/reports/v4/:reportId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/reports/v4/:reportId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/v4/:reportId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/v4/:reportId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/reports/v4/:reportId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/v4/:reportId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/v4/:reportId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/v4/:reportId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/reports/v4/:reportId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/v4/:reportId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/reports/v4/:reportId
http GET {{baseUrl}}/reports/v4/:reportId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/reports/v4/:reportId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/v4/:reportId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 5,
"items": [
{
"timestamp": "2020-11-29T22:00:00.000Z",
"value": 13
},
{
"timestamp": "2020-12-06T22:00:00.000Z",
"value": 11
},
{
"timestamp": "2020-12-13T22:00:00.000Z",
"value": 17
},
{
"timestamp": "2020-12-20T22:00:00.000Z",
"value": 0
},
{
"timestamp": "2020-12-27T22:00:00.000Z",
"value": 30
}
],
"limit": 5,
"nextPageToken": "024ggjjea253d79fc",
"status": "completed"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets service health (13)
{{baseUrl}}/reports/v4/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/v4/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/reports/v4/health")
require "http/client"
url = "{{baseUrl}}/reports/v4/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/reports/v4/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/v4/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/v4/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/reports/v4/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/reports/v4/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/v4/health"))
.method("GET", 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}}/reports/v4/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/reports/v4/health")
.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('GET', '{{baseUrl}}/reports/v4/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/reports/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/v4/health';
const options = {method: 'GET'};
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}}/reports/v4/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/reports/v4/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/v4/health',
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: 'GET', url: '{{baseUrl}}/reports/v4/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/reports/v4/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/reports/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/v4/health';
const options = {method: 'GET'};
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}}/reports/v4/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/reports/v4/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/v4/health",
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;
}
request('GET', '{{baseUrl}}/reports/v4/health');
echo $response->getBody();
setUrl('{{baseUrl}}/reports/v4/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/reports/v4/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/v4/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/v4/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/reports/v4/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/v4/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/v4/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/v4/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/reports/v4/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/v4/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/reports/v4/health
http GET {{baseUrl}}/reports/v4/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/reports/v4/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/v4/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (13)
{{baseUrl}}/reports/v4/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/v4/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/reports/v4/version")
require "http/client"
url = "{{baseUrl}}/reports/v4/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/reports/v4/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/reports/v4/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/v4/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/reports/v4/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/reports/v4/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/v4/version"))
.method("GET", 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}}/reports/v4/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/reports/v4/version")
.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('GET', '{{baseUrl}}/reports/v4/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/reports/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/v4/version';
const options = {method: 'GET'};
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}}/reports/v4/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/reports/v4/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/reports/v4/version',
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: 'GET', url: '{{baseUrl}}/reports/v4/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/reports/v4/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/reports/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/v4/version';
const options = {method: 'GET'};
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}}/reports/v4/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/reports/v4/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/v4/version",
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;
}
request('GET', '{{baseUrl}}/reports/v4/version');
echo $response->getBody();
setUrl('{{baseUrl}}/reports/v4/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/reports/v4/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/reports/v4/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/v4/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/reports/v4/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/v4/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/v4/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/reports/v4/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/reports/v4/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/v4/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/reports/v4/version
http GET {{baseUrl}}/reports/v4/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/reports/v4/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/v4/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
Starts report creation
{{baseUrl}}/reports/v4
BODY json
{
"end": "",
"ruleId": "",
"start": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/reports/v4");
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 \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/reports/v4" {:content-type :json
:form-params {:end ""
:ruleId ""
:start ""}})
require "http/client"
url = "{{baseUrl}}/reports/v4"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/reports/v4"),
Content = new StringContent("{\n \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\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}}/reports/v4");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/reports/v4"
payload := strings.NewReader("{\n \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\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/reports/v4 HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 46
{
"end": "",
"ruleId": "",
"start": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/reports/v4")
.setHeader("content-type", "application/json")
.setBody("{\n \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/reports/v4"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\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 \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/reports/v4")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/reports/v4")
.header("content-type", "application/json")
.body("{\n \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\n}")
.asString();
const data = JSON.stringify({
end: '',
ruleId: '',
start: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/reports/v4');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/reports/v4',
headers: {'content-type': 'application/json'},
data: {end: '', ruleId: '', start: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/reports/v4';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"end":"","ruleId":"","start":""}'
};
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}}/reports/v4',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "end": "",\n "ruleId": "",\n "start": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/reports/v4")
.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/reports/v4',
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({end: '', ruleId: '', start: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/reports/v4',
headers: {'content-type': 'application/json'},
body: {end: '', ruleId: '', start: ''},
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}}/reports/v4');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
end: '',
ruleId: '',
start: ''
});
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}}/reports/v4',
headers: {'content-type': 'application/json'},
data: {end: '', ruleId: '', start: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/reports/v4';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"end":"","ruleId":"","start":""}'
};
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 = @{ @"end": @"",
@"ruleId": @"",
@"start": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/reports/v4"]
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}}/reports/v4" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/reports/v4",
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([
'end' => '',
'ruleId' => '',
'start' => ''
]),
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}}/reports/v4', [
'body' => '{
"end": "",
"ruleId": "",
"start": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/reports/v4');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'end' => '',
'ruleId' => '',
'start' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'end' => '',
'ruleId' => '',
'start' => ''
]));
$request->setRequestUrl('{{baseUrl}}/reports/v4');
$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}}/reports/v4' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"end": "",
"ruleId": "",
"start": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/reports/v4' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"end": "",
"ruleId": "",
"start": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/reports/v4", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/reports/v4"
payload = {
"end": "",
"ruleId": "",
"start": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/reports/v4"
payload <- "{\n \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\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}}/reports/v4")
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 \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/reports/v4') do |req|
req.body = "{\n \"end\": \"\",\n \"ruleId\": \"\",\n \"start\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/reports/v4";
let payload = json!({
"end": "",
"ruleId": "",
"start": ""
});
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}}/reports/v4 \
--header 'content-type: application/json' \
--data '{
"end": "",
"ruleId": "",
"start": ""
}'
echo '{
"end": "",
"ruleId": "",
"start": ""
}' | \
http POST {{baseUrl}}/reports/v4 \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "end": "",\n "ruleId": "",\n "start": ""\n}' \
--output-document \
- {{baseUrl}}/reports/v4
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"end": "",
"ruleId": "",
"start": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/reports/v4")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
POST
Creates a rule
{{baseUrl}}/rules/v4
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rules/v4");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/rules/v4")
require "http/client"
url = "{{baseUrl}}/rules/v4"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/rules/v4"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rules/v4");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rules/v4"
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/rules/v4 HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/rules/v4")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rules/v4"))
.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}}/rules/v4")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/rules/v4")
.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}}/rules/v4');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/rules/v4'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rules/v4';
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}}/rules/v4',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/rules/v4")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/rules/v4',
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}}/rules/v4'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/rules/v4');
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}}/rules/v4'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rules/v4';
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}}/rules/v4"]
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}}/rules/v4" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rules/v4",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/rules/v4');
echo $response->getBody();
setUrl('{{baseUrl}}/rules/v4');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/rules/v4');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rules/v4' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rules/v4' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/rules/v4", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rules/v4"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rules/v4"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rules/v4")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/rules/v4') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rules/v4";
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}}/rules/v4
http POST {{baseUrl}}/rules/v4
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/rules/v4
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rules/v4")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
DELETE
Deletes a rule
{{baseUrl}}/rules/v4/:ruleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rules/v4/:ruleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/rules/v4/:ruleId")
require "http/client"
url = "{{baseUrl}}/rules/v4/:ruleId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/rules/v4/:ruleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rules/v4/:ruleId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rules/v4/:ruleId"
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/rules/v4/:ruleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/rules/v4/:ruleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rules/v4/:ruleId"))
.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}}/rules/v4/:ruleId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/rules/v4/:ruleId")
.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}}/rules/v4/:ruleId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/rules/v4/:ruleId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rules/v4/:ruleId';
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}}/rules/v4/:ruleId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/rules/v4/:ruleId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/rules/v4/:ruleId',
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}}/rules/v4/:ruleId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/rules/v4/:ruleId');
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}}/rules/v4/:ruleId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rules/v4/:ruleId';
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}}/rules/v4/:ruleId"]
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}}/rules/v4/:ruleId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rules/v4/:ruleId",
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}}/rules/v4/:ruleId');
echo $response->getBody();
setUrl('{{baseUrl}}/rules/v4/:ruleId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/rules/v4/:ruleId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rules/v4/:ruleId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rules/v4/:ruleId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/rules/v4/:ruleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rules/v4/:ruleId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rules/v4/:ruleId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rules/v4/:ruleId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/rules/v4/:ruleId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rules/v4/:ruleId";
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}}/rules/v4/:ruleId
http DELETE {{baseUrl}}/rules/v4/:ruleId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/rules/v4/:ruleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rules/v4/:ruleId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "No rules with the provided ruleId were found"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 409,
"details": {
"hereErrorCode": 404306
},
"error": "Conflict",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource already exists."
}
DELETE
Deletes all rules
{{baseUrl}}/rules/v4
HEADERS
x-confirm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rules/v4");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-confirm: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/rules/v4" {:headers {:x-confirm ""}})
require "http/client"
url = "{{baseUrl}}/rules/v4"
headers = HTTP::Headers{
"x-confirm" => ""
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/rules/v4"),
Headers =
{
{ "x-confirm", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rules/v4");
var request = new RestRequest("", Method.Delete);
request.AddHeader("x-confirm", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rules/v4"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-confirm", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/rules/v4 HTTP/1.1
X-Confirm:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/rules/v4")
.setHeader("x-confirm", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rules/v4"))
.header("x-confirm", "")
.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}}/rules/v4")
.delete(null)
.addHeader("x-confirm", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/rules/v4")
.header("x-confirm", "")
.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}}/rules/v4');
xhr.setRequestHeader('x-confirm', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/rules/v4',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rules/v4';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
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}}/rules/v4',
method: 'DELETE',
headers: {
'x-confirm': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/rules/v4")
.delete(null)
.addHeader("x-confirm", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/rules/v4',
headers: {
'x-confirm': ''
}
};
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}}/rules/v4',
headers: {'x-confirm': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/rules/v4');
req.headers({
'x-confirm': ''
});
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}}/rules/v4',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rules/v4';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-confirm": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/rules/v4"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
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}}/rules/v4" in
let headers = Header.add (Header.init ()) "x-confirm" "" in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rules/v4",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"x-confirm: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/rules/v4', [
'headers' => [
'x-confirm' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/rules/v4');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'x-confirm' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/rules/v4');
$request->setRequestMethod('DELETE');
$request->setHeaders([
'x-confirm' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rules/v4' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rules/v4' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'x-confirm': "" }
conn.request("DELETE", "/baseUrl/rules/v4", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rules/v4"
headers = {"x-confirm": ""}
response = requests.delete(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rules/v4"
response <- VERB("DELETE", url, add_headers('x-confirm' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rules/v4")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-confirm"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/rules/v4') do |req|
req.headers['x-confirm'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rules/v4";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-confirm", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/rules/v4 \
--header 'x-confirm: '
http DELETE {{baseUrl}}/rules/v4 \
x-confirm:''
wget --quiet \
--method DELETE \
--header 'x-confirm: ' \
--output-document \
- {{baseUrl}}/rules/v4
import Foundation
let headers = ["x-confirm": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rules/v4")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets a single rule
{{baseUrl}}/rules/v4/:ruleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rules/v4/:ruleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/rules/v4/:ruleId")
require "http/client"
url = "{{baseUrl}}/rules/v4/:ruleId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/rules/v4/:ruleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rules/v4/:ruleId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rules/v4/:ruleId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/rules/v4/:ruleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/rules/v4/:ruleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rules/v4/:ruleId"))
.method("GET", 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}}/rules/v4/:ruleId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/rules/v4/:ruleId")
.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('GET', '{{baseUrl}}/rules/v4/:ruleId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/rules/v4/:ruleId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rules/v4/:ruleId';
const options = {method: 'GET'};
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}}/rules/v4/:ruleId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/rules/v4/:ruleId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/rules/v4/:ruleId',
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: 'GET', url: '{{baseUrl}}/rules/v4/:ruleId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/rules/v4/:ruleId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/rules/v4/:ruleId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rules/v4/:ruleId';
const options = {method: 'GET'};
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}}/rules/v4/:ruleId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/rules/v4/:ruleId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rules/v4/:ruleId",
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;
}
request('GET', '{{baseUrl}}/rules/v4/:ruleId');
echo $response->getBody();
setUrl('{{baseUrl}}/rules/v4/:ruleId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/rules/v4/:ruleId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rules/v4/:ruleId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rules/v4/:ruleId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/rules/v4/:ruleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rules/v4/:ruleId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rules/v4/:ruleId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rules/v4/:ruleId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/rules/v4/:ruleId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rules/v4/:ruleId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/rules/v4/:ruleId
http GET {{baseUrl}}/rules/v4/:ruleId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/rules/v4/:ruleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rules/v4/:ruleId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"rule": {
"threshold": {
"durationS": 3600
},
"type": "dwelling"
},
"ruleId": "f4c26630-5d26-4cd1-a57e-g7834e72cb99"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "No rules with the provided ruleId were found"
}
GET
Gets all rules
{{baseUrl}}/rules/v4
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rules/v4");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/rules/v4")
require "http/client"
url = "{{baseUrl}}/rules/v4"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/rules/v4"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rules/v4");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rules/v4"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/rules/v4 HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/rules/v4")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rules/v4"))
.method("GET", 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}}/rules/v4")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/rules/v4")
.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('GET', '{{baseUrl}}/rules/v4');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/rules/v4'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rules/v4';
const options = {method: 'GET'};
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}}/rules/v4',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/rules/v4")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/rules/v4',
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: 'GET', url: '{{baseUrl}}/rules/v4'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/rules/v4');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/rules/v4'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rules/v4';
const options = {method: 'GET'};
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}}/rules/v4"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/rules/v4" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rules/v4",
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;
}
request('GET', '{{baseUrl}}/rules/v4');
echo $response->getBody();
setUrl('{{baseUrl}}/rules/v4');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/rules/v4');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rules/v4' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rules/v4' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/rules/v4")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rules/v4"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rules/v4"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rules/v4")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/rules/v4') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rules/v4";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/rules/v4
http GET {{baseUrl}}/rules/v4
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/rules/v4
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rules/v4")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 1,
"items": [
{
"rule": {
"threshold": {
"durationS": 3600
},
"type": "dwelling"
},
"ruleId": "f4c26630-5d26-4cd1-a57e-g7834e72cb99"
}
],
"limit": 100,
"nextPageToken": "024ggjjea253d79fc"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets service health (14)
{{baseUrl}}/rules/v4/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rules/v4/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/rules/v4/health")
require "http/client"
url = "{{baseUrl}}/rules/v4/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/rules/v4/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rules/v4/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rules/v4/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/rules/v4/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/rules/v4/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rules/v4/health"))
.method("GET", 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}}/rules/v4/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/rules/v4/health")
.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('GET', '{{baseUrl}}/rules/v4/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/rules/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rules/v4/health';
const options = {method: 'GET'};
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}}/rules/v4/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/rules/v4/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/rules/v4/health',
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: 'GET', url: '{{baseUrl}}/rules/v4/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/rules/v4/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/rules/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rules/v4/health';
const options = {method: 'GET'};
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}}/rules/v4/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/rules/v4/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rules/v4/health",
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;
}
request('GET', '{{baseUrl}}/rules/v4/health');
echo $response->getBody();
setUrl('{{baseUrl}}/rules/v4/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/rules/v4/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rules/v4/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rules/v4/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/rules/v4/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rules/v4/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rules/v4/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rules/v4/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/rules/v4/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rules/v4/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/rules/v4/health
http GET {{baseUrl}}/rules/v4/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/rules/v4/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rules/v4/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (14)
{{baseUrl}}/rules/v4/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rules/v4/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/rules/v4/version")
require "http/client"
url = "{{baseUrl}}/rules/v4/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/rules/v4/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rules/v4/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rules/v4/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/rules/v4/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/rules/v4/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rules/v4/version"))
.method("GET", 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}}/rules/v4/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/rules/v4/version")
.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('GET', '{{baseUrl}}/rules/v4/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/rules/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rules/v4/version';
const options = {method: 'GET'};
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}}/rules/v4/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/rules/v4/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/rules/v4/version',
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: 'GET', url: '{{baseUrl}}/rules/v4/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/rules/v4/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/rules/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rules/v4/version';
const options = {method: 'GET'};
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}}/rules/v4/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/rules/v4/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rules/v4/version",
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;
}
request('GET', '{{baseUrl}}/rules/v4/version');
echo $response->getBody();
setUrl('{{baseUrl}}/rules/v4/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/rules/v4/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rules/v4/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rules/v4/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/rules/v4/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rules/v4/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rules/v4/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rules/v4/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/rules/v4/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rules/v4/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/rules/v4/version
http GET {{baseUrl}}/rules/v4/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/rules/v4/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rules/v4/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
Updates a single rule
{{baseUrl}}/rules/v4/:ruleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/rules/v4/:ruleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/rules/v4/:ruleId")
require "http/client"
url = "{{baseUrl}}/rules/v4/:ruleId"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/rules/v4/:ruleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/rules/v4/:ruleId");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/rules/v4/:ruleId"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/rules/v4/:ruleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/rules/v4/:ruleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/rules/v4/:ruleId"))
.method("PUT", 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}}/rules/v4/:ruleId")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/rules/v4/:ruleId")
.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('PUT', '{{baseUrl}}/rules/v4/:ruleId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'PUT', url: '{{baseUrl}}/rules/v4/:ruleId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/rules/v4/:ruleId';
const options = {method: 'PUT'};
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}}/rules/v4/:ruleId',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/rules/v4/:ruleId")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/rules/v4/:ruleId',
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: 'PUT', url: '{{baseUrl}}/rules/v4/:ruleId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/rules/v4/:ruleId');
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}}/rules/v4/:ruleId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/rules/v4/:ruleId';
const options = {method: 'PUT'};
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}}/rules/v4/:ruleId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/rules/v4/:ruleId" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/rules/v4/:ruleId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/rules/v4/:ruleId');
echo $response->getBody();
setUrl('{{baseUrl}}/rules/v4/:ruleId');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/rules/v4/:ruleId');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/rules/v4/:ruleId' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/rules/v4/:ruleId' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("PUT", "/baseUrl/rules/v4/:ruleId", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/rules/v4/:ruleId"
payload = ""
response = requests.put(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/rules/v4/:ruleId"
payload <- ""
response <- VERB("PUT", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/rules/v4/:ruleId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/rules/v4/:ruleId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/rules/v4/:ruleId";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/rules/v4/:ruleId
http PUT {{baseUrl}}/rules/v4/:ruleId
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/rules/v4/:ruleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/rules/v4/:ruleId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "No rules with the provided ruleId were found"
}
POST
Creates a sensor rule
{{baseUrl}}/sensors/v3
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sensors/v3");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/sensors/v3")
require "http/client"
url = "{{baseUrl}}/sensors/v3"
response = HTTP::Client.post url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/sensors/v3"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sensors/v3");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sensors/v3"
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/sensors/v3 HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/sensors/v3")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sensors/v3"))
.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}}/sensors/v3")
.post(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/sensors/v3")
.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}}/sensors/v3');
xhr.send(data);
import axios from 'axios';
const options = {method: 'POST', url: '{{baseUrl}}/sensors/v3'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sensors/v3';
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}}/sensors/v3',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sensors/v3")
.post(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/sensors/v3',
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}}/sensors/v3'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/sensors/v3');
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}}/sensors/v3'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sensors/v3';
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}}/sensors/v3"]
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}}/sensors/v3" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sensors/v3",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('POST', '{{baseUrl}}/sensors/v3');
echo $response->getBody();
setUrl('{{baseUrl}}/sensors/v3');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sensors/v3');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sensors/v3' -Method POST
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sensors/v3' -Method POST
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("POST", "/baseUrl/sensors/v3", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sensors/v3"
payload = ""
response = requests.post(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sensors/v3"
payload <- ""
response <- VERB("POST", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sensors/v3")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/sensors/v3') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sensors/v3";
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}}/sensors/v3
http POST {{baseUrl}}/sensors/v3
wget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/sensors/v3
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sensors/v3")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
DELETE
Deletes a sensor rule
{{baseUrl}}/sensors/v3/:sensorRuleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sensors/v3/:sensorRuleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/sensors/v3/:sensorRuleId")
require "http/client"
url = "{{baseUrl}}/sensors/v3/:sensorRuleId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/sensors/v3/:sensorRuleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sensors/v3/:sensorRuleId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sensors/v3/:sensorRuleId"
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/sensors/v3/:sensorRuleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/sensors/v3/:sensorRuleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sensors/v3/:sensorRuleId"))
.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}}/sensors/v3/:sensorRuleId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/sensors/v3/:sensorRuleId")
.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}}/sensors/v3/:sensorRuleId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/sensors/v3/:sensorRuleId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sensors/v3/:sensorRuleId';
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}}/sensors/v3/:sensorRuleId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sensors/v3/:sensorRuleId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/sensors/v3/:sensorRuleId',
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}}/sensors/v3/:sensorRuleId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/sensors/v3/:sensorRuleId');
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}}/sensors/v3/:sensorRuleId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sensors/v3/:sensorRuleId';
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}}/sensors/v3/:sensorRuleId"]
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}}/sensors/v3/:sensorRuleId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sensors/v3/:sensorRuleId",
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}}/sensors/v3/:sensorRuleId');
echo $response->getBody();
setUrl('{{baseUrl}}/sensors/v3/:sensorRuleId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sensors/v3/:sensorRuleId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sensors/v3/:sensorRuleId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sensors/v3/:sensorRuleId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/sensors/v3/:sensorRuleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sensors/v3/:sensorRuleId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sensors/v3/:sensorRuleId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sensors/v3/:sensorRuleId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/sensors/v3/:sensorRuleId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sensors/v3/:sensorRuleId";
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}}/sensors/v3/:sensorRuleId
http DELETE {{baseUrl}}/sensors/v3/:sensorRuleId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/sensors/v3/:sensorRuleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sensors/v3/:sensorRuleId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "The sensor rule ID was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 409,
"details": {
"hereErrorCode": 404306
},
"error": "Conflict",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource already exists."
}
DELETE
Deletes all sensor rules
{{baseUrl}}/sensors/v3
HEADERS
x-confirm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sensors/v3");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-confirm: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/sensors/v3" {:headers {:x-confirm ""}})
require "http/client"
url = "{{baseUrl}}/sensors/v3"
headers = HTTP::Headers{
"x-confirm" => ""
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/sensors/v3"),
Headers =
{
{ "x-confirm", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sensors/v3");
var request = new RestRequest("", Method.Delete);
request.AddHeader("x-confirm", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sensors/v3"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-confirm", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/sensors/v3 HTTP/1.1
X-Confirm:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/sensors/v3")
.setHeader("x-confirm", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sensors/v3"))
.header("x-confirm", "")
.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}}/sensors/v3")
.delete(null)
.addHeader("x-confirm", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/sensors/v3")
.header("x-confirm", "")
.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}}/sensors/v3');
xhr.setRequestHeader('x-confirm', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/sensors/v3',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sensors/v3';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
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}}/sensors/v3',
method: 'DELETE',
headers: {
'x-confirm': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sensors/v3")
.delete(null)
.addHeader("x-confirm", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/sensors/v3',
headers: {
'x-confirm': ''
}
};
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}}/sensors/v3',
headers: {'x-confirm': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/sensors/v3');
req.headers({
'x-confirm': ''
});
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}}/sensors/v3',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sensors/v3';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-confirm": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/sensors/v3"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
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}}/sensors/v3" in
let headers = Header.add (Header.init ()) "x-confirm" "" in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sensors/v3",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"x-confirm: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/sensors/v3', [
'headers' => [
'x-confirm' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/sensors/v3');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'x-confirm' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sensors/v3');
$request->setRequestMethod('DELETE');
$request->setHeaders([
'x-confirm' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sensors/v3' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sensors/v3' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'x-confirm': "" }
conn.request("DELETE", "/baseUrl/sensors/v3", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sensors/v3"
headers = {"x-confirm": ""}
response = requests.delete(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sensors/v3"
response <- VERB("DELETE", url, add_headers('x-confirm' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sensors/v3")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-confirm"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/sensors/v3') do |req|
req.headers['x-confirm'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sensors/v3";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-confirm", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/sensors/v3 \
--header 'x-confirm: '
http DELETE {{baseUrl}}/sensors/v3 \
x-confirm:''
wget --quiet \
--method DELETE \
--header 'x-confirm: ' \
--output-document \
- {{baseUrl}}/sensors/v3
import Foundation
let headers = ["x-confirm": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sensors/v3")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets a single sensor rule
{{baseUrl}}/sensors/v3/:sensorRuleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sensors/v3/:sensorRuleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sensors/v3/:sensorRuleId")
require "http/client"
url = "{{baseUrl}}/sensors/v3/:sensorRuleId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sensors/v3/:sensorRuleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sensors/v3/:sensorRuleId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sensors/v3/:sensorRuleId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sensors/v3/:sensorRuleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sensors/v3/:sensorRuleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sensors/v3/:sensorRuleId"))
.method("GET", 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}}/sensors/v3/:sensorRuleId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sensors/v3/:sensorRuleId")
.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('GET', '{{baseUrl}}/sensors/v3/:sensorRuleId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/sensors/v3/:sensorRuleId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sensors/v3/:sensorRuleId';
const options = {method: 'GET'};
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}}/sensors/v3/:sensorRuleId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sensors/v3/:sensorRuleId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sensors/v3/:sensorRuleId',
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: 'GET', url: '{{baseUrl}}/sensors/v3/:sensorRuleId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sensors/v3/:sensorRuleId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/sensors/v3/:sensorRuleId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sensors/v3/:sensorRuleId';
const options = {method: 'GET'};
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}}/sensors/v3/:sensorRuleId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/sensors/v3/:sensorRuleId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sensors/v3/:sensorRuleId",
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;
}
request('GET', '{{baseUrl}}/sensors/v3/:sensorRuleId');
echo $response->getBody();
setUrl('{{baseUrl}}/sensors/v3/:sensorRuleId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sensors/v3/:sensorRuleId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sensors/v3/:sensorRuleId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sensors/v3/:sensorRuleId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sensors/v3/:sensorRuleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sensors/v3/:sensorRuleId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sensors/v3/:sensorRuleId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sensors/v3/:sensorRuleId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sensors/v3/:sensorRuleId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sensors/v3/:sensorRuleId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sensors/v3/:sensorRuleId
http GET {{baseUrl}}/sensors/v3/:sensorRuleId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sensors/v3/:sensorRuleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sensors/v3/:sensorRuleId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"id": "f4c26630-5d26-4cd1-a57e-g7834e72cb99",
"range": {
"begin": -20,
"end": 30
},
"type": "temperature"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "The sensor rule ID was not found."
}
GET
Gets all sensor rules
{{baseUrl}}/sensors/v3
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sensors/v3");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sensors/v3")
require "http/client"
url = "{{baseUrl}}/sensors/v3"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sensors/v3"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sensors/v3");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sensors/v3"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sensors/v3 HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sensors/v3")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sensors/v3"))
.method("GET", 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}}/sensors/v3")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sensors/v3")
.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('GET', '{{baseUrl}}/sensors/v3');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/sensors/v3'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sensors/v3';
const options = {method: 'GET'};
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}}/sensors/v3',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sensors/v3")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sensors/v3',
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: 'GET', url: '{{baseUrl}}/sensors/v3'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sensors/v3');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/sensors/v3'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sensors/v3';
const options = {method: 'GET'};
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}}/sensors/v3"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/sensors/v3" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sensors/v3",
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;
}
request('GET', '{{baseUrl}}/sensors/v3');
echo $response->getBody();
setUrl('{{baseUrl}}/sensors/v3');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sensors/v3');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sensors/v3' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sensors/v3' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sensors/v3")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sensors/v3"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sensors/v3"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sensors/v3")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sensors/v3') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sensors/v3";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sensors/v3
http GET {{baseUrl}}/sensors/v3
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sensors/v3
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sensors/v3")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 2,
"data": [
{
"id": "f4c26630-5d26-4cd1-a57e-g7834e72cb99",
"range": {
"begin": -20,
"end": 30
},
"type": "temperature"
},
{
"id": "j7c24430-5f26-4kd1-c58e-g7126e72ab33",
"range": {
"begin": 30,
"end": 80
},
"type": "pressure"
}
],
"pageToken": "024ggjjea253d79fc"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets service health (15)
{{baseUrl}}/sensors/v3/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sensors/v3/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sensors/v3/health")
require "http/client"
url = "{{baseUrl}}/sensors/v3/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sensors/v3/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sensors/v3/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sensors/v3/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sensors/v3/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sensors/v3/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sensors/v3/health"))
.method("GET", 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}}/sensors/v3/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sensors/v3/health")
.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('GET', '{{baseUrl}}/sensors/v3/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/sensors/v3/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sensors/v3/health';
const options = {method: 'GET'};
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}}/sensors/v3/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sensors/v3/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sensors/v3/health',
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: 'GET', url: '{{baseUrl}}/sensors/v3/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sensors/v3/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/sensors/v3/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sensors/v3/health';
const options = {method: 'GET'};
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}}/sensors/v3/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/sensors/v3/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sensors/v3/health",
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;
}
request('GET', '{{baseUrl}}/sensors/v3/health');
echo $response->getBody();
setUrl('{{baseUrl}}/sensors/v3/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sensors/v3/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sensors/v3/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sensors/v3/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sensors/v3/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sensors/v3/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sensors/v3/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sensors/v3/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sensors/v3/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sensors/v3/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sensors/v3/health
http GET {{baseUrl}}/sensors/v3/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sensors/v3/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sensors/v3/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (15)
{{baseUrl}}/sensors/v3/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sensors/v3/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/sensors/v3/version")
require "http/client"
url = "{{baseUrl}}/sensors/v3/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/sensors/v3/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sensors/v3/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sensors/v3/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/sensors/v3/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/sensors/v3/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sensors/v3/version"))
.method("GET", 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}}/sensors/v3/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/sensors/v3/version")
.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('GET', '{{baseUrl}}/sensors/v3/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/sensors/v3/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sensors/v3/version';
const options = {method: 'GET'};
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}}/sensors/v3/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sensors/v3/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/sensors/v3/version',
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: 'GET', url: '{{baseUrl}}/sensors/v3/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/sensors/v3/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/sensors/v3/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sensors/v3/version';
const options = {method: 'GET'};
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}}/sensors/v3/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/sensors/v3/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sensors/v3/version",
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;
}
request('GET', '{{baseUrl}}/sensors/v3/version');
echo $response->getBody();
setUrl('{{baseUrl}}/sensors/v3/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sensors/v3/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sensors/v3/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sensors/v3/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/sensors/v3/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sensors/v3/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sensors/v3/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sensors/v3/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/sensors/v3/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sensors/v3/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/sensors/v3/version
http GET {{baseUrl}}/sensors/v3/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/sensors/v3/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sensors/v3/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
Updates a single sensor rule
{{baseUrl}}/sensors/v3/:sensorRuleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/sensors/v3/:sensorRuleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/sensors/v3/:sensorRuleId")
require "http/client"
url = "{{baseUrl}}/sensors/v3/:sensorRuleId"
response = HTTP::Client.put url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/sensors/v3/:sensorRuleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/sensors/v3/:sensorRuleId");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/sensors/v3/:sensorRuleId"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
PUT /baseUrl/sensors/v3/:sensorRuleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/sensors/v3/:sensorRuleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/sensors/v3/:sensorRuleId"))
.method("PUT", 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}}/sensors/v3/:sensorRuleId")
.put(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/sensors/v3/:sensorRuleId")
.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('PUT', '{{baseUrl}}/sensors/v3/:sensorRuleId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'PUT', url: '{{baseUrl}}/sensors/v3/:sensorRuleId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/sensors/v3/:sensorRuleId';
const options = {method: 'PUT'};
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}}/sensors/v3/:sensorRuleId',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/sensors/v3/:sensorRuleId")
.put(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/sensors/v3/:sensorRuleId',
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: 'PUT', url: '{{baseUrl}}/sensors/v3/:sensorRuleId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/sensors/v3/:sensorRuleId');
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}}/sensors/v3/:sensorRuleId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/sensors/v3/:sensorRuleId';
const options = {method: 'PUT'};
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}}/sensors/v3/:sensorRuleId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
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}}/sensors/v3/:sensorRuleId" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/sensors/v3/:sensorRuleId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('PUT', '{{baseUrl}}/sensors/v3/:sensorRuleId');
echo $response->getBody();
setUrl('{{baseUrl}}/sensors/v3/:sensorRuleId');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/sensors/v3/:sensorRuleId');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/sensors/v3/:sensorRuleId' -Method PUT
$response = Invoke-RestMethod -Uri '{{baseUrl}}/sensors/v3/:sensorRuleId' -Method PUT
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = ""
conn.request("PUT", "/baseUrl/sensors/v3/:sensorRuleId", payload)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/sensors/v3/:sensorRuleId"
payload = ""
response = requests.put(url, data=payload)
print(response.json())
library(httr)
url <- "{{baseUrl}}/sensors/v3/:sensorRuleId"
payload <- ""
response <- VERB("PUT", url, body = payload, content_type(""))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/sensors/v3/:sensorRuleId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/sensors/v3/:sensorRuleId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/sensors/v3/:sensorRuleId";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/sensors/v3/:sensorRuleId
http PUT {{baseUrl}}/sensors/v3/:sensorRuleId
wget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/sensors/v3/:sensorRuleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/sensors/v3/:sensorRuleId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "The sensor rule ID was not found."
}
DELETE
Clears a device shadow
{{baseUrl}}/shadows/v2/:trackingId
QUERY PARAMS
trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shadows/v2/:trackingId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/shadows/v2/:trackingId")
require "http/client"
url = "{{baseUrl}}/shadows/v2/:trackingId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/shadows/v2/:trackingId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shadows/v2/:trackingId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shadows/v2/:trackingId"
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/shadows/v2/:trackingId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/shadows/v2/:trackingId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shadows/v2/:trackingId"))
.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}}/shadows/v2/:trackingId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/shadows/v2/:trackingId")
.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}}/shadows/v2/:trackingId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/shadows/v2/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shadows/v2/:trackingId';
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}}/shadows/v2/:trackingId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shadows/v2/:trackingId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/shadows/v2/:trackingId',
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}}/shadows/v2/:trackingId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/shadows/v2/:trackingId');
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}}/shadows/v2/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shadows/v2/:trackingId';
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}}/shadows/v2/:trackingId"]
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}}/shadows/v2/:trackingId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shadows/v2/:trackingId",
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}}/shadows/v2/:trackingId');
echo $response->getBody();
setUrl('{{baseUrl}}/shadows/v2/:trackingId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shadows/v2/:trackingId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shadows/v2/:trackingId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shadows/v2/:trackingId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/shadows/v2/:trackingId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shadows/v2/:trackingId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shadows/v2/:trackingId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shadows/v2/:trackingId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/shadows/v2/:trackingId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shadows/v2/:trackingId";
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}}/shadows/v2/:trackingId
http DELETE {{baseUrl}}/shadows/v2/:trackingId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/shadows/v2/:trackingId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shadows/v2/:trackingId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "Invalid Authorization, the request lacks valid authentication credentials for the target resource."
}
]
POST
Gets a batch of device shadows
{{baseUrl}}/shadows/v2/batch
BODY json
[
{}
]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shadows/v2/batch");
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 {}\n]");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/shadows/v2/batch" {:content-type :json
:form-params [{}]})
require "http/client"
url = "{{baseUrl}}/shadows/v2/batch"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "[\n {}\n]"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/shadows/v2/batch"),
Content = new StringContent("[\n {}\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}}/shadows/v2/batch");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "[\n {}\n]", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shadows/v2/batch"
payload := strings.NewReader("[\n {}\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/shadows/v2/batch HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 8
[
{}
]
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/shadows/v2/batch")
.setHeader("content-type", "application/json")
.setBody("[\n {}\n]")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shadows/v2/batch"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("[\n {}\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 {}\n]");
Request request = new Request.Builder()
.url("{{baseUrl}}/shadows/v2/batch")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/shadows/v2/batch")
.header("content-type", "application/json")
.body("[\n {}\n]")
.asString();
const data = JSON.stringify([
{}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/shadows/v2/batch');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/shadows/v2/batch',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shadows/v2/batch';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '[{}]'};
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}}/shadows/v2/batch',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '[\n {}\n]'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "[\n {}\n]")
val request = Request.Builder()
.url("{{baseUrl}}/shadows/v2/batch")
.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/shadows/v2/batch',
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([{}]));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/shadows/v2/batch',
headers: {'content-type': 'application/json'},
body: [{}],
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}}/shadows/v2/batch');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send([
{}
]);
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}}/shadows/v2/batch',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shadows/v2/batch';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '[{}]'};
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 = @[ @{ } ];
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shadows/v2/batch"]
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}}/shadows/v2/batch" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "[\n {}\n]" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shadows/v2/batch",
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([
[
]
]),
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}}/shadows/v2/batch', [
'body' => '[
{}
]',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shadows/v2/batch');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
[
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
[
]
]));
$request->setRequestUrl('{{baseUrl}}/shadows/v2/batch');
$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}}/shadows/v2/batch' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{}
]'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shadows/v2/batch' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{}
]'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "[\n {}\n]"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/shadows/v2/batch", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shadows/v2/batch"
payload = [{}]
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shadows/v2/batch"
payload <- "[\n {}\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}}/shadows/v2/batch")
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 {}\n]"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/shadows/v2/batch') do |req|
req.body = "[\n {}\n]"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shadows/v2/batch";
let payload = (json!({}));
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}}/shadows/v2/batch \
--header 'content-type: application/json' \
--data '[
{}
]'
echo '[
{}
]' | \
http POST {{baseUrl}}/shadows/v2/batch \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '[\n {}\n]' \
--output-document \
- {{baseUrl}}/shadows/v2/batch
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [[]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shadows/v2/batch")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"body": {
"desired": {},
"reported": {
"position": {
"accuracy": 30,
"lat": 40,
"lng": 30.2
},
"system": {
"phoneNumber": "+4917012345"
}
}
},
"statusCode": 200,
"trackingId": "HERE-6da0f871-b4eb-4800-90e6-4bae86a788d6"
},
{
"statusCode": 404,
"trackingId": "HERE-b0146d7b-2e46-4cee-bc71-6da03ba2da85"
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets a device shadow
{{baseUrl}}/shadows/v2/:trackingId
QUERY PARAMS
trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shadows/v2/:trackingId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shadows/v2/:trackingId")
require "http/client"
url = "{{baseUrl}}/shadows/v2/:trackingId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shadows/v2/:trackingId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shadows/v2/:trackingId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shadows/v2/:trackingId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shadows/v2/:trackingId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shadows/v2/:trackingId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shadows/v2/:trackingId"))
.method("GET", 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}}/shadows/v2/:trackingId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shadows/v2/:trackingId")
.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('GET', '{{baseUrl}}/shadows/v2/:trackingId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/shadows/v2/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shadows/v2/:trackingId';
const options = {method: 'GET'};
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}}/shadows/v2/:trackingId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shadows/v2/:trackingId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shadows/v2/:trackingId',
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: 'GET', url: '{{baseUrl}}/shadows/v2/:trackingId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shadows/v2/:trackingId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/shadows/v2/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shadows/v2/:trackingId';
const options = {method: 'GET'};
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}}/shadows/v2/:trackingId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shadows/v2/:trackingId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shadows/v2/:trackingId",
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;
}
request('GET', '{{baseUrl}}/shadows/v2/:trackingId');
echo $response->getBody();
setUrl('{{baseUrl}}/shadows/v2/:trackingId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shadows/v2/:trackingId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shadows/v2/:trackingId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shadows/v2/:trackingId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shadows/v2/:trackingId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shadows/v2/:trackingId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shadows/v2/:trackingId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shadows/v2/:trackingId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shadows/v2/:trackingId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shadows/v2/:trackingId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shadows/v2/:trackingId
http GET {{baseUrl}}/shadows/v2/:trackingId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shadows/v2/:trackingId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shadows/v2/:trackingId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"desired": {
"payload": {
"color": "red",
"velocity": 100
}
},
"reported": {
"payload": {
"color": "blue",
"velocity": 100
},
"position": {
"alt": 97,
"lat": 52.5,
"lng": 13.4
}
},
"timestamp": 1461065261010
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "Invalid Authorization, the request lacks valid authentication credentials for the target resource."
}
]
GET
Gets a value of a shadow property
{{baseUrl}}/shadows/v2/:trackingId/:state/:selector
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shadows/v2/:trackingId/:state/:selector");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shadows/v2/:trackingId/:state/:selector")
require "http/client"
url = "{{baseUrl}}/shadows/v2/:trackingId/:state/:selector"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shadows/v2/:trackingId/:state/:selector"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shadows/v2/:trackingId/:state/:selector");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shadows/v2/:trackingId/:state/:selector"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shadows/v2/:trackingId/:state/:selector HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shadows/v2/:trackingId/:state/:selector")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shadows/v2/:trackingId/:state/:selector"))
.method("GET", 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}}/shadows/v2/:trackingId/:state/:selector")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shadows/v2/:trackingId/:state/:selector")
.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('GET', '{{baseUrl}}/shadows/v2/:trackingId/:state/:selector');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shadows/v2/:trackingId/:state/:selector'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shadows/v2/:trackingId/:state/:selector';
const options = {method: 'GET'};
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}}/shadows/v2/:trackingId/:state/:selector',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shadows/v2/:trackingId/:state/:selector")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shadows/v2/:trackingId/:state/:selector',
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: 'GET',
url: '{{baseUrl}}/shadows/v2/:trackingId/:state/:selector'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shadows/v2/:trackingId/:state/:selector');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/shadows/v2/:trackingId/:state/:selector'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shadows/v2/:trackingId/:state/:selector';
const options = {method: 'GET'};
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}}/shadows/v2/:trackingId/:state/:selector"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shadows/v2/:trackingId/:state/:selector" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shadows/v2/:trackingId/:state/:selector",
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;
}
request('GET', '{{baseUrl}}/shadows/v2/:trackingId/:state/:selector');
echo $response->getBody();
setUrl('{{baseUrl}}/shadows/v2/:trackingId/:state/:selector');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shadows/v2/:trackingId/:state/:selector');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shadows/v2/:trackingId/:state/:selector' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shadows/v2/:trackingId/:state/:selector' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shadows/v2/:trackingId/:state/:selector")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shadows/v2/:trackingId/:state/:selector"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shadows/v2/:trackingId/:state/:selector"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shadows/v2/:trackingId/:state/:selector")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shadows/v2/:trackingId/:state/:selector') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shadows/v2/:trackingId/:state/:selector";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shadows/v2/:trackingId/:state/:selector
http GET {{baseUrl}}/shadows/v2/:trackingId/:state/:selector
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shadows/v2/:trackingId/:state/:selector
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shadows/v2/:trackingId/:state/:selector")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"accuracy": "18",
"alt": "105",
"altaccuracy": "15",
"lat": "52.5308544",
"lng": "13.38480101"
}
RESPONSE HEADERS
Content-Type
text/plain
RESPONSE BODY text
red
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "Invalid Authorization, the request lacks valid authentication credentials for the target resource."
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
[
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "Invalid Authorization, the request lacks valid authentication credentials for the target resource."
}
]
GET
Gets all shadows
{{baseUrl}}/shadows/v4
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shadows/v4");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shadows/v4")
require "http/client"
url = "{{baseUrl}}/shadows/v4"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shadows/v4"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shadows/v4");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shadows/v4"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shadows/v4 HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shadows/v4")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shadows/v4"))
.method("GET", 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}}/shadows/v4")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shadows/v4")
.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('GET', '{{baseUrl}}/shadows/v4');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/shadows/v4'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shadows/v4';
const options = {method: 'GET'};
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}}/shadows/v4',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shadows/v4")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shadows/v4',
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: 'GET', url: '{{baseUrl}}/shadows/v4'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shadows/v4');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/shadows/v4'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shadows/v4';
const options = {method: 'GET'};
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}}/shadows/v4"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shadows/v4" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shadows/v4",
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;
}
request('GET', '{{baseUrl}}/shadows/v4');
echo $response->getBody();
setUrl('{{baseUrl}}/shadows/v4');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shadows/v4');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shadows/v4' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shadows/v4' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shadows/v4")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shadows/v4"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shadows/v4"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shadows/v4")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shadows/v4') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shadows/v4";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shadows/v4
http GET {{baseUrl}}/shadows/v4
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shadows/v4
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shadows/v4")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets reported or desired state object of a device
{{baseUrl}}/shadows/v2/:trackingId/:state
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shadows/v2/:trackingId/:state");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shadows/v2/:trackingId/:state")
require "http/client"
url = "{{baseUrl}}/shadows/v2/:trackingId/:state"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shadows/v2/:trackingId/:state"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shadows/v2/:trackingId/:state");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shadows/v2/:trackingId/:state"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shadows/v2/:trackingId/:state HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shadows/v2/:trackingId/:state")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shadows/v2/:trackingId/:state"))
.method("GET", 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}}/shadows/v2/:trackingId/:state")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shadows/v2/:trackingId/:state")
.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('GET', '{{baseUrl}}/shadows/v2/:trackingId/:state');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shadows/v2/:trackingId/:state'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shadows/v2/:trackingId/:state';
const options = {method: 'GET'};
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}}/shadows/v2/:trackingId/:state',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shadows/v2/:trackingId/:state")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shadows/v2/:trackingId/:state',
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: 'GET',
url: '{{baseUrl}}/shadows/v2/:trackingId/:state'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shadows/v2/:trackingId/:state');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/shadows/v2/:trackingId/:state'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shadows/v2/:trackingId/:state';
const options = {method: 'GET'};
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}}/shadows/v2/:trackingId/:state"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shadows/v2/:trackingId/:state" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shadows/v2/:trackingId/:state",
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;
}
request('GET', '{{baseUrl}}/shadows/v2/:trackingId/:state');
echo $response->getBody();
setUrl('{{baseUrl}}/shadows/v2/:trackingId/:state');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shadows/v2/:trackingId/:state');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shadows/v2/:trackingId/:state' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shadows/v2/:trackingId/:state' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shadows/v2/:trackingId/:state")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shadows/v2/:trackingId/:state"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shadows/v2/:trackingId/:state"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shadows/v2/:trackingId/:state")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shadows/v2/:trackingId/:state') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shadows/v2/:trackingId/:state";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shadows/v2/:trackingId/:state
http GET {{baseUrl}}/shadows/v2/:trackingId/:state
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shadows/v2/:trackingId/:state
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shadows/v2/:trackingId/:state")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"position": {
"accuracy": "18",
"alt": "105",
"altaccuracy": "15",
"lat": "52.5308544",
"lng": "13.38480101"
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets service health (16)
{{baseUrl}}/shadows/v2/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shadows/v2/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shadows/v2/health")
require "http/client"
url = "{{baseUrl}}/shadows/v2/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shadows/v2/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shadows/v2/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shadows/v2/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shadows/v2/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shadows/v2/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shadows/v2/health"))
.method("GET", 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}}/shadows/v2/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shadows/v2/health")
.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('GET', '{{baseUrl}}/shadows/v2/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/shadows/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shadows/v2/health';
const options = {method: 'GET'};
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}}/shadows/v2/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shadows/v2/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shadows/v2/health',
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: 'GET', url: '{{baseUrl}}/shadows/v2/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shadows/v2/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/shadows/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shadows/v2/health';
const options = {method: 'GET'};
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}}/shadows/v2/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shadows/v2/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shadows/v2/health",
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;
}
request('GET', '{{baseUrl}}/shadows/v2/health');
echo $response->getBody();
setUrl('{{baseUrl}}/shadows/v2/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shadows/v2/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shadows/v2/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shadows/v2/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shadows/v2/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shadows/v2/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shadows/v2/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shadows/v2/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shadows/v2/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shadows/v2/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shadows/v2/health
http GET {{baseUrl}}/shadows/v2/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shadows/v2/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shadows/v2/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (16)
{{baseUrl}}/shadows/v2/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shadows/v2/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shadows/v2/version")
require "http/client"
url = "{{baseUrl}}/shadows/v2/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shadows/v2/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shadows/v2/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shadows/v2/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shadows/v2/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shadows/v2/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shadows/v2/version"))
.method("GET", 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}}/shadows/v2/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shadows/v2/version")
.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('GET', '{{baseUrl}}/shadows/v2/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/shadows/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shadows/v2/version';
const options = {method: 'GET'};
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}}/shadows/v2/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shadows/v2/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shadows/v2/version',
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: 'GET', url: '{{baseUrl}}/shadows/v2/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shadows/v2/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/shadows/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shadows/v2/version';
const options = {method: 'GET'};
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}}/shadows/v2/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shadows/v2/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shadows/v2/version",
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;
}
request('GET', '{{baseUrl}}/shadows/v2/version');
echo $response->getBody();
setUrl('{{baseUrl}}/shadows/v2/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shadows/v2/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shadows/v2/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shadows/v2/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shadows/v2/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shadows/v2/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shadows/v2/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shadows/v2/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shadows/v2/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shadows/v2/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shadows/v2/version
http GET {{baseUrl}}/shadows/v2/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shadows/v2/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shadows/v2/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
Updates a device shadow
{{baseUrl}}/shadows/v2/:trackingId
HEADERS
content-length
QUERY PARAMS
trackingId
BODY json
{
"desired": {
"payload": {},
"system": {
"detectOutliers": false,
"disableTracking": {
"periods": [
{
"begin": 0,
"end": 0
}
],
"position": "",
"sensors": ""
},
"rate": {
"distanceM": "",
"sampleMs": "",
"sendMs": ""
},
"sensorLoggingConfigurations": [
{
"samplingFrequency": "",
"type": ""
}
],
"sensorLoggingEnabled": false,
"syncGeofences": false,
"wlanConfigurations": [
{
"password": "",
"securityMode": "",
"ssid": "",
"ssidIsHidden": false
}
],
"wlanConnectivityEnabled": false
}
}
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shadows/v2/:trackingId");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-length: ");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/shadows/v2/:trackingId" {:headers {:content-length ""}
:content-type :json
:form-params {:desired {:payload {}
:system {:detectOutliers false
:disableTracking {:periods [{:begin 0
:end 0}]
:position ""
:sensors ""}
:rate {:distanceM ""
:sampleMs ""
:sendMs ""}
:sensorLoggingConfigurations [{:samplingFrequency ""
:type ""}]
:sensorLoggingEnabled false
:syncGeofences false
:wlanConfigurations [{:password ""
:securityMode ""
:ssid ""
:ssidIsHidden false}]
:wlanConnectivityEnabled false}}}})
require "http/client"
url = "{{baseUrl}}/shadows/v2/:trackingId"
headers = HTTP::Headers{
"content-length" => ""
"content-type" => "application/json"
}
reqBody = "{\n \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/shadows/v2/:trackingId"),
Content = new StringContent("{\n \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\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}}/shadows/v2/:trackingId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-length", "");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shadows/v2/:trackingId"
payload := strings.NewReader("{\n \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("content-length", "")
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/shadows/v2/:trackingId HTTP/1.1
Content-Length:
Content-Type: application/json
Host: example.com
{
"desired": {
"payload": {},
"system": {
"detectOutliers": false,
"disableTracking": {
"periods": [
{
"begin": 0,
"end": 0
}
],
"position": "",
"sensors": ""
},
"rate": {
"distanceM": "",
"sampleMs": "",
"sendMs": ""
},
"sensorLoggingConfigurations": [
{
"samplingFrequency": "",
"type": ""
}
],
"sensorLoggingEnabled": false,
"syncGeofences": false,
"wlanConfigurations": [
{
"password": "",
"securityMode": "",
"ssid": "",
"ssidIsHidden": false
}
],
"wlanConnectivityEnabled": false
}
}
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/shadows/v2/:trackingId")
.setHeader("content-length", "")
.setHeader("content-type", "application/json")
.setBody("{\n \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shadows/v2/:trackingId"))
.header("content-length", "")
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\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 \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shadows/v2/:trackingId")
.put(body)
.addHeader("content-length", "")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/shadows/v2/:trackingId")
.header("content-length", "")
.header("content-type", "application/json")
.body("{\n \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\n}")
.asString();
const data = JSON.stringify({
desired: {
payload: {},
system: {
detectOutliers: false,
disableTracking: {
periods: [
{
begin: 0,
end: 0
}
],
position: '',
sensors: ''
},
rate: {
distanceM: '',
sampleMs: '',
sendMs: ''
},
sensorLoggingConfigurations: [
{
samplingFrequency: '',
type: ''
}
],
sensorLoggingEnabled: false,
syncGeofences: false,
wlanConfigurations: [
{
password: '',
securityMode: '',
ssid: '',
ssidIsHidden: false
}
],
wlanConnectivityEnabled: false
}
}
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/shadows/v2/:trackingId');
xhr.setRequestHeader('content-length', '');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/shadows/v2/:trackingId',
headers: {'content-length': '', 'content-type': 'application/json'},
data: {
desired: {
payload: {},
system: {
detectOutliers: false,
disableTracking: {periods: [{begin: 0, end: 0}], position: '', sensors: ''},
rate: {distanceM: '', sampleMs: '', sendMs: ''},
sensorLoggingConfigurations: [{samplingFrequency: '', type: ''}],
sensorLoggingEnabled: false,
syncGeofences: false,
wlanConfigurations: [{password: '', securityMode: '', ssid: '', ssidIsHidden: false}],
wlanConnectivityEnabled: false
}
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shadows/v2/:trackingId';
const options = {
method: 'PUT',
headers: {'content-length': '', 'content-type': 'application/json'},
body: '{"desired":{"payload":{},"system":{"detectOutliers":false,"disableTracking":{"periods":[{"begin":0,"end":0}],"position":"","sensors":""},"rate":{"distanceM":"","sampleMs":"","sendMs":""},"sensorLoggingConfigurations":[{"samplingFrequency":"","type":""}],"sensorLoggingEnabled":false,"syncGeofences":false,"wlanConfigurations":[{"password":"","securityMode":"","ssid":"","ssidIsHidden":false}],"wlanConnectivityEnabled":false}}}'
};
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}}/shadows/v2/:trackingId',
method: 'PUT',
headers: {
'content-length': '',
'content-type': 'application/json'
},
processData: false,
data: '{\n "desired": {\n "payload": {},\n "system": {\n "detectOutliers": false,\n "disableTracking": {\n "periods": [\n {\n "begin": 0,\n "end": 0\n }\n ],\n "position": "",\n "sensors": ""\n },\n "rate": {\n "distanceM": "",\n "sampleMs": "",\n "sendMs": ""\n },\n "sensorLoggingConfigurations": [\n {\n "samplingFrequency": "",\n "type": ""\n }\n ],\n "sensorLoggingEnabled": false,\n "syncGeofences": false,\n "wlanConfigurations": [\n {\n "password": "",\n "securityMode": "",\n "ssid": "",\n "ssidIsHidden": false\n }\n ],\n "wlanConnectivityEnabled": false\n }\n }\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\n}")
val request = Request.Builder()
.url("{{baseUrl}}/shadows/v2/:trackingId")
.put(body)
.addHeader("content-length", "")
.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/shadows/v2/:trackingId',
headers: {
'content-length': '',
'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({
desired: {
payload: {},
system: {
detectOutliers: false,
disableTracking: {periods: [{begin: 0, end: 0}], position: '', sensors: ''},
rate: {distanceM: '', sampleMs: '', sendMs: ''},
sensorLoggingConfigurations: [{samplingFrequency: '', type: ''}],
sensorLoggingEnabled: false,
syncGeofences: false,
wlanConfigurations: [{password: '', securityMode: '', ssid: '', ssidIsHidden: false}],
wlanConnectivityEnabled: false
}
}
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/shadows/v2/:trackingId',
headers: {'content-length': '', 'content-type': 'application/json'},
body: {
desired: {
payload: {},
system: {
detectOutliers: false,
disableTracking: {periods: [{begin: 0, end: 0}], position: '', sensors: ''},
rate: {distanceM: '', sampleMs: '', sendMs: ''},
sensorLoggingConfigurations: [{samplingFrequency: '', type: ''}],
sensorLoggingEnabled: false,
syncGeofences: false,
wlanConfigurations: [{password: '', securityMode: '', ssid: '', ssidIsHidden: false}],
wlanConnectivityEnabled: false
}
}
},
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}}/shadows/v2/:trackingId');
req.headers({
'content-length': '',
'content-type': 'application/json'
});
req.type('json');
req.send({
desired: {
payload: {},
system: {
detectOutliers: false,
disableTracking: {
periods: [
{
begin: 0,
end: 0
}
],
position: '',
sensors: ''
},
rate: {
distanceM: '',
sampleMs: '',
sendMs: ''
},
sensorLoggingConfigurations: [
{
samplingFrequency: '',
type: ''
}
],
sensorLoggingEnabled: false,
syncGeofences: false,
wlanConfigurations: [
{
password: '',
securityMode: '',
ssid: '',
ssidIsHidden: false
}
],
wlanConnectivityEnabled: false
}
}
});
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}}/shadows/v2/:trackingId',
headers: {'content-length': '', 'content-type': 'application/json'},
data: {
desired: {
payload: {},
system: {
detectOutliers: false,
disableTracking: {periods: [{begin: 0, end: 0}], position: '', sensors: ''},
rate: {distanceM: '', sampleMs: '', sendMs: ''},
sensorLoggingConfigurations: [{samplingFrequency: '', type: ''}],
sensorLoggingEnabled: false,
syncGeofences: false,
wlanConfigurations: [{password: '', securityMode: '', ssid: '', ssidIsHidden: false}],
wlanConnectivityEnabled: false
}
}
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shadows/v2/:trackingId';
const options = {
method: 'PUT',
headers: {'content-length': '', 'content-type': 'application/json'},
body: '{"desired":{"payload":{},"system":{"detectOutliers":false,"disableTracking":{"periods":[{"begin":0,"end":0}],"position":"","sensors":""},"rate":{"distanceM":"","sampleMs":"","sendMs":""},"sensorLoggingConfigurations":[{"samplingFrequency":"","type":""}],"sensorLoggingEnabled":false,"syncGeofences":false,"wlanConfigurations":[{"password":"","securityMode":"","ssid":"","ssidIsHidden":false}],"wlanConnectivityEnabled":false}}}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"content-length": @"",
@"content-type": @"application/json" };
NSDictionary *parameters = @{ @"desired": @{ @"payload": @{ }, @"system": @{ @"detectOutliers": @NO, @"disableTracking": @{ @"periods": @[ @{ @"begin": @0, @"end": @0 } ], @"position": @"", @"sensors": @"" }, @"rate": @{ @"distanceM": @"", @"sampleMs": @"", @"sendMs": @"" }, @"sensorLoggingConfigurations": @[ @{ @"samplingFrequency": @"", @"type": @"" } ], @"sensorLoggingEnabled": @NO, @"syncGeofences": @NO, @"wlanConfigurations": @[ @{ @"password": @"", @"securityMode": @"", @"ssid": @"", @"ssidIsHidden": @NO } ], @"wlanConnectivityEnabled": @NO } } };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shadows/v2/:trackingId"]
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}}/shadows/v2/:trackingId" in
let headers = Header.add_list (Header.init ()) [
("content-length", "");
("content-type", "application/json");
] in
let body = Cohttp_lwt_body.of_string "{\n \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shadows/v2/:trackingId",
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([
'desired' => [
'payload' => [
],
'system' => [
'detectOutliers' => null,
'disableTracking' => [
'periods' => [
[
'begin' => 0,
'end' => 0
]
],
'position' => '',
'sensors' => ''
],
'rate' => [
'distanceM' => '',
'sampleMs' => '',
'sendMs' => ''
],
'sensorLoggingConfigurations' => [
[
'samplingFrequency' => '',
'type' => ''
]
],
'sensorLoggingEnabled' => null,
'syncGeofences' => null,
'wlanConfigurations' => [
[
'password' => '',
'securityMode' => '',
'ssid' => '',
'ssidIsHidden' => null
]
],
'wlanConnectivityEnabled' => null
]
]
]),
CURLOPT_HTTPHEADER => [
"content-length: ",
"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}}/shadows/v2/:trackingId', [
'body' => '{
"desired": {
"payload": {},
"system": {
"detectOutliers": false,
"disableTracking": {
"periods": [
{
"begin": 0,
"end": 0
}
],
"position": "",
"sensors": ""
},
"rate": {
"distanceM": "",
"sampleMs": "",
"sendMs": ""
},
"sensorLoggingConfigurations": [
{
"samplingFrequency": "",
"type": ""
}
],
"sensorLoggingEnabled": false,
"syncGeofences": false,
"wlanConfigurations": [
{
"password": "",
"securityMode": "",
"ssid": "",
"ssidIsHidden": false
}
],
"wlanConnectivityEnabled": false
}
}
}',
'headers' => [
'content-length' => '',
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shadows/v2/:trackingId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-length' => '',
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'desired' => [
'payload' => [
],
'system' => [
'detectOutliers' => null,
'disableTracking' => [
'periods' => [
[
'begin' => 0,
'end' => 0
]
],
'position' => '',
'sensors' => ''
],
'rate' => [
'distanceM' => '',
'sampleMs' => '',
'sendMs' => ''
],
'sensorLoggingConfigurations' => [
[
'samplingFrequency' => '',
'type' => ''
]
],
'sensorLoggingEnabled' => null,
'syncGeofences' => null,
'wlanConfigurations' => [
[
'password' => '',
'securityMode' => '',
'ssid' => '',
'ssidIsHidden' => null
]
],
'wlanConnectivityEnabled' => null
]
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'desired' => [
'payload' => [
],
'system' => [
'detectOutliers' => null,
'disableTracking' => [
'periods' => [
[
'begin' => 0,
'end' => 0
]
],
'position' => '',
'sensors' => ''
],
'rate' => [
'distanceM' => '',
'sampleMs' => '',
'sendMs' => ''
],
'sensorLoggingConfigurations' => [
[
'samplingFrequency' => '',
'type' => ''
]
],
'sensorLoggingEnabled' => null,
'syncGeofences' => null,
'wlanConfigurations' => [
[
'password' => '',
'securityMode' => '',
'ssid' => '',
'ssidIsHidden' => null
]
],
'wlanConnectivityEnabled' => null
]
]
]));
$request->setRequestUrl('{{baseUrl}}/shadows/v2/:trackingId');
$request->setRequestMethod('PUT');
$request->setBody($body);
$request->setHeaders([
'content-length' => '',
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("content-length", "")
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shadows/v2/:trackingId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"desired": {
"payload": {},
"system": {
"detectOutliers": false,
"disableTracking": {
"periods": [
{
"begin": 0,
"end": 0
}
],
"position": "",
"sensors": ""
},
"rate": {
"distanceM": "",
"sampleMs": "",
"sendMs": ""
},
"sensorLoggingConfigurations": [
{
"samplingFrequency": "",
"type": ""
}
],
"sensorLoggingEnabled": false,
"syncGeofences": false,
"wlanConfigurations": [
{
"password": "",
"securityMode": "",
"ssid": "",
"ssidIsHidden": false
}
],
"wlanConnectivityEnabled": false
}
}
}'
$headers=@{}
$headers.Add("content-length", "")
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shadows/v2/:trackingId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"desired": {
"payload": {},
"system": {
"detectOutliers": false,
"disableTracking": {
"periods": [
{
"begin": 0,
"end": 0
}
],
"position": "",
"sensors": ""
},
"rate": {
"distanceM": "",
"sampleMs": "",
"sendMs": ""
},
"sensorLoggingConfigurations": [
{
"samplingFrequency": "",
"type": ""
}
],
"sensorLoggingEnabled": false,
"syncGeofences": false,
"wlanConfigurations": [
{
"password": "",
"securityMode": "",
"ssid": "",
"ssidIsHidden": false
}
],
"wlanConnectivityEnabled": false
}
}
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\n}"
headers = {
'content-length': "",
'content-type': "application/json"
}
conn.request("PUT", "/baseUrl/shadows/v2/:trackingId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shadows/v2/:trackingId"
payload = { "desired": {
"payload": {},
"system": {
"detectOutliers": False,
"disableTracking": {
"periods": [
{
"begin": 0,
"end": 0
}
],
"position": "",
"sensors": ""
},
"rate": {
"distanceM": "",
"sampleMs": "",
"sendMs": ""
},
"sensorLoggingConfigurations": [
{
"samplingFrequency": "",
"type": ""
}
],
"sensorLoggingEnabled": False,
"syncGeofences": False,
"wlanConfigurations": [
{
"password": "",
"securityMode": "",
"ssid": "",
"ssidIsHidden": False
}
],
"wlanConnectivityEnabled": False
}
} }
headers = {
"content-length": "",
"content-type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shadows/v2/:trackingId"
payload <- "{\n \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\n}"
encode <- "json"
response <- VERB("PUT", url, body = payload, add_headers('content-length' = ''), content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shadows/v2/:trackingId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["content-length"] = ''
request["content-type"] = 'application/json'
request.body = "{\n \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/shadows/v2/:trackingId') do |req|
req.headers['content-length'] = ''
req.body = "{\n \"desired\": {\n \"payload\": {},\n \"system\": {\n \"detectOutliers\": false,\n \"disableTracking\": {\n \"periods\": [\n {\n \"begin\": 0,\n \"end\": 0\n }\n ],\n \"position\": \"\",\n \"sensors\": \"\"\n },\n \"rate\": {\n \"distanceM\": \"\",\n \"sampleMs\": \"\",\n \"sendMs\": \"\"\n },\n \"sensorLoggingConfigurations\": [\n {\n \"samplingFrequency\": \"\",\n \"type\": \"\"\n }\n ],\n \"sensorLoggingEnabled\": false,\n \"syncGeofences\": false,\n \"wlanConfigurations\": [\n {\n \"password\": \"\",\n \"securityMode\": \"\",\n \"ssid\": \"\",\n \"ssidIsHidden\": false\n }\n ],\n \"wlanConnectivityEnabled\": false\n }\n }\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shadows/v2/:trackingId";
let payload = json!({"desired": json!({
"payload": json!({}),
"system": json!({
"detectOutliers": false,
"disableTracking": json!({
"periods": (
json!({
"begin": 0,
"end": 0
})
),
"position": "",
"sensors": ""
}),
"rate": json!({
"distanceM": "",
"sampleMs": "",
"sendMs": ""
}),
"sensorLoggingConfigurations": (
json!({
"samplingFrequency": "",
"type": ""
})
),
"sensorLoggingEnabled": false,
"syncGeofences": false,
"wlanConfigurations": (
json!({
"password": "",
"securityMode": "",
"ssid": "",
"ssidIsHidden": false
})
),
"wlanConnectivityEnabled": false
})
})});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-length", "".parse().unwrap());
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}}/shadows/v2/:trackingId \
--header 'content-length: ' \
--header 'content-type: application/json' \
--data '{
"desired": {
"payload": {},
"system": {
"detectOutliers": false,
"disableTracking": {
"periods": [
{
"begin": 0,
"end": 0
}
],
"position": "",
"sensors": ""
},
"rate": {
"distanceM": "",
"sampleMs": "",
"sendMs": ""
},
"sensorLoggingConfigurations": [
{
"samplingFrequency": "",
"type": ""
}
],
"sensorLoggingEnabled": false,
"syncGeofences": false,
"wlanConfigurations": [
{
"password": "",
"securityMode": "",
"ssid": "",
"ssidIsHidden": false
}
],
"wlanConnectivityEnabled": false
}
}
}'
echo '{
"desired": {
"payload": {},
"system": {
"detectOutliers": false,
"disableTracking": {
"periods": [
{
"begin": 0,
"end": 0
}
],
"position": "",
"sensors": ""
},
"rate": {
"distanceM": "",
"sampleMs": "",
"sendMs": ""
},
"sensorLoggingConfigurations": [
{
"samplingFrequency": "",
"type": ""
}
],
"sensorLoggingEnabled": false,
"syncGeofences": false,
"wlanConfigurations": [
{
"password": "",
"securityMode": "",
"ssid": "",
"ssidIsHidden": false
}
],
"wlanConnectivityEnabled": false
}
}
}' | \
http PUT {{baseUrl}}/shadows/v2/:trackingId \
content-length:'' \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-length: ' \
--header 'content-type: application/json' \
--body-data '{\n "desired": {\n "payload": {},\n "system": {\n "detectOutliers": false,\n "disableTracking": {\n "periods": [\n {\n "begin": 0,\n "end": 0\n }\n ],\n "position": "",\n "sensors": ""\n },\n "rate": {\n "distanceM": "",\n "sampleMs": "",\n "sendMs": ""\n },\n "sensorLoggingConfigurations": [\n {\n "samplingFrequency": "",\n "type": ""\n }\n ],\n "sensorLoggingEnabled": false,\n "syncGeofences": false,\n "wlanConfigurations": [\n {\n "password": "",\n "securityMode": "",\n "ssid": "",\n "ssidIsHidden": false\n }\n ],\n "wlanConnectivityEnabled": false\n }\n }\n}' \
--output-document \
- {{baseUrl}}/shadows/v2/:trackingId
import Foundation
let headers = [
"content-length": "",
"content-type": "application/json"
]
let parameters = ["desired": [
"payload": [],
"system": [
"detectOutliers": false,
"disableTracking": [
"periods": [
[
"begin": 0,
"end": 0
]
],
"position": "",
"sensors": ""
],
"rate": [
"distanceM": "",
"sampleMs": "",
"sendMs": ""
],
"sensorLoggingConfigurations": [
[
"samplingFrequency": "",
"type": ""
]
],
"sensorLoggingEnabled": false,
"syncGeofences": false,
"wlanConfigurations": [
[
"password": "",
"securityMode": "",
"ssid": "",
"ssidIsHidden": false
]
],
"wlanConnectivityEnabled": false
]
]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shadows/v2/:trackingId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"desired": {
"payload": {
"color": "red"
},
"system": {
"lastModifiedGeofenceTimestamp": 0,
"rate": {
"distanceM": 0,
"sampleMs": 300000,
"sendMs": 300000
},
"stateVersion": 2
},
"timestamp": 1461065261010
}
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 409,
"details": {
"hereErrorCode": 404306
},
"error": "Conflict",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource already exists."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 413,
"details": {
"hereErrorCode": 413306
},
"error": "Payload Too Large",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request size exceeds the maximum size limit for payloads."
}
GET
Gets metrics of the shipment report
{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric")
require "http/client"
url = "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shipment-reports/v4/:shipmentReportId/:metric HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric"))
.method("GET", 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}}/shipment-reports/v4/:shipmentReportId/:metric")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric")
.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('GET', '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric';
const options = {method: 'GET'};
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}}/shipment-reports/v4/:shipmentReportId/:metric',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipment-reports/v4/:shipmentReportId/:metric',
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: 'GET',
url: '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric';
const options = {method: 'GET'};
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}}/shipment-reports/v4/:shipmentReportId/:metric"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shipment-reports/v4/:shipmentReportId/:metric" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric",
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;
}
request('GET', '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric');
echo $response->getBody();
setUrl('{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shipment-reports/v4/:shipmentReportId/:metric")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shipment-reports/v4/:shipmentReportId/:metric') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric
http GET {{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/:metric")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 429,
"error": "Too Many Requests",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "Too Many Requests"
}
GET
Gets service health (17)
{{baseUrl}}/shipment-reports/v4/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipment-reports/v4/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shipment-reports/v4/health")
require "http/client"
url = "{{baseUrl}}/shipment-reports/v4/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shipment-reports/v4/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipment-reports/v4/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipment-reports/v4/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shipment-reports/v4/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shipment-reports/v4/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipment-reports/v4/health"))
.method("GET", 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}}/shipment-reports/v4/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shipment-reports/v4/health")
.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('GET', '{{baseUrl}}/shipment-reports/v4/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/shipment-reports/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipment-reports/v4/health';
const options = {method: 'GET'};
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}}/shipment-reports/v4/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipment-reports/v4/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipment-reports/v4/health',
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: 'GET', url: '{{baseUrl}}/shipment-reports/v4/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shipment-reports/v4/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/shipment-reports/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipment-reports/v4/health';
const options = {method: 'GET'};
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}}/shipment-reports/v4/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shipment-reports/v4/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipment-reports/v4/health",
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;
}
request('GET', '{{baseUrl}}/shipment-reports/v4/health');
echo $response->getBody();
setUrl('{{baseUrl}}/shipment-reports/v4/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipment-reports/v4/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipment-reports/v4/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipment-reports/v4/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shipment-reports/v4/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipment-reports/v4/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipment-reports/v4/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipment-reports/v4/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shipment-reports/v4/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipment-reports/v4/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shipment-reports/v4/health
http GET {{baseUrl}}/shipment-reports/v4/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shipment-reports/v4/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipment-reports/v4/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (17)
{{baseUrl}}/shipment-reports/v4/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipment-reports/v4/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shipment-reports/v4/version")
require "http/client"
url = "{{baseUrl}}/shipment-reports/v4/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shipment-reports/v4/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipment-reports/v4/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipment-reports/v4/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shipment-reports/v4/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shipment-reports/v4/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipment-reports/v4/version"))
.method("GET", 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}}/shipment-reports/v4/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shipment-reports/v4/version")
.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('GET', '{{baseUrl}}/shipment-reports/v4/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/shipment-reports/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipment-reports/v4/version';
const options = {method: 'GET'};
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}}/shipment-reports/v4/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipment-reports/v4/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipment-reports/v4/version',
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: 'GET', url: '{{baseUrl}}/shipment-reports/v4/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shipment-reports/v4/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/shipment-reports/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipment-reports/v4/version';
const options = {method: 'GET'};
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}}/shipment-reports/v4/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shipment-reports/v4/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipment-reports/v4/version",
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;
}
request('GET', '{{baseUrl}}/shipment-reports/v4/version');
echo $response->getBody();
setUrl('{{baseUrl}}/shipment-reports/v4/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipment-reports/v4/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipment-reports/v4/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipment-reports/v4/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shipment-reports/v4/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipment-reports/v4/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipment-reports/v4/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipment-reports/v4/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shipment-reports/v4/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipment-reports/v4/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shipment-reports/v4/version
http GET {{baseUrl}}/shipment-reports/v4/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shipment-reports/v4/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipment-reports/v4/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets status of generation of the shipment report
{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status")
require "http/client"
url = "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shipment-reports/v4/:shipmentReportId/status HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status"))
.method("GET", 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}}/shipment-reports/v4/:shipmentReportId/status")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status")
.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('GET', '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status';
const options = {method: 'GET'};
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}}/shipment-reports/v4/:shipmentReportId/status',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipment-reports/v4/:shipmentReportId/status',
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: 'GET',
url: '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status';
const options = {method: 'GET'};
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}}/shipment-reports/v4/:shipmentReportId/status"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shipment-reports/v4/:shipmentReportId/status" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status",
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;
}
request('GET', '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status');
echo $response->getBody();
setUrl('{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shipment-reports/v4/:shipmentReportId/status")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shipment-reports/v4/:shipmentReportId/status') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shipment-reports/v4/:shipmentReportId/status
http GET {{baseUrl}}/shipment-reports/v4/:shipmentReportId/status
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shipment-reports/v4/:shipmentReportId/status
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/status")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 429,
"error": "Too Many Requests",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "Too Many Requests"
}
GET
Gets summary of the shipment report
{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary")
require "http/client"
url = "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shipment-reports/v4/:shipmentReportId/summary HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary"))
.method("GET", 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}}/shipment-reports/v4/:shipmentReportId/summary")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary")
.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('GET', '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary';
const options = {method: 'GET'};
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}}/shipment-reports/v4/:shipmentReportId/summary',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipment-reports/v4/:shipmentReportId/summary',
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: 'GET',
url: '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary';
const options = {method: 'GET'};
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}}/shipment-reports/v4/:shipmentReportId/summary"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shipment-reports/v4/:shipmentReportId/summary" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary",
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;
}
request('GET', '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary');
echo $response->getBody();
setUrl('{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shipment-reports/v4/:shipmentReportId/summary")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shipment-reports/v4/:shipmentReportId/summary') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary
http GET {{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipment-reports/v4/:shipmentReportId/summary")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 429,
"error": "Too Many Requests",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "Too Many Requests"
}
POST
Starts shipment report generation
{{baseUrl}}/shipment-reports/v4
BODY json
{
"endedAfter": "",
"endedBefore": "",
"shipmentPlanIds": [],
"startedAfter": "",
"startedBefore": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipment-reports/v4");
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 \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/shipment-reports/v4" {:content-type :json
:form-params {:endedAfter ""
:endedBefore ""
:shipmentPlanIds []
:startedAfter ""
:startedBefore ""}})
require "http/client"
url = "{{baseUrl}}/shipment-reports/v4"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/shipment-reports/v4"),
Content = new StringContent("{\n \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\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}}/shipment-reports/v4");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipment-reports/v4"
payload := strings.NewReader("{\n \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\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/shipment-reports/v4 HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 113
{
"endedAfter": "",
"endedBefore": "",
"shipmentPlanIds": [],
"startedAfter": "",
"startedBefore": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/shipment-reports/v4")
.setHeader("content-type", "application/json")
.setBody("{\n \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipment-reports/v4"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\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 \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shipment-reports/v4")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/shipment-reports/v4")
.header("content-type", "application/json")
.body("{\n \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\n}")
.asString();
const data = JSON.stringify({
endedAfter: '',
endedBefore: '',
shipmentPlanIds: [],
startedAfter: '',
startedBefore: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/shipment-reports/v4');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/shipment-reports/v4',
headers: {'content-type': 'application/json'},
data: {
endedAfter: '',
endedBefore: '',
shipmentPlanIds: [],
startedAfter: '',
startedBefore: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipment-reports/v4';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"endedAfter":"","endedBefore":"","shipmentPlanIds":[],"startedAfter":"","startedBefore":""}'
};
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}}/shipment-reports/v4',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "endedAfter": "",\n "endedBefore": "",\n "shipmentPlanIds": [],\n "startedAfter": "",\n "startedBefore": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/shipment-reports/v4")
.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/shipment-reports/v4',
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({
endedAfter: '',
endedBefore: '',
shipmentPlanIds: [],
startedAfter: '',
startedBefore: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/shipment-reports/v4',
headers: {'content-type': 'application/json'},
body: {
endedAfter: '',
endedBefore: '',
shipmentPlanIds: [],
startedAfter: '',
startedBefore: ''
},
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}}/shipment-reports/v4');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
endedAfter: '',
endedBefore: '',
shipmentPlanIds: [],
startedAfter: '',
startedBefore: ''
});
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}}/shipment-reports/v4',
headers: {'content-type': 'application/json'},
data: {
endedAfter: '',
endedBefore: '',
shipmentPlanIds: [],
startedAfter: '',
startedBefore: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipment-reports/v4';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"endedAfter":"","endedBefore":"","shipmentPlanIds":[],"startedAfter":"","startedBefore":""}'
};
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 = @{ @"endedAfter": @"",
@"endedBefore": @"",
@"shipmentPlanIds": @[ ],
@"startedAfter": @"",
@"startedBefore": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shipment-reports/v4"]
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}}/shipment-reports/v4" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipment-reports/v4",
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([
'endedAfter' => '',
'endedBefore' => '',
'shipmentPlanIds' => [
],
'startedAfter' => '',
'startedBefore' => ''
]),
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}}/shipment-reports/v4', [
'body' => '{
"endedAfter": "",
"endedBefore": "",
"shipmentPlanIds": [],
"startedAfter": "",
"startedBefore": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shipment-reports/v4');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'endedAfter' => '',
'endedBefore' => '',
'shipmentPlanIds' => [
],
'startedAfter' => '',
'startedBefore' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'endedAfter' => '',
'endedBefore' => '',
'shipmentPlanIds' => [
],
'startedAfter' => '',
'startedBefore' => ''
]));
$request->setRequestUrl('{{baseUrl}}/shipment-reports/v4');
$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}}/shipment-reports/v4' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"endedAfter": "",
"endedBefore": "",
"shipmentPlanIds": [],
"startedAfter": "",
"startedBefore": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipment-reports/v4' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"endedAfter": "",
"endedBefore": "",
"shipmentPlanIds": [],
"startedAfter": "",
"startedBefore": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/shipment-reports/v4", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipment-reports/v4"
payload = {
"endedAfter": "",
"endedBefore": "",
"shipmentPlanIds": [],
"startedAfter": "",
"startedBefore": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipment-reports/v4"
payload <- "{\n \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\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}}/shipment-reports/v4")
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 \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/shipment-reports/v4') do |req|
req.body = "{\n \"endedAfter\": \"\",\n \"endedBefore\": \"\",\n \"shipmentPlanIds\": [],\n \"startedAfter\": \"\",\n \"startedBefore\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipment-reports/v4";
let payload = json!({
"endedAfter": "",
"endedBefore": "",
"shipmentPlanIds": (),
"startedAfter": "",
"startedBefore": ""
});
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}}/shipment-reports/v4 \
--header 'content-type: application/json' \
--data '{
"endedAfter": "",
"endedBefore": "",
"shipmentPlanIds": [],
"startedAfter": "",
"startedBefore": ""
}'
echo '{
"endedAfter": "",
"endedBefore": "",
"shipmentPlanIds": [],
"startedAfter": "",
"startedBefore": ""
}' | \
http POST {{baseUrl}}/shipment-reports/v4 \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "endedAfter": "",\n "endedBefore": "",\n "shipmentPlanIds": [],\n "startedAfter": "",\n "startedBefore": ""\n}' \
--output-document \
- {{baseUrl}}/shipment-reports/v4
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"endedAfter": "",
"endedBefore": "",
"shipmentPlanIds": [],
"startedAfter": "",
"startedBefore": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipment-reports/v4")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 429,
"error": "Too Many Requests",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "Too Many Requests"
}
POST
Creates a shipment plan
{{baseUrl}}/shipments/v4/plans
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/plans");
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, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/shipments/v4/plans" {:content-type :json})
require "http/client"
url = "{{baseUrl}}/shipments/v4/plans"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/plans"),
Content = new StringContent("{}")
{
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}}/shipments/v4/plans");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/plans"
payload := strings.NewReader("{}")
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/shipments/v4/plans HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/shipments/v4/plans")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/plans"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.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, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shipments/v4/plans")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/shipments/v4/plans")
.header("content-type", "application/json")
.body("{}")
.asString();
const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/shipments/v4/plans');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/shipments/v4/plans',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/plans';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
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}}/shipments/v4/plans',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/plans")
.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/shipments/v4/plans',
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({}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/shipments/v4/plans',
headers: {'content-type': 'application/json'},
body: {},
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}}/shipments/v4/plans');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
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}}/shipments/v4/plans',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/plans';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
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 = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shipments/v4/plans"]
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}}/shipments/v4/plans" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/plans",
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([
]),
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}}/shipments/v4/plans', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/plans');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/shipments/v4/plans');
$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}}/shipments/v4/plans' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/plans' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/shipments/v4/plans", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/plans"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/plans"
payload <- "{}"
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}}/shipments/v4/plans")
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 = "{}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/shipments/v4/plans') do |req|
req.body = "{}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/plans";
let payload = json!({});
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}}/shipments/v4/plans \
--header 'content-type: application/json' \
--data '{}'
echo '{}' | \
http POST {{baseUrl}}/shipments/v4/plans \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/shipments/v4/plans
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/plans")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"shipmentPlanId": "SHPP-de2bd93d-a371-4e22-801a-528238d1a33a"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
POST
Creates a shipment
{{baseUrl}}/shipments/v4
BODY json
{}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4");
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, "{}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/shipments/v4" {:content-type :json})
require "http/client"
url = "{{baseUrl}}/shipments/v4"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/shipments/v4"),
Content = new StringContent("{}")
{
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}}/shipments/v4");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4"
payload := strings.NewReader("{}")
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/shipments/v4 HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 2
{}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/shipments/v4")
.setHeader("content-type", "application/json")
.setBody("{}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{}"))
.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, "{}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shipments/v4")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/shipments/v4")
.header("content-type", "application/json")
.body("{}")
.asString();
const data = JSON.stringify({});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/shipments/v4');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/shipments/v4',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
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}}/shipments/v4',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{}")
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4")
.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/shipments/v4',
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({}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/shipments/v4',
headers: {'content-type': 'application/json'},
body: {},
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}}/shipments/v4');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({});
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}}/shipments/v4',
headers: {'content-type': 'application/json'},
data: {}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '{}'};
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 = @{ };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shipments/v4"]
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}}/shipments/v4" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4",
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([
]),
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}}/shipments/v4', [
'body' => '{}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
]));
$request->setRequestUrl('{{baseUrl}}/shipments/v4');
$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}}/shipments/v4' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/shipments/v4", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4"
payload = {}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4"
payload <- "{}"
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}}/shipments/v4")
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 = "{}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/shipments/v4') do |req|
req.body = "{}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4";
let payload = json!({});
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}}/shipments/v4 \
--header 'content-type: application/json' \
--data '{}'
echo '{}' | \
http POST {{baseUrl}}/shipments/v4 \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{}' \
--output-document \
- {{baseUrl}}/shipments/v4
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"shipmentId": "SHP-d306beb9-e110-450e-9f81-3db9de1ac001"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Deletes a shipment plan
{{baseUrl}}/shipments/v4/plans/:shipmentPlanId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
require "http/client"
url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"
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/shipments/v4/plans/:shipmentPlanId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"))
.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}}/shipments/v4/plans/:shipmentPlanId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
.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}}/shipments/v4/plans/:shipmentPlanId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId';
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}}/shipments/v4/plans/:shipmentPlanId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/plans/:shipmentPlanId',
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}}/shipments/v4/plans/:shipmentPlanId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId');
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}}/shipments/v4/plans/:shipmentPlanId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId';
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}}/shipments/v4/plans/:shipmentPlanId"]
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}}/shipments/v4/plans/:shipmentPlanId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/plans/:shipmentPlanId",
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}}/shipments/v4/plans/:shipmentPlanId');
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/plans/:shipmentPlanId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipments/v4/plans/:shipmentPlanId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/shipments/v4/plans/:shipmentPlanId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/shipments/v4/plans/:shipmentPlanId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId";
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}}/shipments/v4/plans/:shipmentPlanId
http DELETE {{baseUrl}}/shipments/v4/plans/:shipmentPlanId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/shipments/v4/plans/:shipmentPlanId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Deletes a shipment
{{baseUrl}}/shipments/v4/:shipmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/:shipmentId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/shipments/v4/:shipmentId")
require "http/client"
url = "{{baseUrl}}/shipments/v4/:shipmentId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/:shipmentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipments/v4/:shipmentId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/:shipmentId"
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/shipments/v4/:shipmentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/shipments/v4/:shipmentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/:shipmentId"))
.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}}/shipments/v4/:shipmentId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/shipments/v4/:shipmentId")
.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}}/shipments/v4/:shipmentId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/shipments/v4/:shipmentId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/:shipmentId';
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}}/shipments/v4/:shipmentId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/:shipmentId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/:shipmentId',
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}}/shipments/v4/:shipmentId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/shipments/v4/:shipmentId');
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}}/shipments/v4/:shipmentId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/:shipmentId';
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}}/shipments/v4/:shipmentId"]
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}}/shipments/v4/:shipmentId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/:shipmentId",
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}}/shipments/v4/:shipmentId');
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/:shipmentId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipments/v4/:shipmentId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipments/v4/:shipmentId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/:shipmentId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/shipments/v4/:shipmentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/:shipmentId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/:shipmentId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/:shipmentId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/shipments/v4/:shipmentId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/:shipmentId";
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}}/shipments/v4/:shipmentId
http DELETE {{baseUrl}}/shipments/v4/:shipmentId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/shipments/v4/:shipmentId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/:shipmentId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Deletes all shipment plans
{{baseUrl}}/shipments/v4/plans
HEADERS
x-confirm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/plans");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-confirm: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/shipments/v4/plans" {:headers {:x-confirm ""}})
require "http/client"
url = "{{baseUrl}}/shipments/v4/plans"
headers = HTTP::Headers{
"x-confirm" => ""
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/plans"),
Headers =
{
{ "x-confirm", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipments/v4/plans");
var request = new RestRequest("", Method.Delete);
request.AddHeader("x-confirm", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/plans"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-confirm", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/shipments/v4/plans HTTP/1.1
X-Confirm:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/shipments/v4/plans")
.setHeader("x-confirm", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/plans"))
.header("x-confirm", "")
.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}}/shipments/v4/plans")
.delete(null)
.addHeader("x-confirm", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/shipments/v4/plans")
.header("x-confirm", "")
.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}}/shipments/v4/plans');
xhr.setRequestHeader('x-confirm', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/shipments/v4/plans',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/plans';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
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}}/shipments/v4/plans',
method: 'DELETE',
headers: {
'x-confirm': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/plans")
.delete(null)
.addHeader("x-confirm", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/plans',
headers: {
'x-confirm': ''
}
};
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}}/shipments/v4/plans',
headers: {'x-confirm': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/shipments/v4/plans');
req.headers({
'x-confirm': ''
});
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}}/shipments/v4/plans',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/plans';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-confirm": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shipments/v4/plans"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
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}}/shipments/v4/plans" in
let headers = Header.add (Header.init ()) "x-confirm" "" in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"x-confirm: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/shipments/v4/plans', [
'headers' => [
'x-confirm' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/plans');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'x-confirm' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipments/v4/plans');
$request->setRequestMethod('DELETE');
$request->setHeaders([
'x-confirm' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipments/v4/plans' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/plans' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'x-confirm': "" }
conn.request("DELETE", "/baseUrl/shipments/v4/plans", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/plans"
headers = {"x-confirm": ""}
response = requests.delete(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/plans"
response <- VERB("DELETE", url, add_headers('x-confirm' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/plans")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-confirm"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/shipments/v4/plans') do |req|
req.headers['x-confirm'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/plans";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-confirm", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/shipments/v4/plans \
--header 'x-confirm: '
http DELETE {{baseUrl}}/shipments/v4/plans \
x-confirm:''
wget --quiet \
--method DELETE \
--header 'x-confirm: ' \
--output-document \
- {{baseUrl}}/shipments/v4/plans
import Foundation
let headers = ["x-confirm": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/plans")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
DELETE
Deletes all shipments
{{baseUrl}}/shipments/v4
HEADERS
x-confirm
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "x-confirm: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/shipments/v4" {:headers {:x-confirm ""}})
require "http/client"
url = "{{baseUrl}}/shipments/v4"
headers = HTTP::Headers{
"x-confirm" => ""
}
response = HTTP::Client.delete url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/shipments/v4"),
Headers =
{
{ "x-confirm", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipments/v4");
var request = new RestRequest("", Method.Delete);
request.AddHeader("x-confirm", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-confirm", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
DELETE /baseUrl/shipments/v4 HTTP/1.1
X-Confirm:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/shipments/v4")
.setHeader("x-confirm", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4"))
.header("x-confirm", "")
.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}}/shipments/v4")
.delete(null)
.addHeader("x-confirm", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/shipments/v4")
.header("x-confirm", "")
.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}}/shipments/v4');
xhr.setRequestHeader('x-confirm', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/shipments/v4',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
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}}/shipments/v4',
method: 'DELETE',
headers: {
'x-confirm': ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4")
.delete(null)
.addHeader("x-confirm", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4',
headers: {
'x-confirm': ''
}
};
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}}/shipments/v4',
headers: {'x-confirm': ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/shipments/v4');
req.headers({
'x-confirm': ''
});
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}}/shipments/v4',
headers: {'x-confirm': ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4';
const options = {method: 'DELETE', headers: {'x-confirm': ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"x-confirm": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shipments/v4"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
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}}/shipments/v4" in
let headers = Header.add (Header.init ()) "x-confirm" "" in
Client.call ~headers `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"x-confirm: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('DELETE', '{{baseUrl}}/shipments/v4', [
'headers' => [
'x-confirm' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'x-confirm' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipments/v4');
$request->setRequestMethod('DELETE');
$request->setHeaders([
'x-confirm' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipments/v4' -Method DELETE -Headers $headers
$headers=@{}
$headers.Add("x-confirm", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4' -Method DELETE -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'x-confirm': "" }
conn.request("DELETE", "/baseUrl/shipments/v4", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4"
headers = {"x-confirm": ""}
response = requests.delete(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4"
response <- VERB("DELETE", url, add_headers('x-confirm' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["x-confirm"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/shipments/v4') do |req|
req.headers['x-confirm'] = ''
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("x-confirm", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/shipments/v4 \
--header 'x-confirm: '
http DELETE {{baseUrl}}/shipments/v4 \
x-confirm:''
wget --quiet \
--method DELETE \
--header 'x-confirm: ' \
--output-document \
- {{baseUrl}}/shipments/v4
import Foundation
let headers = ["x-confirm": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets a segment details
{{baseUrl}}/shipments/v4/:shipmentId/:segmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId")
require "http/client"
url = "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/:shipmentId/:segmentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipments/v4/:shipmentId/:segmentId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shipments/v4/:shipmentId/:segmentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/:shipmentId/:segmentId"))
.method("GET", 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}}/shipments/v4/:shipmentId/:segmentId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shipments/v4/:shipmentId/:segmentId")
.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('GET', '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId';
const options = {method: 'GET'};
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}}/shipments/v4/:shipmentId/:segmentId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/:shipmentId/:segmentId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/:shipmentId/:segmentId',
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: 'GET',
url: '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId';
const options = {method: 'GET'};
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}}/shipments/v4/:shipmentId/:segmentId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shipments/v4/:shipmentId/:segmentId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/:shipmentId/:segmentId",
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;
}
request('GET', '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId');
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/:shipmentId/:segmentId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipments/v4/:shipmentId/:segmentId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shipments/v4/:shipmentId/:segmentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/:shipmentId/:segmentId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shipments/v4/:shipmentId/:segmentId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shipments/v4/:shipmentId/:segmentId
http GET {{baseUrl}}/shipments/v4/:shipmentId/:segmentId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shipments/v4/:shipmentId/:segmentId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "From factory to port",
"destination": "LOC-7b6b15cc-2307-4875-9f66-99deb5227e92",
"endedAt": "2020-05-27T11:40:01Z",
"name": "Truck transport",
"origin": "LOC-54531862-f87a-4b70-99a4-0e8224a56be4",
"segmentId": "SEG-156986fa-1ed9-42ab-a022-9ac1a70ae137",
"startedAt": "2020-05-27T11:40:01Z",
"status": "pending",
"trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d",
"transportMode": "truck"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets a segment plan details
{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId")
require "http/client"
url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shipments/v4/plans/:shipmentPlanId/:segmentPlanId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId"))
.method("GET", 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}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId")
.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('GET', '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId';
const options = {method: 'GET'};
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}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/plans/:shipmentPlanId/:segmentPlanId',
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: 'GET',
url: '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId';
const options = {method: 'GET'};
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}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId",
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;
}
request('GET', '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId');
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shipments/v4/plans/:shipmentPlanId/:segmentPlanId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shipments/v4/plans/:shipmentPlanId/:segmentPlanId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId
http GET {{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"description": "From factory to port",
"destination": "LOC-7b6b15cc-2307-4875-9f66-99deb5227e92",
"durationS": 28800,
"name": "Truck transport",
"origin": "LOC-54531862-f87a-4b70-99a4-0e8224a56be4",
"segmentPlanId": "SEGP-3253bff4-97ba-4dfa-866c-fa8703902fcf",
"trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d",
"transportMode": "truck"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets a shipment details
{{baseUrl}}/shipments/v4/:shipmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/:shipmentId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shipments/v4/:shipmentId")
require "http/client"
url = "{{baseUrl}}/shipments/v4/:shipmentId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/:shipmentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipments/v4/:shipmentId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/:shipmentId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shipments/v4/:shipmentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shipments/v4/:shipmentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/:shipmentId"))
.method("GET", 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}}/shipments/v4/:shipmentId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shipments/v4/:shipmentId")
.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('GET', '{{baseUrl}}/shipments/v4/:shipmentId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/shipments/v4/:shipmentId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/:shipmentId';
const options = {method: 'GET'};
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}}/shipments/v4/:shipmentId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/:shipmentId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/:shipmentId',
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: 'GET', url: '{{baseUrl}}/shipments/v4/:shipmentId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shipments/v4/:shipmentId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/shipments/v4/:shipmentId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/:shipmentId';
const options = {method: 'GET'};
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}}/shipments/v4/:shipmentId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shipments/v4/:shipmentId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/:shipmentId",
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;
}
request('GET', '{{baseUrl}}/shipments/v4/:shipmentId');
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/:shipmentId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipments/v4/:shipmentId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipments/v4/:shipmentId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/:shipmentId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shipments/v4/:shipmentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/:shipmentId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/:shipmentId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/:shipmentId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shipments/v4/:shipmentId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/:shipmentId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shipments/v4/:shipmentId
http GET {{baseUrl}}/shipments/v4/:shipmentId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shipments/v4/:shipmentId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/:shipmentId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"autoStart": true,
"description": "A shipment consisting of one segment",
"name": "From Portugal to Panama",
"ruleIds": [
"712dde2c-20e6-4903-82f1-0beb0dd9e4bd",
"6d1da24b-5187-42ab-9eb5-1e43c61b6bae"
],
"segments": [
{
"description": "From factory to port",
"destination": "LOC-7b6b15cc-2307-4875-9f66-99deb5227e92",
"endedAt": "2020-05-27T11:40:01Z",
"name": "Truck transport",
"origin": "LOC-54531862-f87a-4b70-99a4-0e8224a56be4",
"segmentId": "SEG-156986fa-1ed9-42ab-a022-9ac1a70ae137",
"startedAt": "2020-05-27T11:40:01Z",
"status": "pending",
"trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d",
"transportMode": "truck"
}
],
"shipmentId": "SHP-d306beb9-e110-450e-9f81-3db9de1ac001",
"shipmentPlanId": "SHPP-de2bd93d-a371-4e22-801a-528238d1a33a",
"status": "pending",
"subShipment": false
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets a shipment plan details
{{baseUrl}}/shipments/v4/plans/:shipmentPlanId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
require "http/client"
url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shipments/v4/plans/:shipmentPlanId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"))
.method("GET", 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}}/shipments/v4/plans/:shipmentPlanId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
.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('GET', '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId';
const options = {method: 'GET'};
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}}/shipments/v4/plans/:shipmentPlanId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/plans/:shipmentPlanId',
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: 'GET',
url: '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId';
const options = {method: 'GET'};
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}}/shipments/v4/plans/:shipmentPlanId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shipments/v4/plans/:shipmentPlanId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/plans/:shipmentPlanId",
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;
}
request('GET', '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId');
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/plans/:shipmentPlanId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipments/v4/plans/:shipmentPlanId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shipments/v4/plans/:shipmentPlanId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shipments/v4/plans/:shipmentPlanId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shipments/v4/plans/:shipmentPlanId
http GET {{baseUrl}}/shipments/v4/plans/:shipmentPlanId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shipments/v4/plans/:shipmentPlanId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"autoStart": true,
"createdAt": "2020-05-27T11:40:01Z",
"description": "A shipment consisting of four segments",
"name": "From Portugal to Panama",
"ruleIds": [
"49716c18-9858-40bb-842a-15bf2ed02c64",
"ccc540b3-b2c8-4914-b00f-de518cb56e75"
],
"segments": [
{
"description": "From factory to port",
"destination": "LOC-7b6b15cc-2307-4875-9f66-99deb5227e92",
"durationS": 10800,
"name": "Truck transport",
"origin": "LOC-54531862-f87a-4b70-99a4-0e8224a56be4",
"segmentPlanId": "e19cec4f-445e-41d0-9f0e-d1304ea707d1",
"trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d",
"transportMode": "truck"
},
{
"description": "From port to another port",
"destination": "LOC-a2dc2c70-cc3e-4fa5-ac77-4c63558e7f97",
"durationS": 129600,
"name": "Marine transport",
"origin": "LOC-7b6b15cc-2307-4875-9f66-99deb5227e92",
"segmentPlanId": "6c668d6b-1eeb-46c2-ba12-31265c346c04",
"trackingId": "VRTR-8b9fd950-ce19-4aaf-98d5-840a76652658",
"transportMode": "sea"
},
{
"description": "From port to storage",
"destination": "LOC-733deb91-efa3-41b6-9003-92845866b511",
"durationS": 7200,
"name": "Truck transport",
"origin": "LOC-a2dc2c70-cc3e-4fa5-ac77-4c63558e7f97",
"segmentPlanId": "b331cc64-0c83-4347-8a08-bf984675832f",
"trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d",
"transportMode": "truck"
}
],
"shipmentPlanId": "SHPP-730b08fe-ec44-4e6f-b2b0-1d3cc264981c",
"subShipment": false
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets all shipments
{{baseUrl}}/shipments/v4
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shipments/v4")
require "http/client"
url = "{{baseUrl}}/shipments/v4"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shipments/v4"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipments/v4");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shipments/v4 HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shipments/v4")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4"))
.method("GET", 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}}/shipments/v4")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shipments/v4")
.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('GET', '{{baseUrl}}/shipments/v4');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/shipments/v4'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4';
const options = {method: 'GET'};
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}}/shipments/v4',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4',
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: 'GET', url: '{{baseUrl}}/shipments/v4'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shipments/v4');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/shipments/v4'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4';
const options = {method: 'GET'};
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}}/shipments/v4"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shipments/v4" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4",
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;
}
request('GET', '{{baseUrl}}/shipments/v4');
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipments/v4');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipments/v4' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shipments/v4")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shipments/v4') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shipments/v4
http GET {{baseUrl}}/shipments/v4
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shipments/v4
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 1,
"items": [
{
"autoStart": true,
"description": "A shipment consisting of one segment",
"name": "From Portugal to Panama",
"segments": [
{
"description": "From factory to port",
"destination": "LOC-7b6b15cc-2307-4875-9f66-99deb5227e92",
"endedAt": "2020-05-27T11:40:01Z",
"name": "Truck transport",
"origin": "LOC-54531862-f87a-4b70-99a4-0e8224a56be4",
"segmentId": "SEG-156986fa-1ed9-42ab-a022-9ac1a70ae137",
"startedAt": "2020-05-27T11:40:01Z",
"status": "pending",
"trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d",
"transportMode": "truck"
}
],
"shipmentId": "SHP-d306beb9-e110-450e-9f81-3db9de1ac001",
"status": "pending",
"subShipment": false
}
],
"limit": 100
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets segments assigned to a device
{{baseUrl}}/shipments/v4/:trackingId/segments
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/:trackingId/segments");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shipments/v4/:trackingId/segments")
require "http/client"
url = "{{baseUrl}}/shipments/v4/:trackingId/segments"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/:trackingId/segments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipments/v4/:trackingId/segments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/:trackingId/segments"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shipments/v4/:trackingId/segments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shipments/v4/:trackingId/segments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/:trackingId/segments"))
.method("GET", 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}}/shipments/v4/:trackingId/segments")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shipments/v4/:trackingId/segments")
.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('GET', '{{baseUrl}}/shipments/v4/:trackingId/segments');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/shipments/v4/:trackingId/segments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/:trackingId/segments';
const options = {method: 'GET'};
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}}/shipments/v4/:trackingId/segments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/:trackingId/segments")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/:trackingId/segments',
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: 'GET',
url: '{{baseUrl}}/shipments/v4/:trackingId/segments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shipments/v4/:trackingId/segments');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/shipments/v4/:trackingId/segments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/:trackingId/segments';
const options = {method: 'GET'};
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}}/shipments/v4/:trackingId/segments"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shipments/v4/:trackingId/segments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/:trackingId/segments",
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;
}
request('GET', '{{baseUrl}}/shipments/v4/:trackingId/segments');
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/:trackingId/segments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipments/v4/:trackingId/segments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipments/v4/:trackingId/segments' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/:trackingId/segments' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shipments/v4/:trackingId/segments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/:trackingId/segments"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/:trackingId/segments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/:trackingId/segments")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shipments/v4/:trackingId/segments') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/:trackingId/segments";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shipments/v4/:trackingId/segments
http GET {{baseUrl}}/shipments/v4/:trackingId/segments
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shipments/v4/:trackingId/segments
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/:trackingId/segments")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets service health (18)
{{baseUrl}}/shipments/v4/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shipments/v4/health")
require "http/client"
url = "{{baseUrl}}/shipments/v4/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipments/v4/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shipments/v4/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shipments/v4/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/health"))
.method("GET", 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}}/shipments/v4/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shipments/v4/health")
.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('GET', '{{baseUrl}}/shipments/v4/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/shipments/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/health';
const options = {method: 'GET'};
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}}/shipments/v4/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/health',
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: 'GET', url: '{{baseUrl}}/shipments/v4/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shipments/v4/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/shipments/v4/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/health';
const options = {method: 'GET'};
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}}/shipments/v4/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shipments/v4/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/health",
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;
}
request('GET', '{{baseUrl}}/shipments/v4/health');
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipments/v4/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipments/v4/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shipments/v4/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shipments/v4/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shipments/v4/health
http GET {{baseUrl}}/shipments/v4/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shipments/v4/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (18)
{{baseUrl}}/shipments/v4/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shipments/v4/version")
require "http/client"
url = "{{baseUrl}}/shipments/v4/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipments/v4/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shipments/v4/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shipments/v4/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/version"))
.method("GET", 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}}/shipments/v4/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shipments/v4/version")
.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('GET', '{{baseUrl}}/shipments/v4/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/shipments/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/version';
const options = {method: 'GET'};
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}}/shipments/v4/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/version',
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: 'GET', url: '{{baseUrl}}/shipments/v4/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shipments/v4/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/shipments/v4/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/version';
const options = {method: 'GET'};
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}}/shipments/v4/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shipments/v4/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/version",
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;
}
request('GET', '{{baseUrl}}/shipments/v4/version');
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipments/v4/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipments/v4/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shipments/v4/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shipments/v4/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shipments/v4/version
http GET {{baseUrl}}/shipments/v4/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shipments/v4/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Lists all shipment plans
{{baseUrl}}/shipments/v4/plans
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/plans");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/shipments/v4/plans")
require "http/client"
url = "{{baseUrl}}/shipments/v4/plans"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/plans"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/shipments/v4/plans");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/plans"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/shipments/v4/plans HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/shipments/v4/plans")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/plans"))
.method("GET", 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}}/shipments/v4/plans")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/shipments/v4/plans")
.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('GET', '{{baseUrl}}/shipments/v4/plans');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/shipments/v4/plans'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/plans';
const options = {method: 'GET'};
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}}/shipments/v4/plans',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/plans")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/plans',
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: 'GET', url: '{{baseUrl}}/shipments/v4/plans'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/shipments/v4/plans');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/shipments/v4/plans'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/plans';
const options = {method: 'GET'};
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}}/shipments/v4/plans"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/shipments/v4/plans" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/plans",
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;
}
request('GET', '{{baseUrl}}/shipments/v4/plans');
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/plans');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/shipments/v4/plans');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/shipments/v4/plans' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/plans' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/shipments/v4/plans")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/plans"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/plans"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/plans")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/shipments/v4/plans') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/plans";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/shipments/v4/plans
http GET {{baseUrl}}/shipments/v4/plans
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/shipments/v4/plans
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/plans")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"items": [
{
"autoStart": true,
"createdAt": "2020-05-27T11:40:01Z",
"description": "A shipment consisting of four segments",
"name": "From Portugal to Panama",
"ruleIds": [
"49716c18-9858-40bb-842a-15bf2ed02c64",
"ccc540b3-b2c8-4914-b00f-de518cb56e75"
],
"segments": [
{
"description": "From factory to port",
"destination": "LOC-7b6b15cc-2307-4875-9f66-99deb5227e92",
"durationS": 10800,
"name": "Truck transport",
"origin": "LOC-54531862-f87a-4b70-99a4-0e8224a56be4",
"segmentPlanId": "e19cec4f-445e-41d0-9f0e-d1304ea707d1",
"trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d",
"transportMode": "truck"
},
{
"description": "From port to another port",
"destination": "LOC-a2dc2c70-cc3e-4fa5-ac77-4c63558e7f97",
"durationS": 129600,
"name": "Marine transport",
"origin": "LOC-7b6b15cc-2307-4875-9f66-99deb5227e92",
"segmentPlanId": "6c668d6b-1eeb-46c2-ba12-31265c346c04",
"trackingId": "VRTR-8b9fd950-ce19-4aaf-98d5-840a76652658",
"transportMode": "sea"
},
{
"description": "From port to storage",
"destination": "LOC-733deb91-efa3-41b6-9003-92845866b511",
"durationS": 7200,
"name": "Truck transport",
"origin": "LOC-a2dc2c70-cc3e-4fa5-ac77-4c63558e7f97",
"segmentPlanId": "b331cc64-0c83-4347-8a08-bf984675832f",
"trackingId": "HERE-540bb24b-0d57-4f8c-aeaf-6c91cd0aff8d",
"transportMode": "truck"
}
],
"shipmentPlanId": "SHPP-730b08fe-ec44-4e6f-b2b0-1d3cc264981c",
"subShipment": false
}
]
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
PATCH
Updates a segment details
{{baseUrl}}/shipments/v4/:shipmentId/:segmentId
BODY json
{
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"status": "",
"trackingId": "",
"transportMode": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId");
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 \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId" {:content-type :json
:form-params {:description ""
:name ""
:providedEta ""
:providedEtd ""
:status ""
:trackingId ""
:transportMode ""}})
require "http/client"
url = "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/:shipmentId/:segmentId"),
Content = new StringContent("{\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\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}}/shipments/v4/:shipmentId/:segmentId");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId"
payload := strings.NewReader("{\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}")
req, _ := http.NewRequest("PATCH", 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))
}
PATCH /baseUrl/shipments/v4/:shipmentId/:segmentId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 138
{
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"status": "",
"trackingId": "",
"transportMode": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/:shipmentId/:segmentId"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\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 \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shipments/v4/:shipmentId/:segmentId")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/shipments/v4/:shipmentId/:segmentId")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}")
.asString();
const data = JSON.stringify({
description: '',
name: '',
providedEta: '',
providedEtd: '',
status: '',
trackingId: '',
transportMode: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId',
headers: {'content-type': 'application/json'},
data: {
description: '',
name: '',
providedEta: '',
providedEtd: '',
status: '',
trackingId: '',
transportMode: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"description":"","name":"","providedEta":"","providedEtd":"","status":"","trackingId":"","transportMode":""}'
};
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}}/shipments/v4/:shipmentId/:segmentId',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\n "name": "",\n "providedEta": "",\n "providedEtd": "",\n "status": "",\n "trackingId": "",\n "transportMode": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/:shipmentId/:segmentId")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/:shipmentId/:segmentId',
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({
description: '',
name: '',
providedEta: '',
providedEtd: '',
status: '',
trackingId: '',
transportMode: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId',
headers: {'content-type': 'application/json'},
body: {
description: '',
name: '',
providedEta: '',
providedEtd: '',
status: '',
trackingId: '',
transportMode: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
name: '',
providedEta: '',
providedEtd: '',
status: '',
trackingId: '',
transportMode: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId',
headers: {'content-type': 'application/json'},
data: {
description: '',
name: '',
providedEta: '',
providedEtd: '',
status: '',
trackingId: '',
transportMode: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"description":"","name":"","providedEta":"","providedEtd":"","status":"","trackingId":"","transportMode":""}'
};
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 = @{ @"description": @"",
@"name": @"",
@"providedEta": @"",
@"providedEtd": @"",
@"status": @"",
@"trackingId": @"",
@"transportMode": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shipments/v4/:shipmentId/:segmentId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[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}}/shipments/v4/:shipmentId/:segmentId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/:shipmentId/:segmentId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '',
'name' => '',
'providedEta' => '',
'providedEtd' => '',
'status' => '',
'trackingId' => '',
'transportMode' => ''
]),
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('PATCH', '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId', [
'body' => '{
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"status": "",
"trackingId": "",
"transportMode": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/:shipmentId/:segmentId');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'name' => '',
'providedEta' => '',
'providedEtd' => '',
'status' => '',
'trackingId' => '',
'transportMode' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'name' => '',
'providedEta' => '',
'providedEtd' => '',
'status' => '',
'trackingId' => '',
'transportMode' => ''
]));
$request->setRequestUrl('{{baseUrl}}/shipments/v4/:shipmentId/:segmentId');
$request->setRequestMethod('PATCH');
$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}}/shipments/v4/:shipmentId/:segmentId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"status": "",
"trackingId": "",
"transportMode": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/:shipmentId/:segmentId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"status": "",
"trackingId": "",
"transportMode": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/shipments/v4/:shipmentId/:segmentId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId"
payload = {
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"status": "",
"trackingId": "",
"transportMode": ""
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId"
payload <- "{\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/:shipmentId/:segmentId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/shipments/v4/:shipmentId/:segmentId') do |req|
req.body = "{\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"status\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId";
let payload = json!({
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"status": "",
"trackingId": "",
"transportMode": ""
});
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("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/shipments/v4/:shipmentId/:segmentId \
--header 'content-type: application/json' \
--data '{
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"status": "",
"trackingId": "",
"transportMode": ""
}'
echo '{
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"status": "",
"trackingId": "",
"transportMode": ""
}' | \
http PATCH {{baseUrl}}/shipments/v4/:shipmentId/:segmentId \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "name": "",\n "providedEta": "",\n "providedEtd": "",\n "status": "",\n "trackingId": "",\n "transportMode": ""\n}' \
--output-document \
- {{baseUrl}}/shipments/v4/:shipmentId/:segmentId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"status": "",
"trackingId": "",
"transportMode": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/:shipmentId/:segmentId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
PATCH
Updates a segment plan details
{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId
BODY json
{
"description": "",
"durationS": 0,
"name": "",
"trackingId": "",
"transportMode": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId");
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 \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId" {:content-type :json
:form-params {:description ""
:durationS 0
:name ""
:trackingId ""
:transportMode ""}})
require "http/client"
url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId"),
Content = new StringContent("{\n \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\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}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId"
payload := strings.NewReader("{\n \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}")
req, _ := http.NewRequest("PATCH", 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))
}
PATCH /baseUrl/shipments/v4/plans/:shipmentPlanId/:segmentPlanId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 98
{
"description": "",
"durationS": 0,
"name": "",
"trackingId": "",
"transportMode": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId")
.setHeader("content-type", "application/json")
.setBody("{\n \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\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 \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId")
.header("content-type", "application/json")
.body("{\n \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}")
.asString();
const data = JSON.stringify({
description: '',
durationS: 0,
name: '',
trackingId: '',
transportMode: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId',
headers: {'content-type': 'application/json'},
data: {description: '', durationS: 0, name: '', trackingId: '', transportMode: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"description":"","durationS":0,"name":"","trackingId":"","transportMode":""}'
};
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}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "description": "",\n "durationS": 0,\n "name": "",\n "trackingId": "",\n "transportMode": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/plans/:shipmentPlanId/:segmentPlanId',
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({description: '', durationS: 0, name: '', trackingId: '', transportMode: ''}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId',
headers: {'content-type': 'application/json'},
body: {description: '', durationS: 0, name: '', trackingId: '', transportMode: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
description: '',
durationS: 0,
name: '',
trackingId: '',
transportMode: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId',
headers: {'content-type': 'application/json'},
data: {description: '', durationS: 0, name: '', trackingId: '', transportMode: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"description":"","durationS":0,"name":"","trackingId":"","transportMode":""}'
};
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 = @{ @"description": @"",
@"durationS": @0,
@"name": @"",
@"trackingId": @"",
@"transportMode": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[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}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'description' => '',
'durationS' => 0,
'name' => '',
'trackingId' => '',
'transportMode' => ''
]),
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('PATCH', '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId', [
'body' => '{
"description": "",
"durationS": 0,
"name": "",
"trackingId": "",
"transportMode": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'description' => '',
'durationS' => 0,
'name' => '',
'trackingId' => '',
'transportMode' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'description' => '',
'durationS' => 0,
'name' => '',
'trackingId' => '',
'transportMode' => ''
]));
$request->setRequestUrl('{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId');
$request->setRequestMethod('PATCH');
$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}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"durationS": 0,
"name": "",
"trackingId": "",
"transportMode": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"description": "",
"durationS": 0,
"name": "",
"trackingId": "",
"transportMode": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/shipments/v4/plans/:shipmentPlanId/:segmentPlanId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId"
payload = {
"description": "",
"durationS": 0,
"name": "",
"trackingId": "",
"transportMode": ""
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId"
payload <- "{\n \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/shipments/v4/plans/:shipmentPlanId/:segmentPlanId') do |req|
req.body = "{\n \"description\": \"\",\n \"durationS\": 0,\n \"name\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId";
let payload = json!({
"description": "",
"durationS": 0,
"name": "",
"trackingId": "",
"transportMode": ""
});
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("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId \
--header 'content-type: application/json' \
--data '{
"description": "",
"durationS": 0,
"name": "",
"trackingId": "",
"transportMode": ""
}'
echo '{
"description": "",
"durationS": 0,
"name": "",
"trackingId": "",
"transportMode": ""
}' | \
http PATCH {{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "description": "",\n "durationS": 0,\n "name": "",\n "trackingId": "",\n "transportMode": ""\n}' \
--output-document \
- {{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"description": "",
"durationS": 0,
"name": "",
"trackingId": "",
"transportMode": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId/:segmentPlanId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
PATCH
Updates a shipment details
{{baseUrl}}/shipments/v4/:shipmentId
BODY json
{
"autoStart": false,
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"ruleIds": [],
"segments": [
{
"description": "",
"destination": "",
"name": "",
"origin": "",
"providedEta": "",
"providedEtd": "",
"trackingId": "",
"transportMode": ""
}
],
"status": "",
"subShipment": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/:shipmentId");
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 \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/shipments/v4/:shipmentId" {:content-type :json
:form-params {:autoStart false
:description ""
:name ""
:providedEta ""
:providedEtd ""
:ruleIds []
:segments [{:description ""
:destination ""
:name ""
:origin ""
:providedEta ""
:providedEtd ""
:trackingId ""
:transportMode ""}]
:status ""
:subShipment false}})
require "http/client"
url = "{{baseUrl}}/shipments/v4/:shipmentId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/:shipmentId"),
Content = new StringContent("{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\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}}/shipments/v4/:shipmentId");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/:shipmentId"
payload := strings.NewReader("{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\n}")
req, _ := http.NewRequest("PATCH", 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))
}
PATCH /baseUrl/shipments/v4/:shipmentId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 379
{
"autoStart": false,
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"ruleIds": [],
"segments": [
{
"description": "",
"destination": "",
"name": "",
"origin": "",
"providedEta": "",
"providedEtd": "",
"trackingId": "",
"transportMode": ""
}
],
"status": "",
"subShipment": false
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/shipments/v4/:shipmentId")
.setHeader("content-type", "application/json")
.setBody("{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/:shipmentId"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\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 \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shipments/v4/:shipmentId")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/shipments/v4/:shipmentId")
.header("content-type", "application/json")
.body("{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\n}")
.asString();
const data = JSON.stringify({
autoStart: false,
description: '',
name: '',
providedEta: '',
providedEtd: '',
ruleIds: [],
segments: [
{
description: '',
destination: '',
name: '',
origin: '',
providedEta: '',
providedEtd: '',
trackingId: '',
transportMode: ''
}
],
status: '',
subShipment: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/shipments/v4/:shipmentId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/shipments/v4/:shipmentId',
headers: {'content-type': 'application/json'},
data: {
autoStart: false,
description: '',
name: '',
providedEta: '',
providedEtd: '',
ruleIds: [],
segments: [
{
description: '',
destination: '',
name: '',
origin: '',
providedEta: '',
providedEtd: '',
trackingId: '',
transportMode: ''
}
],
status: '',
subShipment: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/:shipmentId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"autoStart":false,"description":"","name":"","providedEta":"","providedEtd":"","ruleIds":[],"segments":[{"description":"","destination":"","name":"","origin":"","providedEta":"","providedEtd":"","trackingId":"","transportMode":""}],"status":"","subShipment":false}'
};
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}}/shipments/v4/:shipmentId',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "autoStart": false,\n "description": "",\n "name": "",\n "providedEta": "",\n "providedEtd": "",\n "ruleIds": [],\n "segments": [\n {\n "description": "",\n "destination": "",\n "name": "",\n "origin": "",\n "providedEta": "",\n "providedEtd": "",\n "trackingId": "",\n "transportMode": ""\n }\n ],\n "status": "",\n "subShipment": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/:shipmentId")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/:shipmentId',
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({
autoStart: false,
description: '',
name: '',
providedEta: '',
providedEtd: '',
ruleIds: [],
segments: [
{
description: '',
destination: '',
name: '',
origin: '',
providedEta: '',
providedEtd: '',
trackingId: '',
transportMode: ''
}
],
status: '',
subShipment: false
}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/shipments/v4/:shipmentId',
headers: {'content-type': 'application/json'},
body: {
autoStart: false,
description: '',
name: '',
providedEta: '',
providedEtd: '',
ruleIds: [],
segments: [
{
description: '',
destination: '',
name: '',
origin: '',
providedEta: '',
providedEtd: '',
trackingId: '',
transportMode: ''
}
],
status: '',
subShipment: false
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/shipments/v4/:shipmentId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
autoStart: false,
description: '',
name: '',
providedEta: '',
providedEtd: '',
ruleIds: [],
segments: [
{
description: '',
destination: '',
name: '',
origin: '',
providedEta: '',
providedEtd: '',
trackingId: '',
transportMode: ''
}
],
status: '',
subShipment: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/shipments/v4/:shipmentId',
headers: {'content-type': 'application/json'},
data: {
autoStart: false,
description: '',
name: '',
providedEta: '',
providedEtd: '',
ruleIds: [],
segments: [
{
description: '',
destination: '',
name: '',
origin: '',
providedEta: '',
providedEtd: '',
trackingId: '',
transportMode: ''
}
],
status: '',
subShipment: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/:shipmentId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"autoStart":false,"description":"","name":"","providedEta":"","providedEtd":"","ruleIds":[],"segments":[{"description":"","destination":"","name":"","origin":"","providedEta":"","providedEtd":"","trackingId":"","transportMode":""}],"status":"","subShipment":false}'
};
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 = @{ @"autoStart": @NO,
@"description": @"",
@"name": @"",
@"providedEta": @"",
@"providedEtd": @"",
@"ruleIds": @[ ],
@"segments": @[ @{ @"description": @"", @"destination": @"", @"name": @"", @"origin": @"", @"providedEta": @"", @"providedEtd": @"", @"trackingId": @"", @"transportMode": @"" } ],
@"status": @"",
@"subShipment": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shipments/v4/:shipmentId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[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}}/shipments/v4/:shipmentId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/:shipmentId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'autoStart' => null,
'description' => '',
'name' => '',
'providedEta' => '',
'providedEtd' => '',
'ruleIds' => [
],
'segments' => [
[
'description' => '',
'destination' => '',
'name' => '',
'origin' => '',
'providedEta' => '',
'providedEtd' => '',
'trackingId' => '',
'transportMode' => ''
]
],
'status' => '',
'subShipment' => null
]),
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('PATCH', '{{baseUrl}}/shipments/v4/:shipmentId', [
'body' => '{
"autoStart": false,
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"ruleIds": [],
"segments": [
{
"description": "",
"destination": "",
"name": "",
"origin": "",
"providedEta": "",
"providedEtd": "",
"trackingId": "",
"transportMode": ""
}
],
"status": "",
"subShipment": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/:shipmentId');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'autoStart' => null,
'description' => '',
'name' => '',
'providedEta' => '',
'providedEtd' => '',
'ruleIds' => [
],
'segments' => [
[
'description' => '',
'destination' => '',
'name' => '',
'origin' => '',
'providedEta' => '',
'providedEtd' => '',
'trackingId' => '',
'transportMode' => ''
]
],
'status' => '',
'subShipment' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'autoStart' => null,
'description' => '',
'name' => '',
'providedEta' => '',
'providedEtd' => '',
'ruleIds' => [
],
'segments' => [
[
'description' => '',
'destination' => '',
'name' => '',
'origin' => '',
'providedEta' => '',
'providedEtd' => '',
'trackingId' => '',
'transportMode' => ''
]
],
'status' => '',
'subShipment' => null
]));
$request->setRequestUrl('{{baseUrl}}/shipments/v4/:shipmentId');
$request->setRequestMethod('PATCH');
$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}}/shipments/v4/:shipmentId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"autoStart": false,
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"ruleIds": [],
"segments": [
{
"description": "",
"destination": "",
"name": "",
"origin": "",
"providedEta": "",
"providedEtd": "",
"trackingId": "",
"transportMode": ""
}
],
"status": "",
"subShipment": false
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/:shipmentId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"autoStart": false,
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"ruleIds": [],
"segments": [
{
"description": "",
"destination": "",
"name": "",
"origin": "",
"providedEta": "",
"providedEtd": "",
"trackingId": "",
"transportMode": ""
}
],
"status": "",
"subShipment": false
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/shipments/v4/:shipmentId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/:shipmentId"
payload = {
"autoStart": False,
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"ruleIds": [],
"segments": [
{
"description": "",
"destination": "",
"name": "",
"origin": "",
"providedEta": "",
"providedEtd": "",
"trackingId": "",
"transportMode": ""
}
],
"status": "",
"subShipment": False
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/:shipmentId"
payload <- "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/:shipmentId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/shipments/v4/:shipmentId') do |req|
req.body = "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"ruleIds\": [],\n \"segments\": [\n {\n \"description\": \"\",\n \"destination\": \"\",\n \"name\": \"\",\n \"origin\": \"\",\n \"providedEta\": \"\",\n \"providedEtd\": \"\",\n \"trackingId\": \"\",\n \"transportMode\": \"\"\n }\n ],\n \"status\": \"\",\n \"subShipment\": false\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/:shipmentId";
let payload = json!({
"autoStart": false,
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"ruleIds": (),
"segments": (
json!({
"description": "",
"destination": "",
"name": "",
"origin": "",
"providedEta": "",
"providedEtd": "",
"trackingId": "",
"transportMode": ""
})
),
"status": "",
"subShipment": false
});
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("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/shipments/v4/:shipmentId \
--header 'content-type: application/json' \
--data '{
"autoStart": false,
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"ruleIds": [],
"segments": [
{
"description": "",
"destination": "",
"name": "",
"origin": "",
"providedEta": "",
"providedEtd": "",
"trackingId": "",
"transportMode": ""
}
],
"status": "",
"subShipment": false
}'
echo '{
"autoStart": false,
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"ruleIds": [],
"segments": [
{
"description": "",
"destination": "",
"name": "",
"origin": "",
"providedEta": "",
"providedEtd": "",
"trackingId": "",
"transportMode": ""
}
],
"status": "",
"subShipment": false
}' | \
http PATCH {{baseUrl}}/shipments/v4/:shipmentId \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "autoStart": false,\n "description": "",\n "name": "",\n "providedEta": "",\n "providedEtd": "",\n "ruleIds": [],\n "segments": [\n {\n "description": "",\n "destination": "",\n "name": "",\n "origin": "",\n "providedEta": "",\n "providedEtd": "",\n "trackingId": "",\n "transportMode": ""\n }\n ],\n "status": "",\n "subShipment": false\n}' \
--output-document \
- {{baseUrl}}/shipments/v4/:shipmentId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"autoStart": false,
"description": "",
"name": "",
"providedEta": "",
"providedEtd": "",
"ruleIds": [],
"segments": [
[
"description": "",
"destination": "",
"name": "",
"origin": "",
"providedEta": "",
"providedEtd": "",
"trackingId": "",
"transportMode": ""
]
],
"status": "",
"subShipment": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/:shipmentId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
PATCH
Updates a shipment plan details
{{baseUrl}}/shipments/v4/plans/:shipmentPlanId
BODY json
{
"autoStart": false,
"description": "",
"name": "",
"ruleIds": [],
"subShipment": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId");
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 \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId" {:content-type :json
:form-params {:autoStart false
:description ""
:name ""
:ruleIds []
:subShipment false}})
require "http/client"
url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"),
Content = new StringContent("{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\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}}/shipments/v4/plans/:shipmentPlanId");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"
payload := strings.NewReader("{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\n}")
req, _ := http.NewRequest("PATCH", 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))
}
PATCH /baseUrl/shipments/v4/plans/:shipmentPlanId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 100
{
"autoStart": false,
"description": "",
"name": "",
"ruleIds": [],
"subShipment": false
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
.setHeader("content-type", "application/json")
.setBody("{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\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 \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.patch("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
.header("content-type", "application/json")
.body("{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\n}")
.asString();
const data = JSON.stringify({
autoStart: false,
description: '',
name: '',
ruleIds: [],
subShipment: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId',
headers: {'content-type': 'application/json'},
data: {autoStart: false, description: '', name: '', ruleIds: [], subShipment: false}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"autoStart":false,"description":"","name":"","ruleIds":[],"subShipment":false}'
};
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}}/shipments/v4/plans/:shipmentPlanId',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "autoStart": false,\n "description": "",\n "name": "",\n "ruleIds": [],\n "subShipment": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/shipments/v4/plans/:shipmentPlanId',
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({autoStart: false, description: '', name: '', ruleIds: [], subShipment: false}));
req.end();
const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId',
headers: {'content-type': 'application/json'},
body: {autoStart: false, description: '', name: '', ruleIds: [], subShipment: false},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
autoStart: false,
description: '',
name: '',
ruleIds: [],
subShipment: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId',
headers: {'content-type': 'application/json'},
data: {autoStart: false, description: '', name: '', ruleIds: [], subShipment: false}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"autoStart":false,"description":"","name":"","ruleIds":[],"subShipment":false}'
};
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 = @{ @"autoStart": @NO,
@"description": @"",
@"name": @"",
@"ruleIds": @[ ],
@"subShipment": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[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}}/shipments/v4/plans/:shipmentPlanId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/shipments/v4/plans/:shipmentPlanId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'autoStart' => null,
'description' => '',
'name' => '',
'ruleIds' => [
],
'subShipment' => null
]),
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('PATCH', '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId', [
'body' => '{
"autoStart": false,
"description": "",
"name": "",
"ruleIds": [],
"subShipment": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/shipments/v4/plans/:shipmentPlanId');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'autoStart' => null,
'description' => '',
'name' => '',
'ruleIds' => [
],
'subShipment' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'autoStart' => null,
'description' => '',
'name' => '',
'ruleIds' => [
],
'subShipment' => null
]));
$request->setRequestUrl('{{baseUrl}}/shipments/v4/plans/:shipmentPlanId');
$request->setRequestMethod('PATCH');
$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}}/shipments/v4/plans/:shipmentPlanId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"autoStart": false,
"description": "",
"name": "",
"ruleIds": [],
"subShipment": false
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/shipments/v4/plans/:shipmentPlanId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"autoStart": false,
"description": "",
"name": "",
"ruleIds": [],
"subShipment": false
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/shipments/v4/plans/:shipmentPlanId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"
payload = {
"autoStart": False,
"description": "",
"name": "",
"ruleIds": [],
"subShipment": False
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId"
payload <- "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/shipments/v4/plans/:shipmentPlanId') do |req|
req.body = "{\n \"autoStart\": false,\n \"description\": \"\",\n \"name\": \"\",\n \"ruleIds\": [],\n \"subShipment\": false\n}"
end
puts response.status
puts response.body
use std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId";
let payload = json!({
"autoStart": false,
"description": "",
"name": "",
"ruleIds": (),
"subShipment": false
});
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("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/shipments/v4/plans/:shipmentPlanId \
--header 'content-type: application/json' \
--data '{
"autoStart": false,
"description": "",
"name": "",
"ruleIds": [],
"subShipment": false
}'
echo '{
"autoStart": false,
"description": "",
"name": "",
"ruleIds": [],
"subShipment": false
}' | \
http PATCH {{baseUrl}}/shipments/v4/plans/:shipmentPlanId \
content-type:application/json
wget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "autoStart": false,\n "description": "",\n "name": "",\n "ruleIds": [],\n "subShipment": false\n}' \
--output-document \
- {{baseUrl}}/shipments/v4/plans/:shipmentPlanId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"autoStart": false,
"description": "",
"name": "",
"ruleIds": [],
"subShipment": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/shipments/v4/plans/:shipmentPlanId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
DELETE
Deletes all the device traces and events
{{baseUrl}}/traces/v2/:trackingId
QUERY PARAMS
trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/traces/v2/:trackingId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/traces/v2/:trackingId")
require "http/client"
url = "{{baseUrl}}/traces/v2/:trackingId"
response = HTTP::Client.delete url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/traces/v2/:trackingId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/traces/v2/:trackingId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/traces/v2/:trackingId"
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/traces/v2/:trackingId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/traces/v2/:trackingId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/traces/v2/:trackingId"))
.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}}/traces/v2/:trackingId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/traces/v2/:trackingId")
.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}}/traces/v2/:trackingId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/traces/v2/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/traces/v2/:trackingId';
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}}/traces/v2/:trackingId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/traces/v2/:trackingId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/traces/v2/:trackingId',
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}}/traces/v2/:trackingId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/traces/v2/:trackingId');
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}}/traces/v2/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/traces/v2/:trackingId';
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}}/traces/v2/:trackingId"]
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}}/traces/v2/:trackingId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/traces/v2/:trackingId",
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}}/traces/v2/:trackingId');
echo $response->getBody();
setUrl('{{baseUrl}}/traces/v2/:trackingId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/traces/v2/:trackingId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/traces/v2/:trackingId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/traces/v2/:trackingId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/traces/v2/:trackingId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/traces/v2/:trackingId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/traces/v2/:trackingId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/traces/v2/:trackingId")
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_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/traces/v2/:trackingId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/traces/v2/:trackingId";
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}}/traces/v2/:trackingId
http DELETE {{baseUrl}}/traces/v2/:trackingId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/traces/v2/:trackingId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/traces/v2/:trackingId")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets service health (19)
{{baseUrl}}/traces/v2/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/traces/v2/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/traces/v2/health")
require "http/client"
url = "{{baseUrl}}/traces/v2/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/traces/v2/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/traces/v2/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/traces/v2/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/traces/v2/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/traces/v2/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/traces/v2/health"))
.method("GET", 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}}/traces/v2/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/traces/v2/health")
.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('GET', '{{baseUrl}}/traces/v2/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/traces/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/traces/v2/health';
const options = {method: 'GET'};
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}}/traces/v2/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/traces/v2/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/traces/v2/health',
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: 'GET', url: '{{baseUrl}}/traces/v2/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/traces/v2/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/traces/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/traces/v2/health';
const options = {method: 'GET'};
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}}/traces/v2/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/traces/v2/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/traces/v2/health",
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;
}
request('GET', '{{baseUrl}}/traces/v2/health');
echo $response->getBody();
setUrl('{{baseUrl}}/traces/v2/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/traces/v2/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/traces/v2/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/traces/v2/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/traces/v2/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/traces/v2/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/traces/v2/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/traces/v2/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/traces/v2/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/traces/v2/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/traces/v2/health
http GET {{baseUrl}}/traces/v2/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/traces/v2/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/traces/v2/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (19)
{{baseUrl}}/traces/v2/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/traces/v2/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/traces/v2/version")
require "http/client"
url = "{{baseUrl}}/traces/v2/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/traces/v2/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/traces/v2/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/traces/v2/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/traces/v2/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/traces/v2/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/traces/v2/version"))
.method("GET", 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}}/traces/v2/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/traces/v2/version")
.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('GET', '{{baseUrl}}/traces/v2/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/traces/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/traces/v2/version';
const options = {method: 'GET'};
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}}/traces/v2/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/traces/v2/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/traces/v2/version',
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: 'GET', url: '{{baseUrl}}/traces/v2/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/traces/v2/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/traces/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/traces/v2/version';
const options = {method: 'GET'};
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}}/traces/v2/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/traces/v2/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/traces/v2/version",
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;
}
request('GET', '{{baseUrl}}/traces/v2/version');
echo $response->getBody();
setUrl('{{baseUrl}}/traces/v2/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/traces/v2/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/traces/v2/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/traces/v2/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/traces/v2/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/traces/v2/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/traces/v2/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/traces/v2/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/traces/v2/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/traces/v2/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/traces/v2/version
http GET {{baseUrl}}/traces/v2/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/traces/v2/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/traces/v2/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets traces within a specified time range
{{baseUrl}}/traces/v2/:trackingId
QUERY PARAMS
trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/traces/v2/:trackingId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/traces/v2/:trackingId")
require "http/client"
url = "{{baseUrl}}/traces/v2/:trackingId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/traces/v2/:trackingId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/traces/v2/:trackingId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/traces/v2/:trackingId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/traces/v2/:trackingId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/traces/v2/:trackingId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/traces/v2/:trackingId"))
.method("GET", 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}}/traces/v2/:trackingId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/traces/v2/:trackingId")
.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('GET', '{{baseUrl}}/traces/v2/:trackingId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/traces/v2/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/traces/v2/:trackingId';
const options = {method: 'GET'};
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}}/traces/v2/:trackingId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/traces/v2/:trackingId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/traces/v2/:trackingId',
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: 'GET', url: '{{baseUrl}}/traces/v2/:trackingId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/traces/v2/:trackingId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/traces/v2/:trackingId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/traces/v2/:trackingId';
const options = {method: 'GET'};
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}}/traces/v2/:trackingId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/traces/v2/:trackingId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/traces/v2/:trackingId",
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;
}
request('GET', '{{baseUrl}}/traces/v2/:trackingId');
echo $response->getBody();
setUrl('{{baseUrl}}/traces/v2/:trackingId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/traces/v2/:trackingId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/traces/v2/:trackingId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/traces/v2/:trackingId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/traces/v2/:trackingId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/traces/v2/:trackingId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/traces/v2/:trackingId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/traces/v2/:trackingId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/traces/v2/:trackingId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/traces/v2/:trackingId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/traces/v2/:trackingId
http GET {{baseUrl}}/traces/v2/:trackingId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/traces/v2/:trackingId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/traces/v2/:trackingId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 2,
"data": [
{
"payload": {},
"position": {
"accuracy": "25",
"alt": "86",
"altaccuracy": "96",
"lat": "52.4988217",
"lng": "13.35170005"
},
"serverTimestamp": 1451425709682,
"system": {
"client": {
"firmware": "10.1.1",
"hasAttachSensor": true,
"hasHumiditySensor": true,
"hasPressureSensor": true,
"hasTamperSensor": true,
"hasTemperatureSensor": true,
"manufacturer": "CONCOX",
"model": "AT4H",
"name": "MT2503",
"platform": "MT6261",
"version": "10.0.16"
},
"reportedSensorData": {
"batteryLevel": 100,
"deviceIsAttached": true,
"deviceIsStationary": true,
"deviceIsTampered": false,
"pressureHpa": 994.342,
"relativeHumidity": 31.39,
"temperatureC": 24.48
}
},
"timestamp": 1451425708571
},
{
"payload": {
"refAppData": {
"batteryState": {
"charging": false,
"level": 61,
"temperature": 26.9
},
"nwpos": true
}
},
"position": {
"accuracy": "25",
"alt": "86",
"altaccuracy": "96",
"lat": "52.4988217",
"lng": "13.35170005"
},
"serverTimestamp": 1451425710434,
"system": {
"reportedSensorData": {
"batteryLevel": 100,
"deviceIsAttached": true,
"deviceIsStationary": true,
"deviceIsTampered": false,
"pressureHpa": 994.416,
"relativeHumidity": 31.37,
"temperatureC": 24.46
}
},
"timestamp": 1451425708216
}
],
"pageToken": "1490376144514"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
GET
Gets service health (20)
{{baseUrl}}/transitions/v2/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/transitions/v2/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/transitions/v2/health")
require "http/client"
url = "{{baseUrl}}/transitions/v2/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/transitions/v2/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/transitions/v2/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/transitions/v2/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/transitions/v2/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/transitions/v2/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/transitions/v2/health"))
.method("GET", 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}}/transitions/v2/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/transitions/v2/health")
.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('GET', '{{baseUrl}}/transitions/v2/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/transitions/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/transitions/v2/health';
const options = {method: 'GET'};
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}}/transitions/v2/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/transitions/v2/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/transitions/v2/health',
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: 'GET', url: '{{baseUrl}}/transitions/v2/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/transitions/v2/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/transitions/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/transitions/v2/health';
const options = {method: 'GET'};
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}}/transitions/v2/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/transitions/v2/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/transitions/v2/health",
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;
}
request('GET', '{{baseUrl}}/transitions/v2/health');
echo $response->getBody();
setUrl('{{baseUrl}}/transitions/v2/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/transitions/v2/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/transitions/v2/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/transitions/v2/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/transitions/v2/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/transitions/v2/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/transitions/v2/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/transitions/v2/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/transitions/v2/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/transitions/v2/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/transitions/v2/health
http GET {{baseUrl}}/transitions/v2/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/transitions/v2/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/transitions/v2/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (20)
{{baseUrl}}/transitions/v2/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/transitions/v2/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/transitions/v2/version")
require "http/client"
url = "{{baseUrl}}/transitions/v2/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/transitions/v2/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/transitions/v2/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/transitions/v2/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/transitions/v2/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/transitions/v2/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/transitions/v2/version"))
.method("GET", 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}}/transitions/v2/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/transitions/v2/version")
.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('GET', '{{baseUrl}}/transitions/v2/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/transitions/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/transitions/v2/version';
const options = {method: 'GET'};
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}}/transitions/v2/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/transitions/v2/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/transitions/v2/version',
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: 'GET', url: '{{baseUrl}}/transitions/v2/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/transitions/v2/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/transitions/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/transitions/v2/version';
const options = {method: 'GET'};
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}}/transitions/v2/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/transitions/v2/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/transitions/v2/version",
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;
}
request('GET', '{{baseUrl}}/transitions/v2/version');
echo $response->getBody();
setUrl('{{baseUrl}}/transitions/v2/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/transitions/v2/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/transitions/v2/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/transitions/v2/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/transitions/v2/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/transitions/v2/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/transitions/v2/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/transitions/v2/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/transitions/v2/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/transitions/v2/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/transitions/v2/version
http GET {{baseUrl}}/transitions/v2/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/transitions/v2/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/transitions/v2/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets transitions for a device
{{baseUrl}}/transitions/v2/devices/:trackingId
QUERY PARAMS
trackingId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/transitions/v2/devices/:trackingId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/transitions/v2/devices/:trackingId")
require "http/client"
url = "{{baseUrl}}/transitions/v2/devices/:trackingId"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/transitions/v2/devices/:trackingId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/transitions/v2/devices/:trackingId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/transitions/v2/devices/:trackingId"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/transitions/v2/devices/:trackingId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/transitions/v2/devices/:trackingId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/transitions/v2/devices/:trackingId"))
.method("GET", 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}}/transitions/v2/devices/:trackingId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/transitions/v2/devices/:trackingId")
.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('GET', '{{baseUrl}}/transitions/v2/devices/:trackingId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/transitions/v2/devices/:trackingId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/transitions/v2/devices/:trackingId';
const options = {method: 'GET'};
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}}/transitions/v2/devices/:trackingId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/transitions/v2/devices/:trackingId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/transitions/v2/devices/:trackingId',
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: 'GET',
url: '{{baseUrl}}/transitions/v2/devices/:trackingId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/transitions/v2/devices/:trackingId');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/transitions/v2/devices/:trackingId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/transitions/v2/devices/:trackingId';
const options = {method: 'GET'};
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}}/transitions/v2/devices/:trackingId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/transitions/v2/devices/:trackingId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/transitions/v2/devices/:trackingId",
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;
}
request('GET', '{{baseUrl}}/transitions/v2/devices/:trackingId');
echo $response->getBody();
setUrl('{{baseUrl}}/transitions/v2/devices/:trackingId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/transitions/v2/devices/:trackingId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/transitions/v2/devices/:trackingId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/transitions/v2/devices/:trackingId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/transitions/v2/devices/:trackingId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/transitions/v2/devices/:trackingId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/transitions/v2/devices/:trackingId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/transitions/v2/devices/:trackingId")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/transitions/v2/devices/:trackingId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/transitions/v2/devices/:trackingId";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/transitions/v2/devices/:trackingId
http GET {{baseUrl}}/transitions/v2/devices/:trackingId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/transitions/v2/devices/:trackingId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/transitions/v2/devices/:trackingId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"count": 2,
"data": [
{
"geofenceId": "e2f651ee-f196-4fa3-bf88-894dc131dea3",
"inOut": "PING_OUTSIDE_FENCE",
"notificationStatus": "SENT",
"timestamp": 1499258184142,
"trackingId": "HERE-871eb4c9-76f6-4e9d-bed7-fa114f793e83"
},
{
"geofenceId": "e2f651ee-f196-4fa3-bf88-894dc131dea3",
"inOut": "PING_IN_FENCE",
"notificationStatus": "NOT_SENT",
"timestamp": 1499258057035,
"trackingId": "HERE-871eb4c9-76f6-4e9d-bed7-fa114f793e83"
}
],
"pageToken": "1234abcd"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee",
"message": "The trackingId was not found."
}
POST
Gets a project-scoped user access token
{{baseUrl}}/users/v2/tokenExchange
BODY json
{
"accessToken": "",
"scope": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/v2/tokenExchange");
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 \"accessToken\": \"\",\n \"scope\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/users/v2/tokenExchange" {:content-type :json
:form-params {:accessToken ""
:scope ""}})
require "http/client"
url = "{{baseUrl}}/users/v2/tokenExchange"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"accessToken\": \"\",\n \"scope\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/users/v2/tokenExchange"),
Content = new StringContent("{\n \"accessToken\": \"\",\n \"scope\": \"\"\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}}/users/v2/tokenExchange");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"accessToken\": \"\",\n \"scope\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/v2/tokenExchange"
payload := strings.NewReader("{\n \"accessToken\": \"\",\n \"scope\": \"\"\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/users/v2/tokenExchange HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 38
{
"accessToken": "",
"scope": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/users/v2/tokenExchange")
.setHeader("content-type", "application/json")
.setBody("{\n \"accessToken\": \"\",\n \"scope\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/v2/tokenExchange"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"accessToken\": \"\",\n \"scope\": \"\"\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 \"accessToken\": \"\",\n \"scope\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/users/v2/tokenExchange")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/users/v2/tokenExchange")
.header("content-type", "application/json")
.body("{\n \"accessToken\": \"\",\n \"scope\": \"\"\n}")
.asString();
const data = JSON.stringify({
accessToken: '',
scope: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/users/v2/tokenExchange');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/users/v2/tokenExchange',
headers: {'content-type': 'application/json'},
data: {accessToken: '', scope: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/v2/tokenExchange';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"accessToken":"","scope":""}'
};
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}}/users/v2/tokenExchange',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "accessToken": "",\n "scope": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"accessToken\": \"\",\n \"scope\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/users/v2/tokenExchange")
.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/users/v2/tokenExchange',
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({accessToken: '', scope: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/users/v2/tokenExchange',
headers: {'content-type': 'application/json'},
body: {accessToken: '', scope: ''},
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}}/users/v2/tokenExchange');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
accessToken: '',
scope: ''
});
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}}/users/v2/tokenExchange',
headers: {'content-type': 'application/json'},
data: {accessToken: '', scope: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/v2/tokenExchange';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"accessToken":"","scope":""}'
};
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 = @{ @"accessToken": @"",
@"scope": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/v2/tokenExchange"]
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}}/users/v2/tokenExchange" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"accessToken\": \"\",\n \"scope\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/v2/tokenExchange",
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([
'accessToken' => '',
'scope' => ''
]),
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}}/users/v2/tokenExchange', [
'body' => '{
"accessToken": "",
"scope": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/users/v2/tokenExchange');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'accessToken' => '',
'scope' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'accessToken' => '',
'scope' => ''
]));
$request->setRequestUrl('{{baseUrl}}/users/v2/tokenExchange');
$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}}/users/v2/tokenExchange' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"accessToken": "",
"scope": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/v2/tokenExchange' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"accessToken": "",
"scope": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"accessToken\": \"\",\n \"scope\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/users/v2/tokenExchange", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/v2/tokenExchange"
payload = {
"accessToken": "",
"scope": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/v2/tokenExchange"
payload <- "{\n \"accessToken\": \"\",\n \"scope\": \"\"\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}}/users/v2/tokenExchange")
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 \"accessToken\": \"\",\n \"scope\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/users/v2/tokenExchange') do |req|
req.body = "{\n \"accessToken\": \"\",\n \"scope\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/v2/tokenExchange";
let payload = json!({
"accessToken": "",
"scope": ""
});
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}}/users/v2/tokenExchange \
--header 'content-type: application/json' \
--data '{
"accessToken": "",
"scope": ""
}'
echo '{
"accessToken": "",
"scope": ""
}' | \
http POST {{baseUrl}}/users/v2/tokenExchange \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "accessToken": "",\n "scope": ""\n}' \
--output-document \
- {{baseUrl}}/users/v2/tokenExchange
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"accessToken": "",
"scope": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/v2/tokenExchange")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"accessToken": "h1.2...EyS_b6g3uDcKnpknGWQ",
"expiresIn": 86400,
"issuedTokenType": "urn:ietf:params:oauth:token-type:access_token",
"scope": "hrn:here:authorization::myrealm:project/my-project-0000",
"tokenType": "Bearer"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 404,
"details": {
"hereErrorCode": 404306
},
"error": "Not Found",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The specified resource was not found."
}
POST
Gets a renewed user access token
{{baseUrl}}/users/v2/refresh
BODY json
{
"accessToken": "",
"refreshToken": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/v2/refresh");
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 \"accessToken\": \"\",\n \"refreshToken\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/users/v2/refresh" {:content-type :json
:form-params {:accessToken ""
:refreshToken ""}})
require "http/client"
url = "{{baseUrl}}/users/v2/refresh"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"accessToken\": \"\",\n \"refreshToken\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/users/v2/refresh"),
Content = new StringContent("{\n \"accessToken\": \"\",\n \"refreshToken\": \"\"\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}}/users/v2/refresh");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"accessToken\": \"\",\n \"refreshToken\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/v2/refresh"
payload := strings.NewReader("{\n \"accessToken\": \"\",\n \"refreshToken\": \"\"\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/users/v2/refresh HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 45
{
"accessToken": "",
"refreshToken": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/users/v2/refresh")
.setHeader("content-type", "application/json")
.setBody("{\n \"accessToken\": \"\",\n \"refreshToken\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/v2/refresh"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"accessToken\": \"\",\n \"refreshToken\": \"\"\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 \"accessToken\": \"\",\n \"refreshToken\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/users/v2/refresh")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/users/v2/refresh")
.header("content-type", "application/json")
.body("{\n \"accessToken\": \"\",\n \"refreshToken\": \"\"\n}")
.asString();
const data = JSON.stringify({
accessToken: '',
refreshToken: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/users/v2/refresh');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/users/v2/refresh',
headers: {'content-type': 'application/json'},
data: {accessToken: '', refreshToken: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/v2/refresh';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"accessToken":"","refreshToken":""}'
};
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}}/users/v2/refresh',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "accessToken": "",\n "refreshToken": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"accessToken\": \"\",\n \"refreshToken\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/users/v2/refresh")
.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/users/v2/refresh',
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({accessToken: '', refreshToken: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/users/v2/refresh',
headers: {'content-type': 'application/json'},
body: {accessToken: '', refreshToken: ''},
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}}/users/v2/refresh');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
accessToken: '',
refreshToken: ''
});
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}}/users/v2/refresh',
headers: {'content-type': 'application/json'},
data: {accessToken: '', refreshToken: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/v2/refresh';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"accessToken":"","refreshToken":""}'
};
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 = @{ @"accessToken": @"",
@"refreshToken": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/v2/refresh"]
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}}/users/v2/refresh" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"accessToken\": \"\",\n \"refreshToken\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/v2/refresh",
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([
'accessToken' => '',
'refreshToken' => ''
]),
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}}/users/v2/refresh', [
'body' => '{
"accessToken": "",
"refreshToken": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/users/v2/refresh');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'accessToken' => '',
'refreshToken' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'accessToken' => '',
'refreshToken' => ''
]));
$request->setRequestUrl('{{baseUrl}}/users/v2/refresh');
$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}}/users/v2/refresh' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"accessToken": "",
"refreshToken": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/v2/refresh' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"accessToken": "",
"refreshToken": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"accessToken\": \"\",\n \"refreshToken\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/users/v2/refresh", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/v2/refresh"
payload = {
"accessToken": "",
"refreshToken": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/v2/refresh"
payload <- "{\n \"accessToken\": \"\",\n \"refreshToken\": \"\"\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}}/users/v2/refresh")
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 \"accessToken\": \"\",\n \"refreshToken\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/users/v2/refresh') do |req|
req.body = "{\n \"accessToken\": \"\",\n \"refreshToken\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/v2/refresh";
let payload = json!({
"accessToken": "",
"refreshToken": ""
});
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}}/users/v2/refresh \
--header 'content-type: application/json' \
--data '{
"accessToken": "",
"refreshToken": ""
}'
echo '{
"accessToken": "",
"refreshToken": ""
}' | \
http POST {{baseUrl}}/users/v2/refresh \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "accessToken": "",\n "refreshToken": ""\n}' \
--output-document \
- {{baseUrl}}/users/v2/refresh
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"accessToken": "",
"refreshToken": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/v2/refresh")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"accessToken": "h1.2...EyS_b6g3uDcKnpknGWQ",
"expiresIn": 86400,
"realm": "here",
"refreshToken": "5qlkthf8mgl5lsrn8br5vdisco",
"userId": "HERE-12345678-9abc-4def-0123-456789abcdef"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
POST
Gets a user access token
{{baseUrl}}/users/v2/login
BODY json
{
"email": "",
"password": "",
"realm": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/v2/login");
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 \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/users/v2/login" {:content-type :json
:form-params {:email ""
:password ""
:realm ""}})
require "http/client"
url = "{{baseUrl}}/users/v2/login"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/users/v2/login"),
Content = new StringContent("{\n \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\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}}/users/v2/login");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/v2/login"
payload := strings.NewReader("{\n \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\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/users/v2/login HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 50
{
"email": "",
"password": "",
"realm": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/users/v2/login")
.setHeader("content-type", "application/json")
.setBody("{\n \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/v2/login"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\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 \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/users/v2/login")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/users/v2/login")
.header("content-type", "application/json")
.body("{\n \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\n}")
.asString();
const data = JSON.stringify({
email: '',
password: '',
realm: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/users/v2/login');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/users/v2/login',
headers: {'content-type': 'application/json'},
data: {email: '', password: '', realm: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/v2/login';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"email":"","password":"","realm":""}'
};
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}}/users/v2/login',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "email": "",\n "password": "",\n "realm": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/users/v2/login")
.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/users/v2/login',
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({email: '', password: '', realm: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/users/v2/login',
headers: {'content-type': 'application/json'},
body: {email: '', password: '', realm: ''},
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}}/users/v2/login');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
email: '',
password: '',
realm: ''
});
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}}/users/v2/login',
headers: {'content-type': 'application/json'},
data: {email: '', password: '', realm: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/v2/login';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"email":"","password":"","realm":""}'
};
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 = @{ @"email": @"",
@"password": @"",
@"realm": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/v2/login"]
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}}/users/v2/login" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/v2/login",
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([
'email' => '',
'password' => '',
'realm' => ''
]),
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}}/users/v2/login', [
'body' => '{
"email": "",
"password": "",
"realm": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/users/v2/login');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'email' => '',
'password' => '',
'realm' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'email' => '',
'password' => '',
'realm' => ''
]));
$request->setRequestUrl('{{baseUrl}}/users/v2/login');
$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}}/users/v2/login' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"email": "",
"password": "",
"realm": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/v2/login' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"email": "",
"password": "",
"realm": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/users/v2/login", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/v2/login"
payload = {
"email": "",
"password": "",
"realm": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/v2/login"
payload <- "{\n \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\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}}/users/v2/login")
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 \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\n}"
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/users/v2/login') do |req|
req.body = "{\n \"email\": \"\",\n \"password\": \"\",\n \"realm\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/v2/login";
let payload = json!({
"email": "",
"password": "",
"realm": ""
});
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}}/users/v2/login \
--header 'content-type: application/json' \
--data '{
"email": "",
"password": "",
"realm": ""
}'
echo '{
"email": "",
"password": "",
"realm": ""
}' | \
http POST {{baseUrl}}/users/v2/login \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "email": "",\n "password": "",\n "realm": ""\n}' \
--output-document \
- {{baseUrl}}/users/v2/login
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"email": "",
"password": "",
"realm": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/v2/login")! 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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"accessToken": "h1.2...EyS_b6g3uDcKnpknGWQ",
"expiresIn": 86400,
"realm": "here",
"refreshToken": "5qlkthf8mgl5lsrn8br5vdisco",
"userId": "HERE-12345678-9abc-4def-0123-456789abcdef"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets all devices claimed by a project
{{baseUrl}}/users/v2/devices
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/v2/devices");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users/v2/devices")
require "http/client"
url = "{{baseUrl}}/users/v2/devices"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users/v2/devices"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/users/v2/devices");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/v2/devices"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/users/v2/devices HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users/v2/devices")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/v2/devices"))
.method("GET", 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}}/users/v2/devices")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/users/v2/devices")
.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('GET', '{{baseUrl}}/users/v2/devices');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/users/v2/devices'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/v2/devices';
const options = {method: 'GET'};
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}}/users/v2/devices',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/v2/devices")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/v2/devices',
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: 'GET', url: '{{baseUrl}}/users/v2/devices'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users/v2/devices');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/users/v2/devices'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/v2/devices';
const options = {method: 'GET'};
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}}/users/v2/devices"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/users/v2/devices" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/v2/devices",
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;
}
request('GET', '{{baseUrl}}/users/v2/devices');
echo $response->getBody();
setUrl('{{baseUrl}}/users/v2/devices');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/users/v2/devices');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/v2/devices' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/v2/devices' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users/v2/devices")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/v2/devices"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/v2/devices"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/v2/devices")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users/v2/devices') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/v2/devices";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users/v2/devices
http GET {{baseUrl}}/users/v2/devices
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users/v2/devices
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/v2/devices")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 400,
"details": {
"hereErrorCode": 400306
},
"error": "Bad request",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The request object is in an incorrect format or has values that are invalid or out of range."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 401,
"details": {
"hereErrorCode": 401306
},
"error": "Unauthorized",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The provided credentials are not valid."
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": 403,
"details": {
"hereErrorCode": 403306
},
"error": "Forbidden",
"id": "5771b3d4-95ae-4959-ac63-fbaa3d5d06ee-lds2",
"message": "The account does not have the correct privileges."
}
GET
Gets service health (21)
{{baseUrl}}/users/v2/health
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/v2/health");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users/v2/health")
require "http/client"
url = "{{baseUrl}}/users/v2/health"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users/v2/health"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/users/v2/health");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/v2/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/users/v2/health HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users/v2/health")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/v2/health"))
.method("GET", 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}}/users/v2/health")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/users/v2/health")
.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('GET', '{{baseUrl}}/users/v2/health');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/users/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/v2/health';
const options = {method: 'GET'};
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}}/users/v2/health',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/v2/health")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/v2/health',
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: 'GET', url: '{{baseUrl}}/users/v2/health'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users/v2/health');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/users/v2/health'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/v2/health';
const options = {method: 'GET'};
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}}/users/v2/health"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/users/v2/health" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/v2/health",
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;
}
request('GET', '{{baseUrl}}/users/v2/health');
echo $response->getBody();
setUrl('{{baseUrl}}/users/v2/health');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/users/v2/health');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/v2/health' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/v2/health' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users/v2/health")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/v2/health"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/v2/health"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/v2/health")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users/v2/health') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/v2/health";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users/v2/health
http GET {{baseUrl}}/users/v2/health
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users/v2/health
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/v2/health")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
GET
Gets service version (21)
{{baseUrl}}/users/v2/version
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/v2/version");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users/v2/version")
require "http/client"
url = "{{baseUrl}}/users/v2/version"
response = HTTP::Client.get url
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users/v2/version"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/users/v2/version");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/v2/version"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/users/v2/version HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users/v2/version")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/v2/version"))
.method("GET", 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}}/users/v2/version")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/users/v2/version")
.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('GET', '{{baseUrl}}/users/v2/version');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/users/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/users/v2/version';
const options = {method: 'GET'};
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}}/users/v2/version',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/v2/version")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/v2/version',
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: 'GET', url: '{{baseUrl}}/users/v2/version'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users/v2/version');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/users/v2/version'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/v2/version';
const options = {method: 'GET'};
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}}/users/v2/version"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
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}}/users/v2/version" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/users/v2/version",
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;
}
request('GET', '{{baseUrl}}/users/v2/version');
echo $response->getBody();
setUrl('{{baseUrl}}/users/v2/version');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/users/v2/version');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/v2/version' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/v2/version' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users/v2/version")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/users/v2/version"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/users/v2/version"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/v2/version")
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
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users/v2/version') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/v2/version";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users/v2/version
http GET {{baseUrl}}/users/v2/version
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users/v2/version
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/v2/version")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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()