iQualify Management API
iQualify Management APIvv1
The iQualify API offers management responses for building learning experiences using your iQualify instance data. Once you’ve registered with iQualify, you can request an API access token by navigating to the API access section of the "Account Settings" area. Find out how to Request your API access token on our Knowledge base. All endpoints are only accessible via https and are located at api.iqualify.com. For instance: you can find your current offerings by accessing the following URL: https://api.iqualify.com/v1/offerings/current
- Endpoints
- 84 (48 GET, 13 POST, 10 PUT, 7 DELETE)
- Base URL
https://api.iqualify.com/v1- Authentication
- API key
- Spec format
- OpenAPI 3.0.0
- API version
- v1
- Source
- api.iqualify.com
- Provider
- iqualify.com
- Categories
- Education
- Last updated
Use this API in Bruno:
- Download the Bruno collection above and unzip it.
- In Bruno, choose Open Collection and select the unzipped folder.
- Set the
baseUrlvariable (for examplehttps://api.iqualify.com/v1) and your API key credentials, then send requests.
GET
List supported endpoints URLs
{{baseUrl}}/
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/")require "http/client"
url = "{{baseUrl}}/"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/"
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/ HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/"))
.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}}/")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/")
.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}}/');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/';
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}}/',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/',
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}}/'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/');
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}}/'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/';
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}}/"]
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}}/" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/",
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}}/');
echo $response->getBody();setUrl('{{baseUrl}}/');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/";
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}}/http GET {{baseUrl}}/wget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/import Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()
GET
Find a learner's submission to a specified assessment, including marks if any
{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId
QUERY PARAMS
offeringId
userEmail
assessmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId"
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/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId"))
.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}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId")
.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}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId';
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}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId',
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}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId');
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}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId';
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}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId"]
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}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId",
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}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId";
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}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentIdhttp GET {{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/submissions/:userEmail/assignments/:assessmentId")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find assessment marks
{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments"
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/offerings/:offeringId/analytics/marks/assignments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments"))
.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}}/offerings/:offeringId/analytics/marks/assignments")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments")
.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}}/offerings/:offeringId/analytics/marks/assignments');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments';
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}}/offerings/:offeringId/analytics/marks/assignments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/marks/assignments',
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}}/offerings/:offeringId/analytics/marks/assignments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments');
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}}/offerings/:offeringId/analytics/marks/assignments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments';
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}}/offerings/:offeringId/analytics/marks/assignments"]
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}}/offerings/:offeringId/analytics/marks/assignments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments",
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}}/offerings/:offeringId/analytics/marks/assignments');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/marks/assignments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/marks/assignments') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments";
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}}/offerings/:offeringId/analytics/marks/assignmentshttp GET {{baseUrl}}/offerings/:offeringId/analytics/marks/assignmentswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/marks/assignmentsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/marks/assignments")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find open response activity attempts
{{baseUrl}}/offerings/:offeringId/analytics/activities/responses
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/activities/responses");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/activities/responses")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/activities/responses"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/activities/responses"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/activities/responses");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/activities/responses"
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/offerings/:offeringId/analytics/activities/responses HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/activities/responses")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/activities/responses"))
.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}}/offerings/:offeringId/analytics/activities/responses")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/activities/responses")
.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}}/offerings/:offeringId/analytics/activities/responses');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/activities/responses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/activities/responses';
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}}/offerings/:offeringId/analytics/activities/responses',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/activities/responses")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/activities/responses',
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}}/offerings/:offeringId/analytics/activities/responses'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/activities/responses');
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}}/offerings/:offeringId/analytics/activities/responses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/activities/responses';
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}}/offerings/:offeringId/analytics/activities/responses"]
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}}/offerings/:offeringId/analytics/activities/responses" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/activities/responses",
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}}/offerings/:offeringId/analytics/activities/responses');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/activities/responses');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/activities/responses');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/activities/responses' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/activities/responses' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/activities/responses")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/activities/responses"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/activities/responses"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/activities/responses")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/activities/responses') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/activities/responses";
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}}/offerings/:offeringId/analytics/activities/responseshttp GET {{baseUrl}}/offerings/:offeringId/analytics/activities/responseswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/activities/responsesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/activities/responses")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find quiz marks
{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes"
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/offerings/:offeringId/analytics/marks/quizzes HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes"))
.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}}/offerings/:offeringId/analytics/marks/quizzes")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes")
.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}}/offerings/:offeringId/analytics/marks/quizzes');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes';
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}}/offerings/:offeringId/analytics/marks/quizzes',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/marks/quizzes',
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}}/offerings/:offeringId/analytics/marks/quizzes'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes');
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}}/offerings/:offeringId/analytics/marks/quizzes'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes';
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}}/offerings/:offeringId/analytics/marks/quizzes"]
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}}/offerings/:offeringId/analytics/marks/quizzes" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes",
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}}/offerings/:offeringId/analytics/marks/quizzes');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/marks/quizzes")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/marks/quizzes') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes";
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}}/offerings/:offeringId/analytics/marks/quizzeshttp GET {{baseUrl}}/offerings/:offeringId/analytics/marks/quizzeswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/marks/quizzesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/marks/quizzes")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find submissions to a specified open response assessment, including marks if any
{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId
QUERY PARAMS
offeringId
assessmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId"
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/offerings/:offeringId/analytics/submissions/open-response/:assessmentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId"))
.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}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId")
.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}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId';
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}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/submissions/open-response/:assessmentId',
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}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId');
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}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId';
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}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId"]
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}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId",
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}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/submissions/open-response/:assessmentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/submissions/open-response/:assessmentId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId";
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}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentIdhttp GET {{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/submissions/open-response/:assessmentId")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find submissions to assessments, including marks if any
{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments"
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/offerings/:offeringId/analytics/submissions/assignments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments"))
.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}}/offerings/:offeringId/analytics/submissions/assignments")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments")
.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}}/offerings/:offeringId/analytics/submissions/assignments');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments';
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}}/offerings/:offeringId/analytics/submissions/assignments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/submissions/assignments',
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}}/offerings/:offeringId/analytics/submissions/assignments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments');
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}}/offerings/:offeringId/analytics/submissions/assignments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments';
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}}/offerings/:offeringId/analytics/submissions/assignments"]
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}}/offerings/:offeringId/analytics/submissions/assignments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments",
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}}/offerings/:offeringId/analytics/submissions/assignments');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/submissions/assignments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/submissions/assignments') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments";
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}}/offerings/:offeringId/analytics/submissions/assignmentshttp GET {{baseUrl}}/offerings/:offeringId/analytics/submissions/assignmentswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/submissions/assignmentsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/submissions/assignments")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
POST
Add a learner to an assessment group
{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners
QUERY PARAMS
offeringId
groupId
BODY json
{
"email": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"email\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners" {:content-type :json
:form-params {:email ""}})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"email\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners"),
Content = new StringContent("{\n \"email\": \"\"\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}}/offerings/:offeringId/groups/:groupId/learners");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"email\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners"
payload := strings.NewReader("{\n \"email\": \"\"\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/offerings/:offeringId/groups/:groupId/learners HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 17
{
"email": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners")
.setHeader("content-type", "application/json")
.setBody("{\n \"email\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"email\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"email\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners")
.header("content-type", "application/json")
.body("{\n \"email\": \"\"\n}")
.asString(); const data = JSON.stringify({
email: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners',
headers: {'content-type': 'application/json'},
data: {email: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"email":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "email": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"email\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners")
.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/offerings/:offeringId/groups/:groupId/learners',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({email: ''}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners',
headers: {'content-type': 'application/json'},
body: {email: ''},
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}}/offerings/:offeringId/groups/:groupId/learners');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
email: ''
});
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}}/offerings/:offeringId/groups/:groupId/learners',
headers: {'content-type': 'application/json'},
data: {email: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"email":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"email": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners"]
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}}/offerings/:offeringId/groups/:groupId/learners" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"email\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => ''
]),
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}}/offerings/:offeringId/groups/:groupId/learners', [
'body' => '{
"email": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'email' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'email' => ''
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners');
$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}}/offerings/:offeringId/groups/:groupId/learners' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"email": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"email": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"email\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/offerings/:offeringId/groups/:groupId/learners", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners"
payload = { "email": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners"
payload <- "{\n \"email\": \"\"\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}}/offerings/:offeringId/groups/:groupId/learners")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"email\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/offerings/:offeringId/groups/:groupId/learners') do |req|
req.body = "{\n \"email\": \"\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners";
let payload = json!({"email": ""});
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}}/offerings/:offeringId/groups/:groupId/learners \
--header 'content-type: application/json' \
--data '{
"email": ""
}'echo '{
"email": ""
}' | \
http POST {{baseUrl}}/offerings/:offeringId/groups/:groupId/learners \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "email": ""\n}' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/groups/:groupId/learnersimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["email": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners")! 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
{
"details": "invalid $filter parameter.",
"name": "ApiValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
POST
Add an assessment group
{{baseUrl}}/offerings/:offeringId/groups
QUERY PARAMS
offeringId
BODY json
{
"title": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/groups");
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 \"title\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/offerings/:offeringId/groups" {:content-type :json
:form-params {:title ""}})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/groups"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"title\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/groups"),
Content = new StringContent("{\n \"title\": \"\"\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}}/offerings/:offeringId/groups");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"title\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/groups"
payload := strings.NewReader("{\n \"title\": \"\"\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/offerings/:offeringId/groups HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 17
{
"title": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/offerings/:offeringId/groups")
.setHeader("content-type", "application/json")
.setBody("{\n \"title\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/groups"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"title\": \"\"\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 \"title\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/groups")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/offerings/:offeringId/groups")
.header("content-type", "application/json")
.body("{\n \"title\": \"\"\n}")
.asString(); const data = JSON.stringify({
title: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/offerings/:offeringId/groups');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/groups',
headers: {'content-type': 'application/json'},
data: {title: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/groups';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"title":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/groups',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "title": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"title\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/groups")
.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/offerings/:offeringId/groups',
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({title: ''}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/groups',
headers: {'content-type': 'application/json'},
body: {title: ''},
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}}/offerings/:offeringId/groups');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
title: ''
});
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}}/offerings/:offeringId/groups',
headers: {'content-type': 'application/json'},
data: {title: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/groups';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"title":""}'
};
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 = @{ @"title": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/groups"]
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}}/offerings/:offeringId/groups" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"title\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/groups",
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([
'title' => ''
]),
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}}/offerings/:offeringId/groups', [
'body' => '{
"title": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/groups');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'title' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'title' => ''
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/groups');
$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}}/offerings/:offeringId/groups' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"title": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/groups' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"title": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"title\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/offerings/:offeringId/groups", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/groups"
payload = { "title": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/groups"
payload <- "{\n \"title\": \"\"\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}}/offerings/:offeringId/groups")
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 \"title\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/offerings/:offeringId/groups') do |req|
req.body = "{\n \"title\": \"\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/groups";
let payload = json!({"title": ""});
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}}/offerings/:offeringId/groups \
--header 'content-type: application/json' \
--data '{
"title": ""
}'echo '{
"title": ""
}' | \
http POST {{baseUrl}}/offerings/:offeringId/groups \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "title": ""\n}' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/groupsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["title": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/groups")! 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
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should NOT be shorter than 3 characters",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "should have required property 'example'",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find assessment groups
{{baseUrl}}/offerings/:offeringId/groups
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/groups");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/groups")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/groups"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/groups"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/groups");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/groups"
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/offerings/:offeringId/groups HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/groups")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/groups"))
.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}}/offerings/:offeringId/groups")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/groups")
.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}}/offerings/:offeringId/groups');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/offerings/:offeringId/groups'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/groups';
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}}/offerings/:offeringId/groups',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/groups")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/groups',
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}}/offerings/:offeringId/groups'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/groups');
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}}/offerings/:offeringId/groups'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/groups';
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}}/offerings/:offeringId/groups"]
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}}/offerings/:offeringId/groups" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/groups",
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}}/offerings/:offeringId/groups');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/groups');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/groups');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/groups' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/groups' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/groups")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/groups"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/groups"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/groups")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/groups') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/groups";
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}}/offerings/:offeringId/groupshttp GET {{baseUrl}}/offerings/:offeringId/groupswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/groupsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/groups")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find learners in an assessment group
{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners
QUERY PARAMS
offeringId
groupId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners"
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/offerings/:offeringId/groups/:groupId/learners HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners"))
.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}}/offerings/:offeringId/groups/:groupId/learners")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners")
.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}}/offerings/:offeringId/groups/:groupId/learners');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners';
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}}/offerings/:offeringId/groups/:groupId/learners',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/groups/:groupId/learners',
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}}/offerings/:offeringId/groups/:groupId/learners'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners');
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}}/offerings/:offeringId/groups/:groupId/learners'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners';
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}}/offerings/:offeringId/groups/:groupId/learners"]
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}}/offerings/:offeringId/groups/:groupId/learners" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners",
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}}/offerings/:offeringId/groups/:groupId/learners');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/groups/:groupId/learners")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/groups/:groupId/learners') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners";
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}}/offerings/:offeringId/groups/:groupId/learnershttp GET {{baseUrl}}/offerings/:offeringId/groups/:groupId/learnerswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/groups/:groupId/learnersimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners")! 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
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should NOT be shorter than 3 characters",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "should have required property 'example'",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
DELETE
Remove a learner from an assessment group
{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail
QUERY PARAMS
offeringId
groupId
userEmail
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail"
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/offerings/:offeringId/groups/:groupId/learners/:userEmail HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail"))
.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}}/offerings/:offeringId/groups/:groupId/learners/:userEmail")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail")
.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}}/offerings/:offeringId/groups/:groupId/learners/:userEmail');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail';
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}}/offerings/:offeringId/groups/:groupId/learners/:userEmail',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail")
.delete(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/groups/:groupId/learners/:userEmail',
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}}/offerings/:offeringId/groups/:groupId/learners/:userEmail'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail');
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}}/offerings/:offeringId/groups/:groupId/learners/:userEmail'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail';
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}}/offerings/:offeringId/groups/:groupId/learners/:userEmail"]
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}}/offerings/:offeringId/groups/:groupId/learners/:userEmail" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail",
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}}/offerings/:offeringId/groups/:groupId/learners/:userEmail');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/offerings/:offeringId/groups/:groupId/learners/:userEmail")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/offerings/:offeringId/groups/:groupId/learners/:userEmail') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail";
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}}/offerings/:offeringId/groups/:groupId/learners/:userEmailhttp DELETE {{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmailwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmailimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/groups/:groupId/learners/:userEmail")! 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
{
"details": "invalid $filter parameter.",
"name": "ApiValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find learner's open response assessment submissions
{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response
QUERY PARAMS
offeringId
userEmail
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response"
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/offerings/:offeringId/users/:userEmail/submissions/open-response HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response"))
.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}}/offerings/:offeringId/users/:userEmail/submissions/open-response")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response")
.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}}/offerings/:offeringId/users/:userEmail/submissions/open-response');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response';
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}}/offerings/:offeringId/users/:userEmail/submissions/open-response',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/users/:userEmail/submissions/open-response',
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}}/offerings/:offeringId/users/:userEmail/submissions/open-response'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response');
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}}/offerings/:offeringId/users/:userEmail/submissions/open-response'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response';
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}}/offerings/:offeringId/users/:userEmail/submissions/open-response"]
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}}/offerings/:offeringId/users/:userEmail/submissions/open-response" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response",
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}}/offerings/:offeringId/users/:userEmail/submissions/open-response');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/users/:userEmail/submissions/open-response")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/users/:userEmail/submissions/open-response') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response";
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}}/offerings/:offeringId/users/:userEmail/submissions/open-responsehttp GET {{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-responsewget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-responseimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/users/:userEmail/submissions/open-response")! 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
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find learners with assessments pending x days before due date within the specified offeringId
{{baseUrl}}/offerings/:offeringId/learners/pending-submission
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/learners/pending-submission");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/learners/pending-submission")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/learners/pending-submission"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/learners/pending-submission"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/learners/pending-submission");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/learners/pending-submission"
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/offerings/:offeringId/learners/pending-submission HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/learners/pending-submission")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/learners/pending-submission"))
.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}}/offerings/:offeringId/learners/pending-submission")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/learners/pending-submission")
.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}}/offerings/:offeringId/learners/pending-submission');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/learners/pending-submission'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/learners/pending-submission';
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}}/offerings/:offeringId/learners/pending-submission',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/learners/pending-submission")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/learners/pending-submission',
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}}/offerings/:offeringId/learners/pending-submission'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/learners/pending-submission');
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}}/offerings/:offeringId/learners/pending-submission'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/learners/pending-submission';
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}}/offerings/:offeringId/learners/pending-submission"]
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}}/offerings/:offeringId/learners/pending-submission" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/learners/pending-submission",
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}}/offerings/:offeringId/learners/pending-submission');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/learners/pending-submission');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/learners/pending-submission');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/learners/pending-submission' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/learners/pending-submission' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/learners/pending-submission")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/learners/pending-submission"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/learners/pending-submission"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/learners/pending-submission")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/learners/pending-submission') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/learners/pending-submission";
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}}/offerings/:offeringId/learners/pending-submissionhttp GET {{baseUrl}}/offerings/:offeringId/learners/pending-submissionwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/learners/pending-submissionimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/learners/pending-submission")! 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
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find offering's activities
{{baseUrl}}/offerings/:offeringId/activities/openresponse
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/activities/openresponse");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/activities/openresponse")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/activities/openresponse"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/activities/openresponse"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/activities/openresponse");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/activities/openresponse"
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/offerings/:offeringId/activities/openresponse HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/activities/openresponse")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/activities/openresponse"))
.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}}/offerings/:offeringId/activities/openresponse")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/activities/openresponse")
.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}}/offerings/:offeringId/activities/openresponse');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/activities/openresponse'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/activities/openresponse';
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}}/offerings/:offeringId/activities/openresponse',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/activities/openresponse")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/activities/openresponse',
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}}/offerings/:offeringId/activities/openresponse'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/activities/openresponse');
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}}/offerings/:offeringId/activities/openresponse'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/activities/openresponse';
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}}/offerings/:offeringId/activities/openresponse"]
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}}/offerings/:offeringId/activities/openresponse" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/activities/openresponse",
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}}/offerings/:offeringId/activities/openresponse');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/activities/openresponse');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/activities/openresponse');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/activities/openresponse' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/activities/openresponse' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/activities/openresponse")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/activities/openresponse"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/activities/openresponse"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/activities/openresponse")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/activities/openresponse') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/activities/openresponse";
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}}/offerings/:offeringId/activities/openresponsehttp GET {{baseUrl}}/offerings/:offeringId/activities/openresponsewget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/activities/openresponseimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/activities/openresponse")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find offering's assessments
{{baseUrl}}/offerings/:offeringId/assessments
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/assessments");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/assessments")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/assessments"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/assessments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/assessments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/assessments"
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/offerings/:offeringId/assessments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/assessments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/assessments"))
.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}}/offerings/:offeringId/assessments")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/assessments")
.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}}/offerings/:offeringId/assessments');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/assessments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/assessments';
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}}/offerings/:offeringId/assessments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/assessments")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/assessments',
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}}/offerings/:offeringId/assessments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/assessments');
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}}/offerings/:offeringId/assessments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/assessments';
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}}/offerings/:offeringId/assessments"]
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}}/offerings/:offeringId/assessments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/assessments",
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}}/offerings/:offeringId/assessments');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/assessments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/assessments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/assessments' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/assessments' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/assessments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/assessments"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/assessments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/assessments")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/assessments') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/assessments";
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}}/offerings/:offeringId/assessmentshttp GET {{baseUrl}}/offerings/:offeringId/assessmentswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/assessmentsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/assessments")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
DELETE
Remove assessment document
{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId
QUERY PARAMS
offeringId
assessmentId
documentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId"
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/offerings/:offeringId/assessments/:assessmentId/documents/:documentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId"))
.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}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId")
.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}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId';
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}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId")
.delete(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/assessments/:assessmentId/documents/:documentId',
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}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId');
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}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId';
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}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId"]
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}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId",
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}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/offerings/:offeringId/assessments/:assessmentId/documents/:documentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/offerings/:offeringId/assessments/:assessmentId/documents/:documentId') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId";
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}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentIdhttp DELETE {{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentIdwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/documents/:documentId")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
DELETE
Reset user's assessment to draft state
{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId
QUERY PARAMS
offeringId
userEmail
assessmentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId"
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/offerings/:offeringId/users/:userEmail/assessments/:assessmentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId"))
.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}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId")
.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}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId';
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}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId")
.delete(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/users/:userEmail/assessments/:assessmentId',
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}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId');
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}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId';
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}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId"]
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}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId",
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}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/offerings/:offeringId/users/:userEmail/assessments/:assessmentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/offerings/:offeringId/users/:userEmail/assessments/:assessmentId') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId";
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}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentIdhttp DELETE {{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentIdwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/users/:userEmail/assessments/:assessmentId")! 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
{
"details": "The user alex.doe@test.te has not submitted assessment as1.",
"name": "AssessmentNotSubmittedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The A property B is invalid. Expected value: C",
"name": "ObjectInvalidPropertyError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PATCH
Update assessment details
{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId
QUERY PARAMS
offeringId
assessmentId
BODY json
{
"content": "",
"dueDate": "",
"markNumber": "",
"markType": "",
"openDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId");
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 \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId" {:content-type :json
:form-params {:content ""
:dueDate ""
:markNumber ""
:markType ""
:openDate ""}})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId"),
Content = new StringContent("{\n \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\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}}/offerings/:offeringId/assessments/:assessmentId");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId"
payload := strings.NewReader("{\n \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PATCH /baseUrl/offerings/:offeringId/assessments/:assessmentId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 92
{
"content": "",
"dueDate": "",
"markNumber": "",
"markType": "",
"openDate": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId")
.setHeader("content-type", "application/json")
.setBody("{\n \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\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 \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.patch("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId")
.header("content-type", "application/json")
.body("{\n \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\n}")
.asString(); const data = JSON.stringify({
content: '',
dueDate: '',
markNumber: '',
markType: '',
openDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId',
headers: {'content-type': 'application/json'},
data: {content: '', dueDate: '', markNumber: '', markType: '', openDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"content":"","dueDate":"","markNumber":"","markType":"","openDate":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "content": "",\n "dueDate": "",\n "markNumber": "",\n "markType": "",\n "openDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/assessments/:assessmentId',
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({content: '', dueDate: '', markNumber: '', markType: '', openDate: ''}));
req.end();const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId',
headers: {'content-type': 'application/json'},
body: {content: '', dueDate: '', markNumber: '', markType: '', openDate: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
content: '',
dueDate: '',
markNumber: '',
markType: '',
openDate: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId',
headers: {'content-type': 'application/json'},
data: {content: '', dueDate: '', markNumber: '', markType: '', openDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"content":"","dueDate":"","markNumber":"","markType":"","openDate":""}'
};
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 = @{ @"content": @"",
@"dueDate": @"",
@"markNumber": @"",
@"markType": @"",
@"openDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'content' => '',
'dueDate' => '',
'markNumber' => '',
'markType' => '',
'openDate' => ''
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PATCH', '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId', [
'body' => '{
"content": "",
"dueDate": "",
"markNumber": "",
"markType": "",
"openDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'content' => '',
'dueDate' => '',
'markNumber' => '',
'markType' => '',
'openDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'content' => '',
'dueDate' => '',
'markNumber' => '',
'markType' => '',
'openDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"content": "",
"dueDate": "",
"markNumber": "",
"markType": "",
"openDate": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"content": "",
"dueDate": "",
"markNumber": "",
"markType": "",
"openDate": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/offerings/:offeringId/assessments/:assessmentId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId"
payload = {
"content": "",
"dueDate": "",
"markNumber": "",
"markType": "",
"openDate": ""
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId"
payload <- "{\n \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/offerings/:offeringId/assessments/:assessmentId') do |req|
req.body = "{\n \"content\": \"\",\n \"dueDate\": \"\",\n \"markNumber\": \"\",\n \"markType\": \"\",\n \"openDate\": \"\"\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId";
let payload = json!({
"content": "",
"dueDate": "",
"markNumber": "",
"markType": "",
"openDate": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/offerings/:offeringId/assessments/:assessmentId \
--header 'content-type: application/json' \
--data '{
"content": "",
"dueDate": "",
"markNumber": "",
"markType": "",
"openDate": ""
}'echo '{
"content": "",
"dueDate": "",
"markNumber": "",
"markType": "",
"openDate": ""
}' | \
http PATCH {{baseUrl}}/offerings/:offeringId/assessments/:assessmentId \
content-type:application/jsonwget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "content": "",\n "dueDate": "",\n "markNumber": "",\n "markType": "",\n "openDate": ""\n}' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/assessments/:assessmentIdimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"content": "",
"dueDate": "",
"markNumber": "",
"markType": "",
"openDate": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"example\"",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should NOT be shorter than 3 characters",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PATCH
Update the due dates for a learner's quiz attempt
{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail
QUERY PARAMS
offeringId
assessmentId
userEmail
BODY json
{
"dueDate": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail");
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 \"dueDate\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail" {:content-type :json
:form-params {:dueDate ""}})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"dueDate\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail"),
Content = new StringContent("{\n \"dueDate\": \"\"\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}}/offerings/:offeringId/assessments/:assessmentId/:userEmail");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"dueDate\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail"
payload := strings.NewReader("{\n \"dueDate\": \"\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PATCH /baseUrl/offerings/:offeringId/assessments/:assessmentId/:userEmail HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 19
{
"dueDate": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail")
.setHeader("content-type", "application/json")
.setBody("{\n \"dueDate\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"dueDate\": \"\"\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 \"dueDate\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.patch("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail")
.header("content-type", "application/json")
.body("{\n \"dueDate\": \"\"\n}")
.asString(); const data = JSON.stringify({
dueDate: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail',
headers: {'content-type': 'application/json'},
data: {dueDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"dueDate":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "dueDate": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"dueDate\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/assessments/:assessmentId/:userEmail',
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({dueDate: ''}));
req.end();const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail',
headers: {'content-type': 'application/json'},
body: {dueDate: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
dueDate: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail',
headers: {'content-type': 'application/json'},
data: {dueDate: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"dueDate":""}'
};
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 = @{ @"dueDate": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"dueDate\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'dueDate' => ''
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PATCH', '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail', [
'body' => '{
"dueDate": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'dueDate' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'dueDate' => ''
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"dueDate": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"dueDate": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"dueDate\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/offerings/:offeringId/assessments/:assessmentId/:userEmail", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail"
payload = { "dueDate": "" }
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail"
payload <- "{\n \"dueDate\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"dueDate\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/offerings/:offeringId/assessments/:assessmentId/:userEmail') do |req|
req.body = "{\n \"dueDate\": \"\"\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail";
let payload = json!({"dueDate": ""});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail \
--header 'content-type: application/json' \
--data '{
"dueDate": ""
}'echo '{
"dueDate": ""
}' | \
http PATCH {{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail \
content-type:application/jsonwget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "dueDate": ""\n}' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmailimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["dueDate": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/assessments/:assessmentId/:userEmail")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The specified parameter file.mimetype (image mimetype) has an invalid value \\'text/plain\\'.",
"name": "InvalidParameterError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The A property B is invalid. Expected value: C",
"name": "ObjectInvalidPropertyError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"example\"",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
POST
Award badge
{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award
QUERY PARAMS
offeringId
userEmail
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award"
response = HTTP::Client.post url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/offerings/:offeringId/users/:userEmail/badges/award HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award")
.post(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award")
.post(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/users/:userEmail/badges/award',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award');
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}}/offerings/:offeringId/users/:userEmail/badges/award'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award' -Method POST $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award' -Method POST import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/offerings/:offeringId/users/:userEmail/badges/award")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award"
response = requests.post(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/offerings/:offeringId/users/:userEmail/badges/award') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/awardhttp POST {{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/awardwget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/awardimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/users/:userEmail/badges/award")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The field 'Offering Badge' is missing or invalid.",
"name": "MissingInfoError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The user john.doe@test.te is not a learner in the offering -MEF8kFyURUr6_CZ4IXD.",
"name": "UserNotInOfferingError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find offering badges
{{baseUrl}}/offerings/:offeringId/badges
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/badges");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/badges")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/badges"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/badges"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/badges");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/badges"
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/offerings/:offeringId/badges HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/badges")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/badges"))
.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}}/offerings/:offeringId/badges")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/badges")
.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}}/offerings/:offeringId/badges');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/offerings/:offeringId/badges'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/badges';
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}}/offerings/:offeringId/badges',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/badges")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/badges',
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}}/offerings/:offeringId/badges'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/badges');
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}}/offerings/:offeringId/badges'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/badges';
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}}/offerings/:offeringId/badges"]
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}}/offerings/:offeringId/badges" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/badges",
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}}/offerings/:offeringId/badges');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/badges');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/badges');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/badges' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/badges' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/badges")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/badges"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/badges"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/badges")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/badges') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/badges";
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}}/offerings/:offeringId/badgeshttp GET {{baseUrl}}/offerings/:offeringId/badgeswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/badgesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/badges")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find user's badges
{{baseUrl}}/users/:userEmail/badges
QUERY PARAMS
userEmail
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:userEmail/badges");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users/:userEmail/badges")require "http/client"
url = "{{baseUrl}}/users/:userEmail/badges"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users/:userEmail/badges"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/users/:userEmail/badges");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:userEmail/badges"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/users/:userEmail/badges HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users/:userEmail/badges")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:userEmail/badges"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:userEmail/badges")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/users/:userEmail/badges")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/users/:userEmail/badges');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/users/:userEmail/badges'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/users/:userEmail/badges';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/users/:userEmail/badges',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/:userEmail/badges")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:userEmail/badges',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/users/:userEmail/badges'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users/:userEmail/badges');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/users/:userEmail/badges'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:userEmail/badges';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:userEmail/badges"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/users/:userEmail/badges" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/users/:userEmail/badges",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/users/:userEmail/badges');
echo $response->getBody();setUrl('{{baseUrl}}/users/:userEmail/badges');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/users/:userEmail/badges');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:userEmail/badges' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:userEmail/badges' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users/:userEmail/badges")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/users/:userEmail/badges"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/users/:userEmail/badges"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:userEmail/badges")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users/:userEmail/badges') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:userEmail/badges";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users/:userEmail/badgeshttp GET {{baseUrl}}/users/:userEmail/badgeswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users/:userEmail/badgesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:userEmail/badges")! 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
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
POST
Add channel
{{baseUrl}}/offerings/:offeringId/channels
QUERY PARAMS
offeringId
BODY json
{
"isBroadcastOnly": false,
"title": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/channels");
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 \"isBroadcastOnly\": false,\n \"title\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/offerings/:offeringId/channels" {:content-type :json
:form-params {:isBroadcastOnly false
:title ""}})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/channels"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"isBroadcastOnly\": false,\n \"title\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/channels"),
Content = new StringContent("{\n \"isBroadcastOnly\": false,\n \"title\": \"\"\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}}/offerings/:offeringId/channels");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"isBroadcastOnly\": false,\n \"title\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/channels"
payload := strings.NewReader("{\n \"isBroadcastOnly\": false,\n \"title\": \"\"\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/offerings/:offeringId/channels HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 45
{
"isBroadcastOnly": false,
"title": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/offerings/:offeringId/channels")
.setHeader("content-type", "application/json")
.setBody("{\n \"isBroadcastOnly\": false,\n \"title\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/channels"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"isBroadcastOnly\": false,\n \"title\": \"\"\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 \"isBroadcastOnly\": false,\n \"title\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/channels")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/offerings/:offeringId/channels")
.header("content-type", "application/json")
.body("{\n \"isBroadcastOnly\": false,\n \"title\": \"\"\n}")
.asString(); const data = JSON.stringify({
isBroadcastOnly: false,
title: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/offerings/:offeringId/channels');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/channels',
headers: {'content-type': 'application/json'},
data: {isBroadcastOnly: false, title: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/channels';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"isBroadcastOnly":false,"title":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/channels',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "isBroadcastOnly": false,\n "title": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"isBroadcastOnly\": false,\n \"title\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/channels")
.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/offerings/:offeringId/channels',
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({isBroadcastOnly: false, title: ''}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/channels',
headers: {'content-type': 'application/json'},
body: {isBroadcastOnly: false, title: ''},
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}}/offerings/:offeringId/channels');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
isBroadcastOnly: false,
title: ''
});
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}}/offerings/:offeringId/channels',
headers: {'content-type': 'application/json'},
data: {isBroadcastOnly: false, title: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/channels';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"isBroadcastOnly":false,"title":""}'
};
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 = @{ @"isBroadcastOnly": @NO,
@"title": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/channels"]
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}}/offerings/:offeringId/channels" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"isBroadcastOnly\": false,\n \"title\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/channels",
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([
'isBroadcastOnly' => null,
'title' => ''
]),
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}}/offerings/:offeringId/channels', [
'body' => '{
"isBroadcastOnly": false,
"title": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/channels');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'isBroadcastOnly' => null,
'title' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'isBroadcastOnly' => null,
'title' => ''
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/channels');
$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}}/offerings/:offeringId/channels' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"isBroadcastOnly": false,
"title": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/channels' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"isBroadcastOnly": false,
"title": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"isBroadcastOnly\": false,\n \"title\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/offerings/:offeringId/channels", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/channels"
payload = {
"isBroadcastOnly": False,
"title": ""
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/channels"
payload <- "{\n \"isBroadcastOnly\": false,\n \"title\": \"\"\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}}/offerings/:offeringId/channels")
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 \"isBroadcastOnly\": false,\n \"title\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/offerings/:offeringId/channels') do |req|
req.body = "{\n \"isBroadcastOnly\": false,\n \"title\": \"\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/channels";
let payload = json!({
"isBroadcastOnly": false,
"title": ""
});
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}}/offerings/:offeringId/channels \
--header 'content-type: application/json' \
--data '{
"isBroadcastOnly": false,
"title": ""
}'echo '{
"isBroadcastOnly": false,
"title": ""
}' | \
http POST {{baseUrl}}/offerings/:offeringId/channels \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "isBroadcastOnly": false,\n "title": ""\n}' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/channelsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"isBroadcastOnly": false,
"title": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/channels")! 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
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should NOT be shorter than 3 characters",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "should have required property 'example'",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
POST
Add learners to a group channel
{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners
QUERY PARAMS
offeringId
channelId
BODY json
{
"email": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"email\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners" {:content-type :json
:form-params {:email ""}})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"email\": \"\"\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"),
Content = new StringContent("{\n \"email\": \"\"\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}}/offerings/:offeringId/channels/:channelId/learners");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"email\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"
payload := strings.NewReader("{\n \"email\": \"\"\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/offerings/:offeringId/channels/:channelId/learners HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 17
{
"email": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")
.setHeader("content-type", "application/json")
.setBody("{\n \"email\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"email\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"email\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")
.header("content-type", "application/json")
.body("{\n \"email\": \"\"\n}")
.asString(); const data = JSON.stringify({
email: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners',
headers: {'content-type': 'application/json'},
data: {email: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"email":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "email": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"email\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")
.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/offerings/:offeringId/channels/:channelId/learners',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({email: ''}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners',
headers: {'content-type': 'application/json'},
body: {email: ''},
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}}/offerings/:offeringId/channels/:channelId/learners');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
email: ''
});
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}}/offerings/:offeringId/channels/:channelId/learners',
headers: {'content-type': 'application/json'},
data: {email: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"email":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"email": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"]
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}}/offerings/:offeringId/channels/:channelId/learners" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"email\": \"\"\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => ''
]),
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}}/offerings/:offeringId/channels/:channelId/learners', [
'body' => '{
"email": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'email' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'email' => ''
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners');
$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}}/offerings/:offeringId/channels/:channelId/learners' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"email": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"email": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"email\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/offerings/:offeringId/channels/:channelId/learners", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"
payload = { "email": "" }
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"
payload <- "{\n \"email\": \"\"\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}}/offerings/:offeringId/channels/:channelId/learners")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"email\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/offerings/:offeringId/channels/:channelId/learners') do |req|
req.body = "{\n \"email\": \"\"\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners";
let payload = json!({"email": ""});
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}}/offerings/:offeringId/channels/:channelId/learners \
--header 'content-type: application/json' \
--data '{
"email": ""
}'echo '{
"email": ""
}' | \
http POST {{baseUrl}}/offerings/:offeringId/channels/:channelId/learners \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "email": ""\n}' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/channels/:channelId/learnersimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["email": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")! 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
{
"details": "Channel channel1 is not a group discussion channel.",
"name": "InvalidGroupChannelError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The badge already exists in the offering OFFERING ID.",
"name": "ObjectExistsError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should NOT be shorter than 3 characters",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "should have required property 'example'",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The user john.doe@test.te is not a learner in the offering -MEF8kFyURUr6_CZ4IXD.",
"name": "UserNotInOfferingError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find channels
{{baseUrl}}/offerings/:offeringId/channels
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/channels");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/channels")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/channels"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/channels"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/channels");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/channels"
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/offerings/:offeringId/channels HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/channels")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/channels"))
.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}}/offerings/:offeringId/channels")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/channels")
.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}}/offerings/:offeringId/channels');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/channels'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/channels';
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}}/offerings/:offeringId/channels',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/channels")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/channels',
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}}/offerings/:offeringId/channels'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/channels');
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}}/offerings/:offeringId/channels'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/channels';
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}}/offerings/:offeringId/channels"]
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}}/offerings/:offeringId/channels" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/channels",
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}}/offerings/:offeringId/channels');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/channels');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/channels');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/channels' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/channels' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/channels")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/channels"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/channels"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/channels")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/channels') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/channels";
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}}/offerings/:offeringId/channelshttp GET {{baseUrl}}/offerings/:offeringId/channelswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/channelsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/channels")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find comments
{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments
QUERY PARAMS
offeringId
channelId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments"
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/offerings/:offeringId/analytics/channels/:channelId/comments HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments"))
.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}}/offerings/:offeringId/analytics/channels/:channelId/comments")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments")
.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}}/offerings/:offeringId/analytics/channels/:channelId/comments');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments';
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}}/offerings/:offeringId/analytics/channels/:channelId/comments',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/channels/:channelId/comments',
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}}/offerings/:offeringId/analytics/channels/:channelId/comments'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments');
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}}/offerings/:offeringId/analytics/channels/:channelId/comments'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments';
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}}/offerings/:offeringId/analytics/channels/:channelId/comments"]
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}}/offerings/:offeringId/analytics/channels/:channelId/comments" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments",
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}}/offerings/:offeringId/analytics/channels/:channelId/comments');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/channels/:channelId/comments")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/channels/:channelId/comments') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments";
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}}/offerings/:offeringId/analytics/channels/:channelId/commentshttp GET {{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/commentswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/commentsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/comments")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find learners in a group channel
{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners
QUERY PARAMS
offeringId
channelId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"
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/offerings/:offeringId/channels/:channelId/learners HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"))
.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}}/offerings/:offeringId/channels/:channelId/learners")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")
.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}}/offerings/:offeringId/channels/:channelId/learners');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners';
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}}/offerings/:offeringId/channels/:channelId/learners',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/channels/:channelId/learners',
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}}/offerings/:offeringId/channels/:channelId/learners'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners');
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}}/offerings/:offeringId/channels/:channelId/learners'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners';
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}}/offerings/:offeringId/channels/:channelId/learners"]
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}}/offerings/:offeringId/channels/:channelId/learners" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners",
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}}/offerings/:offeringId/channels/:channelId/learners');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/channels/:channelId/learners")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/channels/:channelId/learners') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners";
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}}/offerings/:offeringId/channels/:channelId/learnershttp GET {{baseUrl}}/offerings/:offeringId/channels/:channelId/learnerswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/channels/:channelId/learnersimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")! 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
{
"details": "Channel channel1 is not a group discussion channel.",
"name": "InvalidGroupChannelError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find posts
{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts
QUERY PARAMS
offeringId
channelId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts"
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/offerings/:offeringId/analytics/channels/:channelId/posts HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts"))
.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}}/offerings/:offeringId/analytics/channels/:channelId/posts")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts")
.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}}/offerings/:offeringId/analytics/channels/:channelId/posts');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts';
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}}/offerings/:offeringId/analytics/channels/:channelId/posts',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/channels/:channelId/posts',
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}}/offerings/:offeringId/analytics/channels/:channelId/posts'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts');
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}}/offerings/:offeringId/analytics/channels/:channelId/posts'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts';
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}}/offerings/:offeringId/analytics/channels/:channelId/posts"]
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}}/offerings/:offeringId/analytics/channels/:channelId/posts" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts",
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}}/offerings/:offeringId/analytics/channels/:channelId/posts');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/channels/:channelId/posts")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/channels/:channelId/posts') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts";
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}}/offerings/:offeringId/analytics/channels/:channelId/postshttp GET {{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/postswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/postsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/posts")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find replies
{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies
QUERY PARAMS
offeringId
channelId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies"
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/offerings/:offeringId/analytics/channels/:channelId/replies HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies"))
.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}}/offerings/:offeringId/analytics/channels/:channelId/replies")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies")
.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}}/offerings/:offeringId/analytics/channels/:channelId/replies');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies';
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}}/offerings/:offeringId/analytics/channels/:channelId/replies',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/channels/:channelId/replies',
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}}/offerings/:offeringId/analytics/channels/:channelId/replies'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies');
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}}/offerings/:offeringId/analytics/channels/:channelId/replies'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies';
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}}/offerings/:offeringId/analytics/channels/:channelId/replies"]
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}}/offerings/:offeringId/analytics/channels/:channelId/replies" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies",
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}}/offerings/:offeringId/analytics/channels/:channelId/replies');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/channels/:channelId/replies")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/channels/:channelId/replies') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies";
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}}/offerings/:offeringId/analytics/channels/:channelId/replieshttp GET {{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replieswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/repliesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/channels/:channelId/replies")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
DELETE
Remove learners from a group channel
{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners
QUERY PARAMS
offeringId
channelId
BODY json
{
"email": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"email\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners" {:content-type :json
:form-params {:email ""}})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"email\": \"\"\n}"
response = HTTP::Client.delete url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"),
Content = new StringContent("{\n \"email\": \"\"\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}}/offerings/:offeringId/channels/:channelId/learners");
var request = new RestRequest("", Method.Delete);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"email\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"
payload := strings.NewReader("{\n \"email\": \"\"\n}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}DELETE /baseUrl/offerings/:offeringId/channels/:channelId/learners HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 17
{
"email": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")
.setHeader("content-type", "application/json")
.setBody("{\n \"email\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"))
.header("content-type", "application/json")
.method("DELETE", HttpRequest.BodyPublishers.ofString("{\n \"email\": \"\"\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"email\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")
.delete(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")
.header("content-type", "application/json")
.body("{\n \"email\": \"\"\n}")
.asString(); const data = JSON.stringify({
email: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners',
headers: {'content-type': 'application/json'},
data: {email: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners';
const options = {
method: 'DELETE',
headers: {'content-type': 'application/json'},
body: '{"email":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners',
method: 'DELETE',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "email": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"email\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")
.delete(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/channels/:channelId/learners',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({email: ''}));
req.end();const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners',
headers: {'content-type': 'application/json'},
body: {email: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
email: ''
});
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}}/offerings/:offeringId/channels/:channelId/learners',
headers: {'content-type': 'application/json'},
data: {email: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners';
const options = {
method: 'DELETE',
headers: {'content-type': 'application/json'},
body: '{"email":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"email": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"email\": \"\"\n}" in
Client.call ~headers ~body `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'email' => ''
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('DELETE', '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners', [
'body' => '{
"email": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'email' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'email' => ''
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners');
$request->setRequestMethod('DELETE');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners' -Method DELETE -Headers $headers -ContentType 'application/json' -Body '{
"email": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners' -Method DELETE -Headers $headers -ContentType 'application/json' -Body '{
"email": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"email\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("DELETE", "/baseUrl/offerings/:offeringId/channels/:channelId/learners", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"
payload = { "email": "" }
headers = {"content-type": "application/json"}
response = requests.delete(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners"
payload <- "{\n \"email\": \"\"\n}"
encode <- "json"
response <- VERB("DELETE", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"email\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.delete('/baseUrl/offerings/:offeringId/channels/:channelId/learners') do |req|
req.body = "{\n \"email\": \"\"\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners";
let payload = json!({"email": ""});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/offerings/:offeringId/channels/:channelId/learners \
--header 'content-type: application/json' \
--data '{
"email": ""
}'echo '{
"email": ""
}' | \
http DELETE {{baseUrl}}/offerings/:offeringId/channels/:channelId/learners \
content-type:application/jsonwget --quiet \
--method DELETE \
--header 'content-type: application/json' \
--body-data '{\n "email": ""\n}' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/channels/:channelId/learnersimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["email": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/channels/:channelId/learners")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "Channel channel1 is not a group discussion channel.",
"name": "InvalidGroupChannelError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The user john.doe@test.te is not a learner in the offering -MEF8kFyURUr6_CZ4IXD.",
"name": "UserNotInOfferingError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PATCH
Update channel
{{baseUrl}}/offerings/:offeringId/channels/:channelId
QUERY PARAMS
offeringId
channelId
BODY json
{
"group": {
"autoAssign": false
},
"groupDiscussion": false,
"isBroadcastOnly": false,
"privateSupport": false,
"title": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/channels/:channelId");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/offerings/:offeringId/channels/:channelId" {:content-type :json
:form-params {:group {:autoAssign false}
:groupDiscussion false
:isBroadcastOnly false
:privateSupport false
:title ""}})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/channels/:channelId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/channels/:channelId"),
Content = new StringContent("{\n \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\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}}/offerings/:offeringId/channels/:channelId");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/channels/:channelId"
payload := strings.NewReader("{\n \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PATCH /baseUrl/offerings/:offeringId/channels/:channelId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 142
{
"group": {
"autoAssign": false
},
"groupDiscussion": false,
"isBroadcastOnly": false,
"privateSupport": false,
"title": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/offerings/:offeringId/channels/:channelId")
.setHeader("content-type", "application/json")
.setBody("{\n \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/channels/:channelId"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\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 \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/channels/:channelId")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.patch("{{baseUrl}}/offerings/:offeringId/channels/:channelId")
.header("content-type", "application/json")
.body("{\n \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\n}")
.asString(); const data = JSON.stringify({
group: {
autoAssign: false
},
groupDiscussion: false,
isBroadcastOnly: false,
privateSupport: false,
title: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/offerings/:offeringId/channels/:channelId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/offerings/:offeringId/channels/:channelId',
headers: {'content-type': 'application/json'},
data: {
group: {autoAssign: false},
groupDiscussion: false,
isBroadcastOnly: false,
privateSupport: false,
title: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/channels/:channelId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"group":{"autoAssign":false},"groupDiscussion":false,"isBroadcastOnly":false,"privateSupport":false,"title":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/channels/:channelId',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "group": {\n "autoAssign": false\n },\n "groupDiscussion": false,\n "isBroadcastOnly": false,\n "privateSupport": false,\n "title": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/channels/:channelId")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/channels/:channelId',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
group: {autoAssign: false},
groupDiscussion: false,
isBroadcastOnly: false,
privateSupport: false,
title: ''
}));
req.end();const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/offerings/:offeringId/channels/:channelId',
headers: {'content-type': 'application/json'},
body: {
group: {autoAssign: false},
groupDiscussion: false,
isBroadcastOnly: false,
privateSupport: false,
title: ''
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/offerings/:offeringId/channels/:channelId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
group: {
autoAssign: false
},
groupDiscussion: false,
isBroadcastOnly: false,
privateSupport: false,
title: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/offerings/:offeringId/channels/:channelId',
headers: {'content-type': 'application/json'},
data: {
group: {autoAssign: false},
groupDiscussion: false,
isBroadcastOnly: false,
privateSupport: false,
title: ''
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/channels/:channelId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"group":{"autoAssign":false},"groupDiscussion":false,"isBroadcastOnly":false,"privateSupport":false,"title":""}'
};
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 = @{ @"group": @{ @"autoAssign": @NO },
@"groupDiscussion": @NO,
@"isBroadcastOnly": @NO,
@"privateSupport": @NO,
@"title": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/channels/:channelId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/offerings/:offeringId/channels/:channelId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/channels/:channelId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'group' => [
'autoAssign' => null
],
'groupDiscussion' => null,
'isBroadcastOnly' => null,
'privateSupport' => null,
'title' => ''
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PATCH', '{{baseUrl}}/offerings/:offeringId/channels/:channelId', [
'body' => '{
"group": {
"autoAssign": false
},
"groupDiscussion": false,
"isBroadcastOnly": false,
"privateSupport": false,
"title": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/channels/:channelId');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'group' => [
'autoAssign' => null
],
'groupDiscussion' => null,
'isBroadcastOnly' => null,
'privateSupport' => null,
'title' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'group' => [
'autoAssign' => null
],
'groupDiscussion' => null,
'isBroadcastOnly' => null,
'privateSupport' => null,
'title' => ''
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/channels/:channelId');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/channels/:channelId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"group": {
"autoAssign": false
},
"groupDiscussion": false,
"isBroadcastOnly": false,
"privateSupport": false,
"title": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/channels/:channelId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"group": {
"autoAssign": false
},
"groupDiscussion": false,
"isBroadcastOnly": false,
"privateSupport": false,
"title": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/offerings/:offeringId/channels/:channelId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/channels/:channelId"
payload = {
"group": { "autoAssign": False },
"groupDiscussion": False,
"isBroadcastOnly": False,
"privateSupport": False,
"title": ""
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/channels/:channelId"
payload <- "{\n \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/channels/:channelId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/offerings/:offeringId/channels/:channelId') do |req|
req.body = "{\n \"group\": {\n \"autoAssign\": false\n },\n \"groupDiscussion\": false,\n \"isBroadcastOnly\": false,\n \"privateSupport\": false,\n \"title\": \"\"\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/channels/:channelId";
let payload = json!({
"group": json!({"autoAssign": false}),
"groupDiscussion": false,
"isBroadcastOnly": false,
"privateSupport": false,
"title": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/offerings/:offeringId/channels/:channelId \
--header 'content-type: application/json' \
--data '{
"group": {
"autoAssign": false
},
"groupDiscussion": false,
"isBroadcastOnly": false,
"privateSupport": false,
"title": ""
}'echo '{
"group": {
"autoAssign": false
},
"groupDiscussion": false,
"isBroadcastOnly": false,
"privateSupport": false,
"title": ""
}' | \
http PATCH {{baseUrl}}/offerings/:offeringId/channels/:channelId \
content-type:application/jsonwget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "group": {\n "autoAssign": false\n },\n "groupDiscussion": false,\n "isBroadcastOnly": false,\n "privateSupport": false,\n "title": ""\n}' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/channels/:channelIdimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"group": ["autoAssign": false],
"groupDiscussion": false,
"isBroadcastOnly": false,
"privateSupport": false,
"title": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/channels/:channelId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should NOT be shorter than 3 characters",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "should have required property 'example'",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PUT
Add course mapping
{{baseUrl}}/course-mappings/:offeringId/:externalCourseId
QUERY PARAMS
offeringId
externalCourseId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId")require "http/client"
url = "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId"
response = HTTP::Client.put url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/course-mappings/:offeringId/:externalCourseId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/course-mappings/:offeringId/:externalCourseId");
var request = new RestRequest("", Method.Put);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId"
req, _ := http.NewRequest("PUT", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PUT /baseUrl/course-mappings/:offeringId/:externalCourseId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/course-mappings/:offeringId/:externalCourseId"))
.method("PUT", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/course-mappings/:offeringId/:externalCourseId")
.put(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/course-mappings/:offeringId/:externalCourseId")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId';
const options = {method: 'PUT'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId',
method: 'PUT',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/course-mappings/:offeringId/:externalCourseId")
.put(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PUT',
hostname: 'example.com',
port: null,
path: '/baseUrl/course-mappings/:offeringId/:externalCourseId',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId');
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}}/course-mappings/:offeringId/:externalCourseId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId';
const options = {method: 'PUT'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/course-mappings/:offeringId/:externalCourseId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PUT"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId" in
Client.call `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PUT', '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId');
echo $response->getBody();setUrl('{{baseUrl}}/course-mappings/:offeringId/:externalCourseId');
$request->setMethod(HTTP_METH_PUT);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/course-mappings/:offeringId/:externalCourseId');
$request->setRequestMethod('PUT');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId' -Method PUT $response = Invoke-RestMethod -Uri '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId' -Method PUT import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("PUT", "/baseUrl/course-mappings/:offeringId/:externalCourseId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId"
response = requests.put(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId"
response <- VERB("PUT", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/course-mappings/:offeringId/:externalCourseId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.put('/baseUrl/course-mappings/:offeringId/:externalCourseId') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId";
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/course-mappings/:offeringId/:externalCourseIdhttp PUT {{baseUrl}}/course-mappings/:offeringId/:externalCourseIdwget --quiet \
--method PUT \
--output-document \
- {{baseUrl}}/course-mappings/:offeringId/:externalCourseIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PUT"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find course mappings by externalCourseId
{{baseUrl}}/course-mappings/externalcourse/:externalCourseId
QUERY PARAMS
externalCourseId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/course-mappings/externalcourse/:externalCourseId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/course-mappings/externalcourse/:externalCourseId")require "http/client"
url = "{{baseUrl}}/course-mappings/externalcourse/:externalCourseId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/course-mappings/externalcourse/:externalCourseId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/course-mappings/externalcourse/:externalCourseId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/course-mappings/externalcourse/:externalCourseId"
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/course-mappings/externalcourse/:externalCourseId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/course-mappings/externalcourse/:externalCourseId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/course-mappings/externalcourse/:externalCourseId"))
.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}}/course-mappings/externalcourse/:externalCourseId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/course-mappings/externalcourse/:externalCourseId")
.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}}/course-mappings/externalcourse/:externalCourseId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/course-mappings/externalcourse/:externalCourseId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/course-mappings/externalcourse/:externalCourseId';
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}}/course-mappings/externalcourse/:externalCourseId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/course-mappings/externalcourse/:externalCourseId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/course-mappings/externalcourse/:externalCourseId',
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}}/course-mappings/externalcourse/:externalCourseId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/course-mappings/externalcourse/:externalCourseId');
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}}/course-mappings/externalcourse/:externalCourseId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/course-mappings/externalcourse/:externalCourseId';
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}}/course-mappings/externalcourse/:externalCourseId"]
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}}/course-mappings/externalcourse/:externalCourseId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/course-mappings/externalcourse/:externalCourseId",
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}}/course-mappings/externalcourse/:externalCourseId');
echo $response->getBody();setUrl('{{baseUrl}}/course-mappings/externalcourse/:externalCourseId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/course-mappings/externalcourse/:externalCourseId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/course-mappings/externalcourse/:externalCourseId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/course-mappings/externalcourse/:externalCourseId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/course-mappings/externalcourse/:externalCourseId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/course-mappings/externalcourse/:externalCourseId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/course-mappings/externalcourse/:externalCourseId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/course-mappings/externalcourse/:externalCourseId")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/course-mappings/externalcourse/:externalCourseId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/course-mappings/externalcourse/:externalCourseId";
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}}/course-mappings/externalcourse/:externalCourseIdhttp GET {{baseUrl}}/course-mappings/externalcourse/:externalCourseIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/course-mappings/externalcourse/:externalCourseIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/course-mappings/externalcourse/:externalCourseId")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find course mappings by offeringId
{{baseUrl}}/course-mappings/:offeringId
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/course-mappings/:offeringId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/course-mappings/:offeringId")require "http/client"
url = "{{baseUrl}}/course-mappings/:offeringId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/course-mappings/:offeringId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/course-mappings/:offeringId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/course-mappings/:offeringId"
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/course-mappings/:offeringId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/course-mappings/:offeringId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/course-mappings/:offeringId"))
.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}}/course-mappings/:offeringId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/course-mappings/:offeringId")
.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}}/course-mappings/:offeringId');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/course-mappings/:offeringId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/course-mappings/:offeringId';
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}}/course-mappings/:offeringId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/course-mappings/:offeringId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/course-mappings/:offeringId',
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}}/course-mappings/:offeringId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/course-mappings/:offeringId');
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}}/course-mappings/:offeringId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/course-mappings/:offeringId';
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}}/course-mappings/:offeringId"]
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}}/course-mappings/:offeringId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/course-mappings/:offeringId",
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}}/course-mappings/:offeringId');
echo $response->getBody();setUrl('{{baseUrl}}/course-mappings/:offeringId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/course-mappings/:offeringId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/course-mappings/:offeringId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/course-mappings/:offeringId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/course-mappings/:offeringId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/course-mappings/:offeringId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/course-mappings/:offeringId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/course-mappings/:offeringId")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/course-mappings/:offeringId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/course-mappings/:offeringId";
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}}/course-mappings/:offeringIdhttp GET {{baseUrl}}/course-mappings/:offeringIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/course-mappings/:offeringIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/course-mappings/:offeringId")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find course mappings
{{baseUrl}}/course-mappings
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/course-mappings");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/course-mappings")require "http/client"
url = "{{baseUrl}}/course-mappings"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/course-mappings"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/course-mappings");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/course-mappings"
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/course-mappings HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/course-mappings")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/course-mappings"))
.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}}/course-mappings")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/course-mappings")
.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}}/course-mappings');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/course-mappings'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/course-mappings';
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}}/course-mappings',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/course-mappings")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/course-mappings',
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}}/course-mappings'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/course-mappings');
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}}/course-mappings'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/course-mappings';
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}}/course-mappings"]
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}}/course-mappings" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/course-mappings",
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}}/course-mappings');
echo $response->getBody();setUrl('{{baseUrl}}/course-mappings');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/course-mappings');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/course-mappings' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/course-mappings' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/course-mappings")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/course-mappings"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/course-mappings"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/course-mappings")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/course-mappings') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/course-mappings";
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}}/course-mappingshttp GET {{baseUrl}}/course-mappingswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/course-mappingsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/course-mappings")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}
DELETE
Remove course mapping
{{baseUrl}}/course-mappings/:offeringId/:externalCourseId
QUERY PARAMS
offeringId
externalCourseId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId")require "http/client"
url = "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/course-mappings/:offeringId/:externalCourseId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/course-mappings/:offeringId/:externalCourseId");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId"
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/course-mappings/:offeringId/:externalCourseId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/course-mappings/:offeringId/:externalCourseId"))
.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}}/course-mappings/:offeringId/:externalCourseId")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/course-mappings/:offeringId/:externalCourseId")
.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}}/course-mappings/:offeringId/:externalCourseId');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId';
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}}/course-mappings/:offeringId/:externalCourseId',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/course-mappings/:offeringId/:externalCourseId")
.delete(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/course-mappings/:offeringId/:externalCourseId',
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}}/course-mappings/:offeringId/:externalCourseId'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId');
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}}/course-mappings/:offeringId/:externalCourseId'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId';
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}}/course-mappings/:offeringId/:externalCourseId"]
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}}/course-mappings/:offeringId/:externalCourseId" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId",
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}}/course-mappings/:offeringId/:externalCourseId');
echo $response->getBody();setUrl('{{baseUrl}}/course-mappings/:offeringId/:externalCourseId');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/course-mappings/:offeringId/:externalCourseId');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/course-mappings/:offeringId/:externalCourseId' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/course-mappings/:offeringId/:externalCourseId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/course-mappings/:offeringId/:externalCourseId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/course-mappings/:offeringId/:externalCourseId') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId";
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}}/course-mappings/:offeringId/:externalCourseIdhttp DELETE {{baseUrl}}/course-mappings/:offeringId/:externalCourseIdwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/course-mappings/:offeringId/:externalCourseIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/course-mappings/:offeringId/:externalCourseId")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PUT
Update course category
{{baseUrl}}/courses/:contentId/metadata/category
QUERY PARAMS
contentId
BODY json
{
"category": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/courses/:contentId/metadata/category");
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 \"category\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/courses/:contentId/metadata/category" {:content-type :json
:form-params {:category ""}})require "http/client"
url = "{{baseUrl}}/courses/:contentId/metadata/category"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"category\": \"\"\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/courses/:contentId/metadata/category"),
Content = new StringContent("{\n \"category\": \"\"\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}}/courses/:contentId/metadata/category");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"category\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/courses/:contentId/metadata/category"
payload := strings.NewReader("{\n \"category\": \"\"\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/courses/:contentId/metadata/category HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 20
{
"category": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/courses/:contentId/metadata/category")
.setHeader("content-type", "application/json")
.setBody("{\n \"category\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/courses/:contentId/metadata/category"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"category\": \"\"\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 \"category\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/courses/:contentId/metadata/category")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/courses/:contentId/metadata/category")
.header("content-type", "application/json")
.body("{\n \"category\": \"\"\n}")
.asString(); const data = JSON.stringify({
category: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/courses/:contentId/metadata/category');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/courses/:contentId/metadata/category',
headers: {'content-type': 'application/json'},
data: {category: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/courses/:contentId/metadata/category';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"category":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/courses/:contentId/metadata/category',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "category": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"category\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/courses/:contentId/metadata/category")
.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/courses/:contentId/metadata/category',
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({category: ''}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/courses/:contentId/metadata/category',
headers: {'content-type': 'application/json'},
body: {category: ''},
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}}/courses/:contentId/metadata/category');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
category: ''
});
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}}/courses/:contentId/metadata/category',
headers: {'content-type': 'application/json'},
data: {category: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/courses/:contentId/metadata/category';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"category":""}'
};
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 = @{ @"category": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/courses/:contentId/metadata/category"]
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}}/courses/:contentId/metadata/category" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"category\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/courses/:contentId/metadata/category",
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([
'category' => ''
]),
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}}/courses/:contentId/metadata/category', [
'body' => '{
"category": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/courses/:contentId/metadata/category');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'category' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'category' => ''
]));
$request->setRequestUrl('{{baseUrl}}/courses/:contentId/metadata/category');
$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}}/courses/:contentId/metadata/category' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"category": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/courses/:contentId/metadata/category' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"category": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"category\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/courses/:contentId/metadata/category", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/courses/:contentId/metadata/category"
payload = { "category": "" }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/courses/:contentId/metadata/category"
payload <- "{\n \"category\": \"\"\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}}/courses/:contentId/metadata/category")
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 \"category\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/courses/:contentId/metadata/category') do |req|
req.body = "{\n \"category\": \"\"\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/courses/:contentId/metadata/category";
let payload = json!({"category": ""});
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}}/courses/:contentId/metadata/category \
--header 'content-type: application/json' \
--data '{
"category": ""
}'echo '{
"category": ""
}' | \
http PUT {{baseUrl}}/courses/:contentId/metadata/category \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "category": ""\n}' \
--output-document \
- {{baseUrl}}/courses/:contentId/metadata/categoryimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["category": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/courses/:contentId/metadata/category")! 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
{
"details": "should NOT have additional properties",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "should have required property 'example'",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PUT
Update course level
{{baseUrl}}/courses/:contentId/metadata/level
QUERY PARAMS
contentId
BODY json
{
"level": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/courses/:contentId/metadata/level");
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 \"level\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/courses/:contentId/metadata/level" {:content-type :json
:form-params {:level ""}})require "http/client"
url = "{{baseUrl}}/courses/:contentId/metadata/level"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"level\": \"\"\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/courses/:contentId/metadata/level"),
Content = new StringContent("{\n \"level\": \"\"\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}}/courses/:contentId/metadata/level");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"level\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/courses/:contentId/metadata/level"
payload := strings.NewReader("{\n \"level\": \"\"\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/courses/:contentId/metadata/level HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 17
{
"level": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/courses/:contentId/metadata/level")
.setHeader("content-type", "application/json")
.setBody("{\n \"level\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/courses/:contentId/metadata/level"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"level\": \"\"\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 \"level\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/courses/:contentId/metadata/level")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/courses/:contentId/metadata/level")
.header("content-type", "application/json")
.body("{\n \"level\": \"\"\n}")
.asString(); const data = JSON.stringify({
level: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/courses/:contentId/metadata/level');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/courses/:contentId/metadata/level',
headers: {'content-type': 'application/json'},
data: {level: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/courses/:contentId/metadata/level';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"level":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/courses/:contentId/metadata/level',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "level": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"level\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/courses/:contentId/metadata/level")
.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/courses/:contentId/metadata/level',
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({level: ''}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/courses/:contentId/metadata/level',
headers: {'content-type': 'application/json'},
body: {level: ''},
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}}/courses/:contentId/metadata/level');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
level: ''
});
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}}/courses/:contentId/metadata/level',
headers: {'content-type': 'application/json'},
data: {level: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/courses/:contentId/metadata/level';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"level":""}'
};
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 = @{ @"level": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/courses/:contentId/metadata/level"]
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}}/courses/:contentId/metadata/level" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"level\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/courses/:contentId/metadata/level",
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([
'level' => ''
]),
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}}/courses/:contentId/metadata/level', [
'body' => '{
"level": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/courses/:contentId/metadata/level');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'level' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'level' => ''
]));
$request->setRequestUrl('{{baseUrl}}/courses/:contentId/metadata/level');
$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}}/courses/:contentId/metadata/level' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"level": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/courses/:contentId/metadata/level' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"level": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"level\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/courses/:contentId/metadata/level", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/courses/:contentId/metadata/level"
payload = { "level": "" }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/courses/:contentId/metadata/level"
payload <- "{\n \"level\": \"\"\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}}/courses/:contentId/metadata/level")
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 \"level\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/courses/:contentId/metadata/level') do |req|
req.body = "{\n \"level\": \"\"\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/courses/:contentId/metadata/level";
let payload = json!({"level": ""});
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}}/courses/:contentId/metadata/level \
--header 'content-type: application/json' \
--data '{
"level": ""
}'echo '{
"level": ""
}' | \
http PUT {{baseUrl}}/courses/:contentId/metadata/level \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "level": ""\n}' \
--output-document \
- {{baseUrl}}/courses/:contentId/metadata/levelimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["level": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/courses/:contentId/metadata/level")! 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
{
"details": "should NOT have additional properties",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "should have required property 'example'",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PUT
Update course tags
{{baseUrl}}/courses/:contentId/metadata/tags
QUERY PARAMS
contentId
BODY json
{
"tags": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/courses/:contentId/metadata/tags");
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 \"tags\": []\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/courses/:contentId/metadata/tags" {:content-type :json
:form-params {:tags []}})require "http/client"
url = "{{baseUrl}}/courses/:contentId/metadata/tags"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"tags\": []\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/courses/:contentId/metadata/tags"),
Content = new StringContent("{\n \"tags\": []\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}}/courses/:contentId/metadata/tags");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"tags\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/courses/:contentId/metadata/tags"
payload := strings.NewReader("{\n \"tags\": []\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/courses/:contentId/metadata/tags HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 16
{
"tags": []
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/courses/:contentId/metadata/tags")
.setHeader("content-type", "application/json")
.setBody("{\n \"tags\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/courses/:contentId/metadata/tags"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"tags\": []\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 \"tags\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/courses/:contentId/metadata/tags")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/courses/:contentId/metadata/tags")
.header("content-type", "application/json")
.body("{\n \"tags\": []\n}")
.asString(); const data = JSON.stringify({
tags: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/courses/:contentId/metadata/tags');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/courses/:contentId/metadata/tags',
headers: {'content-type': 'application/json'},
data: {tags: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/courses/:contentId/metadata/tags';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"tags":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/courses/:contentId/metadata/tags',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "tags": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"tags\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/courses/:contentId/metadata/tags")
.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/courses/:contentId/metadata/tags',
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({tags: []}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/courses/:contentId/metadata/tags',
headers: {'content-type': 'application/json'},
body: {tags: []},
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}}/courses/:contentId/metadata/tags');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
tags: []
});
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}}/courses/:contentId/metadata/tags',
headers: {'content-type': 'application/json'},
data: {tags: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/courses/:contentId/metadata/tags';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"tags":[]}'
};
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 = @{ @"tags": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/courses/:contentId/metadata/tags"]
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}}/courses/:contentId/metadata/tags" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"tags\": []\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/courses/:contentId/metadata/tags",
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([
'tags' => [
]
]),
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}}/courses/:contentId/metadata/tags', [
'body' => '{
"tags": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/courses/:contentId/metadata/tags');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'tags' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'tags' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/courses/:contentId/metadata/tags');
$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}}/courses/:contentId/metadata/tags' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"tags": []
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/courses/:contentId/metadata/tags' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"tags": []
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"tags\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/courses/:contentId/metadata/tags", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/courses/:contentId/metadata/tags"
payload = { "tags": [] }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/courses/:contentId/metadata/tags"
payload <- "{\n \"tags\": []\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}}/courses/:contentId/metadata/tags")
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 \"tags\": []\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/courses/:contentId/metadata/tags') do |req|
req.body = "{\n \"tags\": []\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/courses/:contentId/metadata/tags";
let payload = json!({"tags": ()});
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}}/courses/:contentId/metadata/tags \
--header 'content-type: application/json' \
--data '{
"tags": []
}'echo '{
"tags": []
}' | \
http PUT {{baseUrl}}/courses/:contentId/metadata/tags \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "tags": []\n}' \
--output-document \
- {{baseUrl}}/courses/:contentId/metadata/tagsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["tags": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/courses/:contentId/metadata/tags")! 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
{
"details": "should NOT have additional properties",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "should have required property 'example'",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PUT
Update course topic
{{baseUrl}}/courses/:contentId/metadata/topic
QUERY PARAMS
contentId
BODY json
{
"topic": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/courses/:contentId/metadata/topic");
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 \"topic\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/courses/:contentId/metadata/topic" {:content-type :json
:form-params {:topic ""}})require "http/client"
url = "{{baseUrl}}/courses/:contentId/metadata/topic"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"topic\": \"\"\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/courses/:contentId/metadata/topic"),
Content = new StringContent("{\n \"topic\": \"\"\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}}/courses/:contentId/metadata/topic");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"topic\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/courses/:contentId/metadata/topic"
payload := strings.NewReader("{\n \"topic\": \"\"\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/courses/:contentId/metadata/topic HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 17
{
"topic": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/courses/:contentId/metadata/topic")
.setHeader("content-type", "application/json")
.setBody("{\n \"topic\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/courses/:contentId/metadata/topic"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"topic\": \"\"\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 \"topic\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/courses/:contentId/metadata/topic")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/courses/:contentId/metadata/topic")
.header("content-type", "application/json")
.body("{\n \"topic\": \"\"\n}")
.asString(); const data = JSON.stringify({
topic: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/courses/:contentId/metadata/topic');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/courses/:contentId/metadata/topic',
headers: {'content-type': 'application/json'},
data: {topic: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/courses/:contentId/metadata/topic';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"topic":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/courses/:contentId/metadata/topic',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "topic": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"topic\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/courses/:contentId/metadata/topic")
.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/courses/:contentId/metadata/topic',
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({topic: ''}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/courses/:contentId/metadata/topic',
headers: {'content-type': 'application/json'},
body: {topic: ''},
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}}/courses/:contentId/metadata/topic');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
topic: ''
});
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}}/courses/:contentId/metadata/topic',
headers: {'content-type': 'application/json'},
data: {topic: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/courses/:contentId/metadata/topic';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"topic":""}'
};
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 = @{ @"topic": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/courses/:contentId/metadata/topic"]
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}}/courses/:contentId/metadata/topic" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"topic\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/courses/:contentId/metadata/topic",
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([
'topic' => ''
]),
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}}/courses/:contentId/metadata/topic', [
'body' => '{
"topic": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/courses/:contentId/metadata/topic');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'topic' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'topic' => ''
]));
$request->setRequestUrl('{{baseUrl}}/courses/:contentId/metadata/topic');
$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}}/courses/:contentId/metadata/topic' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"topic": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/courses/:contentId/metadata/topic' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"topic": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"topic\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/courses/:contentId/metadata/topic", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/courses/:contentId/metadata/topic"
payload = { "topic": "" }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/courses/:contentId/metadata/topic"
payload <- "{\n \"topic\": \"\"\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}}/courses/:contentId/metadata/topic")
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 \"topic\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/courses/:contentId/metadata/topic') do |req|
req.body = "{\n \"topic\": \"\"\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/courses/:contentId/metadata/topic";
let payload = json!({"topic": ""});
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}}/courses/:contentId/metadata/topic \
--header 'content-type: application/json' \
--data '{
"topic": ""
}'echo '{
"topic": ""
}' | \
http PUT {{baseUrl}}/courses/:contentId/metadata/topic \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "topic": ""\n}' \
--output-document \
- {{baseUrl}}/courses/:contentId/metadata/topicimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["topic": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/courses/:contentId/metadata/topic")! 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
{
"details": "should NOT have additional properties",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "should have required property 'example'",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find activations for a contentId
{{baseUrl}}/courses/:contentId/activations
QUERY PARAMS
contentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/courses/:contentId/activations");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/courses/:contentId/activations")require "http/client"
url = "{{baseUrl}}/courses/:contentId/activations"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/courses/:contentId/activations"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/courses/:contentId/activations");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/courses/:contentId/activations"
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/courses/:contentId/activations HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/courses/:contentId/activations")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/courses/:contentId/activations"))
.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}}/courses/:contentId/activations")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/courses/:contentId/activations")
.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}}/courses/:contentId/activations');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/courses/:contentId/activations'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/courses/:contentId/activations';
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}}/courses/:contentId/activations',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/courses/:contentId/activations")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/courses/:contentId/activations',
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}}/courses/:contentId/activations'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/courses/:contentId/activations');
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}}/courses/:contentId/activations'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/courses/:contentId/activations';
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}}/courses/:contentId/activations"]
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}}/courses/:contentId/activations" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/courses/:contentId/activations",
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}}/courses/:contentId/activations');
echo $response->getBody();setUrl('{{baseUrl}}/courses/:contentId/activations');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/courses/:contentId/activations');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/courses/:contentId/activations' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/courses/:contentId/activations' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/courses/:contentId/activations")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/courses/:contentId/activations"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/courses/:contentId/activations"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/courses/:contentId/activations")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/courses/:contentId/activations') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/courses/:contentId/activations";
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}}/courses/:contentId/activationshttp GET {{baseUrl}}/courses/:contentId/activationswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/courses/:contentId/activationsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/courses/:contentId/activations")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find course by contentId
{{baseUrl}}/courses/:contentId
QUERY PARAMS
contentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/courses/:contentId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/courses/:contentId")require "http/client"
url = "{{baseUrl}}/courses/:contentId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/courses/:contentId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/courses/:contentId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/courses/:contentId"
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/courses/:contentId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/courses/:contentId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/courses/:contentId"))
.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}}/courses/:contentId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/courses/:contentId")
.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}}/courses/:contentId');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/courses/:contentId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/courses/:contentId';
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}}/courses/:contentId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/courses/:contentId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/courses/:contentId',
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}}/courses/:contentId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/courses/:contentId');
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}}/courses/:contentId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/courses/:contentId';
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}}/courses/:contentId"]
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}}/courses/:contentId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/courses/:contentId",
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}}/courses/:contentId');
echo $response->getBody();setUrl('{{baseUrl}}/courses/:contentId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/courses/:contentId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/courses/:contentId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/courses/:contentId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/courses/:contentId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/courses/:contentId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/courses/:contentId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/courses/:contentId")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/courses/:contentId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/courses/:contentId";
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}}/courses/:contentIdhttp GET {{baseUrl}}/courses/:contentIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/courses/:contentIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/courses/:contentId")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find courses
{{baseUrl}}/courses
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/courses");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/courses")require "http/client"
url = "{{baseUrl}}/courses"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/courses"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/courses");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/courses"
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/courses HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/courses")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/courses"))
.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}}/courses")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/courses")
.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}}/courses');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/courses'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/courses';
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}}/courses',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/courses")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/courses',
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}}/courses'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/courses');
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}}/courses'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/courses';
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}}/courses"]
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}}/courses" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/courses",
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}}/courses');
echo $response->getBody();setUrl('{{baseUrl}}/courses');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/courses');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/courses' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/courses' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/courses")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/courses"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/courses"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/courses")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/courses') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/courses";
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}}/courseshttp GET {{baseUrl}}/courseswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/coursesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/courses")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}
GET
Find users who have access to the contentId provided
{{baseUrl}}/courses/:contentId/permissions
QUERY PARAMS
contentId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/courses/:contentId/permissions");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/courses/:contentId/permissions")require "http/client"
url = "{{baseUrl}}/courses/:contentId/permissions"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/courses/:contentId/permissions"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/courses/:contentId/permissions");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/courses/:contentId/permissions"
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/courses/:contentId/permissions HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/courses/:contentId/permissions")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/courses/:contentId/permissions"))
.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}}/courses/:contentId/permissions")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/courses/:contentId/permissions")
.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}}/courses/:contentId/permissions');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/courses/:contentId/permissions'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/courses/:contentId/permissions';
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}}/courses/:contentId/permissions',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/courses/:contentId/permissions")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/courses/:contentId/permissions',
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}}/courses/:contentId/permissions'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/courses/:contentId/permissions');
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}}/courses/:contentId/permissions'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/courses/:contentId/permissions';
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}}/courses/:contentId/permissions"]
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}}/courses/:contentId/permissions" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/courses/:contentId/permissions",
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}}/courses/:contentId/permissions');
echo $response->getBody();setUrl('{{baseUrl}}/courses/:contentId/permissions');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/courses/:contentId/permissions');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/courses/:contentId/permissions' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/courses/:contentId/permissions' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/courses/:contentId/permissions")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/courses/:contentId/permissions"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/courses/:contentId/permissions"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/courses/:contentId/permissions")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/courses/:contentId/permissions') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/courses/:contentId/permissions";
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}}/courses/:contentId/permissionshttp GET {{baseUrl}}/courses/:contentId/permissionswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/courses/:contentId/permissionsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/courses/:contentId/permissions")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
POST
Update course access
{{baseUrl}}/courses/:rootContentId/permissions/:userEmail
QUERY PARAMS
rootContentId
userEmail
BODY json
{
"isBuilder": false,
"isReviewer": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/courses/:rootContentId/permissions/:userEmail");
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 \"isBuilder\": false,\n \"isReviewer\": false\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/courses/:rootContentId/permissions/:userEmail" {:content-type :json
:form-params {:isBuilder false
:isReviewer false}})require "http/client"
url = "{{baseUrl}}/courses/:rootContentId/permissions/:userEmail"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"isBuilder\": false,\n \"isReviewer\": false\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/courses/:rootContentId/permissions/:userEmail"),
Content = new StringContent("{\n \"isBuilder\": false,\n \"isReviewer\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/courses/:rootContentId/permissions/:userEmail");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"isBuilder\": false,\n \"isReviewer\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/courses/:rootContentId/permissions/:userEmail"
payload := strings.NewReader("{\n \"isBuilder\": false,\n \"isReviewer\": false\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/courses/:rootContentId/permissions/:userEmail HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 47
{
"isBuilder": false,
"isReviewer": false
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/courses/:rootContentId/permissions/:userEmail")
.setHeader("content-type", "application/json")
.setBody("{\n \"isBuilder\": false,\n \"isReviewer\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/courses/:rootContentId/permissions/:userEmail"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"isBuilder\": false,\n \"isReviewer\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"isBuilder\": false,\n \"isReviewer\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/courses/:rootContentId/permissions/:userEmail")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/courses/:rootContentId/permissions/:userEmail")
.header("content-type", "application/json")
.body("{\n \"isBuilder\": false,\n \"isReviewer\": false\n}")
.asString(); const data = JSON.stringify({
isBuilder: false,
isReviewer: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/courses/:rootContentId/permissions/:userEmail');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/courses/:rootContentId/permissions/:userEmail',
headers: {'content-type': 'application/json'},
data: {isBuilder: false, isReviewer: false}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/courses/:rootContentId/permissions/:userEmail';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"isBuilder":false,"isReviewer":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/courses/:rootContentId/permissions/:userEmail',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "isBuilder": false,\n "isReviewer": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"isBuilder\": false,\n \"isReviewer\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/courses/:rootContentId/permissions/:userEmail")
.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/courses/:rootContentId/permissions/:userEmail',
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({isBuilder: false, isReviewer: false}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/courses/:rootContentId/permissions/:userEmail',
headers: {'content-type': 'application/json'},
body: {isBuilder: false, isReviewer: false},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/courses/:rootContentId/permissions/:userEmail');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
isBuilder: false,
isReviewer: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/courses/:rootContentId/permissions/:userEmail',
headers: {'content-type': 'application/json'},
data: {isBuilder: false, isReviewer: false}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/courses/:rootContentId/permissions/:userEmail';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"isBuilder":false,"isReviewer":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"isBuilder": @NO,
@"isReviewer": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/courses/:rootContentId/permissions/:userEmail"]
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}}/courses/:rootContentId/permissions/:userEmail" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"isBuilder\": false,\n \"isReviewer\": false\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/courses/:rootContentId/permissions/:userEmail",
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([
'isBuilder' => null,
'isReviewer' => null
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/courses/:rootContentId/permissions/:userEmail', [
'body' => '{
"isBuilder": false,
"isReviewer": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/courses/:rootContentId/permissions/:userEmail');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'isBuilder' => null,
'isReviewer' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'isBuilder' => null,
'isReviewer' => null
]));
$request->setRequestUrl('{{baseUrl}}/courses/:rootContentId/permissions/:userEmail');
$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}}/courses/:rootContentId/permissions/:userEmail' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"isBuilder": false,
"isReviewer": false
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/courses/:rootContentId/permissions/:userEmail' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"isBuilder": false,
"isReviewer": false
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"isBuilder\": false,\n \"isReviewer\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/courses/:rootContentId/permissions/:userEmail", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/courses/:rootContentId/permissions/:userEmail"
payload = {
"isBuilder": False,
"isReviewer": False
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/courses/:rootContentId/permissions/:userEmail"
payload <- "{\n \"isBuilder\": false,\n \"isReviewer\": false\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}}/courses/:rootContentId/permissions/:userEmail")
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 \"isBuilder\": false,\n \"isReviewer\": false\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/courses/:rootContentId/permissions/:userEmail') do |req|
req.body = "{\n \"isBuilder\": false,\n \"isReviewer\": false\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/courses/:rootContentId/permissions/:userEmail";
let payload = json!({
"isBuilder": false,
"isReviewer": false
});
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}}/courses/:rootContentId/permissions/:userEmail \
--header 'content-type: application/json' \
--data '{
"isBuilder": false,
"isReviewer": false
}'echo '{
"isBuilder": false,
"isReviewer": false
}' | \
http POST {{baseUrl}}/courses/:rootContentId/permissions/:userEmail \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "isBuilder": false,\n "isReviewer": false\n}' \
--output-document \
- {{baseUrl}}/courses/:rootContentId/permissions/:userEmailimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"isBuilder": false,
"isReviewer": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/courses/:rootContentId/permissions/:userEmail")! 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
{
"details": "There are multiple permission with value true (isBuilder | isReviewer).",
"name": "ObjectIsNotError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The user john.doe@test.te is not a builder.",
"name": "ObjectIsNotError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "should have required property 'example'",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find learner progress in a specified offering
{{baseUrl}}/offerings/:offeringId/analytics/learners-progress
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/learners-progress");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/learners-progress")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/learners-progress"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/learners-progress"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/learners-progress");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/learners-progress"
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/offerings/:offeringId/analytics/learners-progress HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/learners-progress")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/learners-progress"))
.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}}/offerings/:offeringId/analytics/learners-progress")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/learners-progress")
.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}}/offerings/:offeringId/analytics/learners-progress');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/learners-progress'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/learners-progress';
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}}/offerings/:offeringId/analytics/learners-progress',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/learners-progress")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/learners-progress',
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}}/offerings/:offeringId/analytics/learners-progress'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/learners-progress');
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}}/offerings/:offeringId/analytics/learners-progress'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/learners-progress';
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}}/offerings/:offeringId/analytics/learners-progress"]
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}}/offerings/:offeringId/analytics/learners-progress" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/learners-progress",
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}}/offerings/:offeringId/analytics/learners-progress');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/learners-progress');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/learners-progress');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/learners-progress' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/learners-progress' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/learners-progress")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/learners-progress"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/learners-progress"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/learners-progress")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/learners-progress') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/learners-progress";
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}}/offerings/:offeringId/analytics/learners-progresshttp GET {{baseUrl}}/offerings/:offeringId/analytics/learners-progresswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/learners-progressimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/learners-progress")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find learner progress in all offerings
{{baseUrl}}/users/all/progress
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/all/progress");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users/all/progress")require "http/client"
url = "{{baseUrl}}/users/all/progress"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users/all/progress"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/users/all/progress");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/all/progress"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/users/all/progress HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users/all/progress")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/all/progress"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/users/all/progress")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/users/all/progress")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/users/all/progress');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/users/all/progress'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/users/all/progress';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/users/all/progress',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/all/progress")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/all/progress',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/users/all/progress'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users/all/progress');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/users/all/progress'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/all/progress';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/all/progress"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/users/all/progress" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/users/all/progress",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/users/all/progress');
echo $response->getBody();setUrl('{{baseUrl}}/users/all/progress');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/users/all/progress');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/all/progress' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/users/all/progress' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users/all/progress")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/users/all/progress"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/users/all/progress"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/all/progress")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users/all/progress') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/all/progress";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users/all/progresshttp GET {{baseUrl}}/users/all/progresswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users/all/progressimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/all/progress")! 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
{
"details": "invalid $filter parameter.",
"name": "ApiValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE Unknown query parameter 'example'",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}
GET
Find learner's progress in a specified offering
{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress
QUERY PARAMS
userEmail
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress")require "http/client"
url = "{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/users/:userEmail/offerings/:offeringId/progress HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:userEmail/offerings/:offeringId/progress',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'GET',
url: '{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'GET',
url: '{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress');
echo $response->getBody();setUrl('{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users/:userEmail/offerings/:offeringId/progress")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users/:userEmail/offerings/:offeringId/progress') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users/:userEmail/offerings/:offeringId/progresshttp GET {{baseUrl}}/users/:userEmail/offerings/:offeringId/progresswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users/:userEmail/offerings/:offeringId/progressimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:userEmail/offerings/:offeringId/progress")! 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
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The user john.doe@test.te is not a learner in the offering -MEF8kFyURUr6_CZ4IXD.",
"name": "UserNotInOfferingError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find learner's progress in offerings
{{baseUrl}}/users/:userEmail/progress
QUERY PARAMS
userEmail
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:userEmail/progress");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users/:userEmail/progress")require "http/client"
url = "{{baseUrl}}/users/:userEmail/progress"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users/:userEmail/progress"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/users/:userEmail/progress");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:userEmail/progress"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/users/:userEmail/progress HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users/:userEmail/progress")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:userEmail/progress"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:userEmail/progress")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/users/:userEmail/progress")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/users/:userEmail/progress');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/users/:userEmail/progress'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/users/:userEmail/progress';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/users/:userEmail/progress',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/:userEmail/progress")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:userEmail/progress',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/users/:userEmail/progress'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users/:userEmail/progress');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/users/:userEmail/progress'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:userEmail/progress';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:userEmail/progress"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/users/:userEmail/progress" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/users/:userEmail/progress",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/users/:userEmail/progress');
echo $response->getBody();setUrl('{{baseUrl}}/users/:userEmail/progress');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/users/:userEmail/progress');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:userEmail/progress' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:userEmail/progress' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users/:userEmail/progress")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/users/:userEmail/progress"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/users/:userEmail/progress"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:userEmail/progress")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users/:userEmail/progress') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:userEmail/progress";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users/:userEmail/progresshttp GET {{baseUrl}}/users/:userEmail/progresswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users/:userEmail/progressimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:userEmail/progress")! 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
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/social-notes");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/social-notes")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/social-notes"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/social-notes"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/social-notes");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/social-notes"
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/offerings/:offeringId/analytics/social-notes HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/social-notes")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/social-notes"))
.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}}/offerings/:offeringId/analytics/social-notes")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/social-notes")
.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}}/offerings/:offeringId/analytics/social-notes');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/social-notes'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/social-notes';
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}}/offerings/:offeringId/analytics/social-notes',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/social-notes")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/social-notes',
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}}/offerings/:offeringId/analytics/social-notes'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/social-notes');
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}}/offerings/:offeringId/analytics/social-notes'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/social-notes';
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}}/offerings/:offeringId/analytics/social-notes"]
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}}/offerings/:offeringId/analytics/social-notes" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/social-notes",
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}}/offerings/:offeringId/analytics/social-notes');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/social-notes');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/social-notes');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/social-notes' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/social-notes' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/social-notes")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/social-notes"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/social-notes"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/social-notes")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/social-notes') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/social-notes";
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}}/offerings/:offeringId/analytics/social-noteshttp GET {{baseUrl}}/offerings/:offeringId/analytics/social-noteswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/social-notesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/social-notes")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find unit reactions
{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions"
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/offerings/:offeringId/analytics/unit-reactions HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions"))
.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}}/offerings/:offeringId/analytics/unit-reactions")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions")
.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}}/offerings/:offeringId/analytics/unit-reactions');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions';
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}}/offerings/:offeringId/analytics/unit-reactions',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/unit-reactions',
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}}/offerings/:offeringId/analytics/unit-reactions'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions');
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}}/offerings/:offeringId/analytics/unit-reactions'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions';
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}}/offerings/:offeringId/analytics/unit-reactions"]
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}}/offerings/:offeringId/analytics/unit-reactions" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions",
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}}/offerings/:offeringId/analytics/unit-reactions');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/unit-reactions")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/unit-reactions') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions";
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}}/offerings/:offeringId/analytics/unit-reactionshttp GET {{baseUrl}}/offerings/:offeringId/analytics/unit-reactionswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/unit-reactionsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/unit-reactions")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
POST
Add learners to be marked by a coach
{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks
QUERY PARAMS
offeringId
markerEmail
BODY json
[
{}
]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "[\n {}\n]");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks" {:content-type :json
:form-params [{}]})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "[\n {}\n]"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"),
Content = new StringContent("[\n {}\n]")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "[\n {}\n]", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"
payload := strings.NewReader("[\n {}\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/offerings/:offeringId/users/:markerEmail/marks HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 8
[
{}
]AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")
.setHeader("content-type", "application/json")
.setBody("[\n {}\n]")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("[\n {}\n]"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[\n {}\n]");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")
.header("content-type", "application/json")
.body("[\n {}\n]")
.asString(); const data = JSON.stringify([
{}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '[{}]'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '[\n {}\n]'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "[\n {}\n]")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")
.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/offerings/:offeringId/users/:markerEmail/marks',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify([{}]));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks',
headers: {'content-type': 'application/json'},
body: [{}],
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send([
{}
]);
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '[{}]'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @[ @{ } ];
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"]
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}}/offerings/:offeringId/users/:markerEmail/marks" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "[\n {}\n]" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
]
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks', [
'body' => '[
{}
]',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
[
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
[
]
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks');
$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}}/offerings/:offeringId/users/:markerEmail/marks' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{}
]'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{}
]'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "[\n {}\n]"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/offerings/:offeringId/users/:markerEmail/marks", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"
payload = [{}]
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"
payload <- "[\n {}\n]"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "[\n {}\n]"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/offerings/:offeringId/users/:markerEmail/marks') do |req|
req.body = "[\n {}\n]"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks";
let payload = (json!({}));
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks \
--header 'content-type: application/json' \
--data '[
{}
]'echo '[
{}
]' | \
http POST {{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '[\n {}\n]' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/users/:markerEmail/marksimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [[]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")! 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
{
"details": "The user john.doe@test.te is not a builder.",
"name": "ObjectIsNotError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
POST
Adds user to the offering
{{baseUrl}}/offerings/:offeringId/users
QUERY PARAMS
offeringId
BODY json
[
{
"email": "",
"firstName": "",
"isFacilitator": false,
"isMarker": false,
"isReadonly": false,
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false,
"sendNotificationEmail": false
}
]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/users");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/offerings/:offeringId/users" {:content-type :json
:form-params [{:email ""
:firstName ""
:isFacilitator false
:isMarker false
:isReadonly false
:lastName ""
:metadata {:tags []}
:personId ""
:profile {:displayName ""}
:sendInvite false
:sendNotificationEmail false}]})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/users"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/users"),
Content = new StringContent("[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/users");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/users"
payload := strings.NewReader("[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/offerings/:offeringId/users HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 315
[
{
"email": "",
"firstName": "",
"isFacilitator": false,
"isMarker": false,
"isReadonly": false,
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false,
"sendNotificationEmail": false
}
]AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/offerings/:offeringId/users")
.setHeader("content-type", "application/json")
.setBody("[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/users"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/users")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/offerings/:offeringId/users")
.header("content-type", "application/json")
.body("[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]")
.asString(); const data = JSON.stringify([
{
email: '',
firstName: '',
isFacilitator: false,
isMarker: false,
isReadonly: false,
lastName: '',
metadata: {
tags: []
},
personId: '',
profile: {
displayName: ''
},
sendInvite: false,
sendNotificationEmail: false
}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/offerings/:offeringId/users');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/users',
headers: {'content-type': 'application/json'},
data: [
{
email: '',
firstName: '',
isFacilitator: false,
isMarker: false,
isReadonly: false,
lastName: '',
metadata: {tags: []},
personId: '',
profile: {displayName: ''},
sendInvite: false,
sendNotificationEmail: false
}
]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/users';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '[{"email":"","firstName":"","isFacilitator":false,"isMarker":false,"isReadonly":false,"lastName":"","metadata":{"tags":[]},"personId":"","profile":{"displayName":""},"sendInvite":false,"sendNotificationEmail":false}]'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/users',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '[\n {\n "email": "",\n "firstName": "",\n "isFacilitator": false,\n "isMarker": false,\n "isReadonly": false,\n "lastName": "",\n "metadata": {\n "tags": []\n },\n "personId": "",\n "profile": {\n "displayName": ""\n },\n "sendInvite": false,\n "sendNotificationEmail": false\n }\n]'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/users")
.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/offerings/:offeringId/users',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify([
{
email: '',
firstName: '',
isFacilitator: false,
isMarker: false,
isReadonly: false,
lastName: '',
metadata: {tags: []},
personId: '',
profile: {displayName: ''},
sendInvite: false,
sendNotificationEmail: false
}
]));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/users',
headers: {'content-type': 'application/json'},
body: [
{
email: '',
firstName: '',
isFacilitator: false,
isMarker: false,
isReadonly: false,
lastName: '',
metadata: {tags: []},
personId: '',
profile: {displayName: ''},
sendInvite: false,
sendNotificationEmail: false
}
],
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/offerings/:offeringId/users');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send([
{
email: '',
firstName: '',
isFacilitator: false,
isMarker: false,
isReadonly: false,
lastName: '',
metadata: {
tags: []
},
personId: '',
profile: {
displayName: ''
},
sendInvite: false,
sendNotificationEmail: false
}
]);
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings/:offeringId/users',
headers: {'content-type': 'application/json'},
data: [
{
email: '',
firstName: '',
isFacilitator: false,
isMarker: false,
isReadonly: false,
lastName: '',
metadata: {tags: []},
personId: '',
profile: {displayName: ''},
sendInvite: false,
sendNotificationEmail: false
}
]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/users';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '[{"email":"","firstName":"","isFacilitator":false,"isMarker":false,"isReadonly":false,"lastName":"","metadata":{"tags":[]},"personId":"","profile":{"displayName":""},"sendInvite":false,"sendNotificationEmail":false}]'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @[ @{ @"email": @"", @"firstName": @"", @"isFacilitator": @NO, @"isMarker": @NO, @"isReadonly": @NO, @"lastName": @"", @"metadata": @{ @"tags": @[ ] }, @"personId": @"", @"profile": @{ @"displayName": @"" }, @"sendInvite": @NO, @"sendNotificationEmail": @NO } ];
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/users"]
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}}/offerings/:offeringId/users" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
'email' => '',
'firstName' => '',
'isFacilitator' => null,
'isMarker' => null,
'isReadonly' => null,
'lastName' => '',
'metadata' => [
'tags' => [
]
],
'personId' => '',
'profile' => [
'displayName' => ''
],
'sendInvite' => null,
'sendNotificationEmail' => null
]
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/offerings/:offeringId/users', [
'body' => '[
{
"email": "",
"firstName": "",
"isFacilitator": false,
"isMarker": false,
"isReadonly": false,
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false,
"sendNotificationEmail": false
}
]',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/users');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
[
'email' => '',
'firstName' => '',
'isFacilitator' => null,
'isMarker' => null,
'isReadonly' => null,
'lastName' => '',
'metadata' => [
'tags' => [
]
],
'personId' => '',
'profile' => [
'displayName' => ''
],
'sendInvite' => null,
'sendNotificationEmail' => null
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
[
'email' => '',
'firstName' => '',
'isFacilitator' => null,
'isMarker' => null,
'isReadonly' => null,
'lastName' => '',
'metadata' => [
'tags' => [
]
],
'personId' => '',
'profile' => [
'displayName' => ''
],
'sendInvite' => null,
'sendNotificationEmail' => null
]
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/users');
$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}}/offerings/:offeringId/users' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{
"email": "",
"firstName": "",
"isFacilitator": false,
"isMarker": false,
"isReadonly": false,
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false,
"sendNotificationEmail": false
}
]'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/users' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{
"email": "",
"firstName": "",
"isFacilitator": false,
"isMarker": false,
"isReadonly": false,
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false,
"sendNotificationEmail": false
}
]'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/offerings/:offeringId/users", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/users"
payload = [
{
"email": "",
"firstName": "",
"isFacilitator": False,
"isMarker": False,
"isReadonly": False,
"lastName": "",
"metadata": { "tags": [] },
"personId": "",
"profile": { "displayName": "" },
"sendInvite": False,
"sendNotificationEmail": False
}
]
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/users"
payload <- "[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/offerings/:offeringId/users') do |req|
req.body = "[\n {\n \"email\": \"\",\n \"firstName\": \"\",\n \"isFacilitator\": false,\n \"isMarker\": false,\n \"isReadonly\": false,\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false,\n \"sendNotificationEmail\": false\n }\n]"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/users";
let payload = (
json!({
"email": "",
"firstName": "",
"isFacilitator": false,
"isMarker": false,
"isReadonly": false,
"lastName": "",
"metadata": json!({"tags": ()}),
"personId": "",
"profile": json!({"displayName": ""}),
"sendInvite": false,
"sendNotificationEmail": false
})
);
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}}/offerings/:offeringId/users \
--header 'content-type: application/json' \
--data '[
{
"email": "",
"firstName": "",
"isFacilitator": false,
"isMarker": false,
"isReadonly": false,
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false,
"sendNotificationEmail": false
}
]'echo '[
{
"email": "",
"firstName": "",
"isFacilitator": false,
"isMarker": false,
"isReadonly": false,
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false,
"sendNotificationEmail": false
}
]' | \
http POST {{baseUrl}}/offerings/:offeringId/users \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '[\n {\n "email": "",\n "firstName": "",\n "isFacilitator": false,\n "isMarker": false,\n "isReadonly": false,\n "lastName": "",\n "metadata": {\n "tags": []\n },\n "personId": "",\n "profile": {\n "displayName": ""\n },\n "sendInvite": false,\n "sendNotificationEmail": false\n }\n]' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/usersimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
[
"email": "",
"firstName": "",
"isFacilitator": false,
"isMarker": false,
"isReadonly": false,
"lastName": "",
"metadata": ["tags": []],
"personId": "",
"profile": ["displayName": ""],
"sendInvite": false,
"sendNotificationEmail": false
]
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/users")! 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
{
"details": "invalid $filter parameter.",
"name": "ApiValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The badge already exists in the offering OFFERING ID.",
"name": "ObjectExistsError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "should have required property 'example'",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find Learners marked by a coach
{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks
QUERY PARAMS
offeringId
markerEmail
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"
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/offerings/:offeringId/users/:markerEmail/marks HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"))
.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}}/offerings/:offeringId/users/:markerEmail/marks")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")
.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}}/offerings/:offeringId/users/:markerEmail/marks');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks';
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}}/offerings/:offeringId/users/:markerEmail/marks',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/users/:markerEmail/marks',
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}}/offerings/:offeringId/users/:markerEmail/marks'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks');
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}}/offerings/:offeringId/users/:markerEmail/marks'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks';
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}}/offerings/:offeringId/users/:markerEmail/marks"]
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}}/offerings/:offeringId/users/:markerEmail/marks" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks",
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}}/offerings/:offeringId/users/:markerEmail/marks');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/users/:markerEmail/marks")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/users/:markerEmail/marks') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks";
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}}/offerings/:offeringId/users/:markerEmail/markshttp GET {{baseUrl}}/offerings/:offeringId/users/:markerEmail/markswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/users/:markerEmail/marksimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find offering's users
{{baseUrl}}/offerings/:offeringId/users
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/users");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/users")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/users"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/users"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/users");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/users"
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/offerings/:offeringId/users HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/users")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/users"))
.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}}/offerings/:offeringId/users")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/users")
.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}}/offerings/:offeringId/users');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/offerings/:offeringId/users'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/users';
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}}/offerings/:offeringId/users',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/users")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/users',
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}}/offerings/:offeringId/users'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/users');
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}}/offerings/:offeringId/users'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/users';
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}}/offerings/:offeringId/users"]
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}}/offerings/:offeringId/users" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/users",
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}}/offerings/:offeringId/users');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/users');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/users');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/users' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/users' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/users")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/users"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/users"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/users")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/users') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/users";
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}}/offerings/:offeringId/usershttp GET {{baseUrl}}/offerings/:offeringId/userswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/usersimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/users")! 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
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be equal to one of the allowed values a, b",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
DELETE
Remove learners from coach's marking list
{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks
QUERY PARAMS
offeringId
markerEmail
BODY json
[
{}
]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "[\n {}\n]");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks" {:content-type :json
:form-params [{}]})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "[\n {}\n]"
response = HTTP::Client.delete url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"),
Content = new StringContent("[\n {}\n]")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks");
var request = new RestRequest("", Method.Delete);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "[\n {}\n]", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"
payload := strings.NewReader("[\n {}\n]")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}DELETE /baseUrl/offerings/:offeringId/users/:markerEmail/marks HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 8
[
{}
]AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")
.setHeader("content-type", "application/json")
.setBody("[\n {}\n]")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"))
.header("content-type", "application/json")
.method("DELETE", HttpRequest.BodyPublishers.ofString("[\n {}\n]"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[\n {}\n]");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")
.delete(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")
.header("content-type", "application/json")
.body("[\n {}\n]")
.asString(); const data = JSON.stringify([
{}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('DELETE', '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks';
const options = {method: 'DELETE', headers: {'content-type': 'application/json'}, body: '[{}]'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks',
method: 'DELETE',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '[\n {}\n]'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "[\n {}\n]")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")
.delete(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/users/:markerEmail/marks',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify([{}]));
req.end();const request = require('request');
const options = {
method: 'DELETE',
url: '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks',
headers: {'content-type': 'application/json'},
body: [{}],
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send([
{}
]);
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'DELETE',
url: '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks';
const options = {method: 'DELETE', headers: {'content-type': 'application/json'}, body: '[{}]'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @[ @{ } ];
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"DELETE"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "[\n {}\n]" in
Client.call ~headers ~body `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
[
]
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('DELETE', '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks', [
'body' => '[
{}
]',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks');
$request->setMethod(HTTP_METH_DELETE);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
[
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
[
]
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks');
$request->setRequestMethod('DELETE');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks' -Method DELETE -Headers $headers -ContentType 'application/json' -Body '[
{}
]'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks' -Method DELETE -Headers $headers -ContentType 'application/json' -Body '[
{}
]'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "[\n {}\n]"
headers = { 'content-type': "application/json" }
conn.request("DELETE", "/baseUrl/offerings/:offeringId/users/:markerEmail/marks", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"
payload = [{}]
headers = {"content-type": "application/json"}
response = requests.delete(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks"
payload <- "[\n {}\n]"
encode <- "json"
response <- VERB("DELETE", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["content-type"] = 'application/json'
request.body = "[\n {}\n]"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.delete('/baseUrl/offerings/:offeringId/users/:markerEmail/marks') do |req|
req.body = "[\n {}\n]"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks";
let payload = (json!({}));
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("DELETE").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request DELETE \
--url {{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks \
--header 'content-type: application/json' \
--data '[
{}
]'echo '[
{}
]' | \
http DELETE {{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks \
content-type:application/jsonwget --quiet \
--method DELETE \
--header 'content-type: application/json' \
--body-data '[\n {}\n]' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/users/:markerEmail/marksimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [[]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/users/:markerEmail/marks")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "DELETE"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The user john.doe@test.te is not a builder.",
"name": "ObjectIsNotError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
DELETE
Removes user from the offering
{{baseUrl}}/offerings/:offeringId/users/:userEmail
QUERY PARAMS
offeringId
userEmail
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/users/:userEmail");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/delete "{{baseUrl}}/offerings/:offeringId/users/:userEmail")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/users/:userEmail"
response = HTTP::Client.delete url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Delete,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/users/:userEmail"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/users/:userEmail");
var request = new RestRequest("", Method.Delete);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/users/:userEmail"
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/offerings/:offeringId/users/:userEmail HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "{{baseUrl}}/offerings/:offeringId/users/:userEmail")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/users/:userEmail"))
.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}}/offerings/:offeringId/users/:userEmail")
.delete(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.delete("{{baseUrl}}/offerings/:offeringId/users/:userEmail")
.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}}/offerings/:offeringId/users/:userEmail');
xhr.send(data);import axios from 'axios';
const options = {
method: 'DELETE',
url: '{{baseUrl}}/offerings/:offeringId/users/:userEmail'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/users/:userEmail';
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}}/offerings/:offeringId/users/:userEmail',
method: 'DELETE',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/users/:userEmail")
.delete(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'DELETE',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/users/:userEmail',
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}}/offerings/:offeringId/users/:userEmail'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('DELETE', '{{baseUrl}}/offerings/:offeringId/users/:userEmail');
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}}/offerings/:offeringId/users/:userEmail'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/users/:userEmail';
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}}/offerings/:offeringId/users/:userEmail"]
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}}/offerings/:offeringId/users/:userEmail" in
Client.call `DELETE uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/users/:userEmail",
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}}/offerings/:offeringId/users/:userEmail');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/users/:userEmail');
$request->setMethod(HTTP_METH_DELETE);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/users/:userEmail');
$request->setRequestMethod('DELETE');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/users/:userEmail' -Method DELETE $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/users/:userEmail' -Method DELETE import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("DELETE", "/baseUrl/offerings/:offeringId/users/:userEmail")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/users/:userEmail"
response = requests.delete(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/users/:userEmail"
response <- VERB("DELETE", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/users/:userEmail")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.delete('/baseUrl/offerings/:offeringId/users/:userEmail') do |req|
end
puts response.status
puts response.bodyuse std::str::FromStr;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/users/:userEmail";
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}}/offerings/:offeringId/users/:userEmailhttp DELETE {{baseUrl}}/offerings/:offeringId/users/:userEmailwget --quiet \
--method DELETE \
--output-document \
- {{baseUrl}}/offerings/:offeringId/users/:userEmailimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/users/:userEmail")! 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
{
"details": "invalid $filter parameter.",
"name": "ApiValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PATCH
Transfer a user between offerings
{{baseUrl}}/users/:userEmail/transfer
QUERY PARAMS
userEmail
BODY json
{
"fromOfferingId": "",
"sendInvite": false,
"toOfferingId": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:userEmail/transfer");
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 \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/users/:userEmail/transfer" {:content-type :json
:form-params {:fromOfferingId ""
:sendInvite false
:toOfferingId ""}})require "http/client"
url = "{{baseUrl}}/users/:userEmail/transfer"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/users/:userEmail/transfer"),
Content = new StringContent("{\n \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/users/:userEmail/transfer");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:userEmail/transfer"
payload := strings.NewReader("{\n \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PATCH /baseUrl/users/:userEmail/transfer HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 71
{
"fromOfferingId": "",
"sendInvite": false,
"toOfferingId": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/users/:userEmail/transfer")
.setHeader("content-type", "application/json")
.setBody("{\n \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:userEmail/transfer"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\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 \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:userEmail/transfer")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.patch("{{baseUrl}}/users/:userEmail/transfer")
.header("content-type", "application/json")
.body("{\n \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\n}")
.asString(); const data = JSON.stringify({
fromOfferingId: '',
sendInvite: false,
toOfferingId: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/users/:userEmail/transfer');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/users/:userEmail/transfer',
headers: {'content-type': 'application/json'},
data: {fromOfferingId: '', sendInvite: false, toOfferingId: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/users/:userEmail/transfer';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"fromOfferingId":"","sendInvite":false,"toOfferingId":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/users/:userEmail/transfer',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "fromOfferingId": "",\n "sendInvite": false,\n "toOfferingId": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/users/:userEmail/transfer")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:userEmail/transfer',
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({fromOfferingId: '', sendInvite: false, toOfferingId: ''}));
req.end();const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/users/:userEmail/transfer',
headers: {'content-type': 'application/json'},
body: {fromOfferingId: '', sendInvite: false, toOfferingId: ''},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/users/:userEmail/transfer');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
fromOfferingId: '',
sendInvite: false,
toOfferingId: ''
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/users/:userEmail/transfer',
headers: {'content-type': 'application/json'},
data: {fromOfferingId: '', sendInvite: false, toOfferingId: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:userEmail/transfer';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"fromOfferingId":"","sendInvite":false,"toOfferingId":""}'
};
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 = @{ @"fromOfferingId": @"",
@"sendInvite": @NO,
@"toOfferingId": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:userEmail/transfer"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/users/:userEmail/transfer" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/users/:userEmail/transfer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'fromOfferingId' => '',
'sendInvite' => null,
'toOfferingId' => ''
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PATCH', '{{baseUrl}}/users/:userEmail/transfer', [
'body' => '{
"fromOfferingId": "",
"sendInvite": false,
"toOfferingId": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/users/:userEmail/transfer');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'fromOfferingId' => '',
'sendInvite' => null,
'toOfferingId' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'fromOfferingId' => '',
'sendInvite' => null,
'toOfferingId' => ''
]));
$request->setRequestUrl('{{baseUrl}}/users/:userEmail/transfer');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:userEmail/transfer' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"fromOfferingId": "",
"sendInvite": false,
"toOfferingId": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:userEmail/transfer' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"fromOfferingId": "",
"sendInvite": false,
"toOfferingId": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/users/:userEmail/transfer", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/users/:userEmail/transfer"
payload = {
"fromOfferingId": "",
"sendInvite": False,
"toOfferingId": ""
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/users/:userEmail/transfer"
payload <- "{\n \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:userEmail/transfer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/users/:userEmail/transfer') do |req|
req.body = "{\n \"fromOfferingId\": \"\",\n \"sendInvite\": false,\n \"toOfferingId\": \"\"\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:userEmail/transfer";
let payload = json!({
"fromOfferingId": "",
"sendInvite": false,
"toOfferingId": ""
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/users/:userEmail/transfer \
--header 'content-type: application/json' \
--data '{
"fromOfferingId": "",
"sendInvite": false,
"toOfferingId": ""
}'echo '{
"fromOfferingId": "",
"sendInvite": false,
"toOfferingId": ""
}' | \
http PATCH {{baseUrl}}/users/:userEmail/transfer \
content-type:application/jsonwget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "fromOfferingId": "",\n "sendInvite": false,\n "toOfferingId": ""\n}' \
--output-document \
- {{baseUrl}}/users/:userEmail/transferimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"fromOfferingId": "",
"sendInvite": false,
"toOfferingId": ""
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:userEmail/transfer")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "contentId needs to be the same in order to perform the requested operation.",
"name": "ContentDoNotMatchError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "Source and target offerings cannot be the same.",
"name": "InvalidSourceAndTargetError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PUT
Update offering category metadata
{{baseUrl}}/offerings/:offeringId/metadata/category
QUERY PARAMS
offeringId
BODY json
{
"category": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/metadata/category");
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 \"category\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/offerings/:offeringId/metadata/category" {:content-type :json
:form-params {:category ""}})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/metadata/category"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"category\": \"\"\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/metadata/category"),
Content = new StringContent("{\n \"category\": \"\"\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}}/offerings/:offeringId/metadata/category");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"category\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/metadata/category"
payload := strings.NewReader("{\n \"category\": \"\"\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/offerings/:offeringId/metadata/category HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 20
{
"category": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/offerings/:offeringId/metadata/category")
.setHeader("content-type", "application/json")
.setBody("{\n \"category\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/metadata/category"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"category\": \"\"\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 \"category\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/metadata/category")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/offerings/:offeringId/metadata/category")
.header("content-type", "application/json")
.body("{\n \"category\": \"\"\n}")
.asString(); const data = JSON.stringify({
category: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/offerings/:offeringId/metadata/category');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/offerings/:offeringId/metadata/category',
headers: {'content-type': 'application/json'},
data: {category: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/metadata/category';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"category":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/metadata/category',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "category": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"category\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/metadata/category")
.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/offerings/:offeringId/metadata/category',
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({category: ''}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/offerings/:offeringId/metadata/category',
headers: {'content-type': 'application/json'},
body: {category: ''},
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}}/offerings/:offeringId/metadata/category');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
category: ''
});
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}}/offerings/:offeringId/metadata/category',
headers: {'content-type': 'application/json'},
data: {category: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/metadata/category';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"category":""}'
};
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 = @{ @"category": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/metadata/category"]
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}}/offerings/:offeringId/metadata/category" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"category\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/metadata/category",
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([
'category' => ''
]),
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}}/offerings/:offeringId/metadata/category', [
'body' => '{
"category": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/metadata/category');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'category' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'category' => ''
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/metadata/category');
$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}}/offerings/:offeringId/metadata/category' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"category": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/metadata/category' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"category": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"category\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/offerings/:offeringId/metadata/category", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/metadata/category"
payload = { "category": "" }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/metadata/category"
payload <- "{\n \"category\": \"\"\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}}/offerings/:offeringId/metadata/category")
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 \"category\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/offerings/:offeringId/metadata/category') do |req|
req.body = "{\n \"category\": \"\"\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/metadata/category";
let payload = json!({"category": ""});
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}}/offerings/:offeringId/metadata/category \
--header 'content-type: application/json' \
--data '{
"category": ""
}'echo '{
"category": ""
}' | \
http PUT {{baseUrl}}/offerings/:offeringId/metadata/category \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "category": ""\n}' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/metadata/categoryimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["category": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/metadata/category")! 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
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PUT
Update offering level metadata
{{baseUrl}}/offerings/:offeringId/metadata/level
QUERY PARAMS
offeringId
BODY json
{
"level": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/metadata/level");
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 \"level\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/offerings/:offeringId/metadata/level" {:content-type :json
:form-params {:level ""}})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/metadata/level"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"level\": \"\"\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/metadata/level"),
Content = new StringContent("{\n \"level\": \"\"\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}}/offerings/:offeringId/metadata/level");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"level\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/metadata/level"
payload := strings.NewReader("{\n \"level\": \"\"\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/offerings/:offeringId/metadata/level HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 17
{
"level": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/offerings/:offeringId/metadata/level")
.setHeader("content-type", "application/json")
.setBody("{\n \"level\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/metadata/level"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"level\": \"\"\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 \"level\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/metadata/level")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/offerings/:offeringId/metadata/level")
.header("content-type", "application/json")
.body("{\n \"level\": \"\"\n}")
.asString(); const data = JSON.stringify({
level: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/offerings/:offeringId/metadata/level');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/offerings/:offeringId/metadata/level',
headers: {'content-type': 'application/json'},
data: {level: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/metadata/level';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"level":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/metadata/level',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "level": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"level\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/metadata/level")
.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/offerings/:offeringId/metadata/level',
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({level: ''}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/offerings/:offeringId/metadata/level',
headers: {'content-type': 'application/json'},
body: {level: ''},
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}}/offerings/:offeringId/metadata/level');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
level: ''
});
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}}/offerings/:offeringId/metadata/level',
headers: {'content-type': 'application/json'},
data: {level: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/metadata/level';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"level":""}'
};
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 = @{ @"level": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/metadata/level"]
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}}/offerings/:offeringId/metadata/level" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"level\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/metadata/level",
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([
'level' => ''
]),
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}}/offerings/:offeringId/metadata/level', [
'body' => '{
"level": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/metadata/level');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'level' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'level' => ''
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/metadata/level');
$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}}/offerings/:offeringId/metadata/level' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"level": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/metadata/level' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"level": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"level\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/offerings/:offeringId/metadata/level", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/metadata/level"
payload = { "level": "" }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/metadata/level"
payload <- "{\n \"level\": \"\"\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}}/offerings/:offeringId/metadata/level")
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 \"level\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/offerings/:offeringId/metadata/level') do |req|
req.body = "{\n \"level\": \"\"\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/metadata/level";
let payload = json!({"level": ""});
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}}/offerings/:offeringId/metadata/level \
--header 'content-type: application/json' \
--data '{
"level": ""
}'echo '{
"level": ""
}' | \
http PUT {{baseUrl}}/offerings/:offeringId/metadata/level \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "level": ""\n}' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/metadata/levelimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["level": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/metadata/level")! 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
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PUT
Update offering tags metadata
{{baseUrl}}/offerings/:offeringId/metadata/tags
QUERY PARAMS
offeringId
BODY json
{
"tags": []
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/metadata/tags");
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 \"tags\": []\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/offerings/:offeringId/metadata/tags" {:content-type :json
:form-params {:tags []}})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/metadata/tags"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"tags\": []\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/metadata/tags"),
Content = new StringContent("{\n \"tags\": []\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}}/offerings/:offeringId/metadata/tags");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"tags\": []\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/metadata/tags"
payload := strings.NewReader("{\n \"tags\": []\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/offerings/:offeringId/metadata/tags HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 16
{
"tags": []
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/offerings/:offeringId/metadata/tags")
.setHeader("content-type", "application/json")
.setBody("{\n \"tags\": []\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/metadata/tags"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"tags\": []\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 \"tags\": []\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/metadata/tags")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/offerings/:offeringId/metadata/tags")
.header("content-type", "application/json")
.body("{\n \"tags\": []\n}")
.asString(); const data = JSON.stringify({
tags: []
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/offerings/:offeringId/metadata/tags');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/offerings/:offeringId/metadata/tags',
headers: {'content-type': 'application/json'},
data: {tags: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/metadata/tags';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"tags":[]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/metadata/tags',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "tags": []\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"tags\": []\n}")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/metadata/tags")
.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/offerings/:offeringId/metadata/tags',
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({tags: []}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/offerings/:offeringId/metadata/tags',
headers: {'content-type': 'application/json'},
body: {tags: []},
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}}/offerings/:offeringId/metadata/tags');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
tags: []
});
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}}/offerings/:offeringId/metadata/tags',
headers: {'content-type': 'application/json'},
data: {tags: []}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/metadata/tags';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"tags":[]}'
};
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 = @{ @"tags": @[ ] };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/metadata/tags"]
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}}/offerings/:offeringId/metadata/tags" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"tags\": []\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/metadata/tags",
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([
'tags' => [
]
]),
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}}/offerings/:offeringId/metadata/tags', [
'body' => '{
"tags": []
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/metadata/tags');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'tags' => [
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'tags' => [
]
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/metadata/tags');
$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}}/offerings/:offeringId/metadata/tags' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"tags": []
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/metadata/tags' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"tags": []
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"tags\": []\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/offerings/:offeringId/metadata/tags", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/metadata/tags"
payload = { "tags": [] }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/metadata/tags"
payload <- "{\n \"tags\": []\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}}/offerings/:offeringId/metadata/tags")
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 \"tags\": []\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/offerings/:offeringId/metadata/tags') do |req|
req.body = "{\n \"tags\": []\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/metadata/tags";
let payload = json!({"tags": ()});
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}}/offerings/:offeringId/metadata/tags \
--header 'content-type: application/json' \
--data '{
"tags": []
}'echo '{
"tags": []
}' | \
http PUT {{baseUrl}}/offerings/:offeringId/metadata/tags \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "tags": []\n}' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/metadata/tagsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["tags": []] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/metadata/tags")! 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
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PUT
Update offering topic metadata
{{baseUrl}}/offerings/:offeringId/metadata/topic
QUERY PARAMS
offeringId
BODY json
{
"topic": ""
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/metadata/topic");
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 \"topic\": \"\"\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/offerings/:offeringId/metadata/topic" {:content-type :json
:form-params {:topic ""}})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/metadata/topic"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"topic\": \"\"\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/metadata/topic"),
Content = new StringContent("{\n \"topic\": \"\"\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}}/offerings/:offeringId/metadata/topic");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"topic\": \"\"\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/metadata/topic"
payload := strings.NewReader("{\n \"topic\": \"\"\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/offerings/:offeringId/metadata/topic HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 17
{
"topic": ""
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/offerings/:offeringId/metadata/topic")
.setHeader("content-type", "application/json")
.setBody("{\n \"topic\": \"\"\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/metadata/topic"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"topic\": \"\"\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 \"topic\": \"\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/metadata/topic")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/offerings/:offeringId/metadata/topic")
.header("content-type", "application/json")
.body("{\n \"topic\": \"\"\n}")
.asString(); const data = JSON.stringify({
topic: ''
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/offerings/:offeringId/metadata/topic');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/offerings/:offeringId/metadata/topic',
headers: {'content-type': 'application/json'},
data: {topic: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/metadata/topic';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"topic":""}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId/metadata/topic',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "topic": ""\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"topic\": \"\"\n}")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/metadata/topic")
.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/offerings/:offeringId/metadata/topic',
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({topic: ''}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/offerings/:offeringId/metadata/topic',
headers: {'content-type': 'application/json'},
body: {topic: ''},
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}}/offerings/:offeringId/metadata/topic');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
topic: ''
});
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}}/offerings/:offeringId/metadata/topic',
headers: {'content-type': 'application/json'},
data: {topic: ''}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/metadata/topic';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"topic":""}'
};
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 = @{ @"topic": @"" };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId/metadata/topic"]
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}}/offerings/:offeringId/metadata/topic" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"topic\": \"\"\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/metadata/topic",
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([
'topic' => ''
]),
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}}/offerings/:offeringId/metadata/topic', [
'body' => '{
"topic": ""
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/metadata/topic');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'topic' => ''
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'topic' => ''
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId/metadata/topic');
$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}}/offerings/:offeringId/metadata/topic' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"topic": ""
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/metadata/topic' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"topic": ""
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"topic\": \"\"\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/offerings/:offeringId/metadata/topic", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/metadata/topic"
payload = { "topic": "" }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/metadata/topic"
payload <- "{\n \"topic\": \"\"\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}}/offerings/:offeringId/metadata/topic")
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 \"topic\": \"\"\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/offerings/:offeringId/metadata/topic') do |req|
req.body = "{\n \"topic\": \"\"\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/metadata/topic";
let payload = json!({"topic": ""});
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}}/offerings/:offeringId/metadata/topic \
--header 'content-type: application/json' \
--data '{
"topic": ""
}'echo '{
"topic": ""
}' | \
http PUT {{baseUrl}}/offerings/:offeringId/metadata/topic \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "topic": ""\n}' \
--output-document \
- {{baseUrl}}/offerings/:offeringId/metadata/topicimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["topic": ""] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/metadata/topic")! 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
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
POST
Create offering
{{baseUrl}}/offerings
BODY json
{
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": false,
"title": ""
},
"contentId": "",
"createDefaultChannels": false,
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings");
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 \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/offerings" {:content-type :json
:form-params {:badge {:badgeExpiry {:expirationDate ""
:expires false
:expiryType ""
:timeframeAmount ""
:timeframeUnit ""}
:description ""
:requiresApproval false
:title ""}
:contentId ""
:createDefaultChannels false
:description ""
:earlyCloseOffDate ""
:end ""
:hasEarlyCloseOff false
:identifier ""
:isReadonly false
:metadata {:category ""
:level ""
:tags []
:topic ""}
:name ""
:rootContentId ""
:start ""
:trailerVideoUrl ""
:useRelativeDates false}})require "http/client"
url = "{{baseUrl}}/offerings"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/offerings"),
Content = new StringContent("{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings"
payload := strings.NewReader("{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\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/offerings HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 631
{
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": false,
"title": ""
},
"contentId": "",
"createDefaultChannels": false,
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/offerings")
.setHeader("content-type", "application/json")
.setBody("{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/offerings")
.header("content-type", "application/json")
.body("{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}")
.asString(); const data = JSON.stringify({
badge: {
badgeExpiry: {
expirationDate: '',
expires: false,
expiryType: '',
timeframeAmount: '',
timeframeUnit: ''
},
description: '',
requiresApproval: false,
title: ''
},
contentId: '',
createDefaultChannels: false,
description: '',
earlyCloseOffDate: '',
end: '',
hasEarlyCloseOff: false,
identifier: '',
isReadonly: false,
metadata: {
category: '',
level: '',
tags: [],
topic: ''
},
name: '',
rootContentId: '',
start: '',
trailerVideoUrl: '',
useRelativeDates: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/offerings');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings',
headers: {'content-type': 'application/json'},
data: {
badge: {
badgeExpiry: {
expirationDate: '',
expires: false,
expiryType: '',
timeframeAmount: '',
timeframeUnit: ''
},
description: '',
requiresApproval: false,
title: ''
},
contentId: '',
createDefaultChannels: false,
description: '',
earlyCloseOffDate: '',
end: '',
hasEarlyCloseOff: false,
identifier: '',
isReadonly: false,
metadata: {category: '', level: '', tags: [], topic: ''},
name: '',
rootContentId: '',
start: '',
trailerVideoUrl: '',
useRelativeDates: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"badge":{"badgeExpiry":{"expirationDate":"","expires":false,"expiryType":"","timeframeAmount":"","timeframeUnit":""},"description":"","requiresApproval":false,"title":""},"contentId":"","createDefaultChannels":false,"description":"","earlyCloseOffDate":"","end":"","hasEarlyCloseOff":false,"identifier":"","isReadonly":false,"metadata":{"category":"","level":"","tags":[],"topic":""},"name":"","rootContentId":"","start":"","trailerVideoUrl":"","useRelativeDates":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "badge": {\n "badgeExpiry": {\n "expirationDate": "",\n "expires": false,\n "expiryType": "",\n "timeframeAmount": "",\n "timeframeUnit": ""\n },\n "description": "",\n "requiresApproval": false,\n "title": ""\n },\n "contentId": "",\n "createDefaultChannels": false,\n "description": "",\n "earlyCloseOffDate": "",\n "end": "",\n "hasEarlyCloseOff": false,\n "identifier": "",\n "isReadonly": false,\n "metadata": {\n "category": "",\n "level": "",\n "tags": [],\n "topic": ""\n },\n "name": "",\n "rootContentId": "",\n "start": "",\n "trailerVideoUrl": "",\n "useRelativeDates": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/offerings")
.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/offerings',
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({
badge: {
badgeExpiry: {
expirationDate: '',
expires: false,
expiryType: '',
timeframeAmount: '',
timeframeUnit: ''
},
description: '',
requiresApproval: false,
title: ''
},
contentId: '',
createDefaultChannels: false,
description: '',
earlyCloseOffDate: '',
end: '',
hasEarlyCloseOff: false,
identifier: '',
isReadonly: false,
metadata: {category: '', level: '', tags: [], topic: ''},
name: '',
rootContentId: '',
start: '',
trailerVideoUrl: '',
useRelativeDates: false
}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings',
headers: {'content-type': 'application/json'},
body: {
badge: {
badgeExpiry: {
expirationDate: '',
expires: false,
expiryType: '',
timeframeAmount: '',
timeframeUnit: ''
},
description: '',
requiresApproval: false,
title: ''
},
contentId: '',
createDefaultChannels: false,
description: '',
earlyCloseOffDate: '',
end: '',
hasEarlyCloseOff: false,
identifier: '',
isReadonly: false,
metadata: {category: '', level: '', tags: [], topic: ''},
name: '',
rootContentId: '',
start: '',
trailerVideoUrl: '',
useRelativeDates: false
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/offerings');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
badge: {
badgeExpiry: {
expirationDate: '',
expires: false,
expiryType: '',
timeframeAmount: '',
timeframeUnit: ''
},
description: '',
requiresApproval: false,
title: ''
},
contentId: '',
createDefaultChannels: false,
description: '',
earlyCloseOffDate: '',
end: '',
hasEarlyCloseOff: false,
identifier: '',
isReadonly: false,
metadata: {
category: '',
level: '',
tags: [],
topic: ''
},
name: '',
rootContentId: '',
start: '',
trailerVideoUrl: '',
useRelativeDates: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/offerings',
headers: {'content-type': 'application/json'},
data: {
badge: {
badgeExpiry: {
expirationDate: '',
expires: false,
expiryType: '',
timeframeAmount: '',
timeframeUnit: ''
},
description: '',
requiresApproval: false,
title: ''
},
contentId: '',
createDefaultChannels: false,
description: '',
earlyCloseOffDate: '',
end: '',
hasEarlyCloseOff: false,
identifier: '',
isReadonly: false,
metadata: {category: '', level: '', tags: [], topic: ''},
name: '',
rootContentId: '',
start: '',
trailerVideoUrl: '',
useRelativeDates: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"badge":{"badgeExpiry":{"expirationDate":"","expires":false,"expiryType":"","timeframeAmount":"","timeframeUnit":""},"description":"","requiresApproval":false,"title":""},"contentId":"","createDefaultChannels":false,"description":"","earlyCloseOffDate":"","end":"","hasEarlyCloseOff":false,"identifier":"","isReadonly":false,"metadata":{"category":"","level":"","tags":[],"topic":""},"name":"","rootContentId":"","start":"","trailerVideoUrl":"","useRelativeDates":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"badge": @{ @"badgeExpiry": @{ @"expirationDate": @"", @"expires": @NO, @"expiryType": @"", @"timeframeAmount": @"", @"timeframeUnit": @"" }, @"description": @"", @"requiresApproval": @NO, @"title": @"" },
@"contentId": @"",
@"createDefaultChannels": @NO,
@"description": @"",
@"earlyCloseOffDate": @"",
@"end": @"",
@"hasEarlyCloseOff": @NO,
@"identifier": @"",
@"isReadonly": @NO,
@"metadata": @{ @"category": @"", @"level": @"", @"tags": @[ ], @"topic": @"" },
@"name": @"",
@"rootContentId": @"",
@"start": @"",
@"trailerVideoUrl": @"",
@"useRelativeDates": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings"]
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}}/offerings" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings",
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([
'badge' => [
'badgeExpiry' => [
'expirationDate' => '',
'expires' => null,
'expiryType' => '',
'timeframeAmount' => '',
'timeframeUnit' => ''
],
'description' => '',
'requiresApproval' => null,
'title' => ''
],
'contentId' => '',
'createDefaultChannels' => null,
'description' => '',
'earlyCloseOffDate' => '',
'end' => '',
'hasEarlyCloseOff' => null,
'identifier' => '',
'isReadonly' => null,
'metadata' => [
'category' => '',
'level' => '',
'tags' => [
],
'topic' => ''
],
'name' => '',
'rootContentId' => '',
'start' => '',
'trailerVideoUrl' => '',
'useRelativeDates' => null
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/offerings', [
'body' => '{
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": false,
"title": ""
},
"contentId": "",
"createDefaultChannels": false,
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'badge' => [
'badgeExpiry' => [
'expirationDate' => '',
'expires' => null,
'expiryType' => '',
'timeframeAmount' => '',
'timeframeUnit' => ''
],
'description' => '',
'requiresApproval' => null,
'title' => ''
],
'contentId' => '',
'createDefaultChannels' => null,
'description' => '',
'earlyCloseOffDate' => '',
'end' => '',
'hasEarlyCloseOff' => null,
'identifier' => '',
'isReadonly' => null,
'metadata' => [
'category' => '',
'level' => '',
'tags' => [
],
'topic' => ''
],
'name' => '',
'rootContentId' => '',
'start' => '',
'trailerVideoUrl' => '',
'useRelativeDates' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'badge' => [
'badgeExpiry' => [
'expirationDate' => '',
'expires' => null,
'expiryType' => '',
'timeframeAmount' => '',
'timeframeUnit' => ''
],
'description' => '',
'requiresApproval' => null,
'title' => ''
],
'contentId' => '',
'createDefaultChannels' => null,
'description' => '',
'earlyCloseOffDate' => '',
'end' => '',
'hasEarlyCloseOff' => null,
'identifier' => '',
'isReadonly' => null,
'metadata' => [
'category' => '',
'level' => '',
'tags' => [
],
'topic' => ''
],
'name' => '',
'rootContentId' => '',
'start' => '',
'trailerVideoUrl' => '',
'useRelativeDates' => null
]));
$request->setRequestUrl('{{baseUrl}}/offerings');
$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}}/offerings' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": false,
"title": ""
},
"contentId": "",
"createDefaultChannels": false,
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": false,
"title": ""
},
"contentId": "",
"createDefaultChannels": false,
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/offerings", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings"
payload = {
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": False,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": False,
"title": ""
},
"contentId": "",
"createDefaultChannels": False,
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": False,
"identifier": "",
"isReadonly": False,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": False
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings"
payload <- "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\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}}/offerings")
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 \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/offerings') do |req|
req.body = "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"createDefaultChannels\": false,\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings";
let payload = json!({
"badge": json!({
"badgeExpiry": json!({
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
}),
"description": "",
"requiresApproval": false,
"title": ""
}),
"contentId": "",
"createDefaultChannels": false,
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": json!({
"category": "",
"level": "",
"tags": (),
"topic": ""
}),
"name": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
});
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}}/offerings \
--header 'content-type: application/json' \
--data '{
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": false,
"title": ""
},
"contentId": "",
"createDefaultChannels": false,
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
}'echo '{
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": false,
"title": ""
},
"contentId": "",
"createDefaultChannels": false,
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
}' | \
http POST {{baseUrl}}/offerings \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "badge": {\n "badgeExpiry": {\n "expirationDate": "",\n "expires": false,\n "expiryType": "",\n "timeframeAmount": "",\n "timeframeUnit": ""\n },\n "description": "",\n "requiresApproval": false,\n "title": ""\n },\n "contentId": "",\n "createDefaultChannels": false,\n "description": "",\n "earlyCloseOffDate": "",\n "end": "",\n "hasEarlyCloseOff": false,\n "identifier": "",\n "isReadonly": false,\n "metadata": {\n "category": "",\n "level": "",\n "tags": [],\n "topic": ""\n },\n "name": "",\n "rootContentId": "",\n "start": "",\n "trailerVideoUrl": "",\n "useRelativeDates": false\n}' \
--output-document \
- {{baseUrl}}/offeringsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"badge": [
"badgeExpiry": [
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
],
"description": "",
"requiresApproval": false,
"title": ""
],
"contentId": "",
"createDefaultChannels": false,
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": [
"category": "",
"level": "",
"tags": [],
"topic": ""
],
"name": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings")! 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
{
"details": "A cannot be B when C is D",
"name": "IncompatibleParametersError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You need to specify content_id or rootContentId.",
"name": "InvalidContentError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The field 'Offering Badge' is missing or invalid.",
"name": "MissingInfoError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The specified offering has relative dates enabled. Absolute task dates can not be set.",
"name": "OfferingIncompatibleDatesError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"example\"",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "should have required property 'example'",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find active offerings
{{baseUrl}}/offerings/current
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/current");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/current")require "http/client"
url = "{{baseUrl}}/offerings/current"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/current"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/current");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/current"
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/offerings/current HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/current")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/current"))
.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}}/offerings/current")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/current")
.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}}/offerings/current');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/offerings/current'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/current';
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}}/offerings/current',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/current")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/current',
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}}/offerings/current'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/current');
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}}/offerings/current'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/current';
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}}/offerings/current"]
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}}/offerings/current" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/current",
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}}/offerings/current');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/current');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/current');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/current' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/current' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/current")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/current"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/current"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/current")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/current') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/current";
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}}/offerings/currenthttp GET {{baseUrl}}/offerings/currentwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/currentimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/current")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}
GET
Find current, past and future offerings
{{baseUrl}}/offerings
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings")require "http/client"
url = "{{baseUrl}}/offerings"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings"
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/offerings HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings"))
.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}}/offerings")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings")
.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}}/offerings');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/offerings'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings';
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}}/offerings',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings',
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}}/offerings'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings');
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}}/offerings'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings';
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}}/offerings"]
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}}/offerings" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings",
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}}/offerings');
echo $response->getBody();setUrl('{{baseUrl}}/offerings');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings";
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}}/offeringshttp GET {{baseUrl}}/offeringswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offeringsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}
GET
Find offering by ID
{{baseUrl}}/offerings/:offeringId
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId"
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/offerings/:offeringId HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId"))
.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}}/offerings/:offeringId")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId")
.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}}/offerings/:offeringId');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/offerings/:offeringId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId';
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}}/offerings/:offeringId',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId',
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}}/offerings/:offeringId'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId');
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}}/offerings/:offeringId'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId';
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}}/offerings/:offeringId"]
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}}/offerings/:offeringId" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId",
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}}/offerings/:offeringId');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId";
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}}/offerings/:offeringIdhttp GET {{baseUrl}}/offerings/:offeringIdwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringIdimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find offerings where info field matches the specified textPattern
{{baseUrl}}/offerings/info/:textPattern
QUERY PARAMS
textPattern
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/info/:textPattern");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/info/:textPattern")require "http/client"
url = "{{baseUrl}}/offerings/info/:textPattern"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/info/:textPattern"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/info/:textPattern");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/info/:textPattern"
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/offerings/info/:textPattern HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/info/:textPattern")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/info/:textPattern"))
.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}}/offerings/info/:textPattern")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/info/:textPattern")
.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}}/offerings/info/:textPattern');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/offerings/info/:textPattern'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/info/:textPattern';
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}}/offerings/info/:textPattern',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/info/:textPattern")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/info/:textPattern',
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}}/offerings/info/:textPattern'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/info/:textPattern');
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}}/offerings/info/:textPattern'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/info/:textPattern';
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}}/offerings/info/:textPattern"]
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}}/offerings/info/:textPattern" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/info/:textPattern",
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}}/offerings/info/:textPattern');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/info/:textPattern');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/info/:textPattern');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/info/:textPattern' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/info/:textPattern' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/info/:textPattern")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/info/:textPattern"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/info/:textPattern"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/info/:textPattern")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/info/:textPattern') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/info/:textPattern";
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}}/offerings/info/:textPatternhttp GET {{baseUrl}}/offerings/info/:textPatternwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/info/:textPatternimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/info/:textPattern")! 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
{
"details": "Text pattern must be a minimum of 3 characters in length.",
"name": "TextPatternError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find past offerings
{{baseUrl}}/offerings/past
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/past");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/past")require "http/client"
url = "{{baseUrl}}/offerings/past"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/past"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/past");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/past"
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/offerings/past HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/past")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/past"))
.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}}/offerings/past")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/past")
.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}}/offerings/past');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/offerings/past'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/past';
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}}/offerings/past',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/past")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/past',
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}}/offerings/past'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/past');
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}}/offerings/past'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/past';
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}}/offerings/past"]
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}}/offerings/past" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/past",
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}}/offerings/past');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/past');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/past');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/past' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/past' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/past")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/past"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/past"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/past")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/past') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/past";
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}}/offerings/pasthttp GET {{baseUrl}}/offerings/pastwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/pastimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/past")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}
GET
Find scheduled offerings
{{baseUrl}}/offerings/future
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/future");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/future")require "http/client"
url = "{{baseUrl}}/offerings/future"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/future"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/future");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/future"
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/offerings/future HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/future")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/future"))
.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}}/offerings/future")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/future")
.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}}/offerings/future');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/offerings/future'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/future';
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}}/offerings/future',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/future")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/future',
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}}/offerings/future'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/future');
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}}/offerings/future'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/future';
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}}/offerings/future"]
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}}/offerings/future" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/future",
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}}/offerings/future');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/future');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/future');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/future' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/future' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/future")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/future"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/future"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/future")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/future') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/future";
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}}/offerings/futurehttp GET {{baseUrl}}/offerings/futurewget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/futureimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/future")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}
GET
Offerings summary
{{baseUrl}}/offerings/summary
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/summary");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/summary")require "http/client"
url = "{{baseUrl}}/offerings/summary"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/summary"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/summary");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/summary"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/offerings/summary HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/summary")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/summary"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/summary")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/summary")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/offerings/summary');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/offerings/summary'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/summary';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/summary',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/summary")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/summary',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/offerings/summary'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/summary');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/offerings/summary'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/summary';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/summary"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/offerings/summary" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/summary",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/offerings/summary');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/summary');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/summary');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/summary' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/summary' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/summary")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/summary"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/summary"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/summary') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/summary";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/offerings/summaryhttp GET {{baseUrl}}/offerings/summarywget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/summaryimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/summary")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "GET"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "invalid $filter parameter.",
"name": "ApiValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE Unknown query parameter 'example'",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}
PATCH
Update offering
{{baseUrl}}/offerings/:offeringId
QUERY PARAMS
offeringId
BODY json
{
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": false,
"title": ""
},
"contentId": "",
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"overview": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId");
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 \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/offerings/:offeringId" {:content-type :json
:form-params {:badge {:badgeExpiry {:expirationDate ""
:expires false
:expiryType ""
:timeframeAmount ""
:timeframeUnit ""}
:description ""
:requiresApproval false
:title ""}
:contentId ""
:description ""
:earlyCloseOffDate ""
:end ""
:hasEarlyCloseOff false
:identifier ""
:isReadonly false
:metadata {:category ""
:level ""
:tags []
:topic ""}
:name ""
:overview ""
:rootContentId ""
:start ""
:trailerVideoUrl ""
:useRelativeDates false}})require "http/client"
url = "{{baseUrl}}/offerings/:offeringId"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId"),
Content = new StringContent("{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId"
payload := strings.NewReader("{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PATCH /baseUrl/offerings/:offeringId HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 615
{
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": false,
"title": ""
},
"contentId": "",
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"overview": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/offerings/:offeringId")
.setHeader("content-type", "application/json")
.setBody("{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.patch("{{baseUrl}}/offerings/:offeringId")
.header("content-type", "application/json")
.body("{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}")
.asString(); const data = JSON.stringify({
badge: {
badgeExpiry: {
expirationDate: '',
expires: false,
expiryType: '',
timeframeAmount: '',
timeframeUnit: ''
},
description: '',
requiresApproval: false,
title: ''
},
contentId: '',
description: '',
earlyCloseOffDate: '',
end: '',
hasEarlyCloseOff: false,
identifier: '',
isReadonly: false,
metadata: {
category: '',
level: '',
tags: [],
topic: ''
},
name: '',
overview: '',
rootContentId: '',
start: '',
trailerVideoUrl: '',
useRelativeDates: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/offerings/:offeringId');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/offerings/:offeringId',
headers: {'content-type': 'application/json'},
data: {
badge: {
badgeExpiry: {
expirationDate: '',
expires: false,
expiryType: '',
timeframeAmount: '',
timeframeUnit: ''
},
description: '',
requiresApproval: false,
title: ''
},
contentId: '',
description: '',
earlyCloseOffDate: '',
end: '',
hasEarlyCloseOff: false,
identifier: '',
isReadonly: false,
metadata: {category: '', level: '', tags: [], topic: ''},
name: '',
overview: '',
rootContentId: '',
start: '',
trailerVideoUrl: '',
useRelativeDates: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"badge":{"badgeExpiry":{"expirationDate":"","expires":false,"expiryType":"","timeframeAmount":"","timeframeUnit":""},"description":"","requiresApproval":false,"title":""},"contentId":"","description":"","earlyCloseOffDate":"","end":"","hasEarlyCloseOff":false,"identifier":"","isReadonly":false,"metadata":{"category":"","level":"","tags":[],"topic":""},"name":"","overview":"","rootContentId":"","start":"","trailerVideoUrl":"","useRelativeDates":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/offerings/:offeringId',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "badge": {\n "badgeExpiry": {\n "expirationDate": "",\n "expires": false,\n "expiryType": "",\n "timeframeAmount": "",\n "timeframeUnit": ""\n },\n "description": "",\n "requiresApproval": false,\n "title": ""\n },\n "contentId": "",\n "description": "",\n "earlyCloseOffDate": "",\n "end": "",\n "hasEarlyCloseOff": false,\n "identifier": "",\n "isReadonly": false,\n "metadata": {\n "category": "",\n "level": "",\n "tags": [],\n "topic": ""\n },\n "name": "",\n "overview": "",\n "rootContentId": "",\n "start": "",\n "trailerVideoUrl": "",\n "useRelativeDates": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId',
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({
badge: {
badgeExpiry: {
expirationDate: '',
expires: false,
expiryType: '',
timeframeAmount: '',
timeframeUnit: ''
},
description: '',
requiresApproval: false,
title: ''
},
contentId: '',
description: '',
earlyCloseOffDate: '',
end: '',
hasEarlyCloseOff: false,
identifier: '',
isReadonly: false,
metadata: {category: '', level: '', tags: [], topic: ''},
name: '',
overview: '',
rootContentId: '',
start: '',
trailerVideoUrl: '',
useRelativeDates: false
}));
req.end();const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/offerings/:offeringId',
headers: {'content-type': 'application/json'},
body: {
badge: {
badgeExpiry: {
expirationDate: '',
expires: false,
expiryType: '',
timeframeAmount: '',
timeframeUnit: ''
},
description: '',
requiresApproval: false,
title: ''
},
contentId: '',
description: '',
earlyCloseOffDate: '',
end: '',
hasEarlyCloseOff: false,
identifier: '',
isReadonly: false,
metadata: {category: '', level: '', tags: [], topic: ''},
name: '',
overview: '',
rootContentId: '',
start: '',
trailerVideoUrl: '',
useRelativeDates: false
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/offerings/:offeringId');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
badge: {
badgeExpiry: {
expirationDate: '',
expires: false,
expiryType: '',
timeframeAmount: '',
timeframeUnit: ''
},
description: '',
requiresApproval: false,
title: ''
},
contentId: '',
description: '',
earlyCloseOffDate: '',
end: '',
hasEarlyCloseOff: false,
identifier: '',
isReadonly: false,
metadata: {
category: '',
level: '',
tags: [],
topic: ''
},
name: '',
overview: '',
rootContentId: '',
start: '',
trailerVideoUrl: '',
useRelativeDates: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/offerings/:offeringId',
headers: {'content-type': 'application/json'},
data: {
badge: {
badgeExpiry: {
expirationDate: '',
expires: false,
expiryType: '',
timeframeAmount: '',
timeframeUnit: ''
},
description: '',
requiresApproval: false,
title: ''
},
contentId: '',
description: '',
earlyCloseOffDate: '',
end: '',
hasEarlyCloseOff: false,
identifier: '',
isReadonly: false,
metadata: {category: '', level: '', tags: [], topic: ''},
name: '',
overview: '',
rootContentId: '',
start: '',
trailerVideoUrl: '',
useRelativeDates: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"badge":{"badgeExpiry":{"expirationDate":"","expires":false,"expiryType":"","timeframeAmount":"","timeframeUnit":""},"description":"","requiresApproval":false,"title":""},"contentId":"","description":"","earlyCloseOffDate":"","end":"","hasEarlyCloseOff":false,"identifier":"","isReadonly":false,"metadata":{"category":"","level":"","tags":[],"topic":""},"name":"","overview":"","rootContentId":"","start":"","trailerVideoUrl":"","useRelativeDates":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"badge": @{ @"badgeExpiry": @{ @"expirationDate": @"", @"expires": @NO, @"expiryType": @"", @"timeframeAmount": @"", @"timeframeUnit": @"" }, @"description": @"", @"requiresApproval": @NO, @"title": @"" },
@"contentId": @"",
@"description": @"",
@"earlyCloseOffDate": @"",
@"end": @"",
@"hasEarlyCloseOff": @NO,
@"identifier": @"",
@"isReadonly": @NO,
@"metadata": @{ @"category": @"", @"level": @"", @"tags": @[ ], @"topic": @"" },
@"name": @"",
@"overview": @"",
@"rootContentId": @"",
@"start": @"",
@"trailerVideoUrl": @"",
@"useRelativeDates": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/offerings/:offeringId"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/offerings/:offeringId" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'badge' => [
'badgeExpiry' => [
'expirationDate' => '',
'expires' => null,
'expiryType' => '',
'timeframeAmount' => '',
'timeframeUnit' => ''
],
'description' => '',
'requiresApproval' => null,
'title' => ''
],
'contentId' => '',
'description' => '',
'earlyCloseOffDate' => '',
'end' => '',
'hasEarlyCloseOff' => null,
'identifier' => '',
'isReadonly' => null,
'metadata' => [
'category' => '',
'level' => '',
'tags' => [
],
'topic' => ''
],
'name' => '',
'overview' => '',
'rootContentId' => '',
'start' => '',
'trailerVideoUrl' => '',
'useRelativeDates' => null
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PATCH', '{{baseUrl}}/offerings/:offeringId', [
'body' => '{
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": false,
"title": ""
},
"contentId": "",
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"overview": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'badge' => [
'badgeExpiry' => [
'expirationDate' => '',
'expires' => null,
'expiryType' => '',
'timeframeAmount' => '',
'timeframeUnit' => ''
],
'description' => '',
'requiresApproval' => null,
'title' => ''
],
'contentId' => '',
'description' => '',
'earlyCloseOffDate' => '',
'end' => '',
'hasEarlyCloseOff' => null,
'identifier' => '',
'isReadonly' => null,
'metadata' => [
'category' => '',
'level' => '',
'tags' => [
],
'topic' => ''
],
'name' => '',
'overview' => '',
'rootContentId' => '',
'start' => '',
'trailerVideoUrl' => '',
'useRelativeDates' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'badge' => [
'badgeExpiry' => [
'expirationDate' => '',
'expires' => null,
'expiryType' => '',
'timeframeAmount' => '',
'timeframeUnit' => ''
],
'description' => '',
'requiresApproval' => null,
'title' => ''
],
'contentId' => '',
'description' => '',
'earlyCloseOffDate' => '',
'end' => '',
'hasEarlyCloseOff' => null,
'identifier' => '',
'isReadonly' => null,
'metadata' => [
'category' => '',
'level' => '',
'tags' => [
],
'topic' => ''
],
'name' => '',
'overview' => '',
'rootContentId' => '',
'start' => '',
'trailerVideoUrl' => '',
'useRelativeDates' => null
]));
$request->setRequestUrl('{{baseUrl}}/offerings/:offeringId');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": false,
"title": ""
},
"contentId": "",
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"overview": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": false,
"title": ""
},
"contentId": "",
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"overview": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/offerings/:offeringId", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId"
payload = {
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": False,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": False,
"title": ""
},
"contentId": "",
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": False,
"identifier": "",
"isReadonly": False,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"overview": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": False
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId"
payload <- "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/offerings/:offeringId') do |req|
req.body = "{\n \"badge\": {\n \"badgeExpiry\": {\n \"expirationDate\": \"\",\n \"expires\": false,\n \"expiryType\": \"\",\n \"timeframeAmount\": \"\",\n \"timeframeUnit\": \"\"\n },\n \"description\": \"\",\n \"requiresApproval\": false,\n \"title\": \"\"\n },\n \"contentId\": \"\",\n \"description\": \"\",\n \"earlyCloseOffDate\": \"\",\n \"end\": \"\",\n \"hasEarlyCloseOff\": false,\n \"identifier\": \"\",\n \"isReadonly\": false,\n \"metadata\": {\n \"category\": \"\",\n \"level\": \"\",\n \"tags\": [],\n \"topic\": \"\"\n },\n \"name\": \"\",\n \"overview\": \"\",\n \"rootContentId\": \"\",\n \"start\": \"\",\n \"trailerVideoUrl\": \"\",\n \"useRelativeDates\": false\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId";
let payload = json!({
"badge": json!({
"badgeExpiry": json!({
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
}),
"description": "",
"requiresApproval": false,
"title": ""
}),
"contentId": "",
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": json!({
"category": "",
"level": "",
"tags": (),
"topic": ""
}),
"name": "",
"overview": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/offerings/:offeringId \
--header 'content-type: application/json' \
--data '{
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": false,
"title": ""
},
"contentId": "",
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"overview": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
}'echo '{
"badge": {
"badgeExpiry": {
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
},
"description": "",
"requiresApproval": false,
"title": ""
},
"contentId": "",
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": {
"category": "",
"level": "",
"tags": [],
"topic": ""
},
"name": "",
"overview": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
}' | \
http PATCH {{baseUrl}}/offerings/:offeringId \
content-type:application/jsonwget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "badge": {\n "badgeExpiry": {\n "expirationDate": "",\n "expires": false,\n "expiryType": "",\n "timeframeAmount": "",\n "timeframeUnit": ""\n },\n "description": "",\n "requiresApproval": false,\n "title": ""\n },\n "contentId": "",\n "description": "",\n "earlyCloseOffDate": "",\n "end": "",\n "hasEarlyCloseOff": false,\n "identifier": "",\n "isReadonly": false,\n "metadata": {\n "category": "",\n "level": "",\n "tags": [],\n "topic": ""\n },\n "name": "",\n "overview": "",\n "rootContentId": "",\n "start": "",\n "trailerVideoUrl": "",\n "useRelativeDates": false\n}' \
--output-document \
- {{baseUrl}}/offerings/:offeringIdimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"badge": [
"badgeExpiry": [
"expirationDate": "",
"expires": false,
"expiryType": "",
"timeframeAmount": "",
"timeframeUnit": ""
],
"description": "",
"requiresApproval": false,
"title": ""
],
"contentId": "",
"description": "",
"earlyCloseOffDate": "",
"end": "",
"hasEarlyCloseOff": false,
"identifier": "",
"isReadonly": false,
"metadata": [
"category": "",
"level": "",
"tags": [],
"topic": ""
],
"name": "",
"overview": "",
"rootContentId": "",
"start": "",
"trailerVideoUrl": "",
"useRelativeDates": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "A cannot be B when C is D",
"name": "IncompatibleParametersError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The field 'Offering Badge' is missing or invalid.",
"name": "MissingInfoError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The badge already exists in the offering OFFERING ID.",
"name": "ObjectExistsError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The specified offering has relative dates enabled. Absolute task dates can not be set.",
"name": "OfferingIncompatibleDatesError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"example\"",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Gets the current organisation
{{baseUrl}}/org
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/org");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/org")require "http/client"
url = "{{baseUrl}}/org"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/org"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/org");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/org"
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/org HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/org")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/org"))
.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}}/org")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/org")
.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}}/org');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/org'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/org';
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}}/org',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/org")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/org',
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}}/org'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/org');
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}}/org'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/org';
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}}/org"]
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}}/org" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/org",
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}}/org');
echo $response->getBody();setUrl('{{baseUrl}}/org');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/org');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/org' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/org' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/org")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/org"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/org"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/org")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/org') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/org";
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}}/orghttp GET {{baseUrl}}/orgwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/orgimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/org")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find all pulse IDs in the specified offering
{{baseUrl}}/offerings/:offeringId/analytics/pulses
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/pulses");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/pulses")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/pulses"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/pulses"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/pulses");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/pulses"
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/offerings/:offeringId/analytics/pulses HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/pulses")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/pulses"))
.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}}/offerings/:offeringId/analytics/pulses")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/pulses")
.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}}/offerings/:offeringId/analytics/pulses');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/pulses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/pulses';
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}}/offerings/:offeringId/analytics/pulses',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/pulses")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/pulses',
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}}/offerings/:offeringId/analytics/pulses'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/pulses');
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}}/offerings/:offeringId/analytics/pulses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/pulses';
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}}/offerings/:offeringId/analytics/pulses"]
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}}/offerings/:offeringId/analytics/pulses" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/pulses",
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}}/offerings/:offeringId/analytics/pulses');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/pulses');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/pulses');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/pulses' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/pulses' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/pulses")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/pulses"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/pulses"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/pulses")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/pulses') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/pulses";
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}}/offerings/:offeringId/analytics/pulseshttp GET {{baseUrl}}/offerings/:offeringId/analytics/pulseswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/pulsesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/pulses")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find pulses by offeringId and pulseId
{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses
QUERY PARAMS
offeringId
pulseId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses"
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/offerings/:offeringId/analytics/pulses/:pulseId/responses HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses"))
.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}}/offerings/:offeringId/analytics/pulses/:pulseId/responses")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses")
.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}}/offerings/:offeringId/analytics/pulses/:pulseId/responses');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses';
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}}/offerings/:offeringId/analytics/pulses/:pulseId/responses',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/pulses/:pulseId/responses',
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}}/offerings/:offeringId/analytics/pulses/:pulseId/responses'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses');
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}}/offerings/:offeringId/analytics/pulses/:pulseId/responses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses';
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}}/offerings/:offeringId/analytics/pulses/:pulseId/responses"]
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}}/offerings/:offeringId/analytics/pulses/:pulseId/responses" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses",
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}}/offerings/:offeringId/analytics/pulses/:pulseId/responses');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/pulses/:pulseId/responses")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/pulses/:pulseId/responses') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses";
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}}/offerings/:offeringId/analytics/pulses/:pulseId/responseshttp GET {{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responseswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responsesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/pulses/:pulseId/responses")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find pulses by offeringId
{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses
QUERY PARAMS
offeringId
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses")require "http/client"
url = "{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses"
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/offerings/:offeringId/analytics/pulses/responses HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses"))
.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}}/offerings/:offeringId/analytics/pulses/responses")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses")
.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}}/offerings/:offeringId/analytics/pulses/responses');
xhr.send(data);import axios from 'axios';
const options = {
method: 'GET',
url: '{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses';
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}}/offerings/:offeringId/analytics/pulses/responses',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/offerings/:offeringId/analytics/pulses/responses',
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}}/offerings/:offeringId/analytics/pulses/responses'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses');
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}}/offerings/:offeringId/analytics/pulses/responses'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses';
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}}/offerings/:offeringId/analytics/pulses/responses"]
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}}/offerings/:offeringId/analytics/pulses/responses" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses",
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}}/offerings/:offeringId/analytics/pulses/responses');
echo $response->getBody();setUrl('{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/offerings/:offeringId/analytics/pulses/responses")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/offerings/:offeringId/analytics/pulses/responses') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses";
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}}/offerings/:offeringId/analytics/pulses/responseshttp GET {{baseUrl}}/offerings/:offeringId/analytics/pulses/responseswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/offerings/:offeringId/analytics/pulses/responsesimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/offerings/:offeringId/analytics/pulses/responses")! 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
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
POST
Add new user
{{baseUrl}}/users
BODY json
{
"email": "",
"firstName": "",
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/users" {:content-type :json
:form-params {:email ""
:firstName ""
:lastName ""
:metadata {:tags []}
:personId ""
:profile {:displayName ""}
:sendInvite false}})require "http/client"
url = "{{baseUrl}}/users"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/users"),
Content = new StringContent("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/users");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users"
payload := strings.NewReader("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/users HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 173
{
"email": "",
"firstName": "",
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/users")
.setHeader("content-type", "application/json")
.setBody("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/users")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/users")
.header("content-type", "application/json")
.body("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}")
.asString(); const data = JSON.stringify({
email: '',
firstName: '',
lastName: '',
metadata: {
tags: []
},
personId: '',
profile: {
displayName: ''
},
sendInvite: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/users');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/users',
headers: {'content-type': 'application/json'},
data: {
email: '',
firstName: '',
lastName: '',
metadata: {tags: []},
personId: '',
profile: {displayName: ''},
sendInvite: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/users';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"email":"","firstName":"","lastName":"","metadata":{"tags":[]},"personId":"","profile":{"displayName":""},"sendInvite":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/users',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "email": "",\n "firstName": "",\n "lastName": "",\n "metadata": {\n "tags": []\n },\n "personId": "",\n "profile": {\n "displayName": ""\n },\n "sendInvite": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/users")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/users',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
email: '',
firstName: '',
lastName: '',
metadata: {tags: []},
personId: '',
profile: {displayName: ''},
sendInvite: false
}));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/users',
headers: {'content-type': 'application/json'},
body: {
email: '',
firstName: '',
lastName: '',
metadata: {tags: []},
personId: '',
profile: {displayName: ''},
sendInvite: false
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/users');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
email: '',
firstName: '',
lastName: '',
metadata: {
tags: []
},
personId: '',
profile: {
displayName: ''
},
sendInvite: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/users',
headers: {'content-type': 'application/json'},
data: {
email: '',
firstName: '',
lastName: '',
metadata: {tags: []},
personId: '',
profile: {displayName: ''},
sendInvite: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/users';
const options = {
method: 'POST',
headers: {'content-type': 'application/json'},
body: '{"email":"","firstName":"","lastName":"","metadata":{"tags":[]},"personId":"","profile":{"displayName":""},"sendInvite":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"email": @"",
@"firstName": @"",
@"lastName": @"",
@"metadata": @{ @"tags": @[ ] },
@"personId": @"",
@"profile": @{ @"displayName": @"" },
@"sendInvite": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/users" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '',
'firstName' => '',
'lastName' => '',
'metadata' => [
'tags' => [
]
],
'personId' => '',
'profile' => [
'displayName' => ''
],
'sendInvite' => null
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/users', [
'body' => '{
"email": "",
"firstName": "",
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/users');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'email' => '',
'firstName' => '',
'lastName' => '',
'metadata' => [
'tags' => [
]
],
'personId' => '',
'profile' => [
'displayName' => ''
],
'sendInvite' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'email' => '',
'firstName' => '',
'lastName' => '',
'metadata' => [
'tags' => [
]
],
'personId' => '',
'profile' => [
'displayName' => ''
],
'sendInvite' => null
]));
$request->setRequestUrl('{{baseUrl}}/users');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"email": "",
"firstName": "",
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"email": "",
"firstName": "",
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/users", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/users"
payload = {
"email": "",
"firstName": "",
"lastName": "",
"metadata": { "tags": [] },
"personId": "",
"profile": { "displayName": "" },
"sendInvite": False
}
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/users"
payload <- "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/users') do |req|
req.body = "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users";
let payload = json!({
"email": "",
"firstName": "",
"lastName": "",
"metadata": json!({"tags": ()}),
"personId": "",
"profile": json!({"displayName": ""}),
"sendInvite": false
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/users \
--header 'content-type: application/json' \
--data '{
"email": "",
"firstName": "",
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false
}'echo '{
"email": "",
"firstName": "",
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false
}' | \
http POST {{baseUrl}}/users \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '{\n "email": "",\n "firstName": "",\n "lastName": "",\n "metadata": {\n "tags": []\n },\n "personId": "",\n "profile": {\n "displayName": ""\n },\n "sendInvite": false\n}' \
--output-document \
- {{baseUrl}}/usersimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"email": "",
"firstName": "",
"lastName": "",
"metadata": ["tags": []],
"personId": "",
"profile": ["displayName": ""],
"sendInvite": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users")! 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
{
"details": "The badge already exists in the offering OFFERING ID.",
"name": "ObjectExistsError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"example\"",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should NOT be shorter than 3 characters",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The user (john.doe@test.te) has been suspended.",
"name": "UserSuspendedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
POST
Add permission to user
{{baseUrl}}/users/:userEmail/permissions/:permissionName
QUERY PARAMS
userEmail
permissionName
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:userEmail/permissions/:permissionName");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/users/:userEmail/permissions/:permissionName")require "http/client"
url = "{{baseUrl}}/users/:userEmail/permissions/:permissionName"
response = HTTP::Client.post url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/users/:userEmail/permissions/:permissionName"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/users/:userEmail/permissions/:permissionName");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:userEmail/permissions/:permissionName"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/users/:userEmail/permissions/:permissionName HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/users/:userEmail/permissions/:permissionName")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:userEmail/permissions/:permissionName"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:userEmail/permissions/:permissionName")
.post(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/users/:userEmail/permissions/:permissionName")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/users/:userEmail/permissions/:permissionName');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/users/:userEmail/permissions/:permissionName'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/users/:userEmail/permissions/:permissionName';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/users/:userEmail/permissions/:permissionName',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/:userEmail/permissions/:permissionName")
.post(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:userEmail/permissions/:permissionName',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/users/:userEmail/permissions/:permissionName'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/users/:userEmail/permissions/:permissionName');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/users/:userEmail/permissions/:permissionName'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:userEmail/permissions/:permissionName';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:userEmail/permissions/:permissionName"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/users/:userEmail/permissions/:permissionName" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/users/:userEmail/permissions/:permissionName",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/users/:userEmail/permissions/:permissionName');
echo $response->getBody();setUrl('{{baseUrl}}/users/:userEmail/permissions/:permissionName');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/users/:userEmail/permissions/:permissionName');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:userEmail/permissions/:permissionName' -Method POST $response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:userEmail/permissions/:permissionName' -Method POST import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/users/:userEmail/permissions/:permissionName")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/users/:userEmail/permissions/:permissionName"
response = requests.post(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/users/:userEmail/permissions/:permissionName"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:userEmail/permissions/:permissionName")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/users/:userEmail/permissions/:permissionName') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:userEmail/permissions/:permissionName";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/users/:userEmail/permissions/:permissionNamehttp POST {{baseUrl}}/users/:userEmail/permissions/:permissionNamewget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/users/:userEmail/permissions/:permissionNameimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:userEmail/permissions/:permissionName")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The field 'Offering Badge' is missing or invalid.",
"name": "MissingInfoError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The user john.doe@test.te is already a manager.",
"name": "ObjectAlreadyIsError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be equal to one of the allowed values a, b",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
POST
Adds the user to the specified offerings as a learner
{{baseUrl}}/users/:userEmail/offerings
QUERY PARAMS
userEmail
BODY json
[
{}
]
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:userEmail/offerings");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "[\n {}\n]");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/users/:userEmail/offerings" {:content-type :json
:form-params [{}]})require "http/client"
url = "{{baseUrl}}/users/:userEmail/offerings"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "[\n {}\n]"
response = HTTP::Client.post url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/users/:userEmail/offerings"),
Content = new StringContent("[\n {}\n]")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/users/:userEmail/offerings");
var request = new RestRequest("", Method.Post);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "[\n {}\n]", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:userEmail/offerings"
payload := strings.NewReader("[\n {}\n]")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/users/:userEmail/offerings HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 8
[
{}
]AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/users/:userEmail/offerings")
.setHeader("content-type", "application/json")
.setBody("[\n {}\n]")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:userEmail/offerings"))
.header("content-type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("[\n {}\n]"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[\n {}\n]");
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:userEmail/offerings")
.post(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/users/:userEmail/offerings")
.header("content-type", "application/json")
.body("[\n {}\n]")
.asString(); const data = JSON.stringify([
{}
]);
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/users/:userEmail/offerings');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/users/:userEmail/offerings',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/users/:userEmail/offerings';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '[{}]'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/users/:userEmail/offerings',
method: 'POST',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '[\n {}\n]'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "[\n {}\n]")
val request = Request.Builder()
.url("{{baseUrl}}/users/:userEmail/offerings")
.post(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:userEmail/offerings',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify([{}]));
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/users/:userEmail/offerings',
headers: {'content-type': 'application/json'},
body: [{}],
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/users/:userEmail/offerings');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send([
{}
]);
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/users/:userEmail/offerings',
headers: {'content-type': 'application/json'},
data: [{}]
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:userEmail/offerings';
const options = {method: 'POST', headers: {'content-type': 'application/json'}, body: '[{}]'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @[ @{ } ];
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:userEmail/offerings"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/users/:userEmail/offerings" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "[\n {}\n]" in
Client.call ~headers ~body `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/users/:userEmail/offerings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
[
]
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/users/:userEmail/offerings', [
'body' => '[
{}
]',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/users/:userEmail/offerings');
$request->setMethod(HTTP_METH_POST);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
[
]
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
[
]
]));
$request->setRequestUrl('{{baseUrl}}/users/:userEmail/offerings');
$request->setRequestMethod('POST');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:userEmail/offerings' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{}
]'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:userEmail/offerings' -Method POST -Headers $headers -ContentType 'application/json' -Body '[
{}
]'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "[\n {}\n]"
headers = { 'content-type': "application/json" }
conn.request("POST", "/baseUrl/users/:userEmail/offerings", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/users/:userEmail/offerings"
payload = [{}]
headers = {"content-type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/users/:userEmail/offerings"
payload <- "[\n {}\n]"
encode <- "json"
response <- VERB("POST", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:userEmail/offerings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/json'
request.body = "[\n {}\n]"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.post('/baseUrl/users/:userEmail/offerings') do |req|
req.body = "[\n {}\n]"
end
puts response.status
puts response.bodyuse serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:userEmail/offerings";
let payload = (json!({}));
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.post(url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/users/:userEmail/offerings \
--header 'content-type: application/json' \
--data '[
{}
]'echo '[
{}
]' | \
http POST {{baseUrl}}/users/:userEmail/offerings \
content-type:application/jsonwget --quiet \
--method POST \
--header 'content-type: application/json' \
--body-data '[\n {}\n]' \
--output-document \
- {{baseUrl}}/users/:userEmail/offeringsimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [[]] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:userEmail/offerings")! 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
{
"details": "The field 'Offering Badge' is missing or invalid.",
"name": "MissingInfoError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find user by email
{{baseUrl}}/users/:userEmail
QUERY PARAMS
userEmail
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:userEmail");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users/:userEmail")require "http/client"
url = "{{baseUrl}}/users/:userEmail"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users/:userEmail"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/users/:userEmail");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:userEmail"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/users/:userEmail HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users/:userEmail")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:userEmail"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:userEmail")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/users/:userEmail")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/users/:userEmail');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/users/:userEmail'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/users/:userEmail';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/users/:userEmail',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/:userEmail")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:userEmail',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/users/:userEmail'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users/:userEmail');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/users/:userEmail'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:userEmail';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:userEmail"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/users/:userEmail" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/users/:userEmail",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/users/:userEmail');
echo $response->getBody();setUrl('{{baseUrl}}/users/:userEmail');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/users/:userEmail');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:userEmail' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:userEmail' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users/:userEmail")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/users/:userEmail"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/users/:userEmail"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:userEmail")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users/:userEmail') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:userEmail";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users/:userEmailhttp GET {{baseUrl}}/users/:userEmailwget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users/:userEmailimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:userEmail")! 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
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
GET
Find user's offerings
{{baseUrl}}/users/:userEmail/offerings
QUERY PARAMS
userEmail
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:userEmail/offerings");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/get "{{baseUrl}}/users/:userEmail/offerings")require "http/client"
url = "{{baseUrl}}/users/:userEmail/offerings"
response = HTTP::Client.get url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Get,
RequestUri = new Uri("{{baseUrl}}/users/:userEmail/offerings"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/users/:userEmail/offerings");
var request = new RestRequest("", Method.Get);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:userEmail/offerings"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}GET /baseUrl/users/:userEmail/offerings HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("GET", "{{baseUrl}}/users/:userEmail/offerings")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:userEmail/offerings"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:userEmail/offerings")
.get()
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.get("{{baseUrl}}/users/:userEmail/offerings")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('GET', '{{baseUrl}}/users/:userEmail/offerings');
xhr.send(data);import axios from 'axios';
const options = {method: 'GET', url: '{{baseUrl}}/users/:userEmail/offerings'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/users/:userEmail/offerings';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/users/:userEmail/offerings',
method: 'GET',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/:userEmail/offerings")
.get()
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'GET',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:userEmail/offerings',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {method: 'GET', url: '{{baseUrl}}/users/:userEmail/offerings'};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('GET', '{{baseUrl}}/users/:userEmail/offerings');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {method: 'GET', url: '{{baseUrl}}/users/:userEmail/offerings'};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:userEmail/offerings';
const options = {method: 'GET'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:userEmail/offerings"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"GET"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/users/:userEmail/offerings" in
Client.call `GET uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/users/:userEmail/offerings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('GET', '{{baseUrl}}/users/:userEmail/offerings');
echo $response->getBody();setUrl('{{baseUrl}}/users/:userEmail/offerings');
$request->setMethod(HTTP_METH_GET);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/users/:userEmail/offerings');
$request->setRequestMethod('GET');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:userEmail/offerings' -Method GET $response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:userEmail/offerings' -Method GET import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("GET", "/baseUrl/users/:userEmail/offerings")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/users/:userEmail/offerings"
response = requests.get(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/users/:userEmail/offerings"
response <- VERB("GET", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:userEmail/offerings")
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_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.get('/baseUrl/users/:userEmail/offerings') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:userEmail/offerings";
let client = reqwest::Client::new();
let response = client.get(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request GET \
--url {{baseUrl}}/users/:userEmail/offeringshttp GET {{baseUrl}}/users/:userEmail/offeringswget --quiet \
--method GET \
--output-document \
- {{baseUrl}}/users/:userEmail/offeringsimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:userEmail/offerings")! 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
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
POST
Resend invitation email
{{baseUrl}}/users/:userEmail/invite-email
QUERY PARAMS
userEmail
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:userEmail/invite-email");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/post "{{baseUrl}}/users/:userEmail/invite-email")require "http/client"
url = "{{baseUrl}}/users/:userEmail/invite-email"
response = HTTP::Client.post url
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Post,
RequestUri = new Uri("{{baseUrl}}/users/:userEmail/invite-email"),
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/users/:userEmail/invite-email");
var request = new RestRequest("", Method.Post);
var response = client.Execute(request);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:userEmail/invite-email"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}POST /baseUrl/users/:userEmail/invite-email HTTP/1.1
Host: example.com
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "{{baseUrl}}/users/:userEmail/invite-email")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:userEmail/invite-email"))
.method("POST", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:userEmail/invite-email")
.post(null)
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.post("{{baseUrl}}/users/:userEmail/invite-email")
.asString(); const data = null;
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('POST', '{{baseUrl}}/users/:userEmail/invite-email');
xhr.send(data);import axios from 'axios';
const options = {
method: 'POST',
url: '{{baseUrl}}/users/:userEmail/invite-email'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/users/:userEmail/invite-email';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/users/:userEmail/invite-email',
method: 'POST',
headers: {}
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val request = Request.Builder()
.url("{{baseUrl}}/users/:userEmail/invite-email")
.post(null)
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'POST',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:userEmail/invite-email',
headers: {}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();const request = require('request');
const options = {
method: 'POST',
url: '{{baseUrl}}/users/:userEmail/invite-email'
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('POST', '{{baseUrl}}/users/:userEmail/invite-email');
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'POST',
url: '{{baseUrl}}/users/:userEmail/invite-email'
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:userEmail/invite-email';
const options = {method: 'POST'};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:userEmail/invite-email"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/users/:userEmail/invite-email" in
Client.call `POST uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/users/:userEmail/invite-email",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('POST', '{{baseUrl}}/users/:userEmail/invite-email');
echo $response->getBody();setUrl('{{baseUrl}}/users/:userEmail/invite-email');
$request->setMethod(HTTP_METH_POST);
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}setRequestUrl('{{baseUrl}}/users/:userEmail/invite-email');
$request->setRequestMethod('POST');
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:userEmail/invite-email' -Method POST $response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:userEmail/invite-email' -Method POST import http.client
conn = http.client.HTTPSConnection("example.com")
conn.request("POST", "/baseUrl/users/:userEmail/invite-email")
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/users/:userEmail/invite-email"
response = requests.post(url)
print(response.json())library(httr)
url <- "{{baseUrl}}/users/:userEmail/invite-email"
response <- VERB("POST", url, content_type("application/octet-stream"))
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:userEmail/invite-email")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
)
response = conn.post('/baseUrl/users/:userEmail/invite-email') do |req|
end
puts response.status
puts response.bodyuse reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:userEmail/invite-email";
let client = reqwest::Client::new();
let response = client.post(url)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request POST \
--url {{baseUrl}}/users/:userEmail/invite-emailhttp POST {{baseUrl}}/users/:userEmail/invite-emailwget --quiet \
--method POST \
--output-document \
- {{baseUrl}}/users/:userEmail/invite-emailimport Foundation
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:userEmail/invite-email")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "POST"
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PUT
Suspend user
{{baseUrl}}/users/:userEmail/suspend
QUERY PARAMS
userEmail
BODY json
{
"suspended": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PUT");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:userEmail/suspend");
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 \"suspended\": false\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/put "{{baseUrl}}/users/:userEmail/suspend" {:content-type :json
:form-params {:suspended false}})require "http/client"
url = "{{baseUrl}}/users/:userEmail/suspend"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"suspended\": false\n}"
response = HTTP::Client.put url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Put,
RequestUri = new Uri("{{baseUrl}}/users/:userEmail/suspend"),
Content = new StringContent("{\n \"suspended\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/users/:userEmail/suspend");
var request = new RestRequest("", Method.Put);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"suspended\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:userEmail/suspend"
payload := strings.NewReader("{\n \"suspended\": false\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/users/:userEmail/suspend HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 24
{
"suspended": false
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PUT", "{{baseUrl}}/users/:userEmail/suspend")
.setHeader("content-type", "application/json")
.setBody("{\n \"suspended\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:userEmail/suspend"))
.header("content-type", "application/json")
.method("PUT", HttpRequest.BodyPublishers.ofString("{\n \"suspended\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"suspended\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:userEmail/suspend")
.put(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.put("{{baseUrl}}/users/:userEmail/suspend")
.header("content-type", "application/json")
.body("{\n \"suspended\": false\n}")
.asString(); const data = JSON.stringify({
suspended: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PUT', '{{baseUrl}}/users/:userEmail/suspend');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PUT',
url: '{{baseUrl}}/users/:userEmail/suspend',
headers: {'content-type': 'application/json'},
data: {suspended: false}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/users/:userEmail/suspend';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"suspended":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/users/:userEmail/suspend',
method: 'PUT',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "suspended": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"suspended\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/users/:userEmail/suspend")
.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/users/:userEmail/suspend',
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({suspended: false}));
req.end();const request = require('request');
const options = {
method: 'PUT',
url: '{{baseUrl}}/users/:userEmail/suspend',
headers: {'content-type': 'application/json'},
body: {suspended: false},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PUT', '{{baseUrl}}/users/:userEmail/suspend');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
suspended: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PUT',
url: '{{baseUrl}}/users/:userEmail/suspend',
headers: {'content-type': 'application/json'},
data: {suspended: false}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:userEmail/suspend';
const options = {
method: 'PUT',
headers: {'content-type': 'application/json'},
body: '{"suspended":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"suspended": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:userEmail/suspend"]
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}}/users/:userEmail/suspend" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"suspended\": false\n}" in
Client.call ~headers ~body `PUT uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/users/:userEmail/suspend",
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([
'suspended' => null
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PUT', '{{baseUrl}}/users/:userEmail/suspend', [
'body' => '{
"suspended": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/users/:userEmail/suspend');
$request->setMethod(HTTP_METH_PUT);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'suspended' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'suspended' => null
]));
$request->setRequestUrl('{{baseUrl}}/users/:userEmail/suspend');
$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}}/users/:userEmail/suspend' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"suspended": false
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:userEmail/suspend' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{
"suspended": false
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"suspended\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("PUT", "/baseUrl/users/:userEmail/suspend", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/users/:userEmail/suspend"
payload = { "suspended": False }
headers = {"content-type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/users/:userEmail/suspend"
payload <- "{\n \"suspended\": false\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}}/users/:userEmail/suspend")
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 \"suspended\": false\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.put('/baseUrl/users/:userEmail/suspend') do |req|
req.body = "{\n \"suspended\": false\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:userEmail/suspend";
let payload = json!({"suspended": false});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PUT").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PUT \
--url {{baseUrl}}/users/:userEmail/suspend \
--header 'content-type: application/json' \
--data '{
"suspended": false
}'echo '{
"suspended": false
}' | \
http PUT {{baseUrl}}/users/:userEmail/suspend \
content-type:application/jsonwget --quiet \
--method PUT \
--header 'content-type: application/json' \
--body-data '{\n "suspended": false\n}' \
--output-document \
- {{baseUrl}}/users/:userEmail/suspendimport Foundation
let headers = ["content-type": "application/json"]
let parameters = ["suspended": false] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:userEmail/suspend")! 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
{
"details": "The specified parameter file.mimetype (image mimetype) has an invalid value \\'text/plain\\'.",
"name": "InvalidParameterError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The badge already exists in the offering OFFERING ID.",
"name": "ObjectExistsError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"example\"",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}
PATCH
Update user
{{baseUrl}}/users/:userEmail
QUERY PARAMS
userEmail
BODY json
{
"email": "",
"firstName": "",
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false
}
Examples
REQUEST
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_easy_setopt(hnd, CURLOPT_URL, "{{baseUrl}}/users/:userEmail");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "content-type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}");
CURLcode ret = curl_easy_perform(hnd);(require '[clj-http.client :as client])
(client/patch "{{baseUrl}}/users/:userEmail" {:content-type :json
:form-params {:email ""
:firstName ""
:lastName ""
:metadata {:tags []}
:personId ""
:profile {:displayName ""}
:sendInvite false}})require "http/client"
url = "{{baseUrl}}/users/:userEmail"
headers = HTTP::Headers{
"content-type" => "application/json"
}
reqBody = "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}"
response = HTTP::Client.patch url, headers: headers, body: reqBody
puts response.bodyusing System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
Method = HttpMethod.Patch,
RequestUri = new Uri("{{baseUrl}}/users/:userEmail"),
Content = new StringContent("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}")
{
Headers =
{
ContentType = new MediaTypeHeaderValue("application/json")
}
}
};
using (var response = await client.SendAsync(request))
{
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
}var client = new RestClient("{{baseUrl}}/users/:userEmail");
var request = new RestRequest("", Method.Patch);
request.AddHeader("content-type", "application/json");
request.AddParameter("application/json", "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}", ParameterType.RequestBody);
var response = client.Execute(request);package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{baseUrl}}/users/:userEmail"
payload := strings.NewReader("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("content-type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}PATCH /baseUrl/users/:userEmail HTTP/1.1
Content-Type: application/json
Host: example.com
Content-Length: 173
{
"email": "",
"firstName": "",
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false
}AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("PATCH", "{{baseUrl}}/users/:userEmail")
.setHeader("content-type", "application/json")
.setBody("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}")
.execute()
.toCompletableFuture()
.thenAccept(System.out::println)
.join();
client.close();HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("{{baseUrl}}/users/:userEmail"))
.header("content-type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}"))
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body()); OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/users/:userEmail")
.patch(body)
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();HttpResponse response = Unirest.patch("{{baseUrl}}/users/:userEmail")
.header("content-type", "application/json")
.body("{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}")
.asString(); const data = JSON.stringify({
email: '',
firstName: '',
lastName: '',
metadata: {
tags: []
},
personId: '',
profile: {
displayName: ''
},
sendInvite: false
});
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener('readystatechange', function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open('PATCH', '{{baseUrl}}/users/:userEmail');
xhr.setRequestHeader('content-type', 'application/json');
xhr.send(data);import axios from 'axios';
const options = {
method: 'PATCH',
url: '{{baseUrl}}/users/:userEmail',
headers: {'content-type': 'application/json'},
data: {
email: '',
firstName: '',
lastName: '',
metadata: {tags: []},
personId: '',
profile: {displayName: ''},
sendInvite: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const url = '{{baseUrl}}/users/:userEmail';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"email":"","firstName":"","lastName":"","metadata":{"tags":[]},"personId":"","profile":{"displayName":""},"sendInvite":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}const settings = {
async: true,
crossDomain: true,
url: '{{baseUrl}}/users/:userEmail',
method: 'PATCH',
headers: {
'content-type': 'application/json'
},
processData: false,
data: '{\n "email": "",\n "firstName": "",\n "lastName": "",\n "metadata": {\n "tags": []\n },\n "personId": "",\n "profile": {\n "displayName": ""\n },\n "sendInvite": false\n}'
};
$.ajax(settings).done(function (response) {
console.log(response);
});val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}")
val request = Request.Builder()
.url("{{baseUrl}}/users/:userEmail")
.patch(body)
.addHeader("content-type", "application/json")
.build()
val response = client.newCall(request).execute()const http = require('https');
const options = {
method: 'PATCH',
hostname: 'example.com',
port: null,
path: '/baseUrl/users/:userEmail',
headers: {
'content-type': 'application/json'
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on('data', function (chunk) {
chunks.push(chunk);
});
res.on('end', function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write(JSON.stringify({
email: '',
firstName: '',
lastName: '',
metadata: {tags: []},
personId: '',
profile: {displayName: ''},
sendInvite: false
}));
req.end();const request = require('request');
const options = {
method: 'PATCH',
url: '{{baseUrl}}/users/:userEmail',
headers: {'content-type': 'application/json'},
body: {
email: '',
firstName: '',
lastName: '',
metadata: {tags: []},
personId: '',
profile: {displayName: ''},
sendInvite: false
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});const unirest = require('unirest');
const req = unirest('PATCH', '{{baseUrl}}/users/:userEmail');
req.headers({
'content-type': 'application/json'
});
req.type('json');
req.send({
email: '',
firstName: '',
lastName: '',
metadata: {
tags: []
},
personId: '',
profile: {
displayName: ''
},
sendInvite: false
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});const axios = require('axios').default;
const options = {
method: 'PATCH',
url: '{{baseUrl}}/users/:userEmail',
headers: {'content-type': 'application/json'},
data: {
email: '',
firstName: '',
lastName: '',
metadata: {tags: []},
personId: '',
profile: {displayName: ''},
sendInvite: false
}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}const fetch = require('node-fetch');
const url = '{{baseUrl}}/users/:userEmail';
const options = {
method: 'PATCH',
headers: {'content-type': 'application/json'},
body: '{"email":"","firstName":"","lastName":"","metadata":{"tags":[]},"personId":"","profile":{"displayName":""},"sendInvite":false}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}#import
NSDictionary *headers = @{ @"content-type": @"application/json" };
NSDictionary *parameters = @{ @"email": @"",
@"firstName": @"",
@"lastName": @"",
@"metadata": @{ @"tags": @[ ] },
@"personId": @"",
@"profile": @{ @"displayName": @"" },
@"sendInvite": @NO };
NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"{{baseUrl}}/users/:userEmail"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"PATCH"];
[request setAllHTTPHeaderFields:headers];
[request setHTTPBody:postData];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSLog(@"%@", httpResponse);
}
}];
[dataTask resume]; open Cohttp_lwt_unix
open Cohttp
open Lwt
let uri = Uri.of_string "{{baseUrl}}/users/:userEmail" in
let headers = Header.add (Header.init ()) "content-type" "application/json" in
let body = Cohttp_lwt_body.of_string "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}" in
Client.call ~headers ~body `PATCH uri
>>= fun (res, body_stream) ->
(* Do stuff with the result *) "{{baseUrl}}/users/:userEmail",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'email' => '',
'firstName' => '',
'lastName' => '',
'metadata' => [
'tags' => [
]
],
'personId' => '',
'profile' => [
'displayName' => ''
],
'sendInvite' => null
]),
CURLOPT_HTTPHEADER => [
"content-type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}request('PATCH', '{{baseUrl}}/users/:userEmail', [
'body' => '{
"email": "",
"firstName": "",
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false
}',
'headers' => [
'content-type' => 'application/json',
],
]);
echo $response->getBody();setUrl('{{baseUrl}}/users/:userEmail');
$request->setMethod(HttpRequest::HTTP_METH_PATCH);
$request->setHeaders([
'content-type' => 'application/json'
]);
$request->setContentType('application/json');
$request->setBody(json_encode([
'email' => '',
'firstName' => '',
'lastName' => '',
'metadata' => [
'tags' => [
]
],
'personId' => '',
'profile' => [
'displayName' => ''
],
'sendInvite' => null
]));
try {
$response = $request->send();
echo $response->getBody();
} catch (HttpException $ex) {
echo $ex;
}append(json_encode([
'email' => '',
'firstName' => '',
'lastName' => '',
'metadata' => [
'tags' => [
]
],
'personId' => '',
'profile' => [
'displayName' => ''
],
'sendInvite' => null
]));
$request->setRequestUrl('{{baseUrl}}/users/:userEmail');
$request->setRequestMethod('PATCH');
$request->setBody($body);
$request->setHeaders([
'content-type' => 'application/json'
]);
$client->enqueue($request)->send();
$response = $client->getResponse();
echo $response->getBody();$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-WebRequest -Uri '{{baseUrl}}/users/:userEmail' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"email": "",
"firstName": "",
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false
}'$headers=@{}
$headers.Add("content-type", "application/json")
$response = Invoke-RestMethod -Uri '{{baseUrl}}/users/:userEmail' -Method PATCH -Headers $headers -ContentType 'application/json' -Body '{
"email": "",
"firstName": "",
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false
}'import http.client
conn = http.client.HTTPSConnection("example.com")
payload = "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}"
headers = { 'content-type': "application/json" }
conn.request("PATCH", "/baseUrl/users/:userEmail", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))import requests
url = "{{baseUrl}}/users/:userEmail"
payload = {
"email": "",
"firstName": "",
"lastName": "",
"metadata": { "tags": [] },
"personId": "",
"profile": { "displayName": "" },
"sendInvite": False
}
headers = {"content-type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())library(httr)
url <- "{{baseUrl}}/users/:userEmail"
payload <- "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}"
encode <- "json"
response <- VERB("PATCH", url, body = payload, content_type("application/json"), encode = encode)
content(response, "text")require 'uri'
require 'net/http'
url = URI("{{baseUrl}}/users/:userEmail")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["content-type"] = 'application/json'
request.body = "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}"
response = http.request(request)
puts response.read_bodyrequire 'faraday'
conn = Faraday.new(
url: 'https://example.com',
headers: {'Content-Type' => 'application/json'}
)
response = conn.patch('/baseUrl/users/:userEmail') do |req|
req.body = "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"metadata\": {\n \"tags\": []\n },\n \"personId\": \"\",\n \"profile\": {\n \"displayName\": \"\"\n },\n \"sendInvite\": false\n}"
end
puts response.status
puts response.bodyuse std::str::FromStr;
use serde_json::json;
use reqwest;
#[tokio::main]
pub async fn main() {
let url = "{{baseUrl}}/users/:userEmail";
let payload = json!({
"email": "",
"firstName": "",
"lastName": "",
"metadata": json!({"tags": ()}),
"personId": "",
"profile": json!({"displayName": ""}),
"sendInvite": false
});
let mut headers = reqwest::header::HeaderMap::new();
headers.insert("content-type", "application/json".parse().unwrap());
let client = reqwest::Client::new();
let response = client.request(reqwest::Method::from_str("PATCH").unwrap(), url)
.headers(headers)
.json(&payload)
.send()
.await;
let results = response.unwrap()
.json::()
.await
.unwrap();
dbg!(results);
}
curl --request PATCH \
--url {{baseUrl}}/users/:userEmail \
--header 'content-type: application/json' \
--data '{
"email": "",
"firstName": "",
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false
}'echo '{
"email": "",
"firstName": "",
"lastName": "",
"metadata": {
"tags": []
},
"personId": "",
"profile": {
"displayName": ""
},
"sendInvite": false
}' | \
http PATCH {{baseUrl}}/users/:userEmail \
content-type:application/jsonwget --quiet \
--method PATCH \
--header 'content-type: application/json' \
--body-data '{\n "email": "",\n "firstName": "",\n "lastName": "",\n "metadata": {\n "tags": []\n },\n "personId": "",\n "profile": {\n "displayName": ""\n },\n "sendInvite": false\n}' \
--output-document \
- {{baseUrl}}/users/:userEmailimport Foundation
let headers = ["content-type": "application/json"]
let parameters = [
"email": "",
"firstName": "",
"lastName": "",
"metadata": ["tags": []],
"personId": "",
"profile": ["displayName": ""],
"sendInvite": false
] as [String : Any]
let postData = JSONSerialization.data(withJSONObject: parameters, options: [])
let request = NSMutableURLRequest(url: NSURL(string: "{{baseUrl}}/users/:userEmail")! as URL,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data
let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
if (error != nil) {
print(error as Any)
} else {
let httpResponse = response as? HTTPURLResponse
print(httpResponse)
}
})
dataTask.resume()RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The badge already exists in the offering OFFERING ID.",
"name": "ObjectExistsError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"email\".",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "PARAMETER_NAME PARAMETER_VALUE should match format \"example\"",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should NOT be shorter than 3 characters",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "[PARAMETER_NAME] PARAMETER_VALUE should be string",
"name": "SchemaValidationError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "No authorization token was found.",
"name": "NotAuthorizedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "You are not allowed to access this resource",
"name": "AccessDeniedError"
}RESPONSE HEADERS
Content-Type
application/json
RESPONSE BODY json
{
"details": "The content badcontentId was not found.",
"name": "ObjectNotFoundError"
}