Skip to main content
POST
/
{assessmentType}
cURL
curl --request POST \
  --url https://api-v2.production.higg.org/api/v1/moduleshares/{assessmentType} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-developer-request-token: <api-key>' \
  --data '
{
  "from": 123,
  "size": 123,
  "assessmentIds": [
    "<string>"
  ],
  "shareStatus": [
    "<string>"
  ],
  "status": [
    "<string>"
  ],
  "version": "<string>",
  "dctVersion": "<string>",
  "reportingPeriodStart": 123,
  "reportingPeriodEnd": 123,
  "cafVersion": "<string>",
  "slcpAssessmentId": "<string>",
  "accountIds": [
    "<string>"
  ],
  "wildcardSearch": {
    "accountName": "<string>",
    "accountId": "<string>"
  },
  "country": "<string>",
  "lastActivityDate": 123,
  "actionsHistory": [
    "<string>"
  ]
}
'
import requests

url = "https://api-v2.production.higg.org/api/v1/moduleshares/{assessmentType}"

payload = {
"from": 123,
"size": 123,
"assessmentIds": ["<string>"],
"shareStatus": ["<string>"],
"status": ["<string>"],
"version": "<string>",
"dctVersion": "<string>",
"reportingPeriodStart": 123,
"reportingPeriodEnd": 123,
"cafVersion": "<string>",
"slcpAssessmentId": "<string>",
"accountIds": ["<string>"],
"wildcardSearch": {
"accountName": "<string>",
"accountId": "<string>"
},
"country": "<string>",
"lastActivityDate": 123,
"actionsHistory": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"x-developer-request-token": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-developer-request-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
from: 123,
size: 123,
assessmentIds: ['<string>'],
shareStatus: ['<string>'],
status: ['<string>'],
version: '<string>',
dctVersion: '<string>',
reportingPeriodStart: 123,
reportingPeriodEnd: 123,
cafVersion: '<string>',
slcpAssessmentId: '<string>',
accountIds: ['<string>'],
wildcardSearch: {accountName: '<string>', accountId: '<string>'},
country: '<string>',
lastActivityDate: 123,
actionsHistory: ['<string>']
})
};

fetch('https://api-v2.production.higg.org/api/v1/moduleshares/{assessmentType}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api-v2.production.higg.org/api/v1/moduleshares/{assessmentType}",
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([
'from' => 123,
'size' => 123,
'assessmentIds' => [
'<string>'
],
'shareStatus' => [
'<string>'
],
'status' => [
'<string>'
],
'version' => '<string>',
'dctVersion' => '<string>',
'reportingPeriodStart' => 123,
'reportingPeriodEnd' => 123,
'cafVersion' => '<string>',
'slcpAssessmentId' => '<string>',
'accountIds' => [
'<string>'
],
'wildcardSearch' => [
'accountName' => '<string>',
'accountId' => '<string>'
],
'country' => '<string>',
'lastActivityDate' => 123,
'actionsHistory' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-developer-request-token: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api-v2.production.higg.org/api/v1/moduleshares/{assessmentType}"

payload := strings.NewReader("{\n \"from\": 123,\n \"size\": 123,\n \"assessmentIds\": [\n \"<string>\"\n ],\n \"shareStatus\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ],\n \"version\": \"<string>\",\n \"dctVersion\": \"<string>\",\n \"reportingPeriodStart\": 123,\n \"reportingPeriodEnd\": 123,\n \"cafVersion\": \"<string>\",\n \"slcpAssessmentId\": \"<string>\",\n \"accountIds\": [\n \"<string>\"\n ],\n \"wildcardSearch\": {\n \"accountName\": \"<string>\",\n \"accountId\": \"<string>\"\n },\n \"country\": \"<string>\",\n \"lastActivityDate\": 123,\n \"actionsHistory\": [\n \"<string>\"\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-developer-request-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api-v2.production.higg.org/api/v1/moduleshares/{assessmentType}")
.header("x-api-key", "<api-key>")
.header("x-developer-request-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"from\": 123,\n \"size\": 123,\n \"assessmentIds\": [\n \"<string>\"\n ],\n \"shareStatus\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ],\n \"version\": \"<string>\",\n \"dctVersion\": \"<string>\",\n \"reportingPeriodStart\": 123,\n \"reportingPeriodEnd\": 123,\n \"cafVersion\": \"<string>\",\n \"slcpAssessmentId\": \"<string>\",\n \"accountIds\": [\n \"<string>\"\n ],\n \"wildcardSearch\": {\n \"accountName\": \"<string>\",\n \"accountId\": \"<string>\"\n },\n \"country\": \"<string>\",\n \"lastActivityDate\": 123,\n \"actionsHistory\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-v2.production.higg.org/api/v1/moduleshares/{assessmentType}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-developer-request-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"from\": 123,\n \"size\": 123,\n \"assessmentIds\": [\n \"<string>\"\n ],\n \"shareStatus\": [\n \"<string>\"\n ],\n \"status\": [\n \"<string>\"\n ],\n \"version\": \"<string>\",\n \"dctVersion\": \"<string>\",\n \"reportingPeriodStart\": 123,\n \"reportingPeriodEnd\": 123,\n \"cafVersion\": \"<string>\",\n \"slcpAssessmentId\": \"<string>\",\n \"accountIds\": [\n \"<string>\"\n ],\n \"wildcardSearch\": {\n \"accountName\": \"<string>\",\n \"accountId\": \"<string>\"\n },\n \"country\": \"<string>\",\n \"lastActivityDate\": 123,\n \"actionsHistory\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "from": 123,
  "size": 123,
  "total": 123,
  "assessments": [
    {}
  ]
}

Authorizations

x-api-key
string
header
required
x-developer-request-token
string
header
required

Path Parameters

assessmentType
enum<string>
required
Available options:
fem,
fslm,
brm,
dct,
one,
ffc

Body

application/json
from
number<double> | null
size
number<double> | null
assessmentIds
string[] | null
shareStatus
string[] | null
status
string[] | null
version
string | null
dctVersion
string | null
reportingPeriodStart
number<double> | null
reportingPeriodEnd
number<double> | null
cafVersion
string | null
slcpAssessmentId
string | null
accountIds
string[] | null
wildcardSearch
object | null
country
string | null
lastActivityDate
number<double> | null
actionsHistory
string[] | null

Response

200 - application/json

Ok

from
number<double>
required
size
number<double>
required
total
number<double>
required
assessments
object[]
required