1 of 34

API reference

Achievements

ContractTypes

EmploymentContracts

EmploymentRelations

Employments

Achievements

ApprovedAchievements

InProgressEntries

Positions

ReferringRelations

SubmittedAchievements

EmploymentUnavailabilities

EvidenceVariants

Achievements

InProgressEntries

Groupings

DefinedGroupings

GroupingTypes

Instances

InProgressEntries

MeasurementSystems

Qualifications

MeasurementValues

Positions

Qualifications

Achievements

EvidenceVariants

InProgressEntries

QualificationTypes

Qualifications

ServiceIsAvailable

ServiceVersion

List all achievements viewable for API user

get

/achievements

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Successful request

get

/achievements/{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 '/achievements/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

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

Successful request

get

/employments/{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

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

200

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

Successful request

List all contractTypes viewable for API user

get

/contractTypes

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Successful request

get

/contractTypes/{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 '/contractTypes/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "name": "text",
  "externalCode": "text",
  "lastModifiedAt": "text",
  "createdAt": "text",
  "externalId": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "code": "text"
}

Successful request

get

/contractTypes/{id}/employmentContracts

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 '/contractTypes/{id}/employmentContracts' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {},
      "externalCode": "text",
      "createdAt": "text",
      "contractTypeID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "externalId": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

List all employmentContracts viewable for API user

get

/employmentContracts

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {},
      "externalCode": "text",
      "createdAt": "text",
      "contractTypeID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "externalId": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/employmentContracts/{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 '/employmentContracts/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "interval": {},
  "externalCode": "text",
  "createdAt": "text",
  "contractTypeID": "550e8400-e29b-41d4-a716-446655440000",
  "lastModifiedAt": "text",
  "externalId": "text",
  "employmentID": "550e8400-e29b-41d4-a716-446655440000"
}

Successful request

List all employments viewable for API user

get

/employments

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "results": [
    {
      "externalCode": "text",
      "remark": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "employeeNumber": "text",
      "externalId": "text",
      "firstName": "text",
      "customValues": {},
      "employmentContracts": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "interval": {},
          "externalCode": "text",
          "createdAt": "text",
          "contractTypeID": "550e8400-e29b-41d4-a716-446655440000",
          "lastModifiedAt": "text",
          "externalId": "text",
          "employmentID": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "email": "text",
      "createdAt": "text",
      "surname": "text",
      "initials": "text",
      "relations": [
        {
          "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
          "lastModifiedAt": "text",
          "createdAt": "text",
          "interval": {},
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "birthDate": "2025-03-12",
      "referringRelations": [
        {
          "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
          "lastModifiedAt": "text",
          "createdAt": "text",
          "interval": {},
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "employmentUnavailabilities": [
        {
          "reason": "text",
          "lastModifiedAt": "text",
          "createdAt": "text",
          "interval": {},
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "employmentID": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "positions": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "interval": {},
          "externalCode": "text",
          "createdAt": "text",
          "externalId": "text",
          "lastModifiedAt": "text",
          "employmentID": "550e8400-e29b-41d4-a716-446655440000",
          "tagIDs": [
            "550e8400-e29b-41d4-a716-446655440000"
          ]
        }
      ],
      "lastModifiedAt": "text"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/employments/{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 '/employments/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "externalCode": "text",
  "remark": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "employeeNumber": "text",
  "externalId": "text",
  "firstName": "text",
  "customValues": {},
  "employmentContracts": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {},
      "externalCode": "text",
      "createdAt": "text",
      "contractTypeID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "externalId": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "email": "text",
  "createdAt": "text",
  "surname": "text",
  "initials": "text",
  "relations": [
    {
      "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "createdAt": "text",
      "interval": {},
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "birthDate": "2025-03-12",
  "referringRelations": [
    {
      "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "createdAt": "text",
      "interval": {},
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "employmentUnavailabilities": [
    {
      "reason": "text",
      "lastModifiedAt": "text",
      "createdAt": "text",
      "interval": {},
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "positions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {},
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "lastModifiedAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "tagIDs": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    }
  ],
  "lastModifiedAt": "text"
}

Successful request

List all employmentRelations viewable for API user

get

/employmentRelations

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "results": [
    {
      "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "createdAt": "text",
      "interval": {},
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/employmentRelations/{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 '/employmentRelations/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
  "lastModifiedAt": "text",
  "createdAt": "text",
  "interval": {},
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
}

Successful request

get

/employments/{id}/positions

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 '/employments/{id}/positions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {},
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "lastModifiedAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "tagIDs": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/employments/{id}/approvedAchievements

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 '/employments/{id}/approvedAchievements' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

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

Successful request

get

/employments/{id}/referringRelations

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 '/employments/{id}/referringRelations' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "results": [
    {
      "fromEmploymentID": "550e8400-e29b-41d4-a716-446655440000",
      "lastModifiedAt": "text",
      "createdAt": "text",
      "interval": {},
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "toEmploymentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/employments/{id}/submittedAchievements

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 '/employments/{id}/submittedAchievements' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

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

Successful request

get

/employments/{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

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

200

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

Successful request

List all evidenceVariants viewable for API user

get

/evidenceVariants

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/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

get

/evidenceVariants/{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 '/evidenceVariants/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

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

Successful request

List all employmentUnavailabilities viewable for API user

get

/employmentUnavailabilities

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "results": [
    {
      "reason": "text",
      "lastModifiedAt": "text",
      "createdAt": "text",
      "interval": {},
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/employmentUnavailabilities/{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 '/employmentUnavailabilities/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "reason": "text",
  "lastModifiedAt": "text",
  "createdAt": "text",
  "interval": {},
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "employmentID": "550e8400-e29b-41d4-a716-446655440000"
}

Successful request

List all groupings viewable for API user

get

/groupings

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Successful request

get

/groupings/{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 '/groupings/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "code": "text",
  "lastModifiedAt": "text",
  "typeID": "550e8400-e29b-41d4-a716-446655440000",
  "externalCode": "text",
  "createdAt": "text",
  "description": "text",
  "externalId": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "text",
  "definedInGroupingID": "550e8400-e29b-41d4-a716-446655440000",
  "interval": {}
}

Successful request

get

/evidenceVariants/{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

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

200

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

Successful request

List all groupingTypes viewable for API user

get

/groupingTypes

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Successful request

get

/groupingTypes/{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 '/groupingTypes/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "name": "text",
  "externalCode": "text",
  "lastModifiedAt": "text",
  "createdAt": "text",
  "externalId": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "code": "text"
}

Successful request

get

/groupings/{id}/definedGroupings

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 '/groupings/{id}/definedGroupings' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

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

Successful request

get

/groupingTypes/{id}/instances

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 '/groupingTypes/{id}/instances' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

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

Successful request

get

/evidenceVariants/{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

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

200

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

Successful request

get

/measurementSystems/{id}/qualifications

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 '/measurementSystems/{id}/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

List all inProgressEntries viewable for API user

get

/inProgressEntries

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Successful request

get

/inProgressEntries/{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 '/inProgressEntries/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

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

Successful request

List all measurementSystems viewable for API user

get

/measurementSystems

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "results": [
    {
      "measurementValues": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "order": 1,
          "externalCode": "text",
          "createdAt": "text",
          "externalId": "text",
          "lastModifiedAt": "text",
          "code": "text",
          "name": "text"
        }
      ],
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "lastModifiedAt": "text",
      "scale": 1,
      "name": "text"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/measurementSystems/{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 '/measurementSystems/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "measurementValues": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "order": 1,
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "lastModifiedAt": "text",
      "code": "text",
      "name": "text"
    }
  ],
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "externalCode": "text",
  "createdAt": "text",
  "externalId": "text",
  "lastModifiedAt": "text",
  "scale": 1,
  "name": "text"
}

Successful request

List all measurementValues viewable for API user

get

/measurementValues

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "order": 1,
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "lastModifiedAt": "text",
      "code": "text",
      "name": "text"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/measurementValues/{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 '/measurementValues/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "order": 1,
  "externalCode": "text",
  "createdAt": "text",
  "externalId": "text",
  "lastModifiedAt": "text",
  "code": "text",
  "name": "text"
}

Successful request

List all positions viewable for API user

get

/positions

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "interval": {},
      "externalCode": "text",
      "createdAt": "text",
      "externalId": "text",
      "lastModifiedAt": "text",
      "employmentID": "550e8400-e29b-41d4-a716-446655440000",
      "tagIDs": [
        "550e8400-e29b-41d4-a716-446655440000"
      ]
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/positions/{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 '/positions/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "interval": {},
  "externalCode": "text",
  "createdAt": "text",
  "externalId": "text",
  "lastModifiedAt": "text",
  "employmentID": "550e8400-e29b-41d4-a716-446655440000",
  "tagIDs": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}

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

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

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

200

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

Successful request

List all qualificationTypes viewable for API user

get

/qualificationTypes

Authorizations

Query parameters

pageTokenstring

limitinteger · int32

sinceDeltaTokenstring

fieldsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "results": [
    {
      "name": "text",
      "externalCode": "text",
      "lastModifiedAt": "text",
      "createdAt": "text",
      "externalId": "text",
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "deltaToken": "text",
  "pageToken": "text"
}

Successful request

get

/qualificationTypes/{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 '/qualificationTypes/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

{
  "name": "text",
  "externalCode": "text",
  "lastModifiedAt": "text",
  "createdAt": "text",
  "externalId": "text",
  "id": "550e8400-e29b-41d4-a716-446655440000"
}

Successful request

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

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

200

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

Successful request

get

/qualificationTypes/{id}/qualifications

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 '/qualificationTypes/{id}/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

/serviceIsAvailable

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

true

Successful request

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

get

/serviceVersion

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

{
  "serviceName": "text",
  "version": "text"
}

Successful request