Skip to main content
POST
cURL

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

competency_requirement_specification_id
string<uuid>
required

The unique identifier for the competency requirement specification.

Query Parameters

include
enum<string>[]

A comma separated list of related resources to include.

Available options:
qualifications,
qualification_units,
skills_registers,
skills_register_schemes,
skills_register_scheme_categories,
training_standards,
training_items,
inductions,
assessment_definitions,
qualification_awards,
training_completions,
induction_completions,
registrations,
scheme_registrations,
category_registrations,
assessment_records

Body

application/vnd.api+json

The collection of users to evaluate compliance for.

data
An array of users · object[]
required
Minimum array length: 1

Response

Per-user compliance results for a CRS — one entry per user supplied in the request.

JSON API response object

data
object[]
required
jsonapi
object
required
included
object[]

Related resources that can be included when a compliance result is returned.

A qualification