Solia Direct DocsControl Plane
⌘K

API ReferenceReference

Serviceability endpoints

Exact request and response contracts for the serviceability endpoints, generated from the enforced Partner API contract.

Machine-readable OpenAPI description

Endpoints in this group

POST/v1/serviceabilityCheck whether a location and test can be fulfilled

Base path: /api/public/partner/v1. Every response carries request_id; every failure uses the standard error envelope documented under Errors.

POST/v1/serviceability

Check whether a location and test can be fulfilled

Authentication & scope

  • Authentication: Authorization: Bearer <API key>. The key is bound to one laboratory, one API client and one environment.
  • Required scope: serviceability:read. A key without it is refused with 403 forbidden.

Request body

Required body fields: program_id, item_id.

json
{
  "program_id": "8f14e45f-ceea-4c2b-9b3f-2a1d0c7b6a11",
  "item_id": "1c9d5b70-3f42-4a51-8d0e-77b6c2419f83",
  "region": "string",
  "collection": "string"
}

Responses

  • 200 — Serviceability decision.
json
{
  "data": {
    "serviceable": true,
    "reasons": [
      "string"
    ]
  },
  "request_id": "string",
  "cursor": "string"
}