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>"
  ]
}
'
{
  "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
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