Skip to content

Staff Skills

Partner-facing endpoints for retrieving the staff skill grid and related metadata for a site within a domain.

Operations

Get staff skill grid for a site

Request

Returns the staff skills grid, exam mappings, and comments for the specified domain and site when authorized.

Security
Bearer
Path
domainstringrequired

Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.

Example:acme
siteNamestringrequired

Site name within the specified domain. Multi-site clients typically share a domain and differentiate sites with this value.

Example:Example Site
Headers
X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:4b7f0a91b4f54f2a
curl -i -X GET \
  'https://partnerdocs.qubs.io/_mock/openapi/integrations/v1/acme/sites/Example Site/staff-skills' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-Id: 4b7f0a91b4f54f2a'

Responses

Staff skills grid and related metadata for the requested domain and site.

Headers
X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:"4b7f0a91b4f54f2a"
Bodyapplication/json
examKeysArray of strings

Ordered list of exam keys used as columns in the grid.

Example:
[
  "Example examKeys"
]
examDisplayobject

Map of exam key to display label.

headerCommentsobject

Map of exam key to optional header comment/marker metadata.

employeesArray of objects(EmployeeSkillResponse)

List of staff rows in the grid.

examSitesobject

Map of exam key to list of sites where the exam is available.

skToExamCodeIdobject

Map of internal exam key to examCodeId.

examCodeSiteKeysobject

Nested map of examCodeId to site name to internal key.

Response
{
  "examKeys": [
    "CT_CHEST"
  ],
  "examDisplay": {
    "CT_CHEST": "CT Chest"
  },
  "headerComments": {
    "CT_CHEST": { … }
  },
  "employees": [
    { … }
  ],
  "examSites": {
    "CT_CHEST": [ … ]
  },
  "skToExamCodeId": {
    "CT_CHEST": "EC100"
  },
  "examCodeSiteKeys": {
    "EC100": { … }
  }
}