Skip to content

List exam codes for a site

Request

Returns exam codes for the specified domain and site when the caller is authorized.

Response body is a JSON array. Fields below apply to each array item.

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/exam-codes' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-Id: 4b7f0a91b4f54f2a'

Responses

Array of exam codes 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
Array [
examCodeIdstringrequired

Unique exam code identifier.

Example:"123"
keystringrequired

QUBS internal key for the exam code record.

Example:"Example key"
sitestringrequired

Site this exam code belongs to.

Example:"Example site"
descriptionstringrequired

Human-readable exam description.

Example:"Example description"
categorystring

Optional exam category.

Example:"Example category"
modalitystring

Optional imaging modality.

Example:"Example modality"
totalDurationinteger, (int32)

Configured duration in minutes.

Example:1
showOnlineboolean

Whether this exam code is visible/available online.

Example:true
lastModifiedDateTimestring, (date-time)

When the exam code was last updated.

Example:"2020-01-01T00:00:00Z"
]
Response
[
  {
    "examCodeId": "EC100",
    "key": "CT_CHEST",
    "site": "Central Clinic",
    "description": "CT Chest",
    "category": "CT",
    "modality": "CT",
    "totalDuration": 15,
    "showOnline": true,
    "lastModifiedDateTime": "2025-01-10T02:03:04Z"
  }
]