Skip to main content
PUT
/
v3
/
qualifications
/
{qualification_id}
Update a qualification
curl --request PUT \
  --url https://api.ctrl-hub.com/v3/qualifications/{qualification_id} \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "status": "ingested"
    }
  }
}
'
{
  "data": {
    "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>"
        }
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "name": "<string>",
        "provenance": "ofqual",
        "recognition_number": "<string>",
        "legal_name": "<string>",
        "acronym": "<string>",
        "website": "<string>",
        "ofqual_status": "Recognised"
      }
    }
  ]
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

qualification_id
string<uuid>
required

The unique identifier for the qualification.

Body

application/vnd.api+json

The qualification fields to update. Only admin-managed fields can be changed — synced fields are overwritten by the sync pipeline.

data
object
required

Response

Get a qualification.

JSON API response object

data
object
required

A qualification

jsonapi
object
required
included
object[]

Related resources that can be included when a qualification is returned