Skip to main content
POST
/
v3
/
qualification-awards
Create a new award for a qualification
curl --request POST \
  --url https://api.ctrl-hub.com/v3/qualification-awards \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "type": "<string>",
    "attributes": {
      "status": "<string>",
      "due": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "organisation": {
        "data": {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "qualification": {
        "data": {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "user": {
        "data": {
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "status": "assigned",
      "due": "2023-11-07T05:31:56Z",
      "awarded_at": "2023-11-07T05:31:56Z"
    },
    "meta": {
      "created_at": "2023-11-07T05:31:56Z",
      "risks": {
        "current": "none",
        "thresholds": {
          "none": "2023-11-07T05:31:56Z",
          "low": "2023-11-07T05:31:56Z",
          "medium": "2023-11-07T05:31:56Z",
          "high": "2023-11-07T05:31:56Z",
          "critical": "2023-11-07T05:31:56Z"
        },
        "next_check": "2023-11-07T05:31:56Z"
      },
      "is_valid": true,
      "is_latest": true,
      "updated_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "user": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "author": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "qualification": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "assessments": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      ],
      "renewed_by": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "renews": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      },
      "folder": {
        "data": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  },
  "included": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "<string>",
      "attributes": {
        "email": "[email protected]",
        "identities": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "platform": "<string>",
            "meta": {}
          }
        ],
        "profile": {
          "work": {
            "occupation": "<string>",
            "cscs": "<string>",
            "eusr": "<string>",
            "start_date": "2023-12-25"
          },
          "personal": {
            "first_name": "<string>",
            "last_name": "<string>",
            "dob": "2023-12-25",
            "username": "<string>"
          },
          "contact": {
            "mobile": "<string>",
            "landline": "<string>"
          },
          "address": {
            "number": "",
            "street": "<string>",
            "area": "<string>",
            "town": "<string>",
            "county": "<string>",
            "postcode": "<string>",
            "country_code": "<string>",
            "what3words": "<string>"
          },
          "settings": {
            "preferred_language": "en-GB",
            "timezone": "<string>"
          }
        }
      },
      "meta": {
        "grants": [
          "<string>"
        ]
      },
      "relationships": {
        "organisations": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        },
        "teams": {
          "data": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "type": "<string>"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Body

application/vnd.api+json

The qualification award to create.

data
object
required

Response

Get a Qualification award

JSON API response object

data
object
required

A qualification award

jsonapi
object
required
included
object[]

Related resources that can be included when a qualification award is returned

A user