Business Registries
GET
Retrieve a list of address types
{{baseUrl}}/classifications/address-types
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/classifications/address-types");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/classifications/address-types")
require "http/client"
url = "{{baseUrl}}/classifications/address-types"
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}}/classifications/address-types"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/classifications/address-types");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/classifications/address-types"
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/classifications/address-types HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/classifications/address-types")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/classifications/address-types"))
.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}}/classifications/address-types")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/classifications/address-types")
.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}}/classifications/address-types');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/classifications/address-types'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/classifications/address-types';
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}}/classifications/address-types',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/classifications/address-types")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/classifications/address-types',
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}}/classifications/address-types'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/classifications/address-types');
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}}/classifications/address-types'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/classifications/address-types';
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}}/classifications/address-types"]
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}}/classifications/address-types" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/classifications/address-types",
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}}/classifications/address-types');
echo $response->getBody();
setUrl('{{baseUrl}}/classifications/address-types');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/classifications/address-types');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/classifications/address-types' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/classifications/address-types' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/classifications/address-types")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/classifications/address-types"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/classifications/address-types"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/classifications/address-types")
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/classifications/address-types') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/classifications/address-types";
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}}/classifications/address-types
http GET {{baseUrl}}/classifications/address-types
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/classifications/address-types
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/classifications/address-types")! 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": "The address at which an individual or organisation receives letters or packages.",
"id": "123e4567-e89b-12d3-a456-426655440001",
"name": "Mailing"
},
{
"description": "The main location where work is conducted.",
"id": "123e4567-e89b-12d3-a456-426655440002",
"name": "Principal Place of Business"
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of business name lifecycle states
{{baseUrl}}/classifications/business-name-lifecycle-states
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/classifications/business-name-lifecycle-states");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/classifications/business-name-lifecycle-states")
require "http/client"
url = "{{baseUrl}}/classifications/business-name-lifecycle-states"
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}}/classifications/business-name-lifecycle-states"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/classifications/business-name-lifecycle-states");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/classifications/business-name-lifecycle-states"
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/classifications/business-name-lifecycle-states HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/classifications/business-name-lifecycle-states")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/classifications/business-name-lifecycle-states"))
.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}}/classifications/business-name-lifecycle-states")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/classifications/business-name-lifecycle-states")
.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}}/classifications/business-name-lifecycle-states');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/classifications/business-name-lifecycle-states'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/classifications/business-name-lifecycle-states';
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}}/classifications/business-name-lifecycle-states',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/classifications/business-name-lifecycle-states")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/classifications/business-name-lifecycle-states',
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}}/classifications/business-name-lifecycle-states'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/classifications/business-name-lifecycle-states');
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}}/classifications/business-name-lifecycle-states'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/classifications/business-name-lifecycle-states';
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}}/classifications/business-name-lifecycle-states"]
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}}/classifications/business-name-lifecycle-states" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/classifications/business-name-lifecycle-states",
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}}/classifications/business-name-lifecycle-states');
echo $response->getBody();
setUrl('{{baseUrl}}/classifications/business-name-lifecycle-states');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/classifications/business-name-lifecycle-states');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/classifications/business-name-lifecycle-states' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/classifications/business-name-lifecycle-states' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/classifications/business-name-lifecycle-states")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/classifications/business-name-lifecycle-states"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/classifications/business-name-lifecycle-states"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/classifications/business-name-lifecycle-states")
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/classifications/business-name-lifecycle-states') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/classifications/business-name-lifecycle-states";
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}}/classifications/business-name-lifecycle-states
http GET {{baseUrl}}/classifications/business-name-lifecycle-states
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/classifications/business-name-lifecycle-states
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/classifications/business-name-lifecycle-states")! 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": "The Business Name has been approved.",
"id": "123e4567-e89b-12d3-a456-426655440001",
"name": "Approved"
},
{
"description": "The Business Name has expired.",
"id": "123e4567-e89b-12d3-a456-426655440002",
"name": "Expired"
},
{
"description": "The Business Name has been issued.",
"id": "123e4567-e89b-12d3-a456-426655440003",
"name": "Issued"
},
{
"description": "The Business Name is pending approval.",
"id": "123e4567-e89b-12d3-a456-426655440004",
"name": "Pending Approval"
},
{
"description": "The Business Name has been suspended.",
"id": "123e4567-e89b-12d3-a456-426655440005",
"name": "Suspended"
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of business names
{{baseUrl}}/business-names
HEADERS
apiKey
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/business-names");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "apikey: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/business-names" {:headers {:apikey ""}})
require "http/client"
url = "{{baseUrl}}/business-names"
headers = HTTP::Headers{
"apikey" => ""
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/business-names"),
Headers =
{
{ "apikey", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/business-names");
var request = new RestRequest("", Method.Get);
request.AddHeader("apikey", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/business-names"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/business-names HTTP/1.1
Apikey:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/business-names")
.setHeader("apikey", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/business-names"))
.header("apikey", "")
.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}}/business-names")
.get()
.addHeader("apikey", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/business-names")
.header("apikey", "")
.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}}/business-names');
xhr.setRequestHeader('apikey', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/business-names',
headers: {apikey: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/business-names';
const options = {method: 'GET', headers: {apikey: ''}};
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}}/business-names',
method: 'GET',
headers: {
apikey: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/business-names")
.get()
.addHeader("apikey", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/business-names',
headers: {
apikey: ''
}
};
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}}/business-names',
headers: {apikey: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/business-names');
req.headers({
apikey: ''
});
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}}/business-names',
headers: {apikey: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/business-names';
const options = {method: 'GET', headers: {apikey: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"apikey": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/business-names"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[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}}/business-names" in
let headers = Header.add (Header.init ()) "apikey" "" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/business-names",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/business-names', [
'headers' => [
'apikey' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/business-names');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'apikey' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/business-names');
$request->setRequestMethod('GET');
$request->setHeaders([
'apikey' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("apikey", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/business-names' -Method GET -Headers $headers
$headers=@{}
$headers.Add("apikey", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/business-names' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'apikey': "" }
conn.request("GET", "/baseUrl/business-names", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/business-names"
headers = {"apikey": ""}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/business-names"
response <- VERB("GET", url, add_headers('apikey' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/business-names")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/business-names') do |req|
req.headers['apikey'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/business-names";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("apikey", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/business-names \
--header 'apikey: '
http GET {{baseUrl}}/business-names \
apikey:''
wget --quiet \
--method GET \
--header 'apikey: ' \
--output-document \
- {{baseUrl}}/business-names
import Foundation
let headers = ["apikey": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/business-names")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
[
{
"fromDate": "1979-01-13T09:05:06+10:00",
"name": "XYZ Technology Ventures",
"toDate": ""
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of electronic address types
{{baseUrl}}/classifications/electronic-address-types
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/classifications/electronic-address-types");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/classifications/electronic-address-types")
require "http/client"
url = "{{baseUrl}}/classifications/electronic-address-types"
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}}/classifications/electronic-address-types"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/classifications/electronic-address-types");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/classifications/electronic-address-types"
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/classifications/electronic-address-types HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/classifications/electronic-address-types")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/classifications/electronic-address-types"))
.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}}/classifications/electronic-address-types")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/classifications/electronic-address-types")
.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}}/classifications/electronic-address-types');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/classifications/electronic-address-types'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/classifications/electronic-address-types';
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}}/classifications/electronic-address-types',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/classifications/electronic-address-types")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/classifications/electronic-address-types',
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}}/classifications/electronic-address-types'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/classifications/electronic-address-types');
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}}/classifications/electronic-address-types'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/classifications/electronic-address-types';
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}}/classifications/electronic-address-types"]
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}}/classifications/electronic-address-types" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/classifications/electronic-address-types",
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}}/classifications/electronic-address-types');
echo $response->getBody();
setUrl('{{baseUrl}}/classifications/electronic-address-types');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/classifications/electronic-address-types');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/classifications/electronic-address-types' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/classifications/electronic-address-types' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/classifications/electronic-address-types")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/classifications/electronic-address-types"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/classifications/electronic-address-types"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/classifications/electronic-address-types")
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/classifications/electronic-address-types') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/classifications/electronic-address-types";
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}}/classifications/electronic-address-types
http GET {{baseUrl}}/classifications/electronic-address-types
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/classifications/electronic-address-types
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/classifications/electronic-address-types")! 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": "An address used to send and receive emails.",
"id": "123e4567-e89b-12d3-a456-426655440001",
"name": "Email"
},
{
"description": "A number used to send and receive faxes.",
"id": "123e4567-e89b-12d3-a456-426655440002",
"name": "Fax"
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of genders
{{baseUrl}}/classifications/genders
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/classifications/genders");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/classifications/genders")
require "http/client"
url = "{{baseUrl}}/classifications/genders"
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}}/classifications/genders"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/classifications/genders");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/classifications/genders"
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/classifications/genders HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/classifications/genders")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/classifications/genders"))
.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}}/classifications/genders")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/classifications/genders")
.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}}/classifications/genders');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/classifications/genders'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/classifications/genders';
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}}/classifications/genders',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/classifications/genders")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/classifications/genders',
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}}/classifications/genders'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/classifications/genders');
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}}/classifications/genders'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/classifications/genders';
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}}/classifications/genders"]
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}}/classifications/genders" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/classifications/genders",
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}}/classifications/genders');
echo $response->getBody();
setUrl('{{baseUrl}}/classifications/genders');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/classifications/genders');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/classifications/genders' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/classifications/genders' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/classifications/genders")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/classifications/genders"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/classifications/genders"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/classifications/genders")
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/classifications/genders') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/classifications/genders";
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}}/classifications/genders
http GET {{baseUrl}}/classifications/genders
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/classifications/genders
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/classifications/genders")! 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
[
{
"gender": "Not Known",
"id": "123e4567-e89b-12d3-a456-426655440001"
},
{
"gender": "Male",
"id": "123e4567-e89b-12d3-a456-426655440002"
},
{
"gender": "Female",
"id": "123e4567-e89b-12d3-a456-426655440003"
},
{
"gender": "Not Applicable",
"id": "123e4567-e89b-12d3-a456-426655440004"
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
POST
Create an individual
{{baseUrl}}/individuals
HEADERS
apiKey
BODY json
{
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "apikey: ");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/individuals" {:headers {:apikey ""}
:content-type :json
:form-params {:addresses []
:dateOfBirth ""
:electronicAddresses [{:areaCode ""
:countryPrefix ""
:electronicAddressType ""
:email ""
:extension ""
:fromDate ""
:id ""
:number ""
:toDate ""
:url ""}]
:fromDate ""
:gender ""
:id ""
:names [{:direction ""
:familyName ""
:formalSalutation ""
:fromDate ""
:givenName ""
:id ""
:informalSalutation ""
:middleName ""
:namePrefix ""
:nameSuffix ""
:nameType ""
:toDate ""}]
:placeOfBirth ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/individuals"
headers = HTTP::Headers{
"apikey" => ""
"content-type" => "application/json"
}
reqBody = "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\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}}/individuals"),
Headers =
{
{ "apikey", "" },
},
Content = new StringContent("{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\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}}/individuals");
var request = new RestRequest("", Method.Post);
request.AddHeader("apikey", "");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals"
payload := strings.NewReader("{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "")
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/individuals HTTP/1.1
Apikey:
Content-Type: application/json
Host: example.com
Content-Length: 703
{
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/individuals")
.setHeader("apikey", "")
.setHeader("content-type", "application/json")
.setBody("{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals"))
.header("apikey", "")
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\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 \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/individuals")
.post(body)
.addHeader("apikey", "")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/individuals")
.header("apikey", "")
.header("content-type", "application/json")
.body("{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
addresses: [],
dateOfBirth: '',
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
fromDate: '',
gender: '',
id: '',
names: [
{
direction: '',
familyName: '',
formalSalutation: '',
fromDate: '',
givenName: '',
id: '',
informalSalutation: '',
middleName: '',
namePrefix: '',
nameSuffix: '',
nameType: '',
toDate: ''
}
],
placeOfBirth: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/individuals');
xhr.setRequestHeader('apikey', '');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/individuals',
headers: {apikey: '', 'content-type': 'application/json'},
data: {
addresses: [],
dateOfBirth: '',
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
fromDate: '',
gender: '',
id: '',
names: [
{
direction: '',
familyName: '',
formalSalutation: '',
fromDate: '',
givenName: '',
id: '',
informalSalutation: '',
middleName: '',
namePrefix: '',
nameSuffix: '',
nameType: '',
toDate: ''
}
],
placeOfBirth: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals';
const options = {
method: 'POST',
headers: {apikey: '', 'content-type': 'application/json'},
body: '{"addresses":[],"dateOfBirth":"","electronicAddresses":[{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","url":""}],"fromDate":"","gender":"","id":"","names":[{"direction":"","familyName":"","formalSalutation":"","fromDate":"","givenName":"","id":"","informalSalutation":"","middleName":"","namePrefix":"","nameSuffix":"","nameType":"","toDate":""}],"placeOfBirth":"","toDate":""}'
};
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}}/individuals',
method: 'POST',
headers: {
apikey: '',
'content-type': 'application/json'
},
processData: false,
data: '{\n "addresses": [],\n "dateOfBirth": "",\n "electronicAddresses": [\n {\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\n "url": ""\n }\n ],\n "fromDate": "",\n "gender": "",\n "id": "",\n "names": [\n {\n "direction": "",\n "familyName": "",\n "formalSalutation": "",\n "fromDate": "",\n "givenName": "",\n "id": "",\n "informalSalutation": "",\n "middleName": "",\n "namePrefix": "",\n "nameSuffix": "",\n "nameType": "",\n "toDate": ""\n }\n ],\n "placeOfBirth": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/individuals")
.post(body)
.addHeader("apikey", "")
.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/individuals',
headers: {
apikey: '',
'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({
addresses: [],
dateOfBirth: '',
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
fromDate: '',
gender: '',
id: '',
names: [
{
direction: '',
familyName: '',
formalSalutation: '',
fromDate: '',
givenName: '',
id: '',
informalSalutation: '',
middleName: '',
namePrefix: '',
nameSuffix: '',
nameType: '',
toDate: ''
}
],
placeOfBirth: '',
toDate: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/individuals',
headers: {apikey: '', 'content-type': 'application/json'},
body: {
addresses: [],
dateOfBirth: '',
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
fromDate: '',
gender: '',
id: '',
names: [
{
direction: '',
familyName: '',
formalSalutation: '',
fromDate: '',
givenName: '',
id: '',
informalSalutation: '',
middleName: '',
namePrefix: '',
nameSuffix: '',
nameType: '',
toDate: ''
}
],
placeOfBirth: '',
toDate: ''
},
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}}/individuals');
req.headers({
apikey: '',
'content-type': 'application/json'
});
req.type('json');
req.send({
addresses: [],
dateOfBirth: '',
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
fromDate: '',
gender: '',
id: '',
names: [
{
direction: '',
familyName: '',
formalSalutation: '',
fromDate: '',
givenName: '',
id: '',
informalSalutation: '',
middleName: '',
namePrefix: '',
nameSuffix: '',
nameType: '',
toDate: ''
}
],
placeOfBirth: '',
toDate: ''
});
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}}/individuals',
headers: {apikey: '', 'content-type': 'application/json'},
data: {
addresses: [],
dateOfBirth: '',
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
fromDate: '',
gender: '',
id: '',
names: [
{
direction: '',
familyName: '',
formalSalutation: '',
fromDate: '',
givenName: '',
id: '',
informalSalutation: '',
middleName: '',
namePrefix: '',
nameSuffix: '',
nameType: '',
toDate: ''
}
],
placeOfBirth: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals';
const options = {
method: 'POST',
headers: {apikey: '', 'content-type': 'application/json'},
body: '{"addresses":[],"dateOfBirth":"","electronicAddresses":[{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","url":""}],"fromDate":"","gender":"","id":"","names":[{"direction":"","familyName":"","formalSalutation":"","fromDate":"","givenName":"","id":"","informalSalutation":"","middleName":"","namePrefix":"","nameSuffix":"","nameType":"","toDate":""}],"placeOfBirth":"","toDate":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"apikey": @"",
@"content-type": @"application/json" };
NSDictionary *parameters = @{ @"addresses": @[ ],
@"dateOfBirth": @"",
@"electronicAddresses": @[ @{ @"areaCode": @"", @"countryPrefix": @"", @"electronicAddressType": @"", @"email": @"", @"extension": @"", @"fromDate": @"", @"id": @"", @"number": @"", @"toDate": @"", @"url": @"" } ],
@"fromDate": @"",
@"gender": @"",
@"id": @"",
@"names": @[ @{ @"direction": @"", @"familyName": @"", @"formalSalutation": @"", @"fromDate": @"", @"givenName": @"", @"id": @"", @"informalSalutation": @"", @"middleName": @"", @"namePrefix": @"", @"nameSuffix": @"", @"nameType": @"", @"toDate": @"" } ],
@"placeOfBirth": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/individuals"]
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}}/individuals" in
let headers = Header.add_list (Header.init ()) [
("apikey", "");
("content-type", "application/json");
] in
let body = Cohttp_lwt_body.of_string "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals",
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([
'addresses' => [
],
'dateOfBirth' => '',
'electronicAddresses' => [
[
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]
],
'fromDate' => '',
'gender' => '',
'id' => '',
'names' => [
[
'direction' => '',
'familyName' => '',
'formalSalutation' => '',
'fromDate' => '',
'givenName' => '',
'id' => '',
'informalSalutation' => '',
'middleName' => '',
'namePrefix' => '',
'nameSuffix' => '',
'nameType' => '',
'toDate' => ''
]
],
'placeOfBirth' => '',
'toDate' => ''
]),
CURLOPT_HTTPHEADER => [
"apikey: ",
"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}}/individuals', [
'body' => '{
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}',
'headers' => [
'apikey' => '',
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/individuals');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'apikey' => '',
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'addresses' => [
],
'dateOfBirth' => '',
'electronicAddresses' => [
[
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]
],
'fromDate' => '',
'gender' => '',
'id' => '',
'names' => [
[
'direction' => '',
'familyName' => '',
'formalSalutation' => '',
'fromDate' => '',
'givenName' => '',
'id' => '',
'informalSalutation' => '',
'middleName' => '',
'namePrefix' => '',
'nameSuffix' => '',
'nameType' => '',
'toDate' => ''
]
],
'placeOfBirth' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'addresses' => [
],
'dateOfBirth' => '',
'electronicAddresses' => [
[
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]
],
'fromDate' => '',
'gender' => '',
'id' => '',
'names' => [
[
'direction' => '',
'familyName' => '',
'formalSalutation' => '',
'fromDate' => '',
'givenName' => '',
'id' => '',
'informalSalutation' => '',
'middleName' => '',
'namePrefix' => '',
'nameSuffix' => '',
'nameType' => '',
'toDate' => ''
]
],
'placeOfBirth' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/individuals');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'apikey' => '',
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("apikey", "")
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("apikey", "")
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}"
headers = {
'apikey': "",
'content-type': "application/json"
}
conn.request("POST", "/baseUrl/individuals", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals"
payload = {
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}
headers = {
"apikey": "",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals"
payload <- "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, add_headers('apikey' = ''), content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = ''
request["content-type"] = 'application/json'
request.body = "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\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/individuals') do |req|
req.headers['apikey'] = ''
req.body = "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals";
let payload = json!({
"addresses": (),
"dateOfBirth": "",
"electronicAddresses": (
json!({
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
})
),
"fromDate": "",
"gender": "",
"id": "",
"names": (
json!({
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
})
),
"placeOfBirth": "",
"toDate": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("apikey", "".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}}/individuals \
--header 'apikey: ' \
--header 'content-type: application/json' \
--data '{
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}'
echo '{
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}' | \
http POST {{baseUrl}}/individuals \
apikey:'' \
content-type:application/json
wget --quiet \
--method POST \
--header 'apikey: ' \
--header 'content-type: application/json' \
--body-data '{\n "addresses": [],\n "dateOfBirth": "",\n "electronicAddresses": [\n {\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\n "url": ""\n }\n ],\n "fromDate": "",\n "gender": "",\n "id": "",\n "names": [\n {\n "direction": "",\n "familyName": "",\n "formalSalutation": "",\n "fromDate": "",\n "givenName": "",\n "id": "",\n "informalSalutation": "",\n "middleName": "",\n "namePrefix": "",\n "nameSuffix": "",\n "nameType": "",\n "toDate": ""\n }\n ],\n "placeOfBirth": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/individuals
import Foundation
let headers = [
"apikey": "",
"content-type": "application/json"
]
let parameters = [
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
[
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
]
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
[
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
]
],
"placeOfBirth": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals")! 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
{
"dateOfBirth": "1979-01-13",
"fromDate": "1979-01-13T09:05:06+10:00",
"placeOfBirth": "Tamworth",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
DELETE
Delete an individual
{{baseUrl}}/individuals/:partyId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/individuals/:partyId")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId"
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}}/individuals/:partyId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId"
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/individuals/:partyId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/individuals/:partyId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId"))
.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}}/individuals/:partyId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/individuals/:partyId")
.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}}/individuals/:partyId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/individuals/:partyId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId';
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}}/individuals/:partyId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId',
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}}/individuals/:partyId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/individuals/:partyId');
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}}/individuals/:partyId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId';
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}}/individuals/:partyId"]
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}}/individuals/:partyId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId",
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}}/individuals/:partyId');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/individuals/:partyId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId")
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/individuals/:partyId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId";
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}}/individuals/:partyId
http DELETE {{baseUrl}}/individuals/:partyId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/individuals/:partyId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId")! 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",
"message": "Request can not be executed in the current system state",
"status": "FAILED_PRECONDITION"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of individuals
{{baseUrl}}/individuals
HEADERS
apiKey
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "apikey: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/individuals" {:headers {:apikey ""}})
require "http/client"
url = "{{baseUrl}}/individuals"
headers = HTTP::Headers{
"apikey" => ""
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/individuals"),
Headers =
{
{ "apikey", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals");
var request = new RestRequest("", Method.Get);
request.AddHeader("apikey", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/individuals HTTP/1.1
Apikey:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/individuals")
.setHeader("apikey", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals"))
.header("apikey", "")
.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}}/individuals")
.get()
.addHeader("apikey", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/individuals")
.header("apikey", "")
.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}}/individuals');
xhr.setRequestHeader('apikey', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/individuals',
headers: {apikey: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals';
const options = {method: 'GET', headers: {apikey: ''}};
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}}/individuals',
method: 'GET',
headers: {
apikey: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals")
.get()
.addHeader("apikey", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals',
headers: {
apikey: ''
}
};
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}}/individuals',
headers: {apikey: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/individuals');
req.headers({
apikey: ''
});
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}}/individuals',
headers: {apikey: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals';
const options = {method: 'GET', headers: {apikey: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"apikey": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/individuals"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[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}}/individuals" in
let headers = Header.add (Header.init ()) "apikey" "" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/individuals', [
'headers' => [
'apikey' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/individuals');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'apikey' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals');
$request->setRequestMethod('GET');
$request->setHeaders([
'apikey' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("apikey", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals' -Method GET -Headers $headers
$headers=@{}
$headers.Add("apikey", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'apikey': "" }
conn.request("GET", "/baseUrl/individuals", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals"
headers = {"apikey": ""}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals"
response <- VERB("GET", url, add_headers('apikey' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/individuals') do |req|
req.headers['apikey'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("apikey", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/individuals \
--header 'apikey: '
http GET {{baseUrl}}/individuals \
apikey:''
wget --quiet \
--method GET \
--header 'apikey: ' \
--output-document \
- {{baseUrl}}/individuals
import Foundation
let headers = ["apikey": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
[
{
"dateOfBirth": "1979-01-13",
"fromDate": "1979-01-13T09:05:06+10:00",
"placeOfBirth": "Tamworth",
"toDate": ""
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve an individual
{{baseUrl}}/individuals/:partyId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/individuals/:partyId")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId"
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}}/individuals/:partyId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId"
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/individuals/:partyId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/individuals/:partyId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId"))
.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}}/individuals/:partyId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/individuals/:partyId")
.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}}/individuals/:partyId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/individuals/:partyId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId';
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}}/individuals/:partyId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId',
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}}/individuals/:partyId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/individuals/:partyId');
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}}/individuals/:partyId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId';
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}}/individuals/:partyId"]
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}}/individuals/:partyId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId",
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}}/individuals/:partyId');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/individuals/:partyId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId")
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/individuals/:partyId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId";
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}}/individuals/:partyId
http GET {{baseUrl}}/individuals/:partyId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/individuals/:partyId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId")! 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
{
"dateOfBirth": "1979-01-13",
"fromDate": "1979-01-13T09:05:06+10:00",
"placeOfBirth": "Tamworth",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
PUT
Update an individual
{{baseUrl}}/individuals/:partyId
BODY json
{
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId");
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 \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/individuals/:partyId" {:content-type :json
:form-params {:addresses []
:dateOfBirth ""
:electronicAddresses [{:areaCode ""
:countryPrefix ""
:electronicAddressType ""
:email ""
:extension ""
:fromDate ""
:id ""
:number ""
:toDate ""
:url ""}]
:fromDate ""
:gender ""
:id ""
:names [{:direction ""
:familyName ""
:formalSalutation ""
:fromDate ""
:givenName ""
:id ""
:informalSalutation ""
:middleName ""
:namePrefix ""
:nameSuffix ""
:nameType ""
:toDate ""}]
:placeOfBirth ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/individuals/:partyId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId"),
Content = new StringContent("{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId"
payload := strings.NewReader("{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 703
{
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/individuals/:partyId")
.setHeader("content-type", "application/json")
.setBody("{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\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 \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/individuals/:partyId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/individuals/:partyId")
.header("content-type", "application/json")
.body("{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
addresses: [],
dateOfBirth: '',
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
fromDate: '',
gender: '',
id: '',
names: [
{
direction: '',
familyName: '',
formalSalutation: '',
fromDate: '',
givenName: '',
id: '',
informalSalutation: '',
middleName: '',
namePrefix: '',
nameSuffix: '',
nameType: '',
toDate: ''
}
],
placeOfBirth: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/individuals/:partyId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/individuals/:partyId',
headers: {'content-type': 'application/json'},
data: {
addresses: [],
dateOfBirth: '',
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
fromDate: '',
gender: '',
id: '',
names: [
{
direction: '',
familyName: '',
formalSalutation: '',
fromDate: '',
givenName: '',
id: '',
informalSalutation: '',
middleName: '',
namePrefix: '',
nameSuffix: '',
nameType: '',
toDate: ''
}
],
placeOfBirth: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"addresses":[],"dateOfBirth":"","electronicAddresses":[{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","url":""}],"fromDate":"","gender":"","id":"","names":[{"direction":"","familyName":"","formalSalutation":"","fromDate":"","givenName":"","id":"","informalSalutation":"","middleName":"","namePrefix":"","nameSuffix":"","nameType":"","toDate":""}],"placeOfBirth":"","toDate":""}'
};
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}}/individuals/:partyId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "addresses": [],\n "dateOfBirth": "",\n "electronicAddresses": [\n {\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\n "url": ""\n }\n ],\n "fromDate": "",\n "gender": "",\n "id": "",\n "names": [\n {\n "direction": "",\n "familyName": "",\n "formalSalutation": "",\n "fromDate": "",\n "givenName": "",\n "id": "",\n "informalSalutation": "",\n "middleName": "",\n "namePrefix": "",\n "nameSuffix": "",\n "nameType": "",\n "toDate": ""\n }\n ],\n "placeOfBirth": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId")
.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/individuals/:partyId',
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({
addresses: [],
dateOfBirth: '',
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
fromDate: '',
gender: '',
id: '',
names: [
{
direction: '',
familyName: '',
formalSalutation: '',
fromDate: '',
givenName: '',
id: '',
informalSalutation: '',
middleName: '',
namePrefix: '',
nameSuffix: '',
nameType: '',
toDate: ''
}
],
placeOfBirth: '',
toDate: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/individuals/:partyId',
headers: {'content-type': 'application/json'},
body: {
addresses: [],
dateOfBirth: '',
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
fromDate: '',
gender: '',
id: '',
names: [
{
direction: '',
familyName: '',
formalSalutation: '',
fromDate: '',
givenName: '',
id: '',
informalSalutation: '',
middleName: '',
namePrefix: '',
nameSuffix: '',
nameType: '',
toDate: ''
}
],
placeOfBirth: '',
toDate: ''
},
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}}/individuals/:partyId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
addresses: [],
dateOfBirth: '',
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
fromDate: '',
gender: '',
id: '',
names: [
{
direction: '',
familyName: '',
formalSalutation: '',
fromDate: '',
givenName: '',
id: '',
informalSalutation: '',
middleName: '',
namePrefix: '',
nameSuffix: '',
nameType: '',
toDate: ''
}
],
placeOfBirth: '',
toDate: ''
});
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}}/individuals/:partyId',
headers: {'content-type': 'application/json'},
data: {
addresses: [],
dateOfBirth: '',
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
fromDate: '',
gender: '',
id: '',
names: [
{
direction: '',
familyName: '',
formalSalutation: '',
fromDate: '',
givenName: '',
id: '',
informalSalutation: '',
middleName: '',
namePrefix: '',
nameSuffix: '',
nameType: '',
toDate: ''
}
],
placeOfBirth: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"addresses":[],"dateOfBirth":"","electronicAddresses":[{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","url":""}],"fromDate":"","gender":"","id":"","names":[{"direction":"","familyName":"","formalSalutation":"","fromDate":"","givenName":"","id":"","informalSalutation":"","middleName":"","namePrefix":"","nameSuffix":"","nameType":"","toDate":""}],"placeOfBirth":"","toDate":""}'
};
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 = @{ @"addresses": @[ ],
@"dateOfBirth": @"",
@"electronicAddresses": @[ @{ @"areaCode": @"", @"countryPrefix": @"", @"electronicAddressType": @"", @"email": @"", @"extension": @"", @"fromDate": @"", @"id": @"", @"number": @"", @"toDate": @"", @"url": @"" } ],
@"fromDate": @"",
@"gender": @"",
@"id": @"",
@"names": @[ @{ @"direction": @"", @"familyName": @"", @"formalSalutation": @"", @"fromDate": @"", @"givenName": @"", @"id": @"", @"informalSalutation": @"", @"middleName": @"", @"namePrefix": @"", @"nameSuffix": @"", @"nameType": @"", @"toDate": @"" } ],
@"placeOfBirth": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/individuals/:partyId"]
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}}/individuals/:partyId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId",
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([
'addresses' => [
],
'dateOfBirth' => '',
'electronicAddresses' => [
[
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]
],
'fromDate' => '',
'gender' => '',
'id' => '',
'names' => [
[
'direction' => '',
'familyName' => '',
'formalSalutation' => '',
'fromDate' => '',
'givenName' => '',
'id' => '',
'informalSalutation' => '',
'middleName' => '',
'namePrefix' => '',
'nameSuffix' => '',
'nameType' => '',
'toDate' => ''
]
],
'placeOfBirth' => '',
'toDate' => ''
]),
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}}/individuals/:partyId', [
'body' => '{
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'addresses' => [
],
'dateOfBirth' => '',
'electronicAddresses' => [
[
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]
],
'fromDate' => '',
'gender' => '',
'id' => '',
'names' => [
[
'direction' => '',
'familyName' => '',
'formalSalutation' => '',
'fromDate' => '',
'givenName' => '',
'id' => '',
'informalSalutation' => '',
'middleName' => '',
'namePrefix' => '',
'nameSuffix' => '',
'nameType' => '',
'toDate' => ''
]
],
'placeOfBirth' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'addresses' => [
],
'dateOfBirth' => '',
'electronicAddresses' => [
[
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]
],
'fromDate' => '',
'gender' => '',
'id' => '',
'names' => [
[
'direction' => '',
'familyName' => '',
'formalSalutation' => '',
'fromDate' => '',
'givenName' => '',
'id' => '',
'informalSalutation' => '',
'middleName' => '',
'namePrefix' => '',
'nameSuffix' => '',
'nameType' => '',
'toDate' => ''
]
],
'placeOfBirth' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/individuals/:partyId');
$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}}/individuals/:partyId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/individuals/:partyId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId"
payload = {
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId"
payload <- "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId")
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 \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId') do |req|
req.body = "{\n \"addresses\": [],\n \"dateOfBirth\": \"\",\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"fromDate\": \"\",\n \"gender\": \"\",\n \"id\": \"\",\n \"names\": [\n {\n \"direction\": \"\",\n \"familyName\": \"\",\n \"formalSalutation\": \"\",\n \"fromDate\": \"\",\n \"givenName\": \"\",\n \"id\": \"\",\n \"informalSalutation\": \"\",\n \"middleName\": \"\",\n \"namePrefix\": \"\",\n \"nameSuffix\": \"\",\n \"nameType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"placeOfBirth\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId";
let payload = json!({
"addresses": (),
"dateOfBirth": "",
"electronicAddresses": (
json!({
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
})
),
"fromDate": "",
"gender": "",
"id": "",
"names": (
json!({
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
})
),
"placeOfBirth": "",
"toDate": ""
});
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}}/individuals/:partyId \
--header 'content-type: application/json' \
--data '{
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}'
echo '{
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
{
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
}
],
"placeOfBirth": "",
"toDate": ""
}' | \
http PUT {{baseUrl}}/individuals/:partyId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "addresses": [],\n "dateOfBirth": "",\n "electronicAddresses": [\n {\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\n "url": ""\n }\n ],\n "fromDate": "",\n "gender": "",\n "id": "",\n "names": [\n {\n "direction": "",\n "familyName": "",\n "formalSalutation": "",\n "fromDate": "",\n "givenName": "",\n "id": "",\n "informalSalutation": "",\n "middleName": "",\n "namePrefix": "",\n "nameSuffix": "",\n "nameType": "",\n "toDate": ""\n }\n ],\n "placeOfBirth": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/individuals/:partyId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"addresses": [],
"dateOfBirth": "",
"electronicAddresses": [
[
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
]
],
"fromDate": "",
"gender": "",
"id": "",
"names": [
[
"direction": "",
"familyName": "",
"formalSalutation": "",
"fromDate": "",
"givenName": "",
"id": "",
"informalSalutation": "",
"middleName": "",
"namePrefix": "",
"nameSuffix": "",
"nameType": "",
"toDate": ""
]
],
"placeOfBirth": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId")! 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
{
"dateOfBirth": "1979-01-13",
"fromDate": "1979-01-13T09:05:06+10:00",
"placeOfBirth": "Tamworth",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
POST
Create an address
{{baseUrl}}/individuals/:partyId/addresses
BODY json
{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/addresses");
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 \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/individuals/:partyId/addresses" {:content-type :json
:form-params {:city ""
:country ""
:fromDate ""
:id ""
:line1 ""
:line2 ""
:line3 ""
:name ""
:postalCode ""
:suburb ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/addresses"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/addresses"),
Content = new StringContent("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/addresses");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/addresses"
payload := strings.NewReader("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/addresses HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 174
{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/individuals/:partyId/addresses")
.setHeader("content-type", "application/json")
.setBody("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/addresses"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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 \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/addresses")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/individuals/:partyId/addresses")
.header("content-type", "application/json")
.body("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/individuals/:partyId/addresses');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/individuals/:partyId/addresses',
headers: {'content-type': 'application/json'},
data: {
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/addresses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"city":"","country":"","fromDate":"","id":"","line1":"","line2":"","line3":"","name":"","postalCode":"","suburb":"","toDate":""}'
};
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}}/individuals/:partyId/addresses',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "city": "",\n "country": "",\n "fromDate": "",\n "id": "",\n "line1": "",\n "line2": "",\n "line3": "",\n "name": "",\n "postalCode": "",\n "suburb": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/addresses")
.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/individuals/:partyId/addresses',
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({
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/individuals/:partyId/addresses',
headers: {'content-type': 'application/json'},
body: {
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
},
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}}/individuals/:partyId/addresses');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
});
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}}/individuals/:partyId/addresses',
headers: {'content-type': 'application/json'},
data: {
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/addresses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"city":"","country":"","fromDate":"","id":"","line1":"","line2":"","line3":"","name":"","postalCode":"","suburb":"","toDate":""}'
};
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 = @{ @"city": @"",
@"country": @"",
@"fromDate": @"",
@"id": @"",
@"line1": @"",
@"line2": @"",
@"line3": @"",
@"name": @"",
@"postalCode": @"",
@"suburb": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/individuals/:partyId/addresses"]
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}}/individuals/:partyId/addresses" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/addresses",
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([
'city' => '',
'country' => '',
'fromDate' => '',
'id' => '',
'line1' => '',
'line2' => '',
'line3' => '',
'name' => '',
'postalCode' => '',
'suburb' => '',
'toDate' => ''
]),
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}}/individuals/:partyId/addresses', [
'body' => '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/addresses');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'city' => '',
'country' => '',
'fromDate' => '',
'id' => '',
'line1' => '',
'line2' => '',
'line3' => '',
'name' => '',
'postalCode' => '',
'suburb' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'city' => '',
'country' => '',
'fromDate' => '',
'id' => '',
'line1' => '',
'line2' => '',
'line3' => '',
'name' => '',
'postalCode' => '',
'suburb' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/individuals/:partyId/addresses');
$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}}/individuals/:partyId/addresses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/addresses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/individuals/:partyId/addresses", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/addresses"
payload = {
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/addresses"
payload <- "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/addresses")
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 \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/addresses') do |req|
req.body = "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/addresses";
let payload = json!({
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
});
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}}/individuals/:partyId/addresses \
--header 'content-type: application/json' \
--data '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}'
echo '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}' | \
http POST {{baseUrl}}/individuals/:partyId/addresses \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "city": "",\n "country": "",\n "fromDate": "",\n "id": "",\n "line1": "",\n "line2": "",\n "line3": "",\n "name": "",\n "postalCode": "",\n "suburb": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/individuals/:partyId/addresses
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/addresses")! 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
{
"city": "Canberra",
"country": "Australia",
"fromDate": "1979-01-13T09:05:06+10:00",
"line1": "Level 7",
"line2": "21 Genge Street",
"line3": "",
"name": "Kembery Building",
"postalCode": "2601",
"suburb": "Civic",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
DELETE
Delete an address
{{baseUrl}}/individuals/:partyId/addresses/:addressId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/addresses/:addressId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/individuals/:partyId/addresses/:addressId")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/addresses/:addressId"
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}}/individuals/:partyId/addresses/:addressId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/addresses/:addressId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/addresses/:addressId"
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/individuals/:partyId/addresses/:addressId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/individuals/:partyId/addresses/:addressId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/addresses/:addressId"))
.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}}/individuals/:partyId/addresses/:addressId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/individuals/:partyId/addresses/:addressId")
.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}}/individuals/:partyId/addresses/:addressId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/individuals/:partyId/addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/addresses/:addressId';
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}}/individuals/:partyId/addresses/:addressId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/addresses/:addressId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/addresses/:addressId',
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}}/individuals/:partyId/addresses/:addressId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/individuals/:partyId/addresses/:addressId');
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}}/individuals/:partyId/addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/addresses/:addressId';
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}}/individuals/:partyId/addresses/:addressId"]
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}}/individuals/:partyId/addresses/:addressId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/addresses/:addressId",
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}}/individuals/:partyId/addresses/:addressId');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/addresses/:addressId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/addresses/:addressId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/addresses/:addressId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/addresses/:addressId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/individuals/:partyId/addresses/:addressId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/addresses/:addressId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/addresses/:addressId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/addresses/:addressId")
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/individuals/:partyId/addresses/:addressId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/addresses/:addressId";
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}}/individuals/:partyId/addresses/:addressId
http DELETE {{baseUrl}}/individuals/:partyId/addresses/:addressId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/individuals/:partyId/addresses/:addressId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/addresses/:addressId")! 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": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of addresses
{{baseUrl}}/individuals/:partyId/addresses
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/addresses");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/individuals/:partyId/addresses")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/addresses"
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}}/individuals/:partyId/addresses"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/addresses");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/addresses"
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/individuals/:partyId/addresses HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/individuals/:partyId/addresses")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/addresses"))
.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}}/individuals/:partyId/addresses")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/individuals/:partyId/addresses")
.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}}/individuals/:partyId/addresses');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/individuals/:partyId/addresses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/addresses';
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}}/individuals/:partyId/addresses',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/addresses")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/addresses',
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}}/individuals/:partyId/addresses'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/individuals/:partyId/addresses');
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}}/individuals/:partyId/addresses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/addresses';
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}}/individuals/:partyId/addresses"]
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}}/individuals/:partyId/addresses" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/addresses",
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}}/individuals/:partyId/addresses');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/addresses');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/addresses');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/addresses' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/addresses' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/individuals/:partyId/addresses")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/addresses"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/addresses"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/addresses")
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/individuals/:partyId/addresses') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/addresses";
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}}/individuals/:partyId/addresses
http GET {{baseUrl}}/individuals/:partyId/addresses
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/individuals/:partyId/addresses
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/addresses")! 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
[
{
"city": "Canberra",
"country": "Australia",
"fromDate": "1979-01-13T09:05:06+10:00",
"line1": "Level 7",
"line2": "21 Genge Street",
"line3": "",
"name": "Kembery Building",
"postalCode": "2601",
"suburb": "Civic",
"toDate": ""
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve an address
{{baseUrl}}/individuals/:partyId/addresses/:addressId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/addresses/:addressId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/individuals/:partyId/addresses/:addressId")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/addresses/:addressId"
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}}/individuals/:partyId/addresses/:addressId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/addresses/:addressId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/addresses/:addressId"
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/individuals/:partyId/addresses/:addressId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/individuals/:partyId/addresses/:addressId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/addresses/:addressId"))
.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}}/individuals/:partyId/addresses/:addressId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/individuals/:partyId/addresses/:addressId")
.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}}/individuals/:partyId/addresses/:addressId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/individuals/:partyId/addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/addresses/:addressId';
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}}/individuals/:partyId/addresses/:addressId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/addresses/:addressId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/addresses/:addressId',
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}}/individuals/:partyId/addresses/:addressId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/individuals/:partyId/addresses/:addressId');
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}}/individuals/:partyId/addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/addresses/:addressId';
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}}/individuals/:partyId/addresses/:addressId"]
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}}/individuals/:partyId/addresses/:addressId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/addresses/:addressId",
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}}/individuals/:partyId/addresses/:addressId');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/addresses/:addressId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/addresses/:addressId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/addresses/:addressId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/addresses/:addressId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/individuals/:partyId/addresses/:addressId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/addresses/:addressId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/addresses/:addressId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/addresses/:addressId")
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/individuals/:partyId/addresses/:addressId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/addresses/:addressId";
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}}/individuals/:partyId/addresses/:addressId
http GET {{baseUrl}}/individuals/:partyId/addresses/:addressId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/individuals/:partyId/addresses/:addressId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/addresses/:addressId")! 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
{
"city": "Canberra",
"country": "Australia",
"fromDate": "1979-01-13T09:05:06+10:00",
"line1": "Level 7",
"line2": "21 Genge Street",
"line3": "",
"name": "Kembery Building",
"postalCode": "2601",
"suburb": "Civic",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
PUT
Update an address
{{baseUrl}}/individuals/:partyId/addresses/:addressId
BODY json
{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/addresses/:addressId");
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 \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/individuals/:partyId/addresses/:addressId" {:content-type :json
:form-params {:city ""
:country ""
:fromDate ""
:id ""
:line1 ""
:line2 ""
:line3 ""
:name ""
:postalCode ""
:suburb ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/addresses/:addressId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/addresses/:addressId"),
Content = new StringContent("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/addresses/:addressId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/addresses/:addressId"
payload := strings.NewReader("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/addresses/:addressId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 174
{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/individuals/:partyId/addresses/:addressId")
.setHeader("content-type", "application/json")
.setBody("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/addresses/:addressId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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 \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/addresses/:addressId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/individuals/:partyId/addresses/:addressId")
.header("content-type", "application/json")
.body("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/individuals/:partyId/addresses/:addressId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/individuals/:partyId/addresses/:addressId',
headers: {'content-type': 'application/json'},
data: {
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/addresses/:addressId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"city":"","country":"","fromDate":"","id":"","line1":"","line2":"","line3":"","name":"","postalCode":"","suburb":"","toDate":""}'
};
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}}/individuals/:partyId/addresses/:addressId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "city": "",\n "country": "",\n "fromDate": "",\n "id": "",\n "line1": "",\n "line2": "",\n "line3": "",\n "name": "",\n "postalCode": "",\n "suburb": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/addresses/:addressId")
.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/individuals/:partyId/addresses/:addressId',
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({
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/individuals/:partyId/addresses/:addressId',
headers: {'content-type': 'application/json'},
body: {
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
},
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}}/individuals/:partyId/addresses/:addressId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
});
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}}/individuals/:partyId/addresses/:addressId',
headers: {'content-type': 'application/json'},
data: {
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/addresses/:addressId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"city":"","country":"","fromDate":"","id":"","line1":"","line2":"","line3":"","name":"","postalCode":"","suburb":"","toDate":""}'
};
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 = @{ @"city": @"",
@"country": @"",
@"fromDate": @"",
@"id": @"",
@"line1": @"",
@"line2": @"",
@"line3": @"",
@"name": @"",
@"postalCode": @"",
@"suburb": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/individuals/:partyId/addresses/:addressId"]
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}}/individuals/:partyId/addresses/:addressId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/addresses/:addressId",
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([
'city' => '',
'country' => '',
'fromDate' => '',
'id' => '',
'line1' => '',
'line2' => '',
'line3' => '',
'name' => '',
'postalCode' => '',
'suburb' => '',
'toDate' => ''
]),
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}}/individuals/:partyId/addresses/:addressId', [
'body' => '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/addresses/:addressId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'city' => '',
'country' => '',
'fromDate' => '',
'id' => '',
'line1' => '',
'line2' => '',
'line3' => '',
'name' => '',
'postalCode' => '',
'suburb' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'city' => '',
'country' => '',
'fromDate' => '',
'id' => '',
'line1' => '',
'line2' => '',
'line3' => '',
'name' => '',
'postalCode' => '',
'suburb' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/individuals/:partyId/addresses/:addressId');
$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}}/individuals/:partyId/addresses/:addressId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/addresses/:addressId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/individuals/:partyId/addresses/:addressId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/addresses/:addressId"
payload = {
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/addresses/:addressId"
payload <- "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/addresses/:addressId")
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 \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/addresses/:addressId') do |req|
req.body = "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/addresses/:addressId";
let payload = json!({
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
});
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}}/individuals/:partyId/addresses/:addressId \
--header 'content-type: application/json' \
--data '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}'
echo '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}' | \
http PUT {{baseUrl}}/individuals/:partyId/addresses/:addressId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "city": "",\n "country": "",\n "fromDate": "",\n "id": "",\n "line1": "",\n "line2": "",\n "line3": "",\n "name": "",\n "postalCode": "",\n "suburb": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/individuals/:partyId/addresses/:addressId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/addresses/:addressId")! 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
{
"city": "Canberra",
"country": "Australia",
"fromDate": "1979-01-13T09:05:06+10:00",
"line1": "Level 7",
"line2": "21 Genge Street",
"line3": "",
"name": "Kembery Building",
"postalCode": "2601",
"suburb": "Civic",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
POST
Create a business name
{{baseUrl}}/individuals/:partyId/business-names
BODY json
{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/business-names");
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/individuals/:partyId/business-names" {:content-type :json
:form-params {:fromDate ""
:id ""
:lifecycleState ""
:name ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/business-names"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/business-names"),
Content = new StringContent("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/business-names");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/business-names"
payload := strings.NewReader("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/business-names HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 86
{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/individuals/:partyId/business-names")
.setHeader("content-type", "application/json")
.setBody("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/business-names"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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 \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/business-names")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/individuals/:partyId/business-names")
.header("content-type", "application/json")
.body("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
fromDate: '',
id: '',
lifecycleState: '',
name: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/individuals/:partyId/business-names');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/individuals/:partyId/business-names',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/business-names';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","lifecycleState":"","name":"","toDate":""}'
};
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}}/individuals/:partyId/business-names',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fromDate": "",\n "id": "",\n "lifecycleState": "",\n "name": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/business-names")
.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/individuals/:partyId/business-names',
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({fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/individuals/:partyId/business-names',
headers: {'content-type': 'application/json'},
body: {fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''},
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}}/individuals/:partyId/business-names');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fromDate: '',
id: '',
lifecycleState: '',
name: '',
toDate: ''
});
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}}/individuals/:partyId/business-names',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/business-names';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","lifecycleState":"","name":"","toDate":""}'
};
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 = @{ @"fromDate": @"",
@"id": @"",
@"lifecycleState": @"",
@"name": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/individuals/:partyId/business-names"]
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}}/individuals/:partyId/business-names" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/business-names",
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([
'fromDate' => '',
'id' => '',
'lifecycleState' => '',
'name' => '',
'toDate' => ''
]),
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}}/individuals/:partyId/business-names', [
'body' => '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/business-names');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fromDate' => '',
'id' => '',
'lifecycleState' => '',
'name' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'fromDate' => '',
'id' => '',
'lifecycleState' => '',
'name' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/individuals/:partyId/business-names');
$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}}/individuals/:partyId/business-names' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/business-names' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/individuals/:partyId/business-names", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/business-names"
payload = {
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/business-names"
payload <- "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/business-names")
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/business-names') do |req|
req.body = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/business-names";
let payload = json!({
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
});
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}}/individuals/:partyId/business-names \
--header 'content-type: application/json' \
--data '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}'
echo '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}' | \
http POST {{baseUrl}}/individuals/:partyId/business-names \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "fromDate": "",\n "id": "",\n "lifecycleState": "",\n "name": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/individuals/:partyId/business-names
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/business-names")! 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
{
"fromDate": "1979-01-13T09:05:06+10:00",
"name": "XYZ Technology Ventures",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
DELETE
Delete a business name
{{baseUrl}}/individuals/:partyId/business-names/:productId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/business-names/:productId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/individuals/:partyId/business-names/:productId")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/business-names/:productId"
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}}/individuals/:partyId/business-names/:productId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/business-names/:productId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/business-names/:productId"
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/individuals/:partyId/business-names/:productId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/individuals/:partyId/business-names/:productId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/business-names/:productId"))
.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}}/individuals/:partyId/business-names/:productId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/individuals/:partyId/business-names/:productId")
.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}}/individuals/:partyId/business-names/:productId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/individuals/:partyId/business-names/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/business-names/:productId';
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}}/individuals/:partyId/business-names/:productId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/business-names/:productId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/business-names/:productId',
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}}/individuals/:partyId/business-names/:productId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/individuals/:partyId/business-names/:productId');
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}}/individuals/:partyId/business-names/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/business-names/:productId';
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}}/individuals/:partyId/business-names/:productId"]
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}}/individuals/:partyId/business-names/:productId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/business-names/:productId",
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}}/individuals/:partyId/business-names/:productId');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/business-names/:productId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/business-names/:productId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/business-names/:productId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/business-names/:productId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/individuals/:partyId/business-names/:productId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/business-names/:productId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/business-names/:productId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/business-names/:productId")
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/individuals/:partyId/business-names/:productId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/business-names/:productId";
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}}/individuals/:partyId/business-names/:productId
http DELETE {{baseUrl}}/individuals/:partyId/business-names/:productId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/individuals/:partyId/business-names/:productId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/business-names/:productId")! 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": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a business name
{{baseUrl}}/individuals/:partyId/business-names/:productId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/business-names/:productId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/individuals/:partyId/business-names/:productId")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/business-names/:productId"
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}}/individuals/:partyId/business-names/:productId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/business-names/:productId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/business-names/:productId"
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/individuals/:partyId/business-names/:productId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/individuals/:partyId/business-names/:productId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/business-names/:productId"))
.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}}/individuals/:partyId/business-names/:productId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/individuals/:partyId/business-names/:productId")
.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}}/individuals/:partyId/business-names/:productId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/individuals/:partyId/business-names/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/business-names/:productId';
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}}/individuals/:partyId/business-names/:productId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/business-names/:productId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/business-names/:productId',
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}}/individuals/:partyId/business-names/:productId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/individuals/:partyId/business-names/:productId');
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}}/individuals/:partyId/business-names/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/business-names/:productId';
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}}/individuals/:partyId/business-names/:productId"]
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}}/individuals/:partyId/business-names/:productId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/business-names/:productId",
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}}/individuals/:partyId/business-names/:productId');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/business-names/:productId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/business-names/:productId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/business-names/:productId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/business-names/:productId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/individuals/:partyId/business-names/:productId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/business-names/:productId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/business-names/:productId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/business-names/:productId")
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/individuals/:partyId/business-names/:productId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/business-names/:productId";
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}}/individuals/:partyId/business-names/:productId
http GET {{baseUrl}}/individuals/:partyId/business-names/:productId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/individuals/:partyId/business-names/:productId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/business-names/:productId")! 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
{
"fromDate": "1979-01-13T09:05:06+10:00",
"name": "XYZ Technology Ventures",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of business names (GET)
{{baseUrl}}/individuals/:partyId/business-names
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/business-names");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/individuals/:partyId/business-names")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/business-names"
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}}/individuals/:partyId/business-names"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/business-names");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/business-names"
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/individuals/:partyId/business-names HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/individuals/:partyId/business-names")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/business-names"))
.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}}/individuals/:partyId/business-names")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/individuals/:partyId/business-names")
.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}}/individuals/:partyId/business-names');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/individuals/:partyId/business-names'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/business-names';
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}}/individuals/:partyId/business-names',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/business-names")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/business-names',
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}}/individuals/:partyId/business-names'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/individuals/:partyId/business-names');
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}}/individuals/:partyId/business-names'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/business-names';
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}}/individuals/:partyId/business-names"]
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}}/individuals/:partyId/business-names" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/business-names",
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}}/individuals/:partyId/business-names');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/business-names');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/business-names');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/business-names' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/business-names' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/individuals/:partyId/business-names")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/business-names"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/business-names"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/business-names")
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/individuals/:partyId/business-names') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/business-names";
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}}/individuals/:partyId/business-names
http GET {{baseUrl}}/individuals/:partyId/business-names
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/individuals/:partyId/business-names
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/business-names")! 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
[
{
"fromDate": "1979-01-13T09:05:06+10:00",
"name": "XYZ Technology Ventures",
"toDate": ""
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
PUT
Update a business name
{{baseUrl}}/individuals/:partyId/business-names/:productId
BODY json
{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/business-names/:productId");
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/individuals/:partyId/business-names/:productId" {:content-type :json
:form-params {:fromDate ""
:id ""
:lifecycleState ""
:name ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/business-names/:productId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/business-names/:productId"),
Content = new StringContent("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/business-names/:productId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/business-names/:productId"
payload := strings.NewReader("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/business-names/:productId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 86
{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/individuals/:partyId/business-names/:productId")
.setHeader("content-type", "application/json")
.setBody("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/business-names/:productId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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 \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/business-names/:productId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/individuals/:partyId/business-names/:productId")
.header("content-type", "application/json")
.body("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
fromDate: '',
id: '',
lifecycleState: '',
name: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/individuals/:partyId/business-names/:productId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/individuals/:partyId/business-names/:productId',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/business-names/:productId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","lifecycleState":"","name":"","toDate":""}'
};
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}}/individuals/:partyId/business-names/:productId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fromDate": "",\n "id": "",\n "lifecycleState": "",\n "name": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/business-names/:productId")
.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/individuals/:partyId/business-names/:productId',
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({fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/individuals/:partyId/business-names/:productId',
headers: {'content-type': 'application/json'},
body: {fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''},
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}}/individuals/:partyId/business-names/:productId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fromDate: '',
id: '',
lifecycleState: '',
name: '',
toDate: ''
});
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}}/individuals/:partyId/business-names/:productId',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/business-names/:productId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","lifecycleState":"","name":"","toDate":""}'
};
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 = @{ @"fromDate": @"",
@"id": @"",
@"lifecycleState": @"",
@"name": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/individuals/:partyId/business-names/:productId"]
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}}/individuals/:partyId/business-names/:productId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/business-names/:productId",
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([
'fromDate' => '',
'id' => '',
'lifecycleState' => '',
'name' => '',
'toDate' => ''
]),
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}}/individuals/:partyId/business-names/:productId', [
'body' => '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/business-names/:productId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fromDate' => '',
'id' => '',
'lifecycleState' => '',
'name' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'fromDate' => '',
'id' => '',
'lifecycleState' => '',
'name' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/individuals/:partyId/business-names/:productId');
$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}}/individuals/:partyId/business-names/:productId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/business-names/:productId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/individuals/:partyId/business-names/:productId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/business-names/:productId"
payload = {
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/business-names/:productId"
payload <- "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/business-names/:productId")
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/business-names/:productId') do |req|
req.body = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/business-names/:productId";
let payload = json!({
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
});
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}}/individuals/:partyId/business-names/:productId \
--header 'content-type: application/json' \
--data '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}'
echo '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}' | \
http PUT {{baseUrl}}/individuals/:partyId/business-names/:productId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "fromDate": "",\n "id": "",\n "lifecycleState": "",\n "name": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/individuals/:partyId/business-names/:productId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/business-names/:productId")! 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
{
"fromDate": "1979-01-13T09:05:06+10:00",
"name": "XYZ Technology Ventures",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
POST
Create an electronic address
{{baseUrl}}/individuals/:partyId/electronic-addresses
BODY json
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/electronic-addresses");
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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/individuals/:partyId/electronic-addresses" {:content-type :json
:form-params {:areaCode ""
:countryPrefix ""
:electronicAddressType ""
:email ""
:extension ""
:fromDate ""
:id ""
:number ""
:toDate ""
:url ""}})
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/electronic-addresses"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/individuals/:partyId/electronic-addresses"),
Content = new StringContent("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/individuals/:partyId/electronic-addresses");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/electronic-addresses"
payload := strings.NewReader("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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/individuals/:partyId/electronic-addresses HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 183
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/individuals/:partyId/electronic-addresses")
.setHeader("content-type", "application/json")
.setBody("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/electronic-addresses"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/electronic-addresses")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/individuals/:partyId/electronic-addresses")
.header("content-type", "application/json")
.body("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}")
.asString();
const data = JSON.stringify({
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
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}}/individuals/:partyId/electronic-addresses');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/individuals/:partyId/electronic-addresses',
headers: {'content-type': 'application/json'},
data: {
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/electronic-addresses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","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}}/individuals/:partyId/electronic-addresses',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/electronic-addresses")
.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/individuals/:partyId/electronic-addresses',
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({
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/individuals/:partyId/electronic-addresses',
headers: {'content-type': 'application/json'},
body: {
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
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}}/individuals/:partyId/electronic-addresses');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
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}}/individuals/:partyId/electronic-addresses',
headers: {'content-type': 'application/json'},
data: {
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/electronic-addresses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","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 = @{ @"areaCode": @"",
@"countryPrefix": @"",
@"electronicAddressType": @"",
@"email": @"",
@"extension": @"",
@"fromDate": @"",
@"id": @"",
@"number": @"",
@"toDate": @"",
@"url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/individuals/:partyId/electronic-addresses"]
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}}/individuals/:partyId/electronic-addresses" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/electronic-addresses",
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([
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'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}}/individuals/:partyId/electronic-addresses', [
'body' => '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/electronic-addresses');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/individuals/:partyId/electronic-addresses');
$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}}/individuals/:partyId/electronic-addresses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/electronic-addresses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/individuals/:partyId/electronic-addresses", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/electronic-addresses"
payload = {
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/electronic-addresses"
payload <- "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/individuals/:partyId/electronic-addresses")
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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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/individuals/:partyId/electronic-addresses') do |req|
req.body = "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/individuals/:partyId/electronic-addresses";
let payload = json!({
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"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}}/individuals/:partyId/electronic-addresses \
--header 'content-type: application/json' \
--data '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}'
echo '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}' | \
http POST {{baseUrl}}/individuals/:partyId/electronic-addresses \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\n "url": ""\n}' \
--output-document \
- {{baseUrl}}/individuals/:partyId/electronic-addresses
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/electronic-addresses")! 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
{
"areaCode": "02",
"countryPrefix": "61",
"email": "",
"extension": "",
"fromDate": "1979-01-13T09:05:06+10:00",
"number": "62164453",
"toDate": "",
"url": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
DELETE
Delete an electronic address
{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"
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}}/individuals/:partyId/electronic-addresses/:addressId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"
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/individuals/:partyId/electronic-addresses/:addressId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"))
.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}}/individuals/:partyId/electronic-addresses/:addressId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")
.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}}/individuals/:partyId/electronic-addresses/:addressId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId';
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}}/individuals/:partyId/electronic-addresses/:addressId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/electronic-addresses/:addressId',
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}}/individuals/:partyId/electronic-addresses/:addressId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId');
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}}/individuals/:partyId/electronic-addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId';
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}}/individuals/:partyId/electronic-addresses/:addressId"]
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}}/individuals/:partyId/electronic-addresses/:addressId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId",
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}}/individuals/:partyId/electronic-addresses/:addressId');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/individuals/:partyId/electronic-addresses/:addressId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")
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/individuals/:partyId/electronic-addresses/:addressId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId";
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}}/individuals/:partyId/electronic-addresses/:addressId
http DELETE {{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")! 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": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of electronic addresses
{{baseUrl}}/individuals/:partyId/electronic-addresses
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/electronic-addresses");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/individuals/:partyId/electronic-addresses")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/electronic-addresses"
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}}/individuals/:partyId/electronic-addresses"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/electronic-addresses");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/electronic-addresses"
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/individuals/:partyId/electronic-addresses HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/individuals/:partyId/electronic-addresses")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/electronic-addresses"))
.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}}/individuals/:partyId/electronic-addresses")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/individuals/:partyId/electronic-addresses")
.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}}/individuals/:partyId/electronic-addresses');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/individuals/:partyId/electronic-addresses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/electronic-addresses';
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}}/individuals/:partyId/electronic-addresses',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/electronic-addresses")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/electronic-addresses',
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}}/individuals/:partyId/electronic-addresses'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/individuals/:partyId/electronic-addresses');
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}}/individuals/:partyId/electronic-addresses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/electronic-addresses';
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}}/individuals/:partyId/electronic-addresses"]
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}}/individuals/:partyId/electronic-addresses" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/electronic-addresses",
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}}/individuals/:partyId/electronic-addresses');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/electronic-addresses');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/electronic-addresses');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/electronic-addresses' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/electronic-addresses' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/individuals/:partyId/electronic-addresses")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/electronic-addresses"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/electronic-addresses"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/electronic-addresses")
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/individuals/:partyId/electronic-addresses') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/electronic-addresses";
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}}/individuals/:partyId/electronic-addresses
http GET {{baseUrl}}/individuals/:partyId/electronic-addresses
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/individuals/:partyId/electronic-addresses
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/electronic-addresses")! 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
[
{
"areaCode": "02",
"countryPrefix": "61",
"email": "",
"extension": "",
"fromDate": "1979-01-13T09:05:06+10:00",
"number": "62164453",
"toDate": "",
"url": ""
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve an electronic address
{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"
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}}/individuals/:partyId/electronic-addresses/:addressId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"
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/individuals/:partyId/electronic-addresses/:addressId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"))
.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}}/individuals/:partyId/electronic-addresses/:addressId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")
.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}}/individuals/:partyId/electronic-addresses/:addressId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId';
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}}/individuals/:partyId/electronic-addresses/:addressId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/electronic-addresses/:addressId',
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}}/individuals/:partyId/electronic-addresses/:addressId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId');
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}}/individuals/:partyId/electronic-addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId';
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}}/individuals/:partyId/electronic-addresses/:addressId"]
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}}/individuals/:partyId/electronic-addresses/:addressId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId",
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}}/individuals/:partyId/electronic-addresses/:addressId');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/individuals/:partyId/electronic-addresses/:addressId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")
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/individuals/:partyId/electronic-addresses/:addressId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId";
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}}/individuals/:partyId/electronic-addresses/:addressId
http GET {{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")! 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
{
"areaCode": "02",
"countryPrefix": "61",
"email": "",
"extension": "",
"fromDate": "1979-01-13T09:05:06+10:00",
"number": "62164453",
"toDate": "",
"url": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
PUT
Update an electronic address
{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId
BODY json
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId");
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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId" {:content-type :json
:form-params {:areaCode ""
:countryPrefix ""
:electronicAddressType ""
:email ""
:extension ""
:fromDate ""
:id ""
:number ""
:toDate ""
:url ""}})
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/individuals/:partyId/electronic-addresses/:addressId"),
Content = new StringContent("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/individuals/:partyId/electronic-addresses/:addressId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"
payload := strings.NewReader("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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/individuals/:partyId/electronic-addresses/:addressId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 183
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")
.setHeader("content-type", "application/json")
.setBody("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")
.header("content-type", "application/json")
.body("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}")
.asString();
const data = JSON.stringify({
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
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}}/individuals/:partyId/electronic-addresses/:addressId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId',
headers: {'content-type': 'application/json'},
data: {
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","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}}/individuals/:partyId/electronic-addresses/:addressId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")
.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/individuals/:partyId/electronic-addresses/:addressId',
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({
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId',
headers: {'content-type': 'application/json'},
body: {
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
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}}/individuals/:partyId/electronic-addresses/:addressId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
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}}/individuals/:partyId/electronic-addresses/:addressId',
headers: {'content-type': 'application/json'},
data: {
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","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 = @{ @"areaCode": @"",
@"countryPrefix": @"",
@"electronicAddressType": @"",
@"email": @"",
@"extension": @"",
@"fromDate": @"",
@"id": @"",
@"number": @"",
@"toDate": @"",
@"url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"]
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}}/individuals/:partyId/electronic-addresses/:addressId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId",
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([
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'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}}/individuals/:partyId/electronic-addresses/:addressId', [
'body' => '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId');
$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}}/individuals/:partyId/electronic-addresses/:addressId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/individuals/:partyId/electronic-addresses/:addressId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"
payload = {
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId"
payload <- "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/individuals/:partyId/electronic-addresses/:addressId")
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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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/individuals/:partyId/electronic-addresses/:addressId') do |req|
req.body = "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/individuals/:partyId/electronic-addresses/:addressId";
let payload = json!({
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"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}}/individuals/:partyId/electronic-addresses/:addressId \
--header 'content-type: application/json' \
--data '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}'
echo '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}' | \
http PUT {{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\n "url": ""\n}' \
--output-document \
- {{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/electronic-addresses/:addressId")! 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
{
"areaCode": "02",
"countryPrefix": "61",
"email": "",
"extension": "",
"fromDate": "1979-01-13T09:05:06+10:00",
"number": "62164453",
"toDate": "",
"url": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
POST
Create a license
{{baseUrl}}/individuals/:partyId/licenses
BODY json
{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/licenses");
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/individuals/:partyId/licenses" {:content-type :json
:form-params {:fromDate ""
:id ""
:licenseType ""
:lifecycleState ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/licenses"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/licenses"),
Content = new StringContent("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/licenses");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/licenses"
payload := strings.NewReader("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/licenses HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 93
{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/individuals/:partyId/licenses")
.setHeader("content-type", "application/json")
.setBody("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/licenses"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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 \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/licenses")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/individuals/:partyId/licenses")
.header("content-type", "application/json")
.body("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
fromDate: '',
id: '',
licenseType: '',
lifecycleState: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/individuals/:partyId/licenses');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/individuals/:partyId/licenses',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/licenses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","licenseType":"","lifecycleState":"","toDate":""}'
};
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}}/individuals/:partyId/licenses',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fromDate": "",\n "id": "",\n "licenseType": "",\n "lifecycleState": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/licenses")
.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/individuals/:partyId/licenses',
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({fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/individuals/:partyId/licenses',
headers: {'content-type': 'application/json'},
body: {fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''},
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}}/individuals/:partyId/licenses');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fromDate: '',
id: '',
licenseType: '',
lifecycleState: '',
toDate: ''
});
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}}/individuals/:partyId/licenses',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/licenses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","licenseType":"","lifecycleState":"","toDate":""}'
};
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 = @{ @"fromDate": @"",
@"id": @"",
@"licenseType": @"",
@"lifecycleState": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/individuals/:partyId/licenses"]
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}}/individuals/:partyId/licenses" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/licenses",
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([
'fromDate' => '',
'id' => '',
'licenseType' => '',
'lifecycleState' => '',
'toDate' => ''
]),
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}}/individuals/:partyId/licenses', [
'body' => '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/licenses');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fromDate' => '',
'id' => '',
'licenseType' => '',
'lifecycleState' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'fromDate' => '',
'id' => '',
'licenseType' => '',
'lifecycleState' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/individuals/:partyId/licenses');
$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}}/individuals/:partyId/licenses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/licenses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/individuals/:partyId/licenses", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/licenses"
payload = {
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/licenses"
payload <- "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/licenses")
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/licenses') do |req|
req.body = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/licenses";
let payload = json!({
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
});
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}}/individuals/:partyId/licenses \
--header 'content-type: application/json' \
--data '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}'
echo '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}' | \
http POST {{baseUrl}}/individuals/:partyId/licenses \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "fromDate": "",\n "id": "",\n "licenseType": "",\n "lifecycleState": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/individuals/:partyId/licenses
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/licenses")! 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
{
"fromDate": "1979-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
DELETE
Delete a license
{{baseUrl}}/individuals/:partyId/licenses/:productId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/licenses/:productId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/individuals/:partyId/licenses/:productId")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/licenses/:productId"
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}}/individuals/:partyId/licenses/:productId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/licenses/:productId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/licenses/:productId"
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/individuals/:partyId/licenses/:productId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/individuals/:partyId/licenses/:productId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/licenses/:productId"))
.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}}/individuals/:partyId/licenses/:productId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/individuals/:partyId/licenses/:productId")
.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}}/individuals/:partyId/licenses/:productId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/individuals/:partyId/licenses/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/licenses/:productId';
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}}/individuals/:partyId/licenses/:productId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/licenses/:productId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/licenses/:productId',
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}}/individuals/:partyId/licenses/:productId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/individuals/:partyId/licenses/:productId');
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}}/individuals/:partyId/licenses/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/licenses/:productId';
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}}/individuals/:partyId/licenses/:productId"]
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}}/individuals/:partyId/licenses/:productId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/licenses/:productId",
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}}/individuals/:partyId/licenses/:productId');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/licenses/:productId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/licenses/:productId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/licenses/:productId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/licenses/:productId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/individuals/:partyId/licenses/:productId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/licenses/:productId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/licenses/:productId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/licenses/:productId")
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/individuals/:partyId/licenses/:productId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/licenses/:productId";
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}}/individuals/:partyId/licenses/:productId
http DELETE {{baseUrl}}/individuals/:partyId/licenses/:productId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/individuals/:partyId/licenses/:productId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/licenses/:productId")! 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": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a license
{{baseUrl}}/individuals/:partyId/licenses/:productId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/licenses/:productId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/individuals/:partyId/licenses/:productId")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/licenses/:productId"
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}}/individuals/:partyId/licenses/:productId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/licenses/:productId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/licenses/:productId"
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/individuals/:partyId/licenses/:productId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/individuals/:partyId/licenses/:productId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/licenses/:productId"))
.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}}/individuals/:partyId/licenses/:productId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/individuals/:partyId/licenses/:productId")
.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}}/individuals/:partyId/licenses/:productId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/individuals/:partyId/licenses/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/licenses/:productId';
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}}/individuals/:partyId/licenses/:productId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/licenses/:productId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/licenses/:productId',
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}}/individuals/:partyId/licenses/:productId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/individuals/:partyId/licenses/:productId');
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}}/individuals/:partyId/licenses/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/licenses/:productId';
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}}/individuals/:partyId/licenses/:productId"]
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}}/individuals/:partyId/licenses/:productId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/licenses/:productId",
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}}/individuals/:partyId/licenses/:productId');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/licenses/:productId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/licenses/:productId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/licenses/:productId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/licenses/:productId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/individuals/:partyId/licenses/:productId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/licenses/:productId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/licenses/:productId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/licenses/:productId")
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/individuals/:partyId/licenses/:productId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/licenses/:productId";
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}}/individuals/:partyId/licenses/:productId
http GET {{baseUrl}}/individuals/:partyId/licenses/:productId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/individuals/:partyId/licenses/:productId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/licenses/:productId")! 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
{
"fromDate": "1979-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of licenses
{{baseUrl}}/individuals/:partyId/licenses
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/licenses");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/individuals/:partyId/licenses")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/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}}/individuals/:partyId/licenses"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/licenses");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/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/individuals/:partyId/licenses HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/individuals/:partyId/licenses")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/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}}/individuals/:partyId/licenses")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/individuals/:partyId/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}}/individuals/:partyId/licenses');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/individuals/:partyId/licenses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/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}}/individuals/:partyId/licenses',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/licenses")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/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}}/individuals/:partyId/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}}/individuals/:partyId/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}}/individuals/:partyId/licenses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/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}}/individuals/:partyId/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}}/individuals/:partyId/licenses" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/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}}/individuals/:partyId/licenses');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/licenses');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/licenses');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/licenses' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/licenses' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/individuals/:partyId/licenses")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/licenses"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/licenses"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/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/individuals/:partyId/licenses') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/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}}/individuals/:partyId/licenses
http GET {{baseUrl}}/individuals/:partyId/licenses
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/individuals/:partyId/licenses
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/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
[
{
"fromDate": "1979-01-13T09:05:06+10:00",
"toDate": ""
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
PUT
Update a license
{{baseUrl}}/individuals/:partyId/licenses/:productId
BODY json
{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/licenses/:productId");
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/individuals/:partyId/licenses/:productId" {:content-type :json
:form-params {:fromDate ""
:id ""
:licenseType ""
:lifecycleState ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/licenses/:productId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/licenses/:productId"),
Content = new StringContent("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/licenses/:productId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/licenses/:productId"
payload := strings.NewReader("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/licenses/:productId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 93
{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/individuals/:partyId/licenses/:productId")
.setHeader("content-type", "application/json")
.setBody("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/licenses/:productId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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 \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/licenses/:productId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/individuals/:partyId/licenses/:productId")
.header("content-type", "application/json")
.body("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
fromDate: '',
id: '',
licenseType: '',
lifecycleState: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/individuals/:partyId/licenses/:productId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/individuals/:partyId/licenses/:productId',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/licenses/:productId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","licenseType":"","lifecycleState":"","toDate":""}'
};
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}}/individuals/:partyId/licenses/:productId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fromDate": "",\n "id": "",\n "licenseType": "",\n "lifecycleState": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/licenses/:productId")
.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/individuals/:partyId/licenses/:productId',
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({fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/individuals/:partyId/licenses/:productId',
headers: {'content-type': 'application/json'},
body: {fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''},
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}}/individuals/:partyId/licenses/:productId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fromDate: '',
id: '',
licenseType: '',
lifecycleState: '',
toDate: ''
});
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}}/individuals/:partyId/licenses/:productId',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/licenses/:productId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","licenseType":"","lifecycleState":"","toDate":""}'
};
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 = @{ @"fromDate": @"",
@"id": @"",
@"licenseType": @"",
@"lifecycleState": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/individuals/:partyId/licenses/:productId"]
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}}/individuals/:partyId/licenses/:productId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/licenses/:productId",
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([
'fromDate' => '',
'id' => '',
'licenseType' => '',
'lifecycleState' => '',
'toDate' => ''
]),
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}}/individuals/:partyId/licenses/:productId', [
'body' => '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/licenses/:productId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fromDate' => '',
'id' => '',
'licenseType' => '',
'lifecycleState' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'fromDate' => '',
'id' => '',
'licenseType' => '',
'lifecycleState' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/individuals/:partyId/licenses/:productId');
$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}}/individuals/:partyId/licenses/:productId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/licenses/:productId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/individuals/:partyId/licenses/:productId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/licenses/:productId"
payload = {
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/licenses/:productId"
payload <- "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/licenses/:productId")
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/licenses/:productId') do |req|
req.body = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/licenses/:productId";
let payload = json!({
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
});
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}}/individuals/:partyId/licenses/:productId \
--header 'content-type: application/json' \
--data '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}'
echo '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}' | \
http PUT {{baseUrl}}/individuals/:partyId/licenses/:productId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "fromDate": "",\n "id": "",\n "licenseType": "",\n "lifecycleState": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/individuals/:partyId/licenses/:productId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/licenses/:productId")! 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
{
"fromDate": "1979-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
POST
Create a role
{{baseUrl}}/individuals/:partyId/roles
BODY json
{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/roles");
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/individuals/:partyId/roles" {:content-type :json
:form-params {:fromDate ""
:id ""
:partyRoleType ""
:relatedPartyId ""
:relatedPartyRoleType ""
:relationshipType ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/roles"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/roles"),
Content = new StringContent("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/roles");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/roles"
payload := strings.NewReader("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/roles HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 151
{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/individuals/:partyId/roles")
.setHeader("content-type", "application/json")
.setBody("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/roles"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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 \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/roles")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/individuals/:partyId/roles")
.header("content-type", "application/json")
.body("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/individuals/:partyId/roles');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/individuals/:partyId/roles',
headers: {'content-type': 'application/json'},
data: {
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/roles';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","partyRoleType":"","relatedPartyId":"","relatedPartyRoleType":"","relationshipType":"","toDate":""}'
};
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}}/individuals/:partyId/roles',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fromDate": "",\n "id": "",\n "partyRoleType": "",\n "relatedPartyId": "",\n "relatedPartyRoleType": "",\n "relationshipType": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/roles")
.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/individuals/:partyId/roles',
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({
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/individuals/:partyId/roles',
headers: {'content-type': 'application/json'},
body: {
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
},
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}}/individuals/:partyId/roles');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
});
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}}/individuals/:partyId/roles',
headers: {'content-type': 'application/json'},
data: {
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/roles';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","partyRoleType":"","relatedPartyId":"","relatedPartyRoleType":"","relationshipType":"","toDate":""}'
};
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 = @{ @"fromDate": @"",
@"id": @"",
@"partyRoleType": @"",
@"relatedPartyId": @"",
@"relatedPartyRoleType": @"",
@"relationshipType": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/individuals/:partyId/roles"]
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}}/individuals/:partyId/roles" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/roles",
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([
'fromDate' => '',
'id' => '',
'partyRoleType' => '',
'relatedPartyId' => '',
'relatedPartyRoleType' => '',
'relationshipType' => '',
'toDate' => ''
]),
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}}/individuals/:partyId/roles', [
'body' => '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/roles');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fromDate' => '',
'id' => '',
'partyRoleType' => '',
'relatedPartyId' => '',
'relatedPartyRoleType' => '',
'relationshipType' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'fromDate' => '',
'id' => '',
'partyRoleType' => '',
'relatedPartyId' => '',
'relatedPartyRoleType' => '',
'relationshipType' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/individuals/:partyId/roles');
$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}}/individuals/:partyId/roles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/roles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/individuals/:partyId/roles", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/roles"
payload = {
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/roles"
payload <- "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/roles")
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/roles') do |req|
req.body = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/roles";
let payload = json!({
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
});
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}}/individuals/:partyId/roles \
--header 'content-type: application/json' \
--data '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}'
echo '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}' | \
http POST {{baseUrl}}/individuals/:partyId/roles \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "fromDate": "",\n "id": "",\n "partyRoleType": "",\n "relatedPartyId": "",\n "relatedPartyRoleType": "",\n "relationshipType": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/individuals/:partyId/roles
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/roles")! 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
{
"fromDate": "2016-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
DELETE
Delete a role
{{baseUrl}}/individuals/:partyId/roles/:roleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/roles/:roleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/individuals/:partyId/roles/:roleId")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/roles/:roleId"
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}}/individuals/:partyId/roles/:roleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/roles/:roleId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/roles/:roleId"
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/individuals/:partyId/roles/:roleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/individuals/:partyId/roles/:roleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/roles/:roleId"))
.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}}/individuals/:partyId/roles/:roleId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/individuals/:partyId/roles/:roleId")
.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}}/individuals/:partyId/roles/:roleId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/individuals/:partyId/roles/:roleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/roles/:roleId';
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}}/individuals/:partyId/roles/:roleId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/roles/:roleId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/roles/:roleId',
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}}/individuals/:partyId/roles/:roleId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/individuals/:partyId/roles/:roleId');
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}}/individuals/:partyId/roles/:roleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/roles/:roleId';
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}}/individuals/:partyId/roles/:roleId"]
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}}/individuals/:partyId/roles/:roleId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/roles/:roleId",
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}}/individuals/:partyId/roles/:roleId');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/roles/:roleId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/roles/:roleId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/roles/:roleId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/roles/:roleId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/individuals/:partyId/roles/:roleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/roles/:roleId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/roles/:roleId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/roles/:roleId")
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/individuals/:partyId/roles/:roleId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/roles/:roleId";
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}}/individuals/:partyId/roles/:roleId
http DELETE {{baseUrl}}/individuals/:partyId/roles/:roleId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/individuals/:partyId/roles/:roleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/roles/:roleId")! 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": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of roles (GET)
{{baseUrl}}/individuals/:partyId/roles
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/roles");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/individuals/:partyId/roles")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/roles"
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}}/individuals/:partyId/roles"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/roles");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/roles"
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/individuals/:partyId/roles HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/individuals/:partyId/roles")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/roles"))
.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}}/individuals/:partyId/roles")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/individuals/:partyId/roles")
.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}}/individuals/:partyId/roles');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/individuals/:partyId/roles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/roles';
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}}/individuals/:partyId/roles',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/roles")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/roles',
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}}/individuals/:partyId/roles'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/individuals/:partyId/roles');
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}}/individuals/:partyId/roles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/roles';
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}}/individuals/:partyId/roles"]
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}}/individuals/:partyId/roles" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/roles",
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}}/individuals/:partyId/roles');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/roles');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/roles');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/roles' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/roles' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/individuals/:partyId/roles")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/roles"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/roles"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/roles")
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/individuals/:partyId/roles') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/roles";
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}}/individuals/:partyId/roles
http GET {{baseUrl}}/individuals/:partyId/roles
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/individuals/:partyId/roles
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/roles")! 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
[
{
"fromDate": "2016-01-13T09:05:06+10:00",
"toDate": ""
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a role
{{baseUrl}}/individuals/:partyId/roles/:roleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/roles/:roleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/individuals/:partyId/roles/:roleId")
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/roles/:roleId"
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}}/individuals/:partyId/roles/:roleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/individuals/:partyId/roles/:roleId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/roles/:roleId"
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/individuals/:partyId/roles/:roleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/individuals/:partyId/roles/:roleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/roles/:roleId"))
.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}}/individuals/:partyId/roles/:roleId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/individuals/:partyId/roles/:roleId")
.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}}/individuals/:partyId/roles/:roleId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/individuals/:partyId/roles/:roleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/roles/:roleId';
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}}/individuals/:partyId/roles/:roleId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/roles/:roleId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/individuals/:partyId/roles/:roleId',
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}}/individuals/:partyId/roles/:roleId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/individuals/:partyId/roles/:roleId');
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}}/individuals/:partyId/roles/:roleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/roles/:roleId';
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}}/individuals/:partyId/roles/:roleId"]
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}}/individuals/:partyId/roles/:roleId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/roles/:roleId",
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}}/individuals/:partyId/roles/:roleId');
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/roles/:roleId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/individuals/:partyId/roles/:roleId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/individuals/:partyId/roles/:roleId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/roles/:roleId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/individuals/:partyId/roles/:roleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/roles/:roleId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/roles/:roleId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/individuals/:partyId/roles/:roleId")
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/individuals/:partyId/roles/:roleId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/individuals/:partyId/roles/:roleId";
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}}/individuals/:partyId/roles/:roleId
http GET {{baseUrl}}/individuals/:partyId/roles/:roleId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/individuals/:partyId/roles/:roleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/roles/:roleId")! 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
{
"fromDate": "2016-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
PUT
Update a role
{{baseUrl}}/individuals/:partyId/roles/:roleId
BODY json
{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/individuals/:partyId/roles/:roleId");
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/individuals/:partyId/roles/:roleId" {:content-type :json
:form-params {:fromDate ""
:id ""
:partyRoleType ""
:relatedPartyId ""
:relatedPartyRoleType ""
:relationshipType ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/individuals/:partyId/roles/:roleId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/roles/:roleId"),
Content = new StringContent("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/roles/:roleId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/individuals/:partyId/roles/:roleId"
payload := strings.NewReader("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/roles/:roleId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 151
{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/individuals/:partyId/roles/:roleId")
.setHeader("content-type", "application/json")
.setBody("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/individuals/:partyId/roles/:roleId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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 \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/roles/:roleId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/individuals/:partyId/roles/:roleId")
.header("content-type", "application/json")
.body("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/individuals/:partyId/roles/:roleId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/individuals/:partyId/roles/:roleId',
headers: {'content-type': 'application/json'},
data: {
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/individuals/:partyId/roles/:roleId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","partyRoleType":"","relatedPartyId":"","relatedPartyRoleType":"","relationshipType":"","toDate":""}'
};
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}}/individuals/:partyId/roles/:roleId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fromDate": "",\n "id": "",\n "partyRoleType": "",\n "relatedPartyId": "",\n "relatedPartyRoleType": "",\n "relationshipType": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/individuals/:partyId/roles/:roleId")
.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/individuals/:partyId/roles/:roleId',
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({
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/individuals/:partyId/roles/:roleId',
headers: {'content-type': 'application/json'},
body: {
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
},
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}}/individuals/:partyId/roles/:roleId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
});
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}}/individuals/:partyId/roles/:roleId',
headers: {'content-type': 'application/json'},
data: {
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/individuals/:partyId/roles/:roleId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","partyRoleType":"","relatedPartyId":"","relatedPartyRoleType":"","relationshipType":"","toDate":""}'
};
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 = @{ @"fromDate": @"",
@"id": @"",
@"partyRoleType": @"",
@"relatedPartyId": @"",
@"relatedPartyRoleType": @"",
@"relationshipType": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/individuals/:partyId/roles/:roleId"]
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}}/individuals/:partyId/roles/:roleId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/individuals/:partyId/roles/:roleId",
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([
'fromDate' => '',
'id' => '',
'partyRoleType' => '',
'relatedPartyId' => '',
'relatedPartyRoleType' => '',
'relationshipType' => '',
'toDate' => ''
]),
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}}/individuals/:partyId/roles/:roleId', [
'body' => '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/individuals/:partyId/roles/:roleId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fromDate' => '',
'id' => '',
'partyRoleType' => '',
'relatedPartyId' => '',
'relatedPartyRoleType' => '',
'relationshipType' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'fromDate' => '',
'id' => '',
'partyRoleType' => '',
'relatedPartyId' => '',
'relatedPartyRoleType' => '',
'relationshipType' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/individuals/:partyId/roles/:roleId');
$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}}/individuals/:partyId/roles/:roleId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/individuals/:partyId/roles/:roleId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/individuals/:partyId/roles/:roleId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/individuals/:partyId/roles/:roleId"
payload = {
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/individuals/:partyId/roles/:roleId"
payload <- "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/roles/:roleId")
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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/individuals/:partyId/roles/:roleId') do |req|
req.body = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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}}/individuals/:partyId/roles/:roleId";
let payload = json!({
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
});
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}}/individuals/:partyId/roles/:roleId \
--header 'content-type: application/json' \
--data '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}'
echo '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}' | \
http PUT {{baseUrl}}/individuals/:partyId/roles/:roleId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "fromDate": "",\n "id": "",\n "partyRoleType": "",\n "relatedPartyId": "",\n "relatedPartyRoleType": "",\n "relationshipType": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/individuals/:partyId/roles/:roleId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/individuals/:partyId/roles/:roleId")! 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
{
"fromDate": "2016-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of legal entity types
{{baseUrl}}/classifications/legal-entity-types
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/classifications/legal-entity-types");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/classifications/legal-entity-types")
require "http/client"
url = "{{baseUrl}}/classifications/legal-entity-types"
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}}/classifications/legal-entity-types"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/classifications/legal-entity-types");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/classifications/legal-entity-types"
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/classifications/legal-entity-types HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/classifications/legal-entity-types")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/classifications/legal-entity-types"))
.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}}/classifications/legal-entity-types")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/classifications/legal-entity-types")
.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}}/classifications/legal-entity-types');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/classifications/legal-entity-types'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/classifications/legal-entity-types';
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}}/classifications/legal-entity-types',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/classifications/legal-entity-types")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/classifications/legal-entity-types',
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}}/classifications/legal-entity-types'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/classifications/legal-entity-types');
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}}/classifications/legal-entity-types'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/classifications/legal-entity-types';
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}}/classifications/legal-entity-types"]
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}}/classifications/legal-entity-types" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/classifications/legal-entity-types",
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}}/classifications/legal-entity-types');
echo $response->getBody();
setUrl('{{baseUrl}}/classifications/legal-entity-types');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/classifications/legal-entity-types');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/classifications/legal-entity-types' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/classifications/legal-entity-types' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/classifications/legal-entity-types")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/classifications/legal-entity-types"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/classifications/legal-entity-types"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/classifications/legal-entity-types")
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/classifications/legal-entity-types') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/classifications/legal-entity-types";
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}}/classifications/legal-entity-types
http GET {{baseUrl}}/classifications/legal-entity-types
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/classifications/legal-entity-types
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/classifications/legal-entity-types")! 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": "If you operate as a sole trader, you're responsible for all aspects of the business, including any debts the business incurs.",
"id": "123e4567-e89b-12d3-a456-426655440001",
"name": "Sole Trader"
},
{
"description": "A partnership is two or more individuals or organisations who do business as partners or receive income jointly.",
"id": "123e4567-e89b-12d3-a456-426655440002",
"name": "Partnership"
},
{
"description": "A joint venture is two or more people or entities who join to do business together for a particular purpose, usually a single project, rather than as an ongoing business.",
"id": "123e4567-e89b-12d3-a456-426655440003",
"name": "Joint Venture"
},
{
"description": "A company is a separate legal entity. This means it has the same rights as a natural person and can incur debt, sue and be sued.",
"id": "123e4567-e89b-12d3-a456-426655440004",
"name": "Company"
},
{
"description": "A trust is an obligation imposed on a person – the trustee – to hold property or assets (e.g. business assets) for the benefit of others (known as beneficiaries).",
"id": "123e4567-e89b-12d3-a456-426655440005",
"name": "Trust"
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of license lifecycle states
{{baseUrl}}/classifications/license-lifecycle-states
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/classifications/license-lifecycle-states");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/classifications/license-lifecycle-states")
require "http/client"
url = "{{baseUrl}}/classifications/license-lifecycle-states"
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}}/classifications/license-lifecycle-states"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/classifications/license-lifecycle-states");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/classifications/license-lifecycle-states"
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/classifications/license-lifecycle-states HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/classifications/license-lifecycle-states")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/classifications/license-lifecycle-states"))
.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}}/classifications/license-lifecycle-states")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/classifications/license-lifecycle-states")
.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}}/classifications/license-lifecycle-states');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/classifications/license-lifecycle-states'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/classifications/license-lifecycle-states';
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}}/classifications/license-lifecycle-states',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/classifications/license-lifecycle-states")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/classifications/license-lifecycle-states',
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}}/classifications/license-lifecycle-states'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/classifications/license-lifecycle-states');
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}}/classifications/license-lifecycle-states'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/classifications/license-lifecycle-states';
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}}/classifications/license-lifecycle-states"]
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}}/classifications/license-lifecycle-states" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/classifications/license-lifecycle-states",
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}}/classifications/license-lifecycle-states');
echo $response->getBody();
setUrl('{{baseUrl}}/classifications/license-lifecycle-states');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/classifications/license-lifecycle-states');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/classifications/license-lifecycle-states' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/classifications/license-lifecycle-states' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/classifications/license-lifecycle-states")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/classifications/license-lifecycle-states"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/classifications/license-lifecycle-states"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/classifications/license-lifecycle-states")
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/classifications/license-lifecycle-states') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/classifications/license-lifecycle-states";
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}}/classifications/license-lifecycle-states
http GET {{baseUrl}}/classifications/license-lifecycle-states
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/classifications/license-lifecycle-states
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/classifications/license-lifecycle-states")! 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": "The License has been approved.",
"id": "123e4567-e89b-12d3-a456-426655440001",
"name": "Approved"
},
{
"description": "The License has expired.",
"id": "123e4567-e89b-12d3-a456-426655440002",
"name": "Expired"
},
{
"description": "The License has been issued.",
"id": "123e4567-e89b-12d3-a456-426655440003",
"name": "Issued"
},
{
"description": "The License is pending approval.",
"id": "123e4567-e89b-12d3-a456-426655440004",
"name": "Pending Approval"
},
{
"description": "The License has been suspended.",
"id": "123e4567-e89b-12d3-a456-426655440005",
"name": "Suspended"
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of license types
{{baseUrl}}/classifications/license-types
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/classifications/license-types");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/classifications/license-types")
require "http/client"
url = "{{baseUrl}}/classifications/license-types"
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}}/classifications/license-types"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/classifications/license-types");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/classifications/license-types"
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/classifications/license-types HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/classifications/license-types")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/classifications/license-types"))
.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}}/classifications/license-types")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/classifications/license-types")
.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}}/classifications/license-types');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/classifications/license-types'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/classifications/license-types';
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}}/classifications/license-types',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/classifications/license-types")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/classifications/license-types',
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}}/classifications/license-types'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/classifications/license-types');
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}}/classifications/license-types'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/classifications/license-types';
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}}/classifications/license-types"]
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}}/classifications/license-types" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/classifications/license-types",
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}}/classifications/license-types');
echo $response->getBody();
setUrl('{{baseUrl}}/classifications/license-types');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/classifications/license-types');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/classifications/license-types' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/classifications/license-types' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/classifications/license-types")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/classifications/license-types"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/classifications/license-types"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/classifications/license-types")
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/classifications/license-types') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/classifications/license-types";
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}}/classifications/license-types
http GET {{baseUrl}}/classifications/license-types
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/classifications/license-types
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/classifications/license-types")! 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": "To conduct a financial services business in Australia, you must have an Australian Financial Services (AFS) licence.",
"id": "123e4567-e89b-12d3-a456-426655440001",
"name": "Australian Financial Services License"
},
{
"description": "To conduct a business you must have a 2B licence.",
"id": "123e4567-e89b-12d3-a456-426655440002",
"name": "2B License"
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of licenses (GET)
{{baseUrl}}/licenses
HEADERS
apiKey
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/licenses");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "apikey: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/licenses" {:headers {:apikey ""}})
require "http/client"
url = "{{baseUrl}}/licenses"
headers = HTTP::Headers{
"apikey" => ""
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/licenses"),
Headers =
{
{ "apikey", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/licenses");
var request = new RestRequest("", Method.Get);
request.AddHeader("apikey", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/licenses"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/licenses HTTP/1.1
Apikey:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/licenses")
.setHeader("apikey", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/licenses"))
.header("apikey", "")
.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}}/licenses")
.get()
.addHeader("apikey", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/licenses")
.header("apikey", "")
.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}}/licenses');
xhr.setRequestHeader('apikey', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/licenses',
headers: {apikey: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/licenses';
const options = {method: 'GET', headers: {apikey: ''}};
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}}/licenses',
method: 'GET',
headers: {
apikey: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/licenses")
.get()
.addHeader("apikey", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/licenses',
headers: {
apikey: ''
}
};
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}}/licenses',
headers: {apikey: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/licenses');
req.headers({
apikey: ''
});
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}}/licenses',
headers: {apikey: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/licenses';
const options = {method: 'GET', headers: {apikey: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"apikey": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/licenses"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[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}}/licenses" in
let headers = Header.add (Header.init ()) "apikey" "" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/licenses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/licenses', [
'headers' => [
'apikey' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/licenses');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'apikey' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/licenses');
$request->setRequestMethod('GET');
$request->setHeaders([
'apikey' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("apikey", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/licenses' -Method GET -Headers $headers
$headers=@{}
$headers.Add("apikey", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/licenses' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'apikey': "" }
conn.request("GET", "/baseUrl/licenses", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/licenses"
headers = {"apikey": ""}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/licenses"
response <- VERB("GET", url, add_headers('apikey' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/licenses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/licenses') do |req|
req.headers['apikey'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/licenses";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("apikey", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/licenses \
--header 'apikey: '
http GET {{baseUrl}}/licenses \
apikey:''
wget --quiet \
--method GET \
--header 'apikey: ' \
--output-document \
- {{baseUrl}}/licenses
import Foundation
let headers = ["apikey": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/licenses")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
[
{
"fromDate": "1979-01-13T09:05:06+10:00",
"toDate": ""
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of name directions
{{baseUrl}}/classifications/name-directions
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/classifications/name-directions");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/classifications/name-directions")
require "http/client"
url = "{{baseUrl}}/classifications/name-directions"
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}}/classifications/name-directions"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/classifications/name-directions");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/classifications/name-directions"
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/classifications/name-directions HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/classifications/name-directions")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/classifications/name-directions"))
.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}}/classifications/name-directions")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/classifications/name-directions")
.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}}/classifications/name-directions');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/classifications/name-directions'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/classifications/name-directions';
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}}/classifications/name-directions',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/classifications/name-directions")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/classifications/name-directions',
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}}/classifications/name-directions'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/classifications/name-directions');
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}}/classifications/name-directions'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/classifications/name-directions';
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}}/classifications/name-directions"]
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}}/classifications/name-directions" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/classifications/name-directions",
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}}/classifications/name-directions');
echo $response->getBody();
setUrl('{{baseUrl}}/classifications/name-directions');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/classifications/name-directions');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/classifications/name-directions' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/classifications/name-directions' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/classifications/name-directions")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/classifications/name-directions"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/classifications/name-directions"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/classifications/name-directions")
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/classifications/name-directions') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/classifications/name-directions";
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}}/classifications/name-directions
http GET {{baseUrl}}/classifications/name-directions
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/classifications/name-directions
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/classifications/name-directions")! 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": "The full name or formal salutation is rendered left to right.",
"id": "123e4567-e89b-12d3-a456-426655440001",
"name": "left-to-right"
},
{
"description": "The full name or formal salutation is rendered right to left.",
"id": "123e4567-e89b-12d3-a456-426655440002",
"name": "right-to-left"
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of name prefixes
{{baseUrl}}/classifications/name-prefixes
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/classifications/name-prefixes");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/classifications/name-prefixes")
require "http/client"
url = "{{baseUrl}}/classifications/name-prefixes"
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}}/classifications/name-prefixes"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/classifications/name-prefixes");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/classifications/name-prefixes"
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/classifications/name-prefixes HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/classifications/name-prefixes")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/classifications/name-prefixes"))
.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}}/classifications/name-prefixes")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/classifications/name-prefixes")
.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}}/classifications/name-prefixes');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/classifications/name-prefixes'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/classifications/name-prefixes';
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}}/classifications/name-prefixes',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/classifications/name-prefixes")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/classifications/name-prefixes',
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}}/classifications/name-prefixes'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/classifications/name-prefixes');
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}}/classifications/name-prefixes'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/classifications/name-prefixes';
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}}/classifications/name-prefixes"]
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}}/classifications/name-prefixes" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/classifications/name-prefixes",
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}}/classifications/name-prefixes');
echo $response->getBody();
setUrl('{{baseUrl}}/classifications/name-prefixes');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/classifications/name-prefixes');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/classifications/name-prefixes' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/classifications/name-prefixes' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/classifications/name-prefixes")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/classifications/name-prefixes"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/classifications/name-prefixes"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/classifications/name-prefixes")
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/classifications/name-prefixes') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/classifications/name-prefixes";
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}}/classifications/name-prefixes
http GET {{baseUrl}}/classifications/name-prefixes
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/classifications/name-prefixes
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/classifications/name-prefixes")! 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": "A title used before a family name or formal salutation to address a man.",
"id": "123e4567-e89b-12d3-a456-426655440001",
"name": "Mr"
},
{
"description": "A title used before a family name or formal salutation to address a woman.",
"id": "123e4567-e89b-12d3-a456-426655440002",
"name": "Ms"
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of name types
{{baseUrl}}/classifications/name-types
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/classifications/name-types");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/classifications/name-types")
require "http/client"
url = "{{baseUrl}}/classifications/name-types"
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}}/classifications/name-types"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/classifications/name-types");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/classifications/name-types"
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/classifications/name-types HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/classifications/name-types")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/classifications/name-types"))
.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}}/classifications/name-types")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/classifications/name-types")
.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}}/classifications/name-types');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/classifications/name-types'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/classifications/name-types';
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}}/classifications/name-types',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/classifications/name-types")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/classifications/name-types',
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}}/classifications/name-types'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/classifications/name-types');
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}}/classifications/name-types'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/classifications/name-types';
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}}/classifications/name-types"]
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}}/classifications/name-types" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/classifications/name-types",
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}}/classifications/name-types');
echo $response->getBody();
setUrl('{{baseUrl}}/classifications/name-types');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/classifications/name-types');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/classifications/name-types' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/classifications/name-types' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/classifications/name-types")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/classifications/name-types"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/classifications/name-types"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/classifications/name-types")
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/classifications/name-types') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/classifications/name-types";
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}}/classifications/name-types
http GET {{baseUrl}}/classifications/name-types
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/classifications/name-types
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/classifications/name-types")! 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": "An alternate name used by a party.",
"id": "123e4567-e89b-12d3-a456-426655440001",
"name": "Alias"
},
{
"description": "The primary name used by a party.",
"id": "123e4567-e89b-12d3-a456-426655440002",
"name": "Principal Name"
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
POST
Create an organisation
{{baseUrl}}/organisations
HEADERS
apiKey
BODY json
{
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "apikey: ");
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/organisations" {:headers {:apikey ""}
:content-type :json
:form-params {:addresses []
:electronicAddresses [{:areaCode ""
:countryPrefix ""
:electronicAddressType ""
:email ""
:extension ""
:fromDate ""
:id ""
:number ""
:toDate ""
:url ""}]
:establishmentDate ""
:fromDate ""
:id ""
:legalEntityType ""
:names [{:fromDate ""
:id ""
:name ""
:toDate ""}]
:registeredIdentifiers [{:fromDate ""
:id ""
:identifier ""
:identifierType ""
:toDate ""}]
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/organisations"
headers = HTTP::Headers{
"apikey" => ""
"content-type" => "application/json"
}
reqBody = "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\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}}/organisations"),
Headers =
{
{ "apikey", "" },
},
Content = new StringContent("{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\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}}/organisations");
var request = new RestRequest("", Method.Post);
request.AddHeader("apikey", "");
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations"
payload := strings.NewReader("{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("apikey", "")
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/organisations HTTP/1.1
Apikey:
Content-Type: application/json
Host: example.com
Content-Length: 643
{
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/organisations")
.setHeader("apikey", "")
.setHeader("content-type", "application/json")
.setBody("{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations"))
.header("apikey", "")
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\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 \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/organisations")
.post(body)
.addHeader("apikey", "")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/organisations")
.header("apikey", "")
.header("content-type", "application/json")
.body("{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
addresses: [],
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
establishmentDate: '',
fromDate: '',
id: '',
legalEntityType: '',
names: [
{
fromDate: '',
id: '',
name: '',
toDate: ''
}
],
registeredIdentifiers: [
{
fromDate: '',
id: '',
identifier: '',
identifierType: '',
toDate: ''
}
],
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/organisations');
xhr.setRequestHeader('apikey', '');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/organisations',
headers: {apikey: '', 'content-type': 'application/json'},
data: {
addresses: [],
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
establishmentDate: '',
fromDate: '',
id: '',
legalEntityType: '',
names: [{fromDate: '', id: '', name: '', toDate: ''}],
registeredIdentifiers: [{fromDate: '', id: '', identifier: '', identifierType: '', toDate: ''}],
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations';
const options = {
method: 'POST',
headers: {apikey: '', 'content-type': 'application/json'},
body: '{"addresses":[],"electronicAddresses":[{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","url":""}],"establishmentDate":"","fromDate":"","id":"","legalEntityType":"","names":[{"fromDate":"","id":"","name":"","toDate":""}],"registeredIdentifiers":[{"fromDate":"","id":"","identifier":"","identifierType":"","toDate":""}],"toDate":""}'
};
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}}/organisations',
method: 'POST',
headers: {
apikey: '',
'content-type': 'application/json'
},
processData: false,
data: '{\n "addresses": [],\n "electronicAddresses": [\n {\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\n "url": ""\n }\n ],\n "establishmentDate": "",\n "fromDate": "",\n "id": "",\n "legalEntityType": "",\n "names": [\n {\n "fromDate": "",\n "id": "",\n "name": "",\n "toDate": ""\n }\n ],\n "registeredIdentifiers": [\n {\n "fromDate": "",\n "id": "",\n "identifier": "",\n "identifierType": "",\n "toDate": ""\n }\n ],\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/organisations")
.post(body)
.addHeader("apikey", "")
.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/organisations',
headers: {
apikey: '',
'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({
addresses: [],
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
establishmentDate: '',
fromDate: '',
id: '',
legalEntityType: '',
names: [{fromDate: '', id: '', name: '', toDate: ''}],
registeredIdentifiers: [{fromDate: '', id: '', identifier: '', identifierType: '', toDate: ''}],
toDate: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/organisations',
headers: {apikey: '', 'content-type': 'application/json'},
body: {
addresses: [],
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
establishmentDate: '',
fromDate: '',
id: '',
legalEntityType: '',
names: [{fromDate: '', id: '', name: '', toDate: ''}],
registeredIdentifiers: [{fromDate: '', id: '', identifier: '', identifierType: '', toDate: ''}],
toDate: ''
},
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}}/organisations');
req.headers({
apikey: '',
'content-type': 'application/json'
});
req.type('json');
req.send({
addresses: [],
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
establishmentDate: '',
fromDate: '',
id: '',
legalEntityType: '',
names: [
{
fromDate: '',
id: '',
name: '',
toDate: ''
}
],
registeredIdentifiers: [
{
fromDate: '',
id: '',
identifier: '',
identifierType: '',
toDate: ''
}
],
toDate: ''
});
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}}/organisations',
headers: {apikey: '', 'content-type': 'application/json'},
data: {
addresses: [],
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
establishmentDate: '',
fromDate: '',
id: '',
legalEntityType: '',
names: [{fromDate: '', id: '', name: '', toDate: ''}],
registeredIdentifiers: [{fromDate: '', id: '', identifier: '', identifierType: '', toDate: ''}],
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations';
const options = {
method: 'POST',
headers: {apikey: '', 'content-type': 'application/json'},
body: '{"addresses":[],"electronicAddresses":[{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","url":""}],"establishmentDate":"","fromDate":"","id":"","legalEntityType":"","names":[{"fromDate":"","id":"","name":"","toDate":""}],"registeredIdentifiers":[{"fromDate":"","id":"","identifier":"","identifierType":"","toDate":""}],"toDate":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"apikey": @"",
@"content-type": @"application/json" };
NSDictionary *parameters = @{ @"addresses": @[ ],
@"electronicAddresses": @[ @{ @"areaCode": @"", @"countryPrefix": @"", @"electronicAddressType": @"", @"email": @"", @"extension": @"", @"fromDate": @"", @"id": @"", @"number": @"", @"toDate": @"", @"url": @"" } ],
@"establishmentDate": @"",
@"fromDate": @"",
@"id": @"",
@"legalEntityType": @"",
@"names": @[ @{ @"fromDate": @"", @"id": @"", @"name": @"", @"toDate": @"" } ],
@"registeredIdentifiers": @[ @{ @"fromDate": @"", @"id": @"", @"identifier": @"", @"identifierType": @"", @"toDate": @"" } ],
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/organisations"]
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}}/organisations" in
let headers = Header.add_list (Header.init ()) [
("apikey", "");
("content-type", "application/json");
] in
let body = Cohttp_lwt_body.of_string "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations",
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([
'addresses' => [
],
'electronicAddresses' => [
[
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]
],
'establishmentDate' => '',
'fromDate' => '',
'id' => '',
'legalEntityType' => '',
'names' => [
[
'fromDate' => '',
'id' => '',
'name' => '',
'toDate' => ''
]
],
'registeredIdentifiers' => [
[
'fromDate' => '',
'id' => '',
'identifier' => '',
'identifierType' => '',
'toDate' => ''
]
],
'toDate' => ''
]),
CURLOPT_HTTPHEADER => [
"apikey: ",
"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}}/organisations', [
'body' => '{
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}',
'headers' => [
'apikey' => '',
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/organisations');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'apikey' => '',
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'addresses' => [
],
'electronicAddresses' => [
[
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]
],
'establishmentDate' => '',
'fromDate' => '',
'id' => '',
'legalEntityType' => '',
'names' => [
[
'fromDate' => '',
'id' => '',
'name' => '',
'toDate' => ''
]
],
'registeredIdentifiers' => [
[
'fromDate' => '',
'id' => '',
'identifier' => '',
'identifierType' => '',
'toDate' => ''
]
],
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'addresses' => [
],
'electronicAddresses' => [
[
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]
],
'establishmentDate' => '',
'fromDate' => '',
'id' => '',
'legalEntityType' => '',
'names' => [
[
'fromDate' => '',
'id' => '',
'name' => '',
'toDate' => ''
]
],
'registeredIdentifiers' => [
[
'fromDate' => '',
'id' => '',
'identifier' => '',
'identifierType' => '',
'toDate' => ''
]
],
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/organisations');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'apikey' => '',
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("apikey", "")
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}'
$headers=@{}
$headers.Add("apikey", "")
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}"
headers = {
'apikey': "",
'content-type': "application/json"
}
conn.request("POST", "/baseUrl/organisations", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations"
payload = {
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}
headers = {
"apikey": "",
"content-type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations"
payload <- "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, add_headers('apikey' = ''), content_type("application/json"), encode = encode)
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["apikey"] = ''
request["content-type"] = 'application/json'
request.body = "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\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/organisations') do |req|
req.headers['apikey'] = ''
req.body = "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations";
let payload = json!({
"addresses": (),
"electronicAddresses": (
json!({
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
})
),
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": (
json!({
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
})
),
"registeredIdentifiers": (
json!({
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
})
),
"toDate": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("apikey", "".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}}/organisations \
--header 'apikey: ' \
--header 'content-type: application/json' \
--data '{
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}'
echo '{
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}' | \
http POST {{baseUrl}}/organisations \
apikey:'' \
content-type:application/json
wget --quiet \
--method POST \
--header 'apikey: ' \
--header 'content-type: application/json' \
--body-data '{\n "addresses": [],\n "electronicAddresses": [\n {\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\n "url": ""\n }\n ],\n "establishmentDate": "",\n "fromDate": "",\n "id": "",\n "legalEntityType": "",\n "names": [\n {\n "fromDate": "",\n "id": "",\n "name": "",\n "toDate": ""\n }\n ],\n "registeredIdentifiers": [\n {\n "fromDate": "",\n "id": "",\n "identifier": "",\n "identifierType": "",\n "toDate": ""\n }\n ],\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/organisations
import Foundation
let headers = [
"apikey": "",
"content-type": "application/json"
]
let parameters = [
"addresses": [],
"electronicAddresses": [
[
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
]
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
[
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
]
],
"registeredIdentifiers": [
[
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
]
],
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations")! 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
{
"establishmentDate": "1928-03-03",
"fromDate": "1979-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
DELETE
Delete an organisation
{{baseUrl}}/organisations/:partyId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/organisations/:partyId")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId"
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}}/organisations/:partyId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId"
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/organisations/:partyId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/organisations/:partyId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId"))
.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}}/organisations/:partyId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/organisations/:partyId")
.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}}/organisations/:partyId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'DELETE', url: '{{baseUrl}}/organisations/:partyId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId';
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}}/organisations/:partyId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId',
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}}/organisations/:partyId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/organisations/:partyId');
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}}/organisations/:partyId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId';
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}}/organisations/:partyId"]
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}}/organisations/:partyId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId",
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}}/organisations/:partyId');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/organisations/:partyId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId")
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/organisations/:partyId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId";
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}}/organisations/:partyId
http DELETE {{baseUrl}}/organisations/:partyId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/organisations/:partyId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId")! 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",
"message": "Request can not be executed in the current system state",
"status": "FAILED_PRECONDITION"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of organisations
{{baseUrl}}/organisations
HEADERS
apiKey
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "apikey: ");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/organisations" {:headers {:apikey ""}})
require "http/client"
url = "{{baseUrl}}/organisations"
headers = HTTP::Headers{
"apikey" => ""
}
response = HTTP::Client.get url, headers: headers
puts response.body
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/organisations"),
Headers =
{
{ "apikey", "" },
},
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations");
var request = new RestRequest("", Method.Get);
request.AddHeader("apikey", "");
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
GET /baseUrl/organisations HTTP/1.1
Apikey:
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/organisations")
.setHeader("apikey", "")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations"))
.header("apikey", "")
.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}}/organisations")
.get()
.addHeader("apikey", "")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/organisations")
.header("apikey", "")
.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}}/organisations');
xhr.setRequestHeader('apikey', '');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/organisations',
headers: {apikey: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations';
const options = {method: 'GET', headers: {apikey: ''}};
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}}/organisations',
method: 'GET',
headers: {
apikey: ''
}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations")
.get()
.addHeader("apikey", "")
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations',
headers: {
apikey: ''
}
};
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}}/organisations',
headers: {apikey: ''}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/organisations');
req.headers({
apikey: ''
});
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}}/organisations',
headers: {apikey: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations';
const options = {method: 'GET', headers: {apikey: ''}};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}
#import
NSDictionary *headers = @{ @"apikey": @"" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/organisations"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
[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}}/organisations" in
let headers = Header.add (Header.init ()) "apikey" "" in
Client.call ~headers `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: "
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
request('GET', '{{baseUrl}}/organisations', [
'headers' => [
'apikey' => '',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/organisations');
$request->setMethod(HTTP_METH_GET);
$request->setHeaders([
'apikey' => ''
]);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations');
$request->setRequestMethod('GET');
$request->setHeaders([
'apikey' => ''
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$headers=@{}
$headers.Add("apikey", "")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations' -Method GET -Headers $headers
$headers=@{}
$headers.Add("apikey", "")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations' -Method GET -Headers $headers
import http.client
conn = http.client.HTTPSConnection("example.com")
headers = { 'apikey': "" }
conn.request("GET", "/baseUrl/organisations", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations"
headers = {"apikey": ""}
response = requests.get(url, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations"
response <- VERB("GET", url, add_headers('apikey' = ''), content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = ''
response = http.request(request)
puts response.read_body
require 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/organisations') do |req|
req.headers['apikey'] = ''
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations";
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("apikey", "".parse().unwrap());
let client = reqwest::Client::new();
let response = client.get(url)
.headers(headers)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/organisations \
--header 'apikey: '
http GET {{baseUrl}}/organisations \
apikey:''
wget --quiet \
--method GET \
--header 'apikey: ' \
--output-document \
- {{baseUrl}}/organisations
import Foundation
let headers = ["apikey": ""]
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
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
[
{
"establishmentDate": "1928-03-03",
"fromDate": "1979-01-13T09:05:06+10:00",
"toDate": ""
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve an organisation
{{baseUrl}}/organisations/:partyId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/organisations/:partyId")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId"
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}}/organisations/:partyId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId"
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/organisations/:partyId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/organisations/:partyId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId"))
.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}}/organisations/:partyId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/organisations/:partyId")
.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}}/organisations/:partyId');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/organisations/:partyId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId';
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}}/organisations/:partyId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId',
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}}/organisations/:partyId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/organisations/:partyId');
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}}/organisations/:partyId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId';
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}}/organisations/:partyId"]
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}}/organisations/:partyId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId",
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}}/organisations/:partyId');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/organisations/:partyId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId")
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/organisations/:partyId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId";
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}}/organisations/:partyId
http GET {{baseUrl}}/organisations/:partyId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/organisations/:partyId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId")! 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
{
"establishmentDate": "1928-03-03",
"fromDate": "1979-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
PUT
Update an organisation
{{baseUrl}}/organisations/:partyId
BODY json
{
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId");
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 \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/organisations/:partyId" {:content-type :json
:form-params {:addresses []
:electronicAddresses [{:areaCode ""
:countryPrefix ""
:electronicAddressType ""
:email ""
:extension ""
:fromDate ""
:id ""
:number ""
:toDate ""
:url ""}]
:establishmentDate ""
:fromDate ""
:id ""
:legalEntityType ""
:names [{:fromDate ""
:id ""
:name ""
:toDate ""}]
:registeredIdentifiers [{:fromDate ""
:id ""
:identifier ""
:identifierType ""
:toDate ""}]
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/organisations/:partyId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\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}}/organisations/:partyId"),
Content = new StringContent("{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\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}}/organisations/:partyId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId"
payload := strings.NewReader("{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\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/organisations/:partyId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 643
{
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/organisations/:partyId")
.setHeader("content-type", "application/json")
.setBody("{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\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 \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/organisations/:partyId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/organisations/:partyId")
.header("content-type", "application/json")
.body("{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
addresses: [],
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
establishmentDate: '',
fromDate: '',
id: '',
legalEntityType: '',
names: [
{
fromDate: '',
id: '',
name: '',
toDate: ''
}
],
registeredIdentifiers: [
{
fromDate: '',
id: '',
identifier: '',
identifierType: '',
toDate: ''
}
],
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/organisations/:partyId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/organisations/:partyId',
headers: {'content-type': 'application/json'},
data: {
addresses: [],
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
establishmentDate: '',
fromDate: '',
id: '',
legalEntityType: '',
names: [{fromDate: '', id: '', name: '', toDate: ''}],
registeredIdentifiers: [{fromDate: '', id: '', identifier: '', identifierType: '', toDate: ''}],
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"addresses":[],"electronicAddresses":[{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","url":""}],"establishmentDate":"","fromDate":"","id":"","legalEntityType":"","names":[{"fromDate":"","id":"","name":"","toDate":""}],"registeredIdentifiers":[{"fromDate":"","id":"","identifier":"","identifierType":"","toDate":""}],"toDate":""}'
};
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}}/organisations/:partyId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "addresses": [],\n "electronicAddresses": [\n {\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\n "url": ""\n }\n ],\n "establishmentDate": "",\n "fromDate": "",\n "id": "",\n "legalEntityType": "",\n "names": [\n {\n "fromDate": "",\n "id": "",\n "name": "",\n "toDate": ""\n }\n ],\n "registeredIdentifiers": [\n {\n "fromDate": "",\n "id": "",\n "identifier": "",\n "identifierType": "",\n "toDate": ""\n }\n ],\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId")
.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/organisations/:partyId',
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({
addresses: [],
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
establishmentDate: '',
fromDate: '',
id: '',
legalEntityType: '',
names: [{fromDate: '', id: '', name: '', toDate: ''}],
registeredIdentifiers: [{fromDate: '', id: '', identifier: '', identifierType: '', toDate: ''}],
toDate: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/organisations/:partyId',
headers: {'content-type': 'application/json'},
body: {
addresses: [],
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
establishmentDate: '',
fromDate: '',
id: '',
legalEntityType: '',
names: [{fromDate: '', id: '', name: '', toDate: ''}],
registeredIdentifiers: [{fromDate: '', id: '', identifier: '', identifierType: '', toDate: ''}],
toDate: ''
},
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}}/organisations/:partyId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
addresses: [],
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
establishmentDate: '',
fromDate: '',
id: '',
legalEntityType: '',
names: [
{
fromDate: '',
id: '',
name: '',
toDate: ''
}
],
registeredIdentifiers: [
{
fromDate: '',
id: '',
identifier: '',
identifierType: '',
toDate: ''
}
],
toDate: ''
});
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}}/organisations/:partyId',
headers: {'content-type': 'application/json'},
data: {
addresses: [],
electronicAddresses: [
{
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
],
establishmentDate: '',
fromDate: '',
id: '',
legalEntityType: '',
names: [{fromDate: '', id: '', name: '', toDate: ''}],
registeredIdentifiers: [{fromDate: '', id: '', identifier: '', identifierType: '', toDate: ''}],
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"addresses":[],"electronicAddresses":[{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","url":""}],"establishmentDate":"","fromDate":"","id":"","legalEntityType":"","names":[{"fromDate":"","id":"","name":"","toDate":""}],"registeredIdentifiers":[{"fromDate":"","id":"","identifier":"","identifierType":"","toDate":""}],"toDate":""}'
};
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 = @{ @"addresses": @[ ],
@"electronicAddresses": @[ @{ @"areaCode": @"", @"countryPrefix": @"", @"electronicAddressType": @"", @"email": @"", @"extension": @"", @"fromDate": @"", @"id": @"", @"number": @"", @"toDate": @"", @"url": @"" } ],
@"establishmentDate": @"",
@"fromDate": @"",
@"id": @"",
@"legalEntityType": @"",
@"names": @[ @{ @"fromDate": @"", @"id": @"", @"name": @"", @"toDate": @"" } ],
@"registeredIdentifiers": @[ @{ @"fromDate": @"", @"id": @"", @"identifier": @"", @"identifierType": @"", @"toDate": @"" } ],
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/organisations/:partyId"]
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}}/organisations/:partyId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId",
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([
'addresses' => [
],
'electronicAddresses' => [
[
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]
],
'establishmentDate' => '',
'fromDate' => '',
'id' => '',
'legalEntityType' => '',
'names' => [
[
'fromDate' => '',
'id' => '',
'name' => '',
'toDate' => ''
]
],
'registeredIdentifiers' => [
[
'fromDate' => '',
'id' => '',
'identifier' => '',
'identifierType' => '',
'toDate' => ''
]
],
'toDate' => ''
]),
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}}/organisations/:partyId', [
'body' => '{
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'addresses' => [
],
'electronicAddresses' => [
[
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]
],
'establishmentDate' => '',
'fromDate' => '',
'id' => '',
'legalEntityType' => '',
'names' => [
[
'fromDate' => '',
'id' => '',
'name' => '',
'toDate' => ''
]
],
'registeredIdentifiers' => [
[
'fromDate' => '',
'id' => '',
'identifier' => '',
'identifierType' => '',
'toDate' => ''
]
],
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'addresses' => [
],
'electronicAddresses' => [
[
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]
],
'establishmentDate' => '',
'fromDate' => '',
'id' => '',
'legalEntityType' => '',
'names' => [
[
'fromDate' => '',
'id' => '',
'name' => '',
'toDate' => ''
]
],
'registeredIdentifiers' => [
[
'fromDate' => '',
'id' => '',
'identifier' => '',
'identifierType' => '',
'toDate' => ''
]
],
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/organisations/:partyId');
$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}}/organisations/:partyId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/organisations/:partyId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId"
payload = {
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId"
payload <- "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\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}}/organisations/:partyId")
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 \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\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/organisations/:partyId') do |req|
req.body = "{\n \"addresses\": [],\n \"electronicAddresses\": [\n {\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n }\n ],\n \"establishmentDate\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"legalEntityType\": \"\",\n \"names\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"registeredIdentifiers\": [\n {\n \"fromDate\": \"\",\n \"id\": \"\",\n \"identifier\": \"\",\n \"identifierType\": \"\",\n \"toDate\": \"\"\n }\n ],\n \"toDate\": \"\"\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}}/organisations/:partyId";
let payload = json!({
"addresses": (),
"electronicAddresses": (
json!({
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
})
),
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": (
json!({
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
})
),
"registeredIdentifiers": (
json!({
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
})
),
"toDate": ""
});
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}}/organisations/:partyId \
--header 'content-type: application/json' \
--data '{
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}'
echo '{
"addresses": [],
"electronicAddresses": [
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
{
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
}
],
"registeredIdentifiers": [
{
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
}
],
"toDate": ""
}' | \
http PUT {{baseUrl}}/organisations/:partyId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "addresses": [],\n "electronicAddresses": [\n {\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\n "url": ""\n }\n ],\n "establishmentDate": "",\n "fromDate": "",\n "id": "",\n "legalEntityType": "",\n "names": [\n {\n "fromDate": "",\n "id": "",\n "name": "",\n "toDate": ""\n }\n ],\n "registeredIdentifiers": [\n {\n "fromDate": "",\n "id": "",\n "identifier": "",\n "identifierType": "",\n "toDate": ""\n }\n ],\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/organisations/:partyId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"addresses": [],
"electronicAddresses": [
[
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
]
],
"establishmentDate": "",
"fromDate": "",
"id": "",
"legalEntityType": "",
"names": [
[
"fromDate": "",
"id": "",
"name": "",
"toDate": ""
]
],
"registeredIdentifiers": [
[
"fromDate": "",
"id": "",
"identifier": "",
"identifierType": "",
"toDate": ""
]
],
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId")! 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
{
"establishmentDate": "1928-03-03",
"fromDate": "1979-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
POST
Create an address (POST)
{{baseUrl}}/organisations/:partyId/addresses
BODY json
{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/addresses");
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 \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/organisations/:partyId/addresses" {:content-type :json
:form-params {:city ""
:country ""
:fromDate ""
:id ""
:line1 ""
:line2 ""
:line3 ""
:name ""
:postalCode ""
:suburb ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/addresses"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/addresses"),
Content = new StringContent("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/addresses");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/addresses"
payload := strings.NewReader("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/addresses HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 174
{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/organisations/:partyId/addresses")
.setHeader("content-type", "application/json")
.setBody("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/addresses"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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 \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/addresses")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/organisations/:partyId/addresses")
.header("content-type", "application/json")
.body("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/organisations/:partyId/addresses');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/organisations/:partyId/addresses',
headers: {'content-type': 'application/json'},
data: {
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/addresses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"city":"","country":"","fromDate":"","id":"","line1":"","line2":"","line3":"","name":"","postalCode":"","suburb":"","toDate":""}'
};
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}}/organisations/:partyId/addresses',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "city": "",\n "country": "",\n "fromDate": "",\n "id": "",\n "line1": "",\n "line2": "",\n "line3": "",\n "name": "",\n "postalCode": "",\n "suburb": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/addresses")
.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/organisations/:partyId/addresses',
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({
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/organisations/:partyId/addresses',
headers: {'content-type': 'application/json'},
body: {
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
},
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}}/organisations/:partyId/addresses');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
});
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}}/organisations/:partyId/addresses',
headers: {'content-type': 'application/json'},
data: {
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/addresses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"city":"","country":"","fromDate":"","id":"","line1":"","line2":"","line3":"","name":"","postalCode":"","suburb":"","toDate":""}'
};
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 = @{ @"city": @"",
@"country": @"",
@"fromDate": @"",
@"id": @"",
@"line1": @"",
@"line2": @"",
@"line3": @"",
@"name": @"",
@"postalCode": @"",
@"suburb": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/organisations/:partyId/addresses"]
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}}/organisations/:partyId/addresses" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/addresses",
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([
'city' => '',
'country' => '',
'fromDate' => '',
'id' => '',
'line1' => '',
'line2' => '',
'line3' => '',
'name' => '',
'postalCode' => '',
'suburb' => '',
'toDate' => ''
]),
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}}/organisations/:partyId/addresses', [
'body' => '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/addresses');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'city' => '',
'country' => '',
'fromDate' => '',
'id' => '',
'line1' => '',
'line2' => '',
'line3' => '',
'name' => '',
'postalCode' => '',
'suburb' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'city' => '',
'country' => '',
'fromDate' => '',
'id' => '',
'line1' => '',
'line2' => '',
'line3' => '',
'name' => '',
'postalCode' => '',
'suburb' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/organisations/:partyId/addresses');
$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}}/organisations/:partyId/addresses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/addresses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/organisations/:partyId/addresses", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/addresses"
payload = {
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/addresses"
payload <- "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/addresses")
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 \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/addresses') do |req|
req.body = "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/addresses";
let payload = json!({
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
});
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}}/organisations/:partyId/addresses \
--header 'content-type: application/json' \
--data '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}'
echo '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}' | \
http POST {{baseUrl}}/organisations/:partyId/addresses \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "city": "",\n "country": "",\n "fromDate": "",\n "id": "",\n "line1": "",\n "line2": "",\n "line3": "",\n "name": "",\n "postalCode": "",\n "suburb": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/organisations/:partyId/addresses
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/addresses")! 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
{
"city": "Canberra",
"country": "Australia",
"fromDate": "1979-01-13T09:05:06+10:00",
"line1": "Level 7",
"line2": "21 Genge Street",
"line3": "",
"name": "Kembery Building",
"postalCode": "2601",
"suburb": "Civic",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
DELETE
Delete an address (DELETE)
{{baseUrl}}/organisations/:partyId/addresses/:addressId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/addresses/:addressId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/organisations/:partyId/addresses/:addressId")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/addresses/:addressId"
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}}/organisations/:partyId/addresses/:addressId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/addresses/:addressId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/addresses/:addressId"
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/organisations/:partyId/addresses/:addressId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/organisations/:partyId/addresses/:addressId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/addresses/:addressId"))
.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}}/organisations/:partyId/addresses/:addressId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/organisations/:partyId/addresses/:addressId")
.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}}/organisations/:partyId/addresses/:addressId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/organisations/:partyId/addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/addresses/:addressId';
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}}/organisations/:partyId/addresses/:addressId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/addresses/:addressId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/addresses/:addressId',
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}}/organisations/:partyId/addresses/:addressId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/organisations/:partyId/addresses/:addressId');
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}}/organisations/:partyId/addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/addresses/:addressId';
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}}/organisations/:partyId/addresses/:addressId"]
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}}/organisations/:partyId/addresses/:addressId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/addresses/:addressId",
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}}/organisations/:partyId/addresses/:addressId');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/addresses/:addressId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/addresses/:addressId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/addresses/:addressId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/addresses/:addressId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/organisations/:partyId/addresses/:addressId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/addresses/:addressId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/addresses/:addressId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/addresses/:addressId")
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/organisations/:partyId/addresses/:addressId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/addresses/:addressId";
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}}/organisations/:partyId/addresses/:addressId
http DELETE {{baseUrl}}/organisations/:partyId/addresses/:addressId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/organisations/:partyId/addresses/:addressId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/addresses/:addressId")! 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": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of addresses (GET)
{{baseUrl}}/organisations/:partyId/addresses
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/addresses");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/organisations/:partyId/addresses")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/addresses"
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}}/organisations/:partyId/addresses"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/addresses");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/addresses"
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/organisations/:partyId/addresses HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/organisations/:partyId/addresses")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/addresses"))
.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}}/organisations/:partyId/addresses")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/organisations/:partyId/addresses")
.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}}/organisations/:partyId/addresses');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/organisations/:partyId/addresses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/addresses';
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}}/organisations/:partyId/addresses',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/addresses")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/addresses',
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}}/organisations/:partyId/addresses'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/organisations/:partyId/addresses');
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}}/organisations/:partyId/addresses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/addresses';
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}}/organisations/:partyId/addresses"]
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}}/organisations/:partyId/addresses" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/addresses",
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}}/organisations/:partyId/addresses');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/addresses');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/addresses');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/addresses' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/addresses' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/organisations/:partyId/addresses")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/addresses"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/addresses"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/addresses")
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/organisations/:partyId/addresses') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/addresses";
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}}/organisations/:partyId/addresses
http GET {{baseUrl}}/organisations/:partyId/addresses
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/organisations/:partyId/addresses
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/addresses")! 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
[
{
"city": "Canberra",
"country": "Australia",
"fromDate": "1979-01-13T09:05:06+10:00",
"line1": "Level 7",
"line2": "21 Genge Street",
"line3": "",
"name": "Kembery Building",
"postalCode": "2601",
"suburb": "Civic",
"toDate": ""
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve an address (GET)
{{baseUrl}}/organisations/:partyId/addresses/:addressId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/addresses/:addressId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/organisations/:partyId/addresses/:addressId")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/addresses/:addressId"
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}}/organisations/:partyId/addresses/:addressId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/addresses/:addressId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/addresses/:addressId"
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/organisations/:partyId/addresses/:addressId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/organisations/:partyId/addresses/:addressId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/addresses/:addressId"))
.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}}/organisations/:partyId/addresses/:addressId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/organisations/:partyId/addresses/:addressId")
.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}}/organisations/:partyId/addresses/:addressId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/organisations/:partyId/addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/addresses/:addressId';
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}}/organisations/:partyId/addresses/:addressId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/addresses/:addressId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/addresses/:addressId',
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}}/organisations/:partyId/addresses/:addressId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/organisations/:partyId/addresses/:addressId');
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}}/organisations/:partyId/addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/addresses/:addressId';
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}}/organisations/:partyId/addresses/:addressId"]
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}}/organisations/:partyId/addresses/:addressId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/addresses/:addressId",
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}}/organisations/:partyId/addresses/:addressId');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/addresses/:addressId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/addresses/:addressId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/addresses/:addressId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/addresses/:addressId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/organisations/:partyId/addresses/:addressId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/addresses/:addressId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/addresses/:addressId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/addresses/:addressId")
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/organisations/:partyId/addresses/:addressId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/addresses/:addressId";
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}}/organisations/:partyId/addresses/:addressId
http GET {{baseUrl}}/organisations/:partyId/addresses/:addressId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/organisations/:partyId/addresses/:addressId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/addresses/:addressId")! 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
{
"city": "Canberra",
"country": "Australia",
"fromDate": "1979-01-13T09:05:06+10:00",
"line1": "Level 7",
"line2": "21 Genge Street",
"line3": "",
"name": "Kembery Building",
"postalCode": "2601",
"suburb": "Civic",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
PUT
Update an address (PUT)
{{baseUrl}}/organisations/:partyId/addresses/:addressId
BODY json
{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/addresses/:addressId");
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 \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/organisations/:partyId/addresses/:addressId" {:content-type :json
:form-params {:city ""
:country ""
:fromDate ""
:id ""
:line1 ""
:line2 ""
:line3 ""
:name ""
:postalCode ""
:suburb ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/addresses/:addressId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/addresses/:addressId"),
Content = new StringContent("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/addresses/:addressId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/addresses/:addressId"
payload := strings.NewReader("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/addresses/:addressId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 174
{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/organisations/:partyId/addresses/:addressId")
.setHeader("content-type", "application/json")
.setBody("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/addresses/:addressId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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 \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/addresses/:addressId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/organisations/:partyId/addresses/:addressId")
.header("content-type", "application/json")
.body("{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/organisations/:partyId/addresses/:addressId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/organisations/:partyId/addresses/:addressId',
headers: {'content-type': 'application/json'},
data: {
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/addresses/:addressId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"city":"","country":"","fromDate":"","id":"","line1":"","line2":"","line3":"","name":"","postalCode":"","suburb":"","toDate":""}'
};
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}}/organisations/:partyId/addresses/:addressId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "city": "",\n "country": "",\n "fromDate": "",\n "id": "",\n "line1": "",\n "line2": "",\n "line3": "",\n "name": "",\n "postalCode": "",\n "suburb": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/addresses/:addressId")
.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/organisations/:partyId/addresses/:addressId',
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({
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/organisations/:partyId/addresses/:addressId',
headers: {'content-type': 'application/json'},
body: {
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
},
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}}/organisations/:partyId/addresses/:addressId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
});
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}}/organisations/:partyId/addresses/:addressId',
headers: {'content-type': 'application/json'},
data: {
city: '',
country: '',
fromDate: '',
id: '',
line1: '',
line2: '',
line3: '',
name: '',
postalCode: '',
suburb: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/addresses/:addressId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"city":"","country":"","fromDate":"","id":"","line1":"","line2":"","line3":"","name":"","postalCode":"","suburb":"","toDate":""}'
};
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 = @{ @"city": @"",
@"country": @"",
@"fromDate": @"",
@"id": @"",
@"line1": @"",
@"line2": @"",
@"line3": @"",
@"name": @"",
@"postalCode": @"",
@"suburb": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/organisations/:partyId/addresses/:addressId"]
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}}/organisations/:partyId/addresses/:addressId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/addresses/:addressId",
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([
'city' => '',
'country' => '',
'fromDate' => '',
'id' => '',
'line1' => '',
'line2' => '',
'line3' => '',
'name' => '',
'postalCode' => '',
'suburb' => '',
'toDate' => ''
]),
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}}/organisations/:partyId/addresses/:addressId', [
'body' => '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/addresses/:addressId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'city' => '',
'country' => '',
'fromDate' => '',
'id' => '',
'line1' => '',
'line2' => '',
'line3' => '',
'name' => '',
'postalCode' => '',
'suburb' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'city' => '',
'country' => '',
'fromDate' => '',
'id' => '',
'line1' => '',
'line2' => '',
'line3' => '',
'name' => '',
'postalCode' => '',
'suburb' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/organisations/:partyId/addresses/:addressId');
$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}}/organisations/:partyId/addresses/:addressId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/addresses/:addressId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/organisations/:partyId/addresses/:addressId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/addresses/:addressId"
payload = {
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/addresses/:addressId"
payload <- "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/addresses/:addressId")
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 \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/addresses/:addressId') do |req|
req.body = "{\n \"city\": \"\",\n \"country\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"line1\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"name\": \"\",\n \"postalCode\": \"\",\n \"suburb\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/addresses/:addressId";
let payload = json!({
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
});
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}}/organisations/:partyId/addresses/:addressId \
--header 'content-type: application/json' \
--data '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}'
echo '{
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
}' | \
http PUT {{baseUrl}}/organisations/:partyId/addresses/:addressId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "city": "",\n "country": "",\n "fromDate": "",\n "id": "",\n "line1": "",\n "line2": "",\n "line3": "",\n "name": "",\n "postalCode": "",\n "suburb": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/organisations/:partyId/addresses/:addressId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"city": "",
"country": "",
"fromDate": "",
"id": "",
"line1": "",
"line2": "",
"line3": "",
"name": "",
"postalCode": "",
"suburb": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/addresses/:addressId")! 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
{
"city": "Canberra",
"country": "Australia",
"fromDate": "1979-01-13T09:05:06+10:00",
"line1": "Level 7",
"line2": "21 Genge Street",
"line3": "",
"name": "Kembery Building",
"postalCode": "2601",
"suburb": "Civic",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
POST
Create a business name (POST)
{{baseUrl}}/organisations/:partyId/business-names
BODY json
{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/business-names");
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/organisations/:partyId/business-names" {:content-type :json
:form-params {:fromDate ""
:id ""
:lifecycleState ""
:name ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/business-names"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/business-names"),
Content = new StringContent("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/business-names");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/business-names"
payload := strings.NewReader("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/business-names HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 86
{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/organisations/:partyId/business-names")
.setHeader("content-type", "application/json")
.setBody("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/business-names"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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 \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/business-names")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/organisations/:partyId/business-names")
.header("content-type", "application/json")
.body("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
fromDate: '',
id: '',
lifecycleState: '',
name: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/organisations/:partyId/business-names');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/organisations/:partyId/business-names',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/business-names';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","lifecycleState":"","name":"","toDate":""}'
};
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}}/organisations/:partyId/business-names',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fromDate": "",\n "id": "",\n "lifecycleState": "",\n "name": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/business-names")
.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/organisations/:partyId/business-names',
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({fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/organisations/:partyId/business-names',
headers: {'content-type': 'application/json'},
body: {fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''},
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}}/organisations/:partyId/business-names');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fromDate: '',
id: '',
lifecycleState: '',
name: '',
toDate: ''
});
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}}/organisations/:partyId/business-names',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/business-names';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","lifecycleState":"","name":"","toDate":""}'
};
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 = @{ @"fromDate": @"",
@"id": @"",
@"lifecycleState": @"",
@"name": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/organisations/:partyId/business-names"]
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}}/organisations/:partyId/business-names" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/business-names",
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([
'fromDate' => '',
'id' => '',
'lifecycleState' => '',
'name' => '',
'toDate' => ''
]),
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}}/organisations/:partyId/business-names', [
'body' => '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/business-names');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fromDate' => '',
'id' => '',
'lifecycleState' => '',
'name' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'fromDate' => '',
'id' => '',
'lifecycleState' => '',
'name' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/organisations/:partyId/business-names');
$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}}/organisations/:partyId/business-names' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/business-names' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/organisations/:partyId/business-names", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/business-names"
payload = {
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/business-names"
payload <- "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/business-names")
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/business-names') do |req|
req.body = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/business-names";
let payload = json!({
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
});
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}}/organisations/:partyId/business-names \
--header 'content-type: application/json' \
--data '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}'
echo '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}' | \
http POST {{baseUrl}}/organisations/:partyId/business-names \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "fromDate": "",\n "id": "",\n "lifecycleState": "",\n "name": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/organisations/:partyId/business-names
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/business-names")! 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
{
"fromDate": "1979-01-13T09:05:06+10:00",
"name": "XYZ Technology Ventures",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
DELETE
Delete a business name (DELETE)
{{baseUrl}}/organisations/:partyId/business-names/:productId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/business-names/:productId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/organisations/:partyId/business-names/:productId")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/business-names/:productId"
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}}/organisations/:partyId/business-names/:productId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/business-names/:productId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/business-names/:productId"
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/organisations/:partyId/business-names/:productId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/organisations/:partyId/business-names/:productId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/business-names/:productId"))
.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}}/organisations/:partyId/business-names/:productId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/organisations/:partyId/business-names/:productId")
.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}}/organisations/:partyId/business-names/:productId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/organisations/:partyId/business-names/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/business-names/:productId';
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}}/organisations/:partyId/business-names/:productId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/business-names/:productId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/business-names/:productId',
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}}/organisations/:partyId/business-names/:productId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/organisations/:partyId/business-names/:productId');
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}}/organisations/:partyId/business-names/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/business-names/:productId';
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}}/organisations/:partyId/business-names/:productId"]
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}}/organisations/:partyId/business-names/:productId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/business-names/:productId",
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}}/organisations/:partyId/business-names/:productId');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/business-names/:productId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/business-names/:productId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/business-names/:productId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/business-names/:productId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/organisations/:partyId/business-names/:productId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/business-names/:productId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/business-names/:productId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/business-names/:productId")
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/organisations/:partyId/business-names/:productId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/business-names/:productId";
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}}/organisations/:partyId/business-names/:productId
http DELETE {{baseUrl}}/organisations/:partyId/business-names/:productId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/organisations/:partyId/business-names/:productId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/business-names/:productId")! 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": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a business name (GET)
{{baseUrl}}/organisations/:partyId/business-names/:productId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/business-names/:productId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/organisations/:partyId/business-names/:productId")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/business-names/:productId"
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}}/organisations/:partyId/business-names/:productId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/business-names/:productId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/business-names/:productId"
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/organisations/:partyId/business-names/:productId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/organisations/:partyId/business-names/:productId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/business-names/:productId"))
.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}}/organisations/:partyId/business-names/:productId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/organisations/:partyId/business-names/:productId")
.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}}/organisations/:partyId/business-names/:productId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/organisations/:partyId/business-names/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/business-names/:productId';
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}}/organisations/:partyId/business-names/:productId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/business-names/:productId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/business-names/:productId',
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}}/organisations/:partyId/business-names/:productId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/organisations/:partyId/business-names/:productId');
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}}/organisations/:partyId/business-names/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/business-names/:productId';
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}}/organisations/:partyId/business-names/:productId"]
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}}/organisations/:partyId/business-names/:productId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/business-names/:productId",
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}}/organisations/:partyId/business-names/:productId');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/business-names/:productId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/business-names/:productId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/business-names/:productId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/business-names/:productId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/organisations/:partyId/business-names/:productId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/business-names/:productId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/business-names/:productId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/business-names/:productId")
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/organisations/:partyId/business-names/:productId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/business-names/:productId";
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}}/organisations/:partyId/business-names/:productId
http GET {{baseUrl}}/organisations/:partyId/business-names/:productId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/organisations/:partyId/business-names/:productId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/business-names/:productId")! 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
{
"fromDate": "1979-01-13T09:05:06+10:00",
"name": "XYZ Technology Ventures",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of business names (1)
{{baseUrl}}/organisations/:partyId/business-names
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/business-names");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/organisations/:partyId/business-names")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/business-names"
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}}/organisations/:partyId/business-names"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/business-names");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/business-names"
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/organisations/:partyId/business-names HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/organisations/:partyId/business-names")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/business-names"))
.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}}/organisations/:partyId/business-names")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/organisations/:partyId/business-names")
.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}}/organisations/:partyId/business-names');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/organisations/:partyId/business-names'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/business-names';
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}}/organisations/:partyId/business-names',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/business-names")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/business-names',
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}}/organisations/:partyId/business-names'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/organisations/:partyId/business-names');
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}}/organisations/:partyId/business-names'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/business-names';
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}}/organisations/:partyId/business-names"]
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}}/organisations/:partyId/business-names" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/business-names",
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}}/organisations/:partyId/business-names');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/business-names');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/business-names');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/business-names' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/business-names' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/organisations/:partyId/business-names")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/business-names"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/business-names"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/business-names")
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/organisations/:partyId/business-names') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/business-names";
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}}/organisations/:partyId/business-names
http GET {{baseUrl}}/organisations/:partyId/business-names
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/organisations/:partyId/business-names
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/business-names")! 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
[
{
"fromDate": "1979-01-13T09:05:06+10:00",
"name": "XYZ Technology Ventures",
"toDate": ""
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
PUT
Update a business name (PUT)
{{baseUrl}}/organisations/:partyId/business-names/:productId
BODY json
{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/business-names/:productId");
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/organisations/:partyId/business-names/:productId" {:content-type :json
:form-params {:fromDate ""
:id ""
:lifecycleState ""
:name ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/business-names/:productId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/business-names/:productId"),
Content = new StringContent("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/business-names/:productId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/business-names/:productId"
payload := strings.NewReader("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/business-names/:productId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 86
{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/organisations/:partyId/business-names/:productId")
.setHeader("content-type", "application/json")
.setBody("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/business-names/:productId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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 \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/business-names/:productId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/organisations/:partyId/business-names/:productId")
.header("content-type", "application/json")
.body("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
fromDate: '',
id: '',
lifecycleState: '',
name: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/organisations/:partyId/business-names/:productId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/organisations/:partyId/business-names/:productId',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/business-names/:productId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","lifecycleState":"","name":"","toDate":""}'
};
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}}/organisations/:partyId/business-names/:productId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fromDate": "",\n "id": "",\n "lifecycleState": "",\n "name": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/business-names/:productId")
.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/organisations/:partyId/business-names/:productId',
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({fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/organisations/:partyId/business-names/:productId',
headers: {'content-type': 'application/json'},
body: {fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''},
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}}/organisations/:partyId/business-names/:productId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fromDate: '',
id: '',
lifecycleState: '',
name: '',
toDate: ''
});
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}}/organisations/:partyId/business-names/:productId',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', lifecycleState: '', name: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/business-names/:productId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","lifecycleState":"","name":"","toDate":""}'
};
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 = @{ @"fromDate": @"",
@"id": @"",
@"lifecycleState": @"",
@"name": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/organisations/:partyId/business-names/:productId"]
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}}/organisations/:partyId/business-names/:productId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/business-names/:productId",
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([
'fromDate' => '',
'id' => '',
'lifecycleState' => '',
'name' => '',
'toDate' => ''
]),
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}}/organisations/:partyId/business-names/:productId', [
'body' => '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/business-names/:productId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fromDate' => '',
'id' => '',
'lifecycleState' => '',
'name' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'fromDate' => '',
'id' => '',
'lifecycleState' => '',
'name' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/organisations/:partyId/business-names/:productId');
$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}}/organisations/:partyId/business-names/:productId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/business-names/:productId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/organisations/:partyId/business-names/:productId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/business-names/:productId"
payload = {
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/business-names/:productId"
payload <- "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/business-names/:productId")
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/business-names/:productId') do |req|
req.body = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"lifecycleState\": \"\",\n \"name\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/business-names/:productId";
let payload = json!({
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
});
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}}/organisations/:partyId/business-names/:productId \
--header 'content-type: application/json' \
--data '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}'
echo '{
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
}' | \
http PUT {{baseUrl}}/organisations/:partyId/business-names/:productId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "fromDate": "",\n "id": "",\n "lifecycleState": "",\n "name": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/organisations/:partyId/business-names/:productId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fromDate": "",
"id": "",
"lifecycleState": "",
"name": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/business-names/:productId")! 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
{
"fromDate": "1979-01-13T09:05:06+10:00",
"name": "XYZ Technology Ventures",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
POST
Create an electronic address (POST)
{{baseUrl}}/organisations/:partyId/electronic-addresses
BODY json
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/electronic-addresses");
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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/organisations/:partyId/electronic-addresses" {:content-type :json
:form-params {:areaCode ""
:countryPrefix ""
:electronicAddressType ""
:email ""
:extension ""
:fromDate ""
:id ""
:number ""
:toDate ""
:url ""}})
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/electronic-addresses"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/organisations/:partyId/electronic-addresses"),
Content = new StringContent("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/organisations/:partyId/electronic-addresses");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/electronic-addresses"
payload := strings.NewReader("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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/organisations/:partyId/electronic-addresses HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 183
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/organisations/:partyId/electronic-addresses")
.setHeader("content-type", "application/json")
.setBody("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/electronic-addresses"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/electronic-addresses")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/organisations/:partyId/electronic-addresses")
.header("content-type", "application/json")
.body("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}")
.asString();
const data = JSON.stringify({
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
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}}/organisations/:partyId/electronic-addresses');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/organisations/:partyId/electronic-addresses',
headers: {'content-type': 'application/json'},
data: {
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/electronic-addresses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","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}}/organisations/:partyId/electronic-addresses',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/electronic-addresses")
.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/organisations/:partyId/electronic-addresses',
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({
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/organisations/:partyId/electronic-addresses',
headers: {'content-type': 'application/json'},
body: {
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
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}}/organisations/:partyId/electronic-addresses');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
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}}/organisations/:partyId/electronic-addresses',
headers: {'content-type': 'application/json'},
data: {
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/electronic-addresses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","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 = @{ @"areaCode": @"",
@"countryPrefix": @"",
@"electronicAddressType": @"",
@"email": @"",
@"extension": @"",
@"fromDate": @"",
@"id": @"",
@"number": @"",
@"toDate": @"",
@"url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/organisations/:partyId/electronic-addresses"]
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}}/organisations/:partyId/electronic-addresses" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/electronic-addresses",
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([
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'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}}/organisations/:partyId/electronic-addresses', [
'body' => '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/electronic-addresses');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/organisations/:partyId/electronic-addresses');
$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}}/organisations/:partyId/electronic-addresses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/electronic-addresses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/organisations/:partyId/electronic-addresses", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/electronic-addresses"
payload = {
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/electronic-addresses"
payload <- "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/organisations/:partyId/electronic-addresses")
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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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/organisations/:partyId/electronic-addresses') do |req|
req.body = "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/organisations/:partyId/electronic-addresses";
let payload = json!({
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"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}}/organisations/:partyId/electronic-addresses \
--header 'content-type: application/json' \
--data '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}'
echo '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}' | \
http POST {{baseUrl}}/organisations/:partyId/electronic-addresses \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\n "url": ""\n}' \
--output-document \
- {{baseUrl}}/organisations/:partyId/electronic-addresses
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/electronic-addresses")! 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
{
"areaCode": "02",
"countryPrefix": "61",
"email": "",
"extension": "",
"fromDate": "1979-01-13T09:05:06+10:00",
"number": "62164453",
"toDate": "",
"url": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
DELETE
Delete an electronic address (DELETE)
{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"
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}}/organisations/:partyId/electronic-addresses/:addressId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"
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/organisations/:partyId/electronic-addresses/:addressId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"))
.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}}/organisations/:partyId/electronic-addresses/:addressId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")
.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}}/organisations/:partyId/electronic-addresses/:addressId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId';
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}}/organisations/:partyId/electronic-addresses/:addressId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/electronic-addresses/:addressId',
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}}/organisations/:partyId/electronic-addresses/:addressId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId');
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}}/organisations/:partyId/electronic-addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId';
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}}/organisations/:partyId/electronic-addresses/:addressId"]
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}}/organisations/:partyId/electronic-addresses/:addressId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId",
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}}/organisations/:partyId/electronic-addresses/:addressId');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/organisations/:partyId/electronic-addresses/:addressId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")
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/organisations/:partyId/electronic-addresses/:addressId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId";
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}}/organisations/:partyId/electronic-addresses/:addressId
http DELETE {{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")! 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": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of electronic addresses (GET)
{{baseUrl}}/organisations/:partyId/electronic-addresses
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/electronic-addresses");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/organisations/:partyId/electronic-addresses")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/electronic-addresses"
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}}/organisations/:partyId/electronic-addresses"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/electronic-addresses");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/electronic-addresses"
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/organisations/:partyId/electronic-addresses HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/organisations/:partyId/electronic-addresses")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/electronic-addresses"))
.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}}/organisations/:partyId/electronic-addresses")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/organisations/:partyId/electronic-addresses")
.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}}/organisations/:partyId/electronic-addresses');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/organisations/:partyId/electronic-addresses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/electronic-addresses';
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}}/organisations/:partyId/electronic-addresses',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/electronic-addresses")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/electronic-addresses',
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}}/organisations/:partyId/electronic-addresses'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/organisations/:partyId/electronic-addresses');
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}}/organisations/:partyId/electronic-addresses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/electronic-addresses';
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}}/organisations/:partyId/electronic-addresses"]
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}}/organisations/:partyId/electronic-addresses" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/electronic-addresses",
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}}/organisations/:partyId/electronic-addresses');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/electronic-addresses');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/electronic-addresses');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/electronic-addresses' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/electronic-addresses' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/organisations/:partyId/electronic-addresses")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/electronic-addresses"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/electronic-addresses"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/electronic-addresses")
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/organisations/:partyId/electronic-addresses') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/electronic-addresses";
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}}/organisations/:partyId/electronic-addresses
http GET {{baseUrl}}/organisations/:partyId/electronic-addresses
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/organisations/:partyId/electronic-addresses
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/electronic-addresses")! 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
[
{
"areaCode": "02",
"countryPrefix": "61",
"email": "",
"extension": "",
"fromDate": "1979-01-13T09:05:06+10:00",
"number": "62164453",
"toDate": "",
"url": ""
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve an electronic address (GET)
{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"
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}}/organisations/:partyId/electronic-addresses/:addressId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"
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/organisations/:partyId/electronic-addresses/:addressId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"))
.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}}/organisations/:partyId/electronic-addresses/:addressId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")
.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}}/organisations/:partyId/electronic-addresses/:addressId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId';
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}}/organisations/:partyId/electronic-addresses/:addressId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/electronic-addresses/:addressId',
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}}/organisations/:partyId/electronic-addresses/:addressId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId');
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}}/organisations/:partyId/electronic-addresses/:addressId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId';
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}}/organisations/:partyId/electronic-addresses/:addressId"]
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}}/organisations/:partyId/electronic-addresses/:addressId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId",
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}}/organisations/:partyId/electronic-addresses/:addressId');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/organisations/:partyId/electronic-addresses/:addressId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")
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/organisations/:partyId/electronic-addresses/:addressId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId";
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}}/organisations/:partyId/electronic-addresses/:addressId
http GET {{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")! 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
{
"areaCode": "02",
"countryPrefix": "61",
"email": "",
"extension": "",
"fromDate": "1979-01-13T09:05:06+10:00",
"number": "62164453",
"toDate": "",
"url": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
PUT
Update an electronic address (PUT)
{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId
BODY json
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId");
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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId" {:content-type :json
:form-params {:areaCode ""
:countryPrefix ""
:electronicAddressType ""
:email ""
:extension ""
:fromDate ""
:id ""
:number ""
:toDate ""
:url ""}})
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/organisations/:partyId/electronic-addresses/:addressId"),
Content = new StringContent("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/organisations/:partyId/electronic-addresses/:addressId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"
payload := strings.NewReader("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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/organisations/:partyId/electronic-addresses/:addressId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 183
{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")
.setHeader("content-type", "application/json")
.setBody("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")
.header("content-type", "application/json")
.body("{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}")
.asString();
const data = JSON.stringify({
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
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}}/organisations/:partyId/electronic-addresses/:addressId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId',
headers: {'content-type': 'application/json'},
data: {
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","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}}/organisations/:partyId/electronic-addresses/:addressId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")
.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/organisations/:partyId/electronic-addresses/:addressId',
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({
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId',
headers: {'content-type': 'application/json'},
body: {
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
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}}/organisations/:partyId/electronic-addresses/:addressId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
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}}/organisations/:partyId/electronic-addresses/:addressId',
headers: {'content-type': 'application/json'},
data: {
areaCode: '',
countryPrefix: '',
electronicAddressType: '',
email: '',
extension: '',
fromDate: '',
id: '',
number: '',
toDate: '',
url: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"areaCode":"","countryPrefix":"","electronicAddressType":"","email":"","extension":"","fromDate":"","id":"","number":"","toDate":"","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 = @{ @"areaCode": @"",
@"countryPrefix": @"",
@"electronicAddressType": @"",
@"email": @"",
@"extension": @"",
@"fromDate": @"",
@"id": @"",
@"number": @"",
@"toDate": @"",
@"url": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"]
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}}/organisations/:partyId/electronic-addresses/:addressId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId",
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([
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'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}}/organisations/:partyId/electronic-addresses/:addressId', [
'body' => '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'areaCode' => '',
'countryPrefix' => '',
'electronicAddressType' => '',
'email' => '',
'extension' => '',
'fromDate' => '',
'id' => '',
'number' => '',
'toDate' => '',
'url' => ''
]));
$request->setRequestUrl('{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId');
$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}}/organisations/:partyId/electronic-addresses/:addressId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\n \"url\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/organisations/:partyId/electronic-addresses/:addressId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"
payload = {
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId"
payload <- "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/organisations/:partyId/electronic-addresses/:addressId")
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 \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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/organisations/:partyId/electronic-addresses/:addressId') do |req|
req.body = "{\n \"areaCode\": \"\",\n \"countryPrefix\": \"\",\n \"electronicAddressType\": \"\",\n \"email\": \"\",\n \"extension\": \"\",\n \"fromDate\": \"\",\n \"id\": \"\",\n \"number\": \"\",\n \"toDate\": \"\",\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}}/organisations/:partyId/electronic-addresses/:addressId";
let payload = json!({
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"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}}/organisations/:partyId/electronic-addresses/:addressId \
--header 'content-type: application/json' \
--data '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}'
echo '{
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
}' | \
http PUT {{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "areaCode": "",\n "countryPrefix": "",\n "electronicAddressType": "",\n "email": "",\n "extension": "",\n "fromDate": "",\n "id": "",\n "number": "",\n "toDate": "",\n "url": ""\n}' \
--output-document \
- {{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"areaCode": "",
"countryPrefix": "",
"electronicAddressType": "",
"email": "",
"extension": "",
"fromDate": "",
"id": "",
"number": "",
"toDate": "",
"url": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/electronic-addresses/:addressId")! 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
{
"areaCode": "02",
"countryPrefix": "61",
"email": "",
"extension": "",
"fromDate": "1979-01-13T09:05:06+10:00",
"number": "62164453",
"toDate": "",
"url": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
POST
Create a license (POST)
{{baseUrl}}/organisations/:partyId/licenses
BODY json
{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/licenses");
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/organisations/:partyId/licenses" {:content-type :json
:form-params {:fromDate ""
:id ""
:licenseType ""
:lifecycleState ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/licenses"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/licenses"),
Content = new StringContent("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/licenses");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/licenses"
payload := strings.NewReader("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/licenses HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 93
{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/organisations/:partyId/licenses")
.setHeader("content-type", "application/json")
.setBody("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/licenses"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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 \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/licenses")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/organisations/:partyId/licenses")
.header("content-type", "application/json")
.body("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
fromDate: '',
id: '',
licenseType: '',
lifecycleState: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/organisations/:partyId/licenses');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/organisations/:partyId/licenses',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/licenses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","licenseType":"","lifecycleState":"","toDate":""}'
};
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}}/organisations/:partyId/licenses',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fromDate": "",\n "id": "",\n "licenseType": "",\n "lifecycleState": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/licenses")
.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/organisations/:partyId/licenses',
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({fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/organisations/:partyId/licenses',
headers: {'content-type': 'application/json'},
body: {fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''},
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}}/organisations/:partyId/licenses');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fromDate: '',
id: '',
licenseType: '',
lifecycleState: '',
toDate: ''
});
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}}/organisations/:partyId/licenses',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/licenses';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","licenseType":"","lifecycleState":"","toDate":""}'
};
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 = @{ @"fromDate": @"",
@"id": @"",
@"licenseType": @"",
@"lifecycleState": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/organisations/:partyId/licenses"]
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}}/organisations/:partyId/licenses" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/licenses",
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([
'fromDate' => '',
'id' => '',
'licenseType' => '',
'lifecycleState' => '',
'toDate' => ''
]),
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}}/organisations/:partyId/licenses', [
'body' => '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/licenses');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fromDate' => '',
'id' => '',
'licenseType' => '',
'lifecycleState' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'fromDate' => '',
'id' => '',
'licenseType' => '',
'lifecycleState' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/organisations/:partyId/licenses');
$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}}/organisations/:partyId/licenses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/licenses' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/organisations/:partyId/licenses", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/licenses"
payload = {
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/licenses"
payload <- "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/licenses")
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/licenses') do |req|
req.body = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/licenses";
let payload = json!({
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
});
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}}/organisations/:partyId/licenses \
--header 'content-type: application/json' \
--data '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}'
echo '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}' | \
http POST {{baseUrl}}/organisations/:partyId/licenses \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "fromDate": "",\n "id": "",\n "licenseType": "",\n "lifecycleState": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/organisations/:partyId/licenses
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/licenses")! 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
{
"fromDate": "1979-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
DELETE
Delete a license (DELETE)
{{baseUrl}}/organisations/:partyId/licenses/:productId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/licenses/:productId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/organisations/:partyId/licenses/:productId")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/licenses/:productId"
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}}/organisations/:partyId/licenses/:productId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/licenses/:productId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/licenses/:productId"
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/organisations/:partyId/licenses/:productId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/organisations/:partyId/licenses/:productId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/licenses/:productId"))
.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}}/organisations/:partyId/licenses/:productId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/organisations/:partyId/licenses/:productId")
.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}}/organisations/:partyId/licenses/:productId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/organisations/:partyId/licenses/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/licenses/:productId';
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}}/organisations/:partyId/licenses/:productId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/licenses/:productId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/licenses/:productId',
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}}/organisations/:partyId/licenses/:productId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/organisations/:partyId/licenses/:productId');
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}}/organisations/:partyId/licenses/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/licenses/:productId';
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}}/organisations/:partyId/licenses/:productId"]
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}}/organisations/:partyId/licenses/:productId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/licenses/:productId",
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}}/organisations/:partyId/licenses/:productId');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/licenses/:productId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/licenses/:productId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/licenses/:productId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/licenses/:productId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/organisations/:partyId/licenses/:productId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/licenses/:productId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/licenses/:productId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/licenses/:productId")
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/organisations/:partyId/licenses/:productId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/licenses/:productId";
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}}/organisations/:partyId/licenses/:productId
http DELETE {{baseUrl}}/organisations/:partyId/licenses/:productId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/organisations/:partyId/licenses/:productId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/licenses/:productId")! 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": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a license (GET)
{{baseUrl}}/organisations/:partyId/licenses/:productId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/licenses/:productId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/organisations/:partyId/licenses/:productId")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/licenses/:productId"
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}}/organisations/:partyId/licenses/:productId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/licenses/:productId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/licenses/:productId"
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/organisations/:partyId/licenses/:productId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/organisations/:partyId/licenses/:productId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/licenses/:productId"))
.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}}/organisations/:partyId/licenses/:productId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/organisations/:partyId/licenses/:productId")
.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}}/organisations/:partyId/licenses/:productId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/organisations/:partyId/licenses/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/licenses/:productId';
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}}/organisations/:partyId/licenses/:productId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/licenses/:productId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/licenses/:productId',
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}}/organisations/:partyId/licenses/:productId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/organisations/:partyId/licenses/:productId');
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}}/organisations/:partyId/licenses/:productId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/licenses/:productId';
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}}/organisations/:partyId/licenses/:productId"]
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}}/organisations/:partyId/licenses/:productId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/licenses/:productId",
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}}/organisations/:partyId/licenses/:productId');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/licenses/:productId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/licenses/:productId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/licenses/:productId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/licenses/:productId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/organisations/:partyId/licenses/:productId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/licenses/:productId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/licenses/:productId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/licenses/:productId")
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/organisations/:partyId/licenses/:productId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/licenses/:productId";
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}}/organisations/:partyId/licenses/:productId
http GET {{baseUrl}}/organisations/:partyId/licenses/:productId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/organisations/:partyId/licenses/:productId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/licenses/:productId")! 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
{
"fromDate": "1979-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of licenses (1)
{{baseUrl}}/organisations/:partyId/licenses
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/licenses");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/organisations/:partyId/licenses")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/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}}/organisations/:partyId/licenses"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/licenses");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/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/organisations/:partyId/licenses HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/organisations/:partyId/licenses")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/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}}/organisations/:partyId/licenses")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/organisations/:partyId/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}}/organisations/:partyId/licenses');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/organisations/:partyId/licenses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/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}}/organisations/:partyId/licenses',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/licenses")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/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}}/organisations/:partyId/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}}/organisations/:partyId/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}}/organisations/:partyId/licenses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/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}}/organisations/:partyId/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}}/organisations/:partyId/licenses" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/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}}/organisations/:partyId/licenses');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/licenses');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/licenses');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/licenses' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/licenses' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/organisations/:partyId/licenses")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/licenses"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/licenses"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/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/organisations/:partyId/licenses') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/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}}/organisations/:partyId/licenses
http GET {{baseUrl}}/organisations/:partyId/licenses
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/organisations/:partyId/licenses
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/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
[
{
"fromDate": "1979-01-13T09:05:06+10:00",
"toDate": ""
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
PUT
Update a license (PUT)
{{baseUrl}}/organisations/:partyId/licenses/:productId
BODY json
{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/licenses/:productId");
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/organisations/:partyId/licenses/:productId" {:content-type :json
:form-params {:fromDate ""
:id ""
:licenseType ""
:lifecycleState ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/licenses/:productId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/licenses/:productId"),
Content = new StringContent("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/licenses/:productId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/licenses/:productId"
payload := strings.NewReader("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/licenses/:productId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 93
{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/organisations/:partyId/licenses/:productId")
.setHeader("content-type", "application/json")
.setBody("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/licenses/:productId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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 \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/licenses/:productId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/organisations/:partyId/licenses/:productId")
.header("content-type", "application/json")
.body("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
fromDate: '',
id: '',
licenseType: '',
lifecycleState: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/organisations/:partyId/licenses/:productId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/organisations/:partyId/licenses/:productId',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/licenses/:productId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","licenseType":"","lifecycleState":"","toDate":""}'
};
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}}/organisations/:partyId/licenses/:productId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fromDate": "",\n "id": "",\n "licenseType": "",\n "lifecycleState": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/licenses/:productId")
.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/organisations/:partyId/licenses/:productId',
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({fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/organisations/:partyId/licenses/:productId',
headers: {'content-type': 'application/json'},
body: {fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''},
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}}/organisations/:partyId/licenses/:productId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fromDate: '',
id: '',
licenseType: '',
lifecycleState: '',
toDate: ''
});
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}}/organisations/:partyId/licenses/:productId',
headers: {'content-type': 'application/json'},
data: {fromDate: '', id: '', licenseType: '', lifecycleState: '', toDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/licenses/:productId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","licenseType":"","lifecycleState":"","toDate":""}'
};
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 = @{ @"fromDate": @"",
@"id": @"",
@"licenseType": @"",
@"lifecycleState": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/organisations/:partyId/licenses/:productId"]
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}}/organisations/:partyId/licenses/:productId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/licenses/:productId",
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([
'fromDate' => '',
'id' => '',
'licenseType' => '',
'lifecycleState' => '',
'toDate' => ''
]),
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}}/organisations/:partyId/licenses/:productId', [
'body' => '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/licenses/:productId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fromDate' => '',
'id' => '',
'licenseType' => '',
'lifecycleState' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'fromDate' => '',
'id' => '',
'licenseType' => '',
'lifecycleState' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/organisations/:partyId/licenses/:productId');
$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}}/organisations/:partyId/licenses/:productId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/licenses/:productId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/organisations/:partyId/licenses/:productId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/licenses/:productId"
payload = {
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/licenses/:productId"
payload <- "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/licenses/:productId")
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/licenses/:productId') do |req|
req.body = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"licenseType\": \"\",\n \"lifecycleState\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/licenses/:productId";
let payload = json!({
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
});
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}}/organisations/:partyId/licenses/:productId \
--header 'content-type: application/json' \
--data '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}'
echo '{
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
}' | \
http PUT {{baseUrl}}/organisations/:partyId/licenses/:productId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "fromDate": "",\n "id": "",\n "licenseType": "",\n "lifecycleState": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/organisations/:partyId/licenses/:productId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fromDate": "",
"id": "",
"licenseType": "",
"lifecycleState": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/licenses/:productId")! 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
{
"fromDate": "1979-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
POST
Create a role (POST)
{{baseUrl}}/organisations/:partyId/roles
BODY json
{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/roles");
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/organisations/:partyId/roles" {:content-type :json
:form-params {:fromDate ""
:id ""
:partyRoleType ""
:relatedPartyId ""
:relatedPartyRoleType ""
:relationshipType ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/roles"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/roles"),
Content = new StringContent("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/roles");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/roles"
payload := strings.NewReader("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/roles HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 151
{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/organisations/:partyId/roles")
.setHeader("content-type", "application/json")
.setBody("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/roles"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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 \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/roles")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.post("{{baseUrl}}/organisations/:partyId/roles")
.header("content-type", "application/json")
.body("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/organisations/:partyId/roles');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/organisations/:partyId/roles',
headers: {'content-type': 'application/json'},
data: {
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/roles';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","partyRoleType":"","relatedPartyId":"","relatedPartyRoleType":"","relationshipType":"","toDate":""}'
};
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}}/organisations/:partyId/roles',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fromDate": "",\n "id": "",\n "partyRoleType": "",\n "relatedPartyId": "",\n "relatedPartyRoleType": "",\n "relationshipType": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/roles")
.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/organisations/:partyId/roles',
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({
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
}));
req.end();
const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/organisations/:partyId/roles',
headers: {'content-type': 'application/json'},
body: {
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
},
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}}/organisations/:partyId/roles');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
});
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}}/organisations/:partyId/roles',
headers: {'content-type': 'application/json'},
data: {
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/roles';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","partyRoleType":"","relatedPartyId":"","relatedPartyRoleType":"","relationshipType":"","toDate":""}'
};
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 = @{ @"fromDate": @"",
@"id": @"",
@"partyRoleType": @"",
@"relatedPartyId": @"",
@"relatedPartyRoleType": @"",
@"relationshipType": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/organisations/:partyId/roles"]
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}}/organisations/:partyId/roles" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/roles",
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([
'fromDate' => '',
'id' => '',
'partyRoleType' => '',
'relatedPartyId' => '',
'relatedPartyRoleType' => '',
'relationshipType' => '',
'toDate' => ''
]),
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}}/organisations/:partyId/roles', [
'body' => '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/roles');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fromDate' => '',
'id' => '',
'partyRoleType' => '',
'relatedPartyId' => '',
'relatedPartyRoleType' => '',
'relationshipType' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'fromDate' => '',
'id' => '',
'partyRoleType' => '',
'relatedPartyId' => '',
'relatedPartyRoleType' => '',
'relationshipType' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/organisations/:partyId/roles');
$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}}/organisations/:partyId/roles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/roles' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/organisations/:partyId/roles", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/roles"
payload = {
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/roles"
payload <- "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/roles")
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/roles') do |req|
req.body = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}"
end
puts response.status
puts response.body
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/roles";
let payload = json!({
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
});
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}}/organisations/:partyId/roles \
--header 'content-type: application/json' \
--data '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}'
echo '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}' | \
http POST {{baseUrl}}/organisations/:partyId/roles \
content-type:application/json
wget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "fromDate": "",\n "id": "",\n "partyRoleType": "",\n "relatedPartyId": "",\n "relatedPartyRoleType": "",\n "relationshipType": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/organisations/:partyId/roles
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/roles")! 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
{
"fromDate": "2016-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
DELETE
Delete a role (DELETE)
{{baseUrl}}/organisations/:partyId/roles/:roleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/roles/:roleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/organisations/:partyId/roles/:roleId")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/roles/:roleId"
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}}/organisations/:partyId/roles/:roleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/roles/:roleId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/roles/:roleId"
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/organisations/:partyId/roles/:roleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/organisations/:partyId/roles/:roleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/roles/:roleId"))
.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}}/organisations/:partyId/roles/:roleId")
.delete(null)
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.delete("{{baseUrl}}/organisations/:partyId/roles/:roleId")
.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}}/organisations/:partyId/roles/:roleId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/organisations/:partyId/roles/:roleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/roles/:roleId';
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}}/organisations/:partyId/roles/:roleId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/roles/:roleId")
.delete(null)
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/roles/:roleId',
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}}/organisations/:partyId/roles/:roleId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/organisations/:partyId/roles/:roleId');
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}}/organisations/:partyId/roles/:roleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/roles/:roleId';
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}}/organisations/:partyId/roles/:roleId"]
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}}/organisations/:partyId/roles/:roleId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/roles/:roleId",
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}}/organisations/:partyId/roles/:roleId');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/roles/:roleId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/roles/:roleId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/roles/:roleId' -Method DELETE
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/roles/:roleId' -Method DELETE
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/organisations/:partyId/roles/:roleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/roles/:roleId"
response = requests.delete(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/roles/:roleId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/roles/:roleId")
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/organisations/:partyId/roles/:roleId') do |req|
end
puts response.status
puts response.body
use std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/roles/:roleId";
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}}/organisations/:partyId/roles/:roleId
http DELETE {{baseUrl}}/organisations/:partyId/roles/:roleId
wget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/organisations/:partyId/roles/:roleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/roles/:roleId")! 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": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of roles (1)
{{baseUrl}}/organisations/:partyId/roles
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/roles");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/organisations/:partyId/roles")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/roles"
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}}/organisations/:partyId/roles"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/roles");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/roles"
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/organisations/:partyId/roles HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/organisations/:partyId/roles")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/roles"))
.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}}/organisations/:partyId/roles")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/organisations/:partyId/roles")
.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}}/organisations/:partyId/roles');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/organisations/:partyId/roles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/roles';
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}}/organisations/:partyId/roles',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/roles")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/roles',
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}}/organisations/:partyId/roles'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/organisations/:partyId/roles');
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}}/organisations/:partyId/roles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/roles';
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}}/organisations/:partyId/roles"]
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}}/organisations/:partyId/roles" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/roles",
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}}/organisations/:partyId/roles');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/roles');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/roles');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/roles' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/roles' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/organisations/:partyId/roles")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/roles"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/roles"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/roles")
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/organisations/:partyId/roles') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/roles";
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}}/organisations/:partyId/roles
http GET {{baseUrl}}/organisations/:partyId/roles
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/organisations/:partyId/roles
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/roles")! 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
[
{
"fromDate": "2016-01-13T09:05:06+10:00",
"toDate": ""
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a role (GET)
{{baseUrl}}/organisations/:partyId/roles/:roleId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/roles/:roleId");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/organisations/:partyId/roles/:roleId")
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/roles/:roleId"
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}}/organisations/:partyId/roles/:roleId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/organisations/:partyId/roles/:roleId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/roles/:roleId"
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/organisations/:partyId/roles/:roleId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/organisations/:partyId/roles/:roleId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/roles/:roleId"))
.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}}/organisations/:partyId/roles/:roleId")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/organisations/:partyId/roles/:roleId")
.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}}/organisations/:partyId/roles/:roleId');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/organisations/:partyId/roles/:roleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/roles/:roleId';
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}}/organisations/:partyId/roles/:roleId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/roles/:roleId")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/organisations/:partyId/roles/:roleId',
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}}/organisations/:partyId/roles/:roleId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/organisations/:partyId/roles/:roleId');
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}}/organisations/:partyId/roles/:roleId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/roles/:roleId';
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}}/organisations/:partyId/roles/:roleId"]
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}}/organisations/:partyId/roles/:roleId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/roles/:roleId",
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}}/organisations/:partyId/roles/:roleId');
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/roles/:roleId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/organisations/:partyId/roles/:roleId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/organisations/:partyId/roles/:roleId' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/roles/:roleId' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/organisations/:partyId/roles/:roleId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/roles/:roleId"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/roles/:roleId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/organisations/:partyId/roles/:roleId")
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/organisations/:partyId/roles/:roleId') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/organisations/:partyId/roles/:roleId";
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}}/organisations/:partyId/roles/:roleId
http GET {{baseUrl}}/organisations/:partyId/roles/:roleId
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/organisations/:partyId/roles/:roleId
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/roles/:roleId")! 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
{
"fromDate": "2016-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
PUT
Update a role (PUT)
{{baseUrl}}/organisations/:partyId/roles/:roleId
BODY json
{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/organisations/:partyId/roles/:roleId");
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/organisations/:partyId/roles/:roleId" {:content-type :json
:form-params {:fromDate ""
:id ""
:partyRoleType ""
:relatedPartyId ""
:relatedPartyRoleType ""
:relationshipType ""
:toDate ""}})
require "http/client"
url = "{{baseUrl}}/organisations/:partyId/roles/:roleId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/roles/:roleId"),
Content = new StringContent("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/roles/:roleId");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/organisations/:partyId/roles/:roleId"
payload := strings.NewReader("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/roles/:roleId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 151
{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/organisations/:partyId/roles/:roleId")
.setHeader("content-type", "application/json")
.setBody("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/organisations/:partyId/roles/:roleId"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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 \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/roles/:roleId")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.put("{{baseUrl}}/organisations/:partyId/roles/:roleId")
.header("content-type", "application/json")
.body("{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}")
.asString();
const data = JSON.stringify({
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/organisations/:partyId/roles/:roleId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/organisations/:partyId/roles/:roleId',
headers: {'content-type': 'application/json'},
data: {
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/organisations/:partyId/roles/:roleId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","partyRoleType":"","relatedPartyId":"","relatedPartyRoleType":"","relationshipType":"","toDate":""}'
};
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}}/organisations/:partyId/roles/:roleId',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fromDate": "",\n "id": "",\n "partyRoleType": "",\n "relatedPartyId": "",\n "relatedPartyRoleType": "",\n "relationshipType": "",\n "toDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/organisations/:partyId/roles/:roleId")
.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/organisations/:partyId/roles/:roleId',
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({
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
}));
req.end();
const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/organisations/:partyId/roles/:roleId',
headers: {'content-type': 'application/json'},
body: {
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
},
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}}/organisations/:partyId/roles/:roleId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
});
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}}/organisations/:partyId/roles/:roleId',
headers: {'content-type': 'application/json'},
data: {
fromDate: '',
id: '',
partyRoleType: '',
relatedPartyId: '',
relatedPartyRoleType: '',
relationshipType: '',
toDate: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/organisations/:partyId/roles/:roleId';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"fromDate":"","id":"","partyRoleType":"","relatedPartyId":"","relatedPartyRoleType":"","relationshipType":"","toDate":""}'
};
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 = @{ @"fromDate": @"",
@"id": @"",
@"partyRoleType": @"",
@"relatedPartyId": @"",
@"relatedPartyRoleType": @"",
@"relationshipType": @"",
@"toDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/organisations/:partyId/roles/:roleId"]
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}}/organisations/:partyId/roles/:roleId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/organisations/:partyId/roles/:roleId",
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([
'fromDate' => '',
'id' => '',
'partyRoleType' => '',
'relatedPartyId' => '',
'relatedPartyRoleType' => '',
'relationshipType' => '',
'toDate' => ''
]),
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}}/organisations/:partyId/roles/:roleId', [
'body' => '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();
setUrl('{{baseUrl}}/organisations/:partyId/roles/:roleId');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fromDate' => '',
'id' => '',
'partyRoleType' => '',
'relatedPartyId' => '',
'relatedPartyRoleType' => '',
'relationshipType' => '',
'toDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
append(json_encode([
'fromDate' => '',
'id' => '',
'partyRoleType' => '',
'relatedPartyId' => '',
'relatedPartyRoleType' => '',
'relationshipType' => '',
'toDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/organisations/:partyId/roles/:roleId');
$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}}/organisations/:partyId/roles/:roleId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}'
$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/organisations/:partyId/roles/:roleId' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}'
import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/organisations/:partyId/roles/:roleId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/organisations/:partyId/roles/:roleId"
payload = {
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())
library(httr)
url <- "{{baseUrl}}/organisations/:partyId/roles/:roleId"
payload <- "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/roles/:roleId")
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 \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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/organisations/:partyId/roles/:roleId') do |req|
req.body = "{\n \"fromDate\": \"\",\n \"id\": \"\",\n \"partyRoleType\": \"\",\n \"relatedPartyId\": \"\",\n \"relatedPartyRoleType\": \"\",\n \"relationshipType\": \"\",\n \"toDate\": \"\"\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}}/organisations/:partyId/roles/:roleId";
let payload = json!({
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
});
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}}/organisations/:partyId/roles/:roleId \
--header 'content-type: application/json' \
--data '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}'
echo '{
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
}' | \
http PUT {{baseUrl}}/organisations/:partyId/roles/:roleId \
content-type:application/json
wget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "fromDate": "",\n "id": "",\n "partyRoleType": "",\n "relatedPartyId": "",\n "relatedPartyRoleType": "",\n "relationshipType": "",\n "toDate": ""\n}' \
--output-document \
- {{baseUrl}}/organisations/:partyId/roles/:roleId
import Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fromDate": "",
"id": "",
"partyRoleType": "",
"relatedPartyId": "",
"relatedPartyRoleType": "",
"relationshipType": "",
"toDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/organisations/:partyId/roles/:roleId")! 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
{
"fromDate": "2016-01-13T09:05:06+10:00",
"toDate": ""
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "400",
"message": "The client specified an invalid argument",
"status": "INVALID_ARGUMENT"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of registered identifier types
{{baseUrl}}/classifications/registered-identifier-types
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/classifications/registered-identifier-types");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/classifications/registered-identifier-types")
require "http/client"
url = "{{baseUrl}}/classifications/registered-identifier-types"
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}}/classifications/registered-identifier-types"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/classifications/registered-identifier-types");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/classifications/registered-identifier-types"
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/classifications/registered-identifier-types HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/classifications/registered-identifier-types")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/classifications/registered-identifier-types"))
.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}}/classifications/registered-identifier-types")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/classifications/registered-identifier-types")
.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}}/classifications/registered-identifier-types');
xhr.send(data);
import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/classifications/registered-identifier-types'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/classifications/registered-identifier-types';
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}}/classifications/registered-identifier-types',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/classifications/registered-identifier-types")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/classifications/registered-identifier-types',
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}}/classifications/registered-identifier-types'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/classifications/registered-identifier-types');
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}}/classifications/registered-identifier-types'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/classifications/registered-identifier-types';
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}}/classifications/registered-identifier-types"]
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}}/classifications/registered-identifier-types" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/classifications/registered-identifier-types",
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}}/classifications/registered-identifier-types');
echo $response->getBody();
setUrl('{{baseUrl}}/classifications/registered-identifier-types');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/classifications/registered-identifier-types');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/classifications/registered-identifier-types' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/classifications/registered-identifier-types' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/classifications/registered-identifier-types")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/classifications/registered-identifier-types"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/classifications/registered-identifier-types"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/classifications/registered-identifier-types")
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/classifications/registered-identifier-types') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/classifications/registered-identifier-types";
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}}/classifications/registered-identifier-types
http GET {{baseUrl}}/classifications/registered-identifier-types
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/classifications/registered-identifier-types
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/classifications/registered-identifier-types")! 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": "An Australian Business Number (ABN) is a unique eleven-character number issued by the Australian Business Register (ABR).",
"id": "123e4567-e89b-12d3-a456-426655440001",
"name": "ABN"
},
{
"description": "An Australian Company Number (ACN) is a unique nine-character number issued by the Australian Securities and Investments Commission (ASIC).",
"id": "123e4567-e89b-12d3-a456-426655440002",
"name": "ACN"
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}
GET
Retrieve a list of roles
{{baseUrl}}/classifications/roles
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/classifications/roles");
CURLcode ret = curl_easy_perform(hnd);
(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/classifications/roles")
require "http/client"
url = "{{baseUrl}}/classifications/roles"
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}}/classifications/roles"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}
var client = new RestClient("{{baseUrl}}/classifications/roles");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/classifications/roles"
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/classifications/roles HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/classifications/roles")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/classifications/roles"))
.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}}/classifications/roles")
.get()
.build();
Response response = client.newCall(request).execute();
HttpResponse response = Unirest.get("{{baseUrl}}/classifications/roles")
.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}}/classifications/roles');
xhr.send(data);
import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/classifications/roles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const url = '{{baseUrl}}/classifications/roles';
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}}/classifications/roles',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});
val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/classifications/roles")
.get()
.build()
val response = client.newCall(request).execute()
const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/classifications/roles',
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}}/classifications/roles'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/classifications/roles');
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}}/classifications/roles'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
const fetch = require('node-fetch');
const url = '{{baseUrl}}/classifications/roles';
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}}/classifications/roles"]
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}}/classifications/roles" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *)
"{{baseUrl}}/classifications/roles",
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}}/classifications/roles');
echo $response->getBody();
setUrl('{{baseUrl}}/classifications/roles');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}
setRequestUrl('{{baseUrl}}/classifications/roles');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();
$response = Invoke-WebRequest -Uri '{{baseUrl}}/classifications/roles' -Method GET
$response = Invoke-RestMethod -Uri '{{baseUrl}}/classifications/roles' -Method GET
import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/classifications/roles")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
import requests
url = "{{baseUrl}}/classifications/roles"
response = requests.get(url)
print(response.json())
library(httr)
url <- "{{baseUrl}}/classifications/roles"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")
require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/classifications/roles")
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/classifications/roles') do |req|
end
puts response.status
puts response.body
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/classifications/roles";
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}}/classifications/roles
http GET {{baseUrl}}/classifications/roles
wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/classifications/roles
import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/classifications/roles")! 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": "123e4567-e89b-12d3-a456-426655440001",
"reciprocalRole": "Company",
"reciprocalRoleDescription": "An incorporated legal entity.",
"relationship": "Directorship",
"role": "Director",
"roleDescription": "An individual responsible for managing a company's business activities."
},
{
"id": "123e4567-e89b-12d3-a456-426655440002",
"reciprocalRole": "Employer",
"reciprocalRoleDescription": "An individual or organisation that employs people.",
"relationship": "Employment",
"role": "Employee",
"roleDescription": "An individual employed for wages or salary."
}
]
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "401",
"details": {
"code": "NullValue",
"message": "Family name must not be null",
"target": "familyName"
},
"message": "Request not authenticated due to missing, invalid, or expired token",
"status": "UNAUTHENTICATED"
}
RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"code": "404",
"message": "The specified resource was not found",
"status": "NOT_FOUND"
}