AG5.com

get

/qualifications/{id}/inProgressEntries

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[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}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

200

Successful request

get

/qualifications/{id}/achievements

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[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}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

200

Successful request

{
  "results": [
    {
      "remark": "text",
      "toDate": "2025-03-12",
      "lastModifiedAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "plannedScoreOrder": 1,
      "closeDate": "2025-03-12",
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "text",
      "externalCode": "text",
      "fromDate": "2025-03-12",
      "createdAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "deadlineDate": "2025-03-12"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

{
  "results": [
    {
      "remark": "text",
      "lastModifiedAt": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "issueDate": "2025-03-12",
      "overriddenExpirationDate": "2025-03-12",
      "qualificationID": "550e8400-e29b-41d4-a716-446655440000",
      "evidenceVariantID": "550e8400-e29b-41d4-a716-446655440000",
      "externalId": "text",
      "documents": [
        {
          "contentType": "text",
          "filename": "text"
        }
      ],
      "externalCode": "text",
      "scoreOrder": 1,
      "submittedByID": "550e8400-e29b-41d4-a716-446655440000",
      "approvedByID": "550e8400-e29b-41d4-a716-446655440000",
      "isAutoAchieved": true,
      "createdAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "expirationDate": "2025-03-12"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

get

/qualifications/{id}/evidenceVariants

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[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}$

Query parameters

pageTokenstring

limitinteger · int32

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/qualifications/{id}/evidenceVariants' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "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": {}
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

List all qualifications viewable for API user

get

/qualifications

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/qualifications' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "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"
}

Successful request

get

/qualifications/{id}

Authorizations

Path parameters

idstring · hexadecimal-integerrequired

Example: 550e8400-e29b-41d4-a716-446655440000

Pattern: ^[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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/qualifications/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "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"
}

Successful request

Qualifications

Achievements

EvidenceVariants

InProgressEntries

InProgressEntries

Achievements

EvidenceVariants

Qualifications

List all qualifications viewable for API user