Qualifications

List all qualifications viewable for API user

get

Authorizations

bearer-token

AuthorizationstringRequired

This API uses Bearer token authentication.

Requests to this API should contain an Authorization header like this:

Authorization: Bearer [Token]

Query parameters

pageTokenstringOptional

limitinteger · int32Optional

sinceDeltaTokenstringOptional

fieldsstring[]Optional

Responses

200

Successful request

application/json

deltaTokenstringRequired

pageTokenstringRequired

get/qualifications

HTTPcURLJavaScriptPython

GET /qualifications HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful request

{
  "results": [
    {
      "interval": {},
      "description": "text",
      "createdAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "externalCode": "text",
      "evidenceVariants": [
        {
          "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
          "lastModifiedAt": "text",
          "externalCode": "text",
          "createdAt": "text",
          "externalId": "text",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "code": "text",
          "name": "text",
          "interval": {}
        }
      ],
      "lastModifiedAt": "text",
      "qualificationTypeID": "550e8400-e29b-41d4-a716-446655440000",
      "measurementSystemID": "550e8400-e29b-41d4-a716-446655440000",
      "name": "text",
      "externalId": "text",
      "code": "text"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

get

Authorizations

bearer-token

AuthorizationstringRequired

This API uses Bearer token authentication.

Requests to this API should contain an Authorization header like this:

Authorization: Bearer [Token]

Path parameters

idstring · hexadecimal-integerRequiredExample: 550e8400-e29b-41d4-a716-446655440000Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

Responses

200

Successful request

application/json

intervalobject · objectRequired

descriptionstringOptional

createdAtstring · timestampRequired

idstring · hexadecimal-integerRequiredExample: 550e8400-e29b-41d4-a716-446655440000Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

externalCodestringOptional

lastModifiedAtstring · timestampRequired

qualificationTypeIDstring · hexadecimal-integerRequiredExample: 550e8400-e29b-41d4-a716-446655440000Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

measurementSystemIDstring · hexadecimal-integerRequiredExample: 550e8400-e29b-41d4-a716-446655440000Pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

namestringRequired

externalIdstringOptional

codestringOptional

get/qualifications/{id}

HTTPcURLJavaScriptPython

GET /qualifications/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful request

{
  "interval": {},
  "description": "text",
  "createdAt": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "externalCode": "text",
  "evidenceVariants": [
    {
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "code": "text",
      "name": "text",
      "interval": {}
    }
  ],
  "lastModifiedAt": "text",
  "qualificationTypeID": "550e8400-e29b-41d4-a716-446655440000",
  "measurementSystemID": "550e8400-e29b-41d4-a716-446655440000",
  "name": "text",
  "externalId": "text",
  "code": "text"
}