Skip to main content
POST
/
v3
/
competency-requirement-specifications
/
{competency_requirement_specification_id}
/
compliance
cURL
curl --request POST \
  --url https://api.ctrl-hub.com/v3/competency-requirement-specifications/{competency_requirement_specification_id}/compliance \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>"
    }
  ]
}
'
{
  "data": [
    {
      "id": "aaaaaaaa-0000-0000-0000-000000000001:bbbbbbbb-0000-0000-0000-000000000001",
      "type": "<string>",
      "attributes": {
        "satisfied": true,
        "report": {
          "satisfied": true,
          "type": "qualifications",
          "reference_id": "aaaaaaaa-0000-0000-0000-000000000001"
        }
      },
      "relationships": {
        "competency_requirement_specification": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        },
        "user": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ],
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "qualification_number": "<string>",
        "title": "<string>",
        "status": "ingested",
        "provenance": "ofqual",
        "level": "<string>",
        "sub_level": "<string>",
        "type": "<string>",
        "total_credits": 123,
        "guided_learning_hours": 123,
        "total_qualification_time": 123,
        "ssa": "<string>",
        "operational_start_date": "2023-11-07T05:31:56Z",
        "operational_end_date": "2023-11-07T05:31:56Z",
        "regulation_status": "<string>",
        "awarding_body_rn": "<string>",
        "awarding_body_name": "<string>"
      },
      "meta": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "relationships": {
        "awarding_body": {
          "data": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        }
      }
    }
  ]
}

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