{"items":[{"type":"link","label":"QUBS Integrations API","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"QUBS Integrations API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"QUBS Integrations API (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partner-facing API providing read access to selected QUBS configuration and scheduling data, plus reporting submission endpoints for tele reporting workflows."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication is via a bearer JWT in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Authorization is domain-scoped; all requests include a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{domain}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter. Tokens are issued via the OAuth 2.0 client credentials flow (see Authentication below)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine-to-machine token handling:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access tokens expire after 60 minutes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cache and reuse the same access token for API calls until it is close to expiry; do not request a new token for every API request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request a replacement token around 50-55 minutes after issue, or after an authorization failure that indicates the token has expired."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The client credentials flow does not use refresh tokens. Token responses contain an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_in"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scopes/audience: no additional scopes are required for current integrations; authorization is domain-scoped via claims. Audience is managed by QUBS; use the client credentials provisioned for your integration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: no public sandbox environment is currently available."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Boundary errors use RFC7807 Problem Details ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/problem+json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Report workflow failures can instead use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; failed final submissions contain operationId, detail and workflowError. Inspect Content-Type before decoding errors. Retain X-Correlation-Id and any operationId for support; a requestId body field is not guaranteed for proxied workflow errors."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data handling: responses may include PHI (patient name/date of birth). Treat all such data as sensitive, apply least-privilege access, and avoid logging or storing longer than required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date/time conventions: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values use ISO 8601 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the scheduled site's local timezone (see "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SiteSettings.timeZone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date-time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are returned in UTC. Numeric values are JSON numbers (integers/decimals), not strings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination: cursor endpoints return page objects with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", while offset endpoints return arrays. For cursor paging, stop when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is empty/omitted; for offset paging, stop when the response count is less than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"take"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Ordering is not guaranteed and should not be assumed to be chronological."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retry guidance: for 429 responses, honor the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Retry-After"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header and use exponential backoff with jitter. GET requests are safe to retry. Report submissions require an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (up to 128 characters) and retain a durable operation receipt: identical retries replay the recorded outcome, and changed payloads under the same key return 409 Conflict. For network retries, preserve the original key and payload. Comment and attachment-upload endpoints only provide best-effort process-local deduplication with cache lifetimes of up to 24 hours and 15 minutes respectively. Cache eviction, restarts, different instances, or concurrent requests can produce duplicates even when a key is supplied. Do not treat those lifetimes as durable guarantees; verify existing records after an uncertain outcome before retrying. A pending report operation requires reconciliation, not another submission with a new key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rate limits: no fixed quotas or standard rate-limit headers are guaranteed. Use 429 responses and Retry-After when present."},"children":[]}]}]}]}],"sectionId":"/openapi"}],"sectionId":"/openapi"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/getting-started"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting started"},"children":[]}]}]}]}],"sectionId":"/openapi/section/getting-started"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/base-url"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base URL"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: https://partners.qubs.io"},"children":[]}]}]}]}]}],"sectionId":"/openapi/section/base-url"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request an access token using the OAuth 2.0 client credentials flow."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send it in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Bearer "},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token endpoint: https://authenticate.qubs.io/oauth2/token"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token request examples:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \"https://authenticate.qubs.io/oauth2/token\" \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n --data-urlencode \"grant_type=client_credentials\" \\\n --data-urlencode \"client_id=\" \\\n --data-urlencode \"client_secret=\"\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \"https://authenticate.qubs.io/oauth2/token\" \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n --data-urlencode \"grant_type=client_credentials\" \\\n --data-urlencode \"client_id=\" \\\n --data-urlencode \"client_secret=\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Unirest.setTimeouts(0, 0);\nHttpResponse response = Unirest.post(\"https://authenticate.qubs.io/oauth2/token\")\n .header(\"Content-Type\", \"application/x-www-form-urlencoded\")\n .field(\"grant_type\", \"client_credentials\")\n .field(\"client_id\", \"\")\n .field(\"client_secret\", \"\")\n .asString();\n","language":"java"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Unirest.setTimeouts(0, 0);\nHttpResponse response = Unirest.post(\"https://authenticate.qubs.io/oauth2/token\")\n .header(\"Content-Type\", \"application/x-www-form-urlencoded\")\n .field(\"grant_type\", \"client_credentials\")\n .field(\"client_id\", \"\")\n .field(\"client_secret\", \"\")\n .asString();\n"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Post, \"https://authenticate.qubs.io/oauth2/token\");\nrequest.Content = new FormUrlEncodedContent(new Dictionary\n{\n [\"grant_type\"] = \"client_credentials\",\n [\"client_id\"] = \"\",\n [\"client_secret\"] = \"\"\n});\nusing var response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nvar tokenPayload = await response.Content.ReadAsStringAsync();\n","language":"csharp"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"using var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Post, \"https://authenticate.qubs.io/oauth2/token\");\nrequest.Content = new FormUrlEncodedContent(new Dictionary\n{\n [\"grant_type\"] = \"client_credentials\",\n [\"client_id\"] = \"\",\n [\"client_secret\"] = \"\"\n});\nusing var response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nvar tokenPayload = await response.Content.ReadAsStringAsync();\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value from the response as your bearer token. Cache that token and reuse it across API requests until it is close to the 60-minute expiry; do not request a token for each API call or each record."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client credentials token responses do not include a refresh-token workflow. When the cached access token is close to expiry, request a new access token with the same client credentials."},"children":[]}]}]}]}],"sectionId":"/openapi/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/example-requests"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example requests"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X GET \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/pending?pageSize=1\" \\\n -H \"Authorization: Bearer \"\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X GET \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/pending?pageSize=1\" \\\n -H \"Authorization: Bearer \"\n"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/200006/report\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Idempotency-Key: \" \\\n -d '{\"reportText\":\"Preliminary report text\",\"reportStatus\":\"preliminary\",\"interpretingClinicianEmail\":\"dr.smith@example.com\",\"reportedAtUtc\":\"2025-01-10T03:04:05Z\"}'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/200006/report\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Idempotency-Key: \" \\\n -d '{\"reportText\":\"Preliminary report text\",\"reportStatus\":\"preliminary\",\"interpretingClinicianEmail\":\"dr.smith@example.com\",\"reportedAtUtc\":\"2025-01-10T03:04:05Z\"}'\n"},"children":[]}]}]}],"sectionId":"/openapi/section/example-requests"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/reporting-workflow-(example)"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reporting workflow (example)"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List pending reporting appointments."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X GET \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/pending?pageSize=1\" \\\n -H \"Authorization: Bearer \"\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X GET \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/pending?pageSize=1\" \\\n -H \"Authorization: Bearer \"\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"items\": [\n {\n \"domain\": \"acme\",\n \"appointmentId\": \"200006\",\n \"status\": \"PENDING REPORTING\",\n \"scheduledSite\": \"Central Clinic\",\n \"appointmentDate\": \"2025-01-12\",\n \"startTime\": \"13:45:00\",\n \"patientName\": \"Jane Doe\"\n }\n ],\n \"nextToken\": \"DDB_NEXT_TOKEN\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"items\": [\n {\n \"domain\": \"acme\",\n \"appointmentId\": \"200006\",\n \"status\": \"PENDING REPORTING\",\n \"scheduledSite\": \"Central Clinic\",\n \"appointmentDate\": \"2025-01-12\",\n \"startTime\": \"13:45:00\",\n \"patientName\": \"Jane Doe\"\n }\n ],\n \"nextToken\": \"DDB_NEXT_TOKEN\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":2,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Optional) Create an appointment comment/alert while the appointment is still PENDING REPORTING. This reporting endpoint returns 404 after the report moves to TYPED or an authorisation state."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/200006/comments\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Idempotency-Key: \" \\\n -d '{\"commentText\":\"Partner report preparation started.\",\"commentType\":\"AC\",\"isAlert\":false}'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/200006/comments\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Idempotency-Key: \" \\\n -d '{\"commentText\":\"Partner report preparation started.\",\"commentType\":\"AC\",\"isAlert\":false}'\n"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":3,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(Optional) Create report attachment upload URLs."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/200006/report/attachments\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Idempotency-Key: \" \\\n -d '{\"items\":[{\"fileName\":\"report.pdf\",\"contentType\":\"application/pdf\"}]}'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/200006/report/attachments\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Idempotency-Key: \" \\\n -d '{\"items\":[{\"fileName\":\"report.pdf\",\"contentType\":\"application/pdf\"}]}'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"items\": [\n {\n \"guid\": \"989dd0c7-13bb-4bba-b7a0-53a28bdf5155\",\n \"fileName\": \"report.pdf\",\n \"category\": \"report\",\n \"uploadUrl\": \"https://example.com/upload/report.pdf\",\n \"uploadUrlExpiresAtUtc\": \"2025-01-10T03:19:05Z\"\n }\n ]\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"items\": [\n {\n \"guid\": \"989dd0c7-13bb-4bba-b7a0-53a28bdf5155\",\n \"fileName\": \"report.pdf\",\n \"category\": \"report\",\n \"uploadUrl\": \"https://example.com/upload/report.pdf\",\n \"uploadUrlExpiresAtUtc\": \"2025-01-10T03:19:05Z\"\n }\n ]\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":4,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload the report artifact bytes with a PUT to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uploadUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X PUT \"https://example.com/upload/report.pdf\" \\\n -H \"Content-Type: application/pdf\" \\\n --data-binary \"@report.pdf\"\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X PUT \"https://example.com/upload/report.pdf\" \\\n -H \"Content-Type: application/pdf\" \\\n --data-binary \"@report.pdf\"\n"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"start":5,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit an editable preliminary report, or send reportStatus final to request normal QUBS authorisation. Supply an active clinician email and the required Idempotency-Key. The partner needs explicit delegation and the clinician needs normal permissions. Attachments are optional. For an existing draft, also send its current reportKey and expectedReportRevision; conflicts return 409. Preliminary saves return 201, while final requests return 202. Inspect workflowStatus; a 202 pending receipt requires reconciliation and must not be repeated with a new key."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X POST \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/200006/report\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Idempotency-Key: \" \\\n -d '{\"reportText\":\"No acute abnormality detected.\",\"reportStatus\":\"preliminary\",\"interpretingClinicianEmail\":\"dr.smith@example.com\",\"reportedAtUtc\":\"2025-01-10T03:04:05Z\"}'\n","language":"bash"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X POST \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/200006/report\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Idempotency-Key: \" \\\n -d '{\"reportText\":\"No acute abnormality detected.\",\"reportStatus\":\"preliminary\",\"interpretingClinicianEmail\":\"dr.smith@example.com\",\"reportedAtUtc\":\"2025-01-10T03:04:05Z\"}'\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example response:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n \"reportGuid\": \"9001\",\n \"reportKey\": \"PT|220000|9001|RT\",\n \"reportRevision\": 1,\n \"workflowStatus\": \"TYPED\",\n \"reportStatus\": \"preliminary\",\n \"reportedAtUtc\": \"2025-01-10T03:04:05Z\"\n}\n","language":"json"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n \"reportGuid\": \"9001\",\n \"reportKey\": \"PT|220000|9001|RT\",\n \"reportRevision\": 1,\n \"workflowStatus\": \"TYPED\",\n \"reportStatus\": \"preliminary\",\n \"reportedAtUtc\": \"2025-01-10T03:04:05Z\"\n}\n"},"children":[]}]}]}],"sectionId":"/openapi/section/reporting-workflow-(example)"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"section/conflict-and-pending-operation-recovery"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict and pending-operation recovery"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Keep reportKey and reportRevision from successful submissions. The partner API currently has no endpoint to retrieve the latest report revision or reconcile a pending operation. After a revision conflict or an unresolved pending response, stop automatic writes and contact QUBS support with the domain, appointmentId, operationId (if returned) and X-Correlation-Id. Do not guess or increment revisions, and do not create a new idempotency key merely to bypass a conflict. Resume only after the current report state and revision have been confirmed through QUBS. Identical network retries must reuse the original key and payload."},"children":[]}]}]}]}],"sectionId":"/openapi/section/conflict-and-pending-operation-recovery"}]}]}},{"type":"link","label":"Getting started","link":"/openapi/section/getting-started","routeSlug":"/openapi/section/getting-started","content":null},{"type":"link","label":"Base URL","link":"/openapi/section/base-url","routeSlug":"/openapi/section/base-url","content":null},{"type":"link","label":"Authentication","link":"/openapi/section/authentication","routeSlug":"/openapi/section/authentication","content":null},{"type":"link","label":"Example requests","link":"/openapi/section/example-requests","routeSlug":"/openapi/section/example-requests","content":null},{"type":"link","label":"Reporting workflow (example)","link":"/openapi/section/reporting-workflow-(example)","routeSlug":"/openapi/section/reporting-workflow-(example)","content":null},{"type":"link","label":"Conflict and pending-operation recovery","link":"/openapi/section/conflict-and-pending-operation-recovery","routeSlug":"/openapi/section/conflict-and-pending-operation-recovery","content":null},{"type":"group","label":"Site Settings","link":"/openapi/site-settings","routeSlug":"/openapi/site-settings","items":[{"label":"List sites in the specified partner domain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/site-settings/integrations_listsites","routeSlug":"/openapi/site-settings/integrations_listsites","metadata":{"seo":{"title":"List sites in the specified partner domain","description":"Returns the active sites a partner is allowed to access within a domain after authorization succeeds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListSites","name":"List sites in the specified partner domain","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1sites/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List sites in the specified partner domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the active sites a partner is allowed to access within a domain after authorization succeeds.\n\nResponse body is a JSON array. Fields below apply to each array item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/sites","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/integrations/v1/{domain}/sites","href":"site-settings/integrations_listsites","openApiOperationId":"Integrations_ListSites","summary":"List sites in the specified partner domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of active sites for the requested domain.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_45","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_45","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/403/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-settings/integrations_listsites"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/sites"},{"label":"Get site settings summary by domain and site name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/site-settings/integrations_getsitesettings_summary","routeSlug":"/openapi/site-settings/integrations_getsitesettings_summary","metadata":{"seo":{"title":"Get site settings summary by domain and site name","description":"Returns the site settings summary view for a specific site when the caller is authorized for the requested domain and site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_GetSiteSettings_Summary","name":"Get site settings summary by domain and site name","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get site settings summary by domain and site name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the site settings summary view for a specific site when the caller is authorized for the requested domain and site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"siteName","in":"path","schemaId":"schema_53","description":"Site name within the specified domain. Multi-site clients typically share a domain and differentiate sites with this value.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/sites/{siteName}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"siteName","in":"path","required":true,"example":"Example Site","schemaId":"schema_53"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/sites/{siteName}","href":"site-settings/integrations_getsitesettings_summary","openApiOperationId":"Integrations_GetSiteSettings_Summary","summary":"Get site settings summary by domain and site name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Site settings summary view for the requested domain and site.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteSettingsSummaryResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/SiteSettingsSummaryResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteSettingsSummaryResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteSettingsSummaryResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-settings/integrations_getsitesettings_summary"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/sites/{siteName}"},{"label":"Get operational site settings by domain and site name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/site-settings/integrations_getsitesettings_operational","routeSlug":"/openapi/site-settings/integrations_getsitesettings_operational","metadata":{"seo":{"title":"Get operational site settings by domain and site name","description":"Returns the operational site settings view for a specific site when the caller is authorized for the requested domain and site."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_GetSiteSettings_Operational","name":"Get operational site settings by domain and site name","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get operational site settings by domain and site name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the operational site settings view for a specific site when the caller is authorized for the requested domain and site."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"siteName","in":"path","schemaId":"schema_53","description":"Site name within the specified domain. Multi-site clients typically share a domain and differentiate sites with this value.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/sites/{siteName}/operational","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"siteName","in":"path","required":true,"example":"Example Site","schemaId":"schema_53"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/sites/{siteName}/operational","href":"site-settings/integrations_getsitesettings_operational","openApiOperationId":"Integrations_GetSiteSettings_Operational","summary":"Get operational site settings by domain and site name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Operational site settings view for the requested domain and site.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteSettingsResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/SiteSettingsResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SiteSettingsResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SiteSettingsResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/site-settings/integrations_getsitesettings_operational"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/sites/{siteName}/operational"}],"content":{"contentType":"group","meta":{"name":"Site Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Site Settings","showPageActions":true},{"nodeType":"markdoc","content":"Partner-facing endpoints for listing sites and retrieving site configuration within a domain."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/integrations/v1/{domain}/sites","summary":"List sites in the specified partner domain","prefix":{"name":"get","color":"get"},"badges":[],"link":"/site-settings/integrations_listsites","deprecated":false},{"title":"/integrations/v1/{domain}/sites/{siteName}","summary":"Get site settings summary by domain and site name","prefix":{"name":"get","color":"get"},"badges":[],"link":"/site-settings/integrations_getsitesettings_summary","deprecated":false},{"title":"/integrations/v1/{domain}/sites/{siteName}/operational","summary":"Get operational site settings by domain and site name","prefix":{"name":"get","color":"get"},"badges":[],"link":"/site-settings/integrations_getsitesettings_operational","deprecated":false}]}]}]}]}},{"type":"group","label":"Exam Codes","link":"/openapi/exam-codes","routeSlug":"/openapi/exam-codes","items":[{"label":"List exam codes for a site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/exam-codes/integrations_listexamcodes","routeSlug":"/openapi/exam-codes/integrations_listexamcodes","metadata":{"seo":{"title":"List exam codes for a site","description":"Returns exam codes for the specified domain and site when the caller is authorized."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListExamCodes","name":"List exam codes for a site","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List exam codes for a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns exam codes for the specified domain and site when the caller is authorized.\n\nResponse body is a JSON array. Fields below apply to each array item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"siteName","in":"path","schemaId":"schema_53","description":"Site name within the specified domain. Multi-site clients typically share a domain and differentiate sites with this value.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/sites/{siteName}/exam-codes","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"siteName","in":"path","required":true,"example":"Example Site","schemaId":"schema_53"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/integrations/v1/{domain}/sites/{siteName}/exam-codes","href":"exam-codes/integrations_listexamcodes","openApiOperationId":"Integrations_ListExamCodes","summary":"List exam codes for a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of exam codes for the requested domain and site.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_55","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_55","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_55","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_55","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/403/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exam-codes/integrations_listexamcodes"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/sites/{siteName}/exam-codes"}],"content":{"contentType":"group","meta":{"name":"Exam Codes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exam Codes","showPageActions":true},{"nodeType":"markdoc","content":"Partner-facing endpoints for retrieving exam code configuration for a site within a domain."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/integrations/v1/{domain}/sites/{siteName}/exam-codes","summary":"List exam codes for a site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exam-codes/integrations_listexamcodes","deprecated":false}]}]}]}]}},{"type":"group","label":"Staff Skills","link":"/openapi/staff-skills","routeSlug":"/openapi/staff-skills","items":[{"label":"Get staff skill grid for a site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/staff-skills/integrations_getstaffskills","routeSlug":"/openapi/staff-skills/integrations_getstaffskills","metadata":{"seo":{"title":"Get staff skill grid for a site","description":"Returns the staff skills grid, exam mappings, and comments for the specified domain and site when authorized."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_GetStaffSkills","name":"Get staff skill grid for a site","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get staff skill grid for a site","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the staff skills grid, exam mappings, and comments for the specified domain and site when authorized."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"siteName","in":"path","schemaId":"schema_53","description":"Site name within the specified domain. Multi-site clients typically share a domain and differentiate sites with this value.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/sites/{siteName}/staff-skills","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"siteName","in":"path","required":true,"example":"Example Site","schemaId":"schema_53"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/integrations/v1/{domain}/sites/{siteName}/staff-skills","href":"staff-skills/integrations_getstaffskills","openApiOperationId":"Integrations_GetStaffSkills","summary":"Get staff skill grid for a site"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Staff skills grid and related metadata for the requested domain and site.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StaffSkillsGridResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/StaffSkillsGridResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StaffSkillsGridResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StaffSkillsGridResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/403/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/staff-skills/integrations_getstaffskills"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/sites/{siteName}/staff-skills"}],"content":{"contentType":"group","meta":{"name":"Staff Skills"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Staff Skills","showPageActions":true},{"nodeType":"markdoc","content":"Partner-facing endpoints for retrieving the staff skill grid and related metadata for a site within a domain."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/integrations/v1/{domain}/sites/{siteName}/staff-skills","summary":"Get staff skill grid for a site","prefix":{"name":"get","color":"get"},"badges":[],"link":"/staff-skills/integrations_getstaffskills","deprecated":false}]}]}]}]}},{"type":"group","label":"Appointments","link":"/openapi/appointments","routeSlug":"/openapi/appointments","items":[{"label":"List operational appointments by status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/appointments/integrations_listappointmentsbystatus_operational","routeSlug":"/openapi/appointments/integrations_listappointmentsbystatus_operational","metadata":{"seo":{"title":"List operational appointments by status","description":"Returns the operational appointment view filtered by status when the caller is authorized. Supports cursor-based pagination via pageSize and nextToken."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListAppointmentsByStatus_Operational","name":"List operational appointments by status","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List operational appointments by status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the operational appointment view filtered by status when the caller is authorized. Supports cursor-based pagination via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"status","in":"path","schemaId":"schema_56","description":"Appointment status filter value. Must match one of the known QUBS appointment status strings.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_57","description":"Maximum number of items to return in a page. Defaults to 100 when omitted. Must be between 1 and 500."},{"name":"nextToken","in":"query","schemaId":"schema_58","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque, URL-safe continuation token returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a previous paged response. Omit for the first page."},"children":[]}]}]}]}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments/operational/by-status/{status}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"status","in":"path","required":true,"example":"NOT ARRIVED","schemaId":"schema_56"}],"query":[{"name":"pageSize","in":"query","example":100,"schemaId":"schema_57"},{"name":"nextToken","in":"query","example":"DDB_NEXT_TOKEN","schemaId":"schema_58"}],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/integrations/v1/{domain}/appointments/operational/by-status/{status}","href":"appointments/integrations_listappointmentsbystatus_operational","openApiOperationId":"Integrations_ListAppointmentsByStatus_Operational","summary":"List operational appointments by status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Page of operational appointments matching the requested status for the requested domain.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentsOperationalPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AppointmentsOperationalPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentsOperationalPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentsOperationalPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/integrations_listappointmentsbystatus_operational"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments/operational/by-status/{status}"},{"label":"Get operational appointment by domain and appointment id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/appointments/integrations_getappointment_operational","routeSlug":"/openapi/appointments/integrations_getappointment_operational","metadata":{"seo":{"title":"Get operational appointment by domain and appointment id","description":"Returns the operational appointment view for the specified domain and appointment id when the caller is authorized."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_GetAppointment_Operational","name":"Get operational appointment by domain and appointment id","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get operational appointment by domain and appointment id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the operational appointment view for the specified domain and appointment id when the caller is authorized."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments/operational/by-id/{appointmentId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/appointments/operational/by-id/{appointmentId}","href":"appointments/integrations_getappointment_operational","openApiOperationId":"Integrations_GetAppointment_Operational","summary":"Get operational appointment by domain and appointment id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Operational appointment view for the requested domain and appointment id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentOperationalResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AppointmentOperationalResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentOperationalResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentOperationalResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/integrations_getappointment_operational"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments/operational/by-id/{appointmentId}"},{"label":"List operational appointments for a domain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/appointments/integrations_listappointments_operational","routeSlug":"/openapi/appointments/integrations_listappointments_operational","metadata":{"seo":{"title":"List operational appointments for a domain","description":"Returns the operational appointment view for the specified domain when the caller is authorized. Supports optional filters via query string and offset paging via skip and take."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListAppointments_Operational","name":"List operational appointments for a domain","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1operational/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List operational appointments for a domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the operational appointment view for the specified domain when the caller is authorized. Supports optional filters via query string and offset paging via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"take"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response body is a JSON array. Fields below apply to each array item."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"appointmentDate","in":"query","schemaId":"schema_60","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional appointment date filter (ISO 8601 date, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the scheduled site's local timezone."},"children":[]}]}]}]},{"name":"startDate","in":"query","schemaId":"schema_61"},{"name":"endDate","in":"query","schemaId":"schema_61"},{"name":"clientUtcOffsetMinutes","in":"query","schemaId":"schema_62"},{"name":"scheduledSite","in":"query","schemaId":"schema_53","description":"Optional scheduled site filter."},{"name":"skip","in":"query","schemaId":"schema_63","description":"Optional number of items to skip. Defaults to 0 when omitted. Must be between 0 and 10000."},{"name":"take","in":"query","schemaId":"schema_57","description":"Optional maximum number of items to return. Defaults to 100 when omitted. Must be between 1 and 500."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments/operational","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"}],"query":[{"name":"appointmentDate","in":"query","example":"2025-01-01","schemaId":"schema_60"},{"name":"startDate","in":"query","schemaId":"schema_61"},{"name":"endDate","in":"query","schemaId":"schema_61"},{"name":"clientUtcOffsetMinutes","in":"query","schemaId":"schema_62"},{"name":"scheduledSite","in":"query","example":"Example Site","schemaId":"schema_53"},{"name":"skip","in":"query","example":0,"schemaId":"schema_63"},{"name":"take","in":"query","example":100,"schemaId":"schema_57"}],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/integrations/v1/{domain}/appointments/operational","href":"appointments/integrations_listappointments_operational","openApiOperationId":"Integrations_ListAppointments_Operational","summary":"List operational appointments for a domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of operational appointments for the requested domain.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_64","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_64","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/403/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/integrations_listappointments_operational"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments/operational"},{"label":"List operational appointments by status for referrers and specialists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/appointments/integrations_listappointmentsbystatus_referreroperational","routeSlug":"/openapi/appointments/integrations_listappointmentsbystatus_referreroperational","metadata":{"seo":{"title":"List operational appointments by status for referrers and specialists","description":"Returns operational appointments filtered by provider number when the caller is authorized and scoped to referrer/specialist grants. Provider numbers are resolved from the authenticated principal's access grants and are not supplied as query parameters. Supports cursor-based pagination via pageSize and nextToken."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListAppointmentsByStatus_ReferrerOperational","name":"List operational appointments by status for referrers and specialists","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List operational appointments by status for referrers and specialists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns operational appointments filtered by provider number when the caller is authorized and scoped to referrer/specialist grants. Provider numbers are resolved from the authenticated principal's access grants and are not supplied as query parameters. Supports cursor-based pagination via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"status","in":"path","schemaId":"schema_56","description":"Appointment status filter value. Must match one of the known QUBS appointment status strings.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_57","description":"Maximum number of items to return in a page. Defaults to 100 when omitted. Must be between 1 and 500."},{"name":"nextToken","in":"query","schemaId":"schema_58","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque, URL-safe continuation token returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a previous paged response. Omit for the first page."},"children":[]}]}]}]}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments/referrer/operational/by-status/{status}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"status","in":"path","required":true,"example":"NOT ARRIVED","schemaId":"schema_56"}],"query":[{"name":"pageSize","in":"query","example":100,"schemaId":"schema_57"},{"name":"nextToken","in":"query","example":"DDB_NEXT_TOKEN","schemaId":"schema_58"}],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/integrations/v1/{domain}/appointments/referrer/operational/by-status/{status}","href":"appointments/integrations_listappointmentsbystatus_referreroperational","openApiOperationId":"Integrations_ListAppointmentsByStatus_ReferrerOperational","summary":"List operational appointments by status for referrers and specialists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentsOperationalPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AppointmentsOperationalPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentsOperationalPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentsOperationalPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/integrations_listappointmentsbystatus_referreroperational"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments/referrer/operational/by-status/{status}"},{"label":"List operational appointments for referrers and specialists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/appointments/integrations_listappointments_referreroperational","routeSlug":"/openapi/appointments/integrations_listappointments_referreroperational","metadata":{"seo":{"title":"List operational appointments for referrers and specialists","description":"Returns operational appointments filtered by provider number when the caller is authorized and scoped to referrer/specialist grants. Provider numbers are resolved from the authenticated principal's access grants and are not supplied as query parameters. Supports optional filters via query string and offset paging via skip and take."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListAppointments_ReferrerOperational","name":"List operational appointments for referrers and specialists","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List operational appointments for referrers and specialists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns operational appointments filtered by provider number when the caller is authorized and scoped to referrer/specialist grants. Provider numbers are resolved from the authenticated principal's access grants and are not supplied as query parameters. Supports optional filters via query string and offset paging via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"take"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response body is a JSON array. Fields below apply to each array item."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"appointmentDate","in":"query","schemaId":"schema_60","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional appointment date filter (ISO 8601 date, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the scheduled site's local timezone."},"children":[]}]}]}]},{"name":"startDate","in":"query","schemaId":"schema_61"},{"name":"endDate","in":"query","schemaId":"schema_61"},{"name":"clientUtcOffsetMinutes","in":"query","schemaId":"schema_62"},{"name":"scheduledSite","in":"query","schemaId":"schema_53","description":"Optional scheduled site filter."},{"name":"skip","in":"query","schemaId":"schema_63","description":"Optional number of items to skip. Defaults to 0 when omitted. Must be between 0 and 10000."},{"name":"take","in":"query","schemaId":"schema_57","description":"Optional maximum number of items to return. Defaults to 100 when omitted. Must be between 1 and 500."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments/referrer/operational","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"}],"query":[{"name":"appointmentDate","in":"query","example":"2025-01-01","schemaId":"schema_60"},{"name":"startDate","in":"query","schemaId":"schema_61"},{"name":"endDate","in":"query","schemaId":"schema_61"},{"name":"clientUtcOffsetMinutes","in":"query","schemaId":"schema_62"},{"name":"scheduledSite","in":"query","example":"Example Site","schemaId":"schema_53"},{"name":"skip","in":"query","example":0,"schemaId":"schema_63"},{"name":"take","in":"query","example":100,"schemaId":"schema_57"}],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/integrations/v1/{domain}/appointments/referrer/operational","href":"appointments/integrations_listappointments_referreroperational","openApiOperationId":"Integrations_ListAppointments_ReferrerOperational","summary":"List operational appointments for referrers and specialists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_64","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_64","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/403/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/integrations_listappointments_referreroperational"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments/referrer/operational"},{"label":"List appointment summaries by status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/appointments/integrations_listappointmentsbystatus_summary","routeSlug":"/openapi/appointments/integrations_listappointmentsbystatus_summary","metadata":{"seo":{"title":"List appointment summaries by status","description":"Returns the appointment summary view filtered by status when the caller is authorized. Supports cursor-based pagination via pageSize and nextToken."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListAppointmentsByStatus_Summary","name":"List appointment summaries by status","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List appointment summaries by status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the appointment summary view filtered by status when the caller is authorized. Supports cursor-based pagination via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"status","in":"path","schemaId":"schema_56","description":"Appointment status filter value. Must match one of the known QUBS appointment status strings.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_57","description":"Maximum number of items to return in a page. Defaults to 100 when omitted. Must be between 1 and 500."},{"name":"nextToken","in":"query","schemaId":"schema_58","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque, URL-safe continuation token returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a previous paged response. Omit for the first page."},"children":[]}]}]}]}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments/by-status/{status}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"status","in":"path","required":true,"example":"NOT ARRIVED","schemaId":"schema_56"}],"query":[{"name":"pageSize","in":"query","example":100,"schemaId":"schema_57"},{"name":"nextToken","in":"query","example":"DDB_NEXT_TOKEN","schemaId":"schema_58"}],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/integrations/v1/{domain}/appointments/by-status/{status}","href":"appointments/integrations_listappointmentsbystatus_summary","openApiOperationId":"Integrations_ListAppointmentsByStatus_Summary","summary":"List appointment summaries by status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Page of appointment summaries matching the requested status for the requested domain.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentsSummaryPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AppointmentsSummaryPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentsSummaryPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentsSummaryPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/integrations_listappointmentsbystatus_summary"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments/by-status/{status}"},{"label":"Get appointment summary by domain and appointment id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/appointments/integrations_getappointment_summary","routeSlug":"/openapi/appointments/integrations_getappointment_summary","metadata":{"seo":{"title":"Get appointment summary by domain and appointment id","description":"Returns the appointment summary view for the specified domain and appointment id when the caller is authorized."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_GetAppointment_Summary","name":"Get appointment summary by domain and appointment id","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get appointment summary by domain and appointment id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the appointment summary view for the specified domain and appointment id when the caller is authorized."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments/{appointmentId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/appointments/{appointmentId}","href":"appointments/integrations_getappointment_summary","openApiOperationId":"Integrations_GetAppointment_Summary","summary":"Get appointment summary by domain and appointment id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Appointment summary view for the requested domain and appointment id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentSummaryResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AppointmentSummaryResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentSummaryResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentSummaryResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/integrations_getappointment_summary"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments/{appointmentId}"},{"label":"List appointment summaries for a domain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/appointments/integrations_listappointments_summary","routeSlug":"/openapi/appointments/integrations_listappointments_summary","metadata":{"seo":{"title":"List appointment summaries for a domain","description":"Returns the appointment summary view for the specified domain when the caller is authorized. Supports optional filters via query string and offset paging via skip and take."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListAppointments_Summary","name":"List appointment summaries for a domain","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List appointment summaries for a domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the appointment summary view for the specified domain when the caller is authorized. Supports optional filters via query string and offset paging via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"take"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response body is a JSON array. Fields below apply to each array item."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"appointmentDate","in":"query","schemaId":"schema_60","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional appointment date filter (ISO 8601 date, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the scheduled site's local timezone."},"children":[]}]}]}]},{"name":"startDate","in":"query","schemaId":"schema_61"},{"name":"endDate","in":"query","schemaId":"schema_61"},{"name":"clientUtcOffsetMinutes","in":"query","schemaId":"schema_62"},{"name":"scheduledSite","in":"query","schemaId":"schema_53","description":"Optional scheduled site filter."},{"name":"skip","in":"query","schemaId":"schema_63","description":"Optional number of items to skip. Defaults to 0 when omitted. Must be between 0 and 10000."},{"name":"take","in":"query","schemaId":"schema_57","description":"Optional maximum number of items to return. Defaults to 100 when omitted. Must be between 1 and 500."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"}],"query":[{"name":"appointmentDate","in":"query","example":"2025-01-01","schemaId":"schema_60"},{"name":"startDate","in":"query","schemaId":"schema_61"},{"name":"endDate","in":"query","schemaId":"schema_61"},{"name":"clientUtcOffsetMinutes","in":"query","schemaId":"schema_62"},{"name":"scheduledSite","in":"query","example":"Example Site","schemaId":"schema_53"},{"name":"skip","in":"query","example":0,"schemaId":"schema_63"},{"name":"take","in":"query","example":100,"schemaId":"schema_57"}],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/integrations/v1/{domain}/appointments","href":"appointments/integrations_listappointments_summary","openApiOperationId":"Integrations_ListAppointments_Summary","summary":"List appointment summaries for a domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of appointment summaries for the requested domain.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_65","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_65","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/403/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/integrations_listappointments_summary"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments"},{"label":"List appointment summaries by status for referrers and specialists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/appointments/integrations_listappointmentsbystatus_referrer","routeSlug":"/openapi/appointments/integrations_listappointmentsbystatus_referrer","metadata":{"seo":{"title":"List appointment summaries by status for referrers and specialists","description":"Returns appointment summaries filtered by provider number when the caller is authorized and scoped to referrer/specialist grants. Provider numbers are resolved from the authenticated principal's access grants and are not supplied as query parameters. Supports cursor-based pagination via pageSize and nextToken."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListAppointmentsByStatus_Referrer","name":"List appointment summaries by status for referrers and specialists","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List appointment summaries by status for referrers and specialists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns appointment summaries filtered by provider number when the caller is authorized and scoped to referrer/specialist grants. Provider numbers are resolved from the authenticated principal's access grants and are not supplied as query parameters. Supports cursor-based pagination via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"status","in":"path","schemaId":"schema_56","description":"Appointment status filter value. Must match one of the known QUBS appointment status strings.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_57","description":"Maximum number of items to return in a page. Defaults to 100 when omitted. Must be between 1 and 500."},{"name":"nextToken","in":"query","schemaId":"schema_58","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque, URL-safe continuation token returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a previous paged response. Omit for the first page."},"children":[]}]}]}]}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments/referrer/by-status/{status}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"status","in":"path","required":true,"example":"NOT ARRIVED","schemaId":"schema_56"}],"query":[{"name":"pageSize","in":"query","example":100,"schemaId":"schema_57"},{"name":"nextToken","in":"query","example":"DDB_NEXT_TOKEN","schemaId":"schema_58"}],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/integrations/v1/{domain}/appointments/referrer/by-status/{status}","href":"appointments/integrations_listappointmentsbystatus_referrer","openApiOperationId":"Integrations_ListAppointmentsByStatus_Referrer","summary":"List appointment summaries by status for referrers and specialists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentsSummaryPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AppointmentsSummaryPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentsSummaryPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentsSummaryPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/integrations_listappointmentsbystatus_referrer"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments/referrer/by-status/{status}"},{"label":"List appointment summaries for referrers and specialists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/appointments/integrations_listappointments_referrer","routeSlug":"/openapi/appointments/integrations_listappointments_referrer","metadata":{"seo":{"title":"List appointment summaries for referrers and specialists","description":"Returns appointment summaries filtered by provider number when the caller is authorized and scoped to referrer/specialist grants. Provider numbers are resolved from the authenticated principal's access grants and are not supplied as query parameters. Supports optional filters via query string and offset paging via skip and take."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListAppointments_Referrer","name":"List appointment summaries for referrers and specialists","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List appointment summaries for referrers and specialists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns appointment summaries filtered by provider number when the caller is authorized and scoped to referrer/specialist grants. Provider numbers are resolved from the authenticated principal's access grants and are not supplied as query parameters. Supports optional filters via query string and offset paging via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"take"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response body is a JSON array. Fields below apply to each array item."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"appointmentDate","in":"query","schemaId":"schema_60","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional appointment date filter (ISO 8601 date, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the scheduled site's local timezone."},"children":[]}]}]}]},{"name":"startDate","in":"query","schemaId":"schema_61"},{"name":"endDate","in":"query","schemaId":"schema_61"},{"name":"clientUtcOffsetMinutes","in":"query","schemaId":"schema_62"},{"name":"scheduledSite","in":"query","schemaId":"schema_53","description":"Optional scheduled site filter."},{"name":"skip","in":"query","schemaId":"schema_63","description":"Optional number of items to skip. Defaults to 0 when omitted. Must be between 0 and 10000."},{"name":"take","in":"query","schemaId":"schema_57","description":"Optional maximum number of items to return. Defaults to 100 when omitted. Must be between 1 and 500."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments/referrer","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"}],"query":[{"name":"appointmentDate","in":"query","example":"2025-01-01","schemaId":"schema_60"},{"name":"startDate","in":"query","schemaId":"schema_61"},{"name":"endDate","in":"query","schemaId":"schema_61"},{"name":"clientUtcOffsetMinutes","in":"query","schemaId":"schema_62"},{"name":"scheduledSite","in":"query","example":"Example Site","schemaId":"schema_53"},{"name":"skip","in":"query","example":0,"schemaId":"schema_63"},{"name":"take","in":"query","example":100,"schemaId":"schema_57"}],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/integrations/v1/{domain}/appointments/referrer","href":"appointments/integrations_listappointments_referrer","openApiOperationId":"Integrations_ListAppointments_Referrer","summary":"List appointment summaries for referrers and specialists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_65","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_65","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/403/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/integrations_listappointments_referrer"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments/referrer"},{"label":"Get appointment billing details by domain and appointment id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/appointments/integrations_getappointment_billing","routeSlug":"/openapi/appointments/integrations_getappointment_billing","metadata":{"seo":{"title":"Get appointment billing details by domain and appointment id","description":"Returns billing and service item details for the specified appointment when the caller has appointments:read_billing access."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_GetAppointment_Billing","name":"Get appointment billing details by domain and appointment id","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get appointment billing details by domain and appointment id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns billing and service item details for the specified appointment when the caller has appointments:read_billing access."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments/{appointmentId}/billing","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/appointments/{appointmentId}/billing","href":"appointments/integrations_getappointment_billing","openApiOperationId":"Integrations_GetAppointment_Billing","summary":"Get appointment billing details by domain and appointment id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Billing details for the requested appointment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentBillingResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AppointmentBillingResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentBillingResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentBillingResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/integrations_getappointment_billing"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments/{appointmentId}/billing"}],"content":{"contentType":"group","meta":{"name":"Appointments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Appointments","showPageActions":true},{"nodeType":"markdoc","content":"Partner-facing endpoints for retrieving appointments within a domain."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/integrations/v1/{domain}/appointments/operational/by-status/{status}","summary":"List operational appointments by status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/integrations_listappointmentsbystatus_operational","deprecated":false},{"title":"/integrations/v1/{domain}/appointments/operational/by-id/{appointmentId}","summary":"Get operational appointment by domain and appointment id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/integrations_getappointment_operational","deprecated":false},{"title":"/integrations/v1/{domain}/appointments/operational","summary":"List operational appointments for a domain","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/integrations_listappointments_operational","deprecated":false},{"title":"/integrations/v1/{domain}/appointments/referrer/operational/by-status/{status}","summary":"List operational appointments by status for referrers and specialists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/integrations_listappointmentsbystatus_referreroperational","deprecated":false},{"title":"/integrations/v1/{domain}/appointments/referrer/operational","summary":"List operational appointments for referrers and specialists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/integrations_listappointments_referreroperational","deprecated":false},{"title":"/integrations/v1/{domain}/appointments/by-status/{status}","summary":"List appointment summaries by status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/integrations_listappointmentsbystatus_summary","deprecated":false},{"title":"/integrations/v1/{domain}/appointments/{appointmentId}","summary":"Get appointment summary by domain and appointment id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/integrations_getappointment_summary","deprecated":false},{"title":"/integrations/v1/{domain}/appointments","summary":"List appointment summaries for a domain","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/integrations_listappointments_summary","deprecated":false},{"title":"/integrations/v1/{domain}/appointments/referrer/by-status/{status}","summary":"List appointment summaries by status for referrers and specialists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/integrations_listappointmentsbystatus_referrer","deprecated":false},{"title":"/integrations/v1/{domain}/appointments/referrer","summary":"List appointment summaries for referrers and specialists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/integrations_listappointments_referrer","deprecated":false},{"title":"/integrations/v1/{domain}/appointments/{appointmentId}/billing","summary":"Get appointment billing details by domain and appointment id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/integrations_getappointment_billing","deprecated":false}]}]}]}]}},{"type":"group","label":"Attachments","link":"/openapi/attachments","routeSlug":"/openapi/attachments","items":[{"label":"List attachments for an appointment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/attachments/integrations_listappointmentattachments","routeSlug":"/openapi/attachments/integrations_listappointmentattachments","metadata":{"seo":{"title":"List attachments for an appointment","description":"Returns appointment attachments (e.g. referrals, worksheets) and a short-lived presigned URL for each attachment when available."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListAppointmentAttachments","name":"List attachments for an appointment","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List attachments for an appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns appointment attachments (e.g. referrals, worksheets) and a short-lived presigned URL for each attachment when available.\n\nResponse body is a JSON array. Fields below apply to each array item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"urlTtlSeconds","in":"query","schemaId":"schema_66","description":"Optional presigned URL lifetime (in seconds). Defaults to 900 when omitted. Values outside 60-3600 are clamped."},{"name":"disposition","in":"query","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional content disposition for the presigned URL ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for display, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for download). Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments/{appointmentId}/attachments","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"}],"query":[{"name":"urlTtlSeconds","in":"query","example":900,"schemaId":"schema_66"},{"name":"disposition","in":"query","example":"inline","schemaId":"schema_67"}],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/appointments/{appointmentId}/attachments","href":"attachments/integrations_listappointmentattachments","openApiOperationId":"Integrations_ListAppointmentAttachments","summary":"List attachments for an appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of attachments for the requested appointment, including short-lived presigned URLs when available.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_68","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_68","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_68","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_68","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/integrations_listappointmentattachments"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments/{appointmentId}/attachments"},{"label":"Get a single attachment for an appointment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/attachments/integrations_getappointmentattachment","routeSlug":"/openapi/attachments/integrations_getappointmentattachment","metadata":{"seo":{"title":"Get a single attachment for an appointment","description":"Returns a single appointment attachment and a short-lived presigned URL when available."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_GetAppointmentAttachment","name":"Get a single attachment for an appointment","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single attachment for an appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single appointment attachment and a short-lived presigned URL when available."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true},{"name":"attachmentGuid","in":"path","schemaId":"schema_69","description":"Attachment GUID for the requested appointment.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"urlTtlSeconds","in":"query","schemaId":"schema_66","description":"Optional presigned URL lifetime (in seconds). Defaults to 900 when omitted. Values outside 60-3600 are clamped."},{"name":"disposition","in":"query","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional content disposition for the presigned URL ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for display, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for download). Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments/{appointmentId}/attachments/{attachmentGuid}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"},{"name":"attachmentGuid","in":"path","required":true,"example":"989dd0c7-13bb-4bba-b7a0-53a28bdf5155","schemaId":"schema_69"}],"query":[{"name":"urlTtlSeconds","in":"query","example":900,"schemaId":"schema_66"},{"name":"disposition","in":"query","example":"inline","schemaId":"schema_67"}],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/appointments/{appointmentId}/attachments/{attachmentGuid}","href":"attachments/integrations_getappointmentattachment","openApiOperationId":"Integrations_GetAppointmentAttachment","summary":"Get a single attachment for an appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment metadata for the requested appointment attachment, including a short-lived presigned URL when available.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentAttachmentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AppointmentAttachmentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentAttachmentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentAttachmentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/attachments/integrations_getappointmentattachment"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments/{appointmentId}/attachments/{attachmentGuid}"}],"content":{"contentType":"group","meta":{"name":"Attachments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attachments","showPageActions":true},{"nodeType":"markdoc","content":"Partner-facing endpoints for retrieving appointment attachments and generating short-lived presigned URLs."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/integrations/v1/{domain}/appointments/{appointmentId}/attachments","summary":"List attachments for an appointment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attachments/integrations_listappointmentattachments","deprecated":false},{"title":"/integrations/v1/{domain}/appointments/{appointmentId}/attachments/{attachmentGuid}","summary":"Get a single attachment for an appointment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/attachments/integrations_getappointmentattachment","deprecated":false}]}]}]}]}},{"type":"group","label":"Comments","link":"/openapi/comments","routeSlug":"/openapi/comments","items":[{"label":"List comments for an appointment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/comments/integrations_listappointmentcomments","routeSlug":"/openapi/comments/integrations_listappointmentcomments","metadata":{"seo":{"title":"List comments for an appointment","description":"Returns all appointment comments/alerts plus patient comments/alerts for the appointment's patient when the caller is authorized."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListAppointmentComments","name":"List comments for an appointment","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List comments for an appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all appointment comments/alerts plus patient comments/alerts for the appointment's patient when the caller is authorized.\n\nResponse body is a JSON array. Fields below apply to each array item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments/{appointmentId}/comments","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/appointments/{appointmentId}/comments","href":"comments/integrations_listappointmentcomments","openApiOperationId":"Integrations_ListAppointmentComments","summary":"List comments for an appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of appointment and patient comments/alerts for the requested appointment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_70","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_70","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_70","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_70","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/comments/integrations_listappointmentcomments"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments/{appointmentId}/comments"},{"label":"Get a single comment for an appointment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/comments/integrations_getappointmentcomment","routeSlug":"/openapi/comments/integrations_getappointmentcomment","metadata":{"seo":{"title":"Get a single comment for an appointment","description":"Returns a single appointment comment/alert or patient comment/alert (for the appointment's patient) when the caller is authorized."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_GetAppointmentComment","name":"Get a single comment for an appointment","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single comment for an appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single appointment comment/alert or patient comment/alert (for the appointment's patient) when the caller is authorized."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true},{"name":"commentGuid","in":"path","schemaId":"schema_71","description":"Comment GUID for the requested appointment/patient comment.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/appointments/{appointmentId}/comments/{commentGuid}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"},{"name":"commentGuid","in":"path","required":true,"example":"ed6ef45a-4e3d-41b2-8049-7aec53bb9ab1","schemaId":"schema_71"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/appointments/{appointmentId}/comments/{commentGuid}","href":"comments/integrations_getappointmentcomment","openApiOperationId":"Integrations_GetAppointmentComment","summary":"Get a single comment for an appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Comment metadata for the requested comment (appointment or patient) for the requested appointment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentCommentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/AppointmentCommentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentCommentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentCommentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/comments/integrations_getappointmentcomment"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/appointments/{appointmentId}/comments/{commentGuid}"}],"content":{"contentType":"group","meta":{"name":"Comments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Comments","showPageActions":true},{"nodeType":"markdoc","content":"Partner-facing endpoints for retrieving appointment and patient comments/alerts associated with an appointment."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/integrations/v1/{domain}/appointments/{appointmentId}/comments","summary":"List comments for an appointment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/comments/integrations_listappointmentcomments","deprecated":false},{"title":"/integrations/v1/{domain}/appointments/{appointmentId}/comments/{commentGuid}","summary":"Get a single comment for an appointment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/comments/integrations_getappointmentcomment","deprecated":false}]}]}]}]}},{"type":"group","label":"Patients","link":"/openapi/patients","routeSlug":"/openapi/patients","items":[{"label":"Get patient summary by domain and patient id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/patients/integrations_getpatient_summary","routeSlug":"/openapi/patients/integrations_getpatient_summary","metadata":{"seo":{"title":"Get patient summary by domain and patient id","description":"Returns the patient summary view for the specified domain and patient id when the caller is authorized."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_GetPatient_Summary","name":"Get patient summary by domain and patient id","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get patient summary by domain and patient id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the patient summary view for the specified domain and patient id when the caller is authorized."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"patientId","in":"path","schemaId":"schema_72","description":"Patient identifier within the specified domain.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/patients/{patientId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"patientId","in":"path","required":true,"example":"220000","schemaId":"schema_72"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/patients/{patientId}","href":"patients/integrations_getpatient_summary","openApiOperationId":"Integrations_GetPatient_Summary","summary":"Get patient summary by domain and patient id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientSummaryResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PatientSummaryResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PatientSummaryResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PatientSummaryResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patients/integrations_getpatient_summary"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/patients/{patientId}"},{"label":"List patient summaries for a domain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/patients/integrations_listpatients_summary","routeSlug":"/openapi/patients/integrations_listpatients_summary","metadata":{"seo":{"title":"List patient summaries for a domain","description":"Returns the patient summary view for the specified domain when the caller is authorized. Supports optional filters via query string and offset paging via skip and take."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListPatients_Summary","name":"List patient summaries for a domain","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1patients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List patient summaries for a domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the patient summary view for the specified domain when the caller is authorized. Supports optional filters via query string and offset paging via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"take"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response body is a JSON array. Fields below apply to each array item."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1patients/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"patientId","in":"query","schemaId":"schema_73"},{"name":"firstName","in":"query","schemaId":"schema_74","description":"Optional patient first name filter. Exact match (case-insensitive); no partial matching."},{"name":"lastName","in":"query","schemaId":"schema_75","description":"Optional patient last name filter. Exact match (case-insensitive); no partial matching."},{"name":"dateOfBirth","in":"query","schemaId":"schema_76","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional patient date of birth filter (ISO 8601 date, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Exact match."},"children":[]}]}]}]},{"name":"email","in":"query","schemaId":"schema_77","description":"Optional patient email filter. Exact match (case-insensitive)."},{"name":"mobilePhone","in":"query","schemaId":"schema_78","description":"Optional patient mobile phone filter. Exact match (case-insensitive); no partial matching."},{"name":"skip","in":"query","schemaId":"schema_63","description":"Optional number of items to skip. Defaults to 0 when omitted. Must be between 0 and 10000."},{"name":"take","in":"query","schemaId":"schema_57","description":"Optional maximum number of items to return. Defaults to 100 when omitted. Must be between 1 and 500."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1patients/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1patients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/patients","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"}],"query":[{"name":"patientId","in":"query","schemaId":"schema_73"},{"name":"firstName","in":"query","example":"Amandeep","schemaId":"schema_74"},{"name":"lastName","in":"query","example":"KAUR","schemaId":"schema_75"},{"name":"dateOfBirth","in":"query","example":"1988-03-03","schemaId":"schema_76"},{"name":"email","in":"query","example":"user@example.com","schemaId":"schema_77"},{"name":"mobilePhone","in":"query","example":"0435531162","schemaId":"schema_78"},{"name":"skip","in":"query","example":0,"schemaId":"schema_63"},{"name":"take","in":"query","example":100,"schemaId":"schema_57"}],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/integrations/v1/{domain}/patients","href":"patients/integrations_listpatients_summary","openApiOperationId":"Integrations_ListPatients_Summary","summary":"List patient summaries for a domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of patient summaries for the requested domain.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_79","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1patients/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_79","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_79","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/403/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1patients/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/patients/integrations_listpatients_summary"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/patients"}],"content":{"contentType":"group","meta":{"name":"Patients"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Patients","showPageActions":true},{"nodeType":"markdoc","content":"Partner-facing endpoints for retrieving patients within a domain."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/integrations/v1/{domain}/patients/{patientId}","summary":"Get patient summary by domain and patient id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/patients/integrations_getpatient_summary","deprecated":false},{"title":"/integrations/v1/{domain}/patients","summary":"List patient summaries for a domain","prefix":{"name":"get","color":"get"},"badges":[],"link":"/patients/integrations_listpatients_summary","deprecated":false}]}]}]}]}},{"type":"group","label":"Reporting","link":"/openapi/reporting","routeSlug":"/openapi/reporting","items":[{"label":"List pending reporting appointments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reporting/integrations_listpendingreportingappointments","routeSlug":"/openapi/reporting/integrations_listpendingreportingappointments","metadata":{"seo":{"title":"List pending reporting appointments","description":"Returns the tele reporting appointment view for appointments in the PENDING REPORTING status. Appointments enter this status after QUBS moves them to PENDING REPORTING, typically when the scan/study is ended; subscribe to appointment.status_changed webhooks for notification and use this endpoint for reconciliation. Supports cursor-based pagination via pageSize and nextToken."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListPendingReportingAppointments","name":"List pending reporting appointments","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List pending reporting appointments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the tele reporting appointment view for appointments in the PENDING REPORTING status. Appointments enter this status after QUBS moves them to PENDING REPORTING, typically when the scan/study is ended; subscribe to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment.status_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhooks for notification and use this endpoint for reconciliation. Supports cursor-based pagination via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"pageSize","in":"query","schemaId":"schema_57","description":"Maximum number of items to return in a page. Defaults to 100 when omitted. Must be between 1 and 500."},{"name":"nextToken","in":"query","schemaId":"schema_58","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque, URL-safe continuation token returned as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nextToken"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a previous paged response. Omit for the first page."},"children":[]}]}]}]}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/reporting/appointments/pending","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"}],"query":[{"name":"pageSize","in":"query","example":100,"schemaId":"schema_57"},{"name":"nextToken","in":"query","example":"DDB_NEXT_TOKEN","schemaId":"schema_58"}],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/integrations/v1/{domain}/reporting/appointments/pending","href":"reporting/integrations_listpendingreportingappointments","openApiOperationId":"Integrations_ListPendingReportingAppointments","summary":"List pending reporting appointments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Page of appointments that are pending reporting for the requested domain. Appointments enter this view after QUBS moves them to PENDING REPORTING, typically when the scan/study is ended. Subscribe to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment.status_changed"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" webhooks for transition notifications and use this endpoint for reconciliation."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentsPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PendingReportingAppointmentsPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PendingReportingAppointmentsPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentsPageResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/403/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting/integrations_listpendingreportingappointments"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/reporting/appointments/pending"},{"label":"Get a pending reporting appointment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reporting/integrations_getpendingreportingappointment","routeSlug":"/openapi/reporting/integrations_getpendingreportingappointment","metadata":{"seo":{"title":"Get a pending reporting appointment","description":"Returns the tele reporting appointment view for the specified opaque appointment id when it is in the PENDING REPORTING status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_GetPendingReportingAppointment","name":"Get a pending reporting appointment","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a pending reporting appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the tele reporting appointment view for the specified opaque appointment id when it is in the PENDING REPORTING status.\n\nReturns 404 when the appointment is not found or is not in the PENDING REPORTING status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}","href":"reporting/integrations_getpendingreportingappointment","openApiOperationId":"Integrations_GetPendingReportingAppointment","summary":"Get a pending reporting appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Pending reporting appointment view for the requested opaque appointment id.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PendingReportingAppointmentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PendingReportingAppointmentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting/integrations_getpendingreportingappointment"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}"},{"label":"List attachments for a pending reporting appointment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reporting/integrations_listpendingreportingappointmentattachments","routeSlug":"/openapi/reporting/integrations_listpendingreportingappointmentattachments","metadata":{"seo":{"title":"List attachments for a pending reporting appointment","description":"Returns appointment attachments (e.g. referrals, worksheets) for the specified appointment when it is in the PENDING REPORTING status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListPendingReportingAppointmentAttachments","name":"List attachments for a pending reporting appointment","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List attachments for a pending reporting appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns appointment attachments (e.g. referrals, worksheets) for the specified appointment when it is in the PENDING REPORTING status.\n\nReturns 404 when the appointment is not found or is not in the PENDING REPORTING status.\n\nResponse body is a JSON array. Fields below apply to each array item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"urlTtlSeconds","in":"query","schemaId":"schema_66","description":"Optional presigned URL lifetime (in seconds). Defaults to 900 when omitted. Values outside 60-3600 are clamped."},{"name":"disposition","in":"query","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional content disposition for the presigned URL ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for display, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for download). Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/attachments","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"}],"query":[{"name":"urlTtlSeconds","in":"query","example":900,"schemaId":"schema_66"},{"name":"disposition","in":"query","example":"inline","schemaId":"schema_67"}],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/attachments","href":"reporting/integrations_listpendingreportingappointmentattachments","openApiOperationId":"Integrations_ListPendingReportingAppointmentAttachments","summary":"List attachments for a pending reporting appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of attachments for the requested pending reporting appointment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_80","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_80","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_80","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting/integrations_listpendingreportingappointmentattachments"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/attachments"},{"label":"Get a single attachment for a pending reporting appointment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reporting/integrations_getpendingreportingappointmentattachment","routeSlug":"/openapi/reporting/integrations_getpendingreportingappointmentattachment","metadata":{"seo":{"title":"Get a single attachment for a pending reporting appointment","description":"Returns a single appointment attachment for the specified appointment when it is in the PENDING REPORTING status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_GetPendingReportingAppointmentAttachment","name":"Get a single attachment for a pending reporting appointment","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single attachment for a pending reporting appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single appointment attachment for the specified appointment when it is in the PENDING REPORTING status.\n\nReturns 404 when the appointment is not found or is not in the PENDING REPORTING status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true},{"name":"attachmentGuid","in":"path","schemaId":"schema_69","description":"Attachment GUID for the requested appointment.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"urlTtlSeconds","in":"query","schemaId":"schema_66","description":"Optional presigned URL lifetime (in seconds). Defaults to 900 when omitted. Values outside 60-3600 are clamped."},{"name":"disposition","in":"query","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional content disposition for the presigned URL ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for display, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for download). Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inline"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/attachments/{attachmentGuid}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"},{"name":"attachmentGuid","in":"path","required":true,"example":"989dd0c7-13bb-4bba-b7a0-53a28bdf5155","schemaId":"schema_69"}],"query":[{"name":"urlTtlSeconds","in":"query","example":900,"schemaId":"schema_66"},{"name":"disposition","in":"query","example":"inline","schemaId":"schema_67"}],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/attachments/{attachmentGuid}","href":"reporting/integrations_getpendingreportingappointmentattachment","openApiOperationId":"Integrations_GetPendingReportingAppointmentAttachment","summary":"Get a single attachment for a pending reporting appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Attachment metadata for the requested pending reporting appointment attachment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentAttachmentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PendingReportingAppointmentAttachmentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PendingReportingAppointmentAttachmentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentAttachmentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting/integrations_getpendingreportingappointmentattachment"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/attachments/{attachmentGuid}"},{"label":"List comments for a pending reporting appointment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reporting/integrations_listpendingreportingappointmentcomments","routeSlug":"/openapi/reporting/integrations_listpendingreportingappointmentcomments","metadata":{"seo":{"title":"List comments for a pending reporting appointment","description":"Returns appointment comments/alerts plus patient comments/alerts for the specified appointment when it is in the PENDING REPORTING status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_ListPendingReportingAppointmentComments","name":"List comments for a pending reporting appointment","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List comments for a pending reporting appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns appointment comments/alerts plus patient comments/alerts for the specified appointment when it is in the PENDING REPORTING status.\n\nReturns 404 when the appointment is not found or is not in the PENDING REPORTING status.\n\nResponse body is a JSON array. Fields below apply to each array item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/comments","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/comments","href":"reporting/integrations_listpendingreportingappointmentcomments","openApiOperationId":"Integrations_ListPendingReportingAppointmentComments","summary":"List comments for a pending reporting appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Array of appointment and patient comments/alerts for the requested pending reporting appointment.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_81","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_81","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_81","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_81","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting/integrations_listpendingreportingappointmentcomments"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/comments"},{"label":"Create a comment for a pending reporting appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reporting/integrations_creatependingreportingappointmentcomment","routeSlug":"/openapi/reporting/integrations_creatependingreportingappointmentcomment","metadata":{"seo":{"title":"Create a comment for a pending reporting appointment","description":"Creates an appointment comment/alert for a pending reporting appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_CreatePendingReportingAppointmentComment","name":"Create a comment for a pending reporting appointment","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a comment for a pending reporting appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an appointment comment/alert for a pending reporting appointment."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Idempotency: supports the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Best-effort process-local deduplication only, with a cache lifetime of up to 24 hours. A cached identical request replays its response; a cached key with a different payload returns 409. Eviction, restarts, different instances or concurrent requests can still create duplicates. Verify existing comments after an uncertain outcome before retrying; retain the original key and payload."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 404 when the appointment is not found or is not in the PENDING REPORTING status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."},{"name":"Idempotency-Key","in":"header","schemaId":"schema_82","description":"Optional key for best-effort process-local deduplication. Reuse the original key and payload, but duplicates remain possible after eviction, restarts, on another instance or with concurrent requests. See endpoint notes for cache lifetimes and recovery guidance."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentCommentCreateRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PendingReportingAppointmentCommentCreateRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/comments","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"},{"name":"Idempotency-Key","in":"header","example":"cd4a859c7a1f4b44b765a8fe17bb44c1","schemaId":"schema_82"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentCommentCreateRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","403","404","409","429","500"],"pointer":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/comments","href":"reporting/integrations_creatependingreportingappointmentcomment","openApiOperationId":"Integrations_CreatePendingReportingAppointmentComment","summary":"Create a comment for a pending reporting appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"schemaId":"components/schemas/PendingReportingAppointmentCommentCreateRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentCommentCreateRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentCommentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/PendingReportingAppointmentCommentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/201/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"409","description":"Conflict","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_83","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/409/content/application~1problem+json/example"]}},"schemaId":"schema_83","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/409/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PendingReportingAppointmentCommentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentCommentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/404/content/application~1problem+json/example"]}}},{"code":"409","schemaId":"schema_83","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/409/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_83","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/409/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting/integrations_creatependingreportingappointmentcomment"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/comments"},{"label":"Get a single comment for a pending reporting appointment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reporting/integrations_getpendingreportingappointmentcomment","routeSlug":"/openapi/reporting/integrations_getpendingreportingappointmentcomment","metadata":{"seo":{"title":"Get a single comment for a pending reporting appointment","description":"Returns a single appointment comment/alert or patient comment/alert (for the appointment's patient) when the appointment is in the PENDING REPORTING status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_GetPendingReportingAppointmentComment","name":"Get a single comment for a pending reporting appointment","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a single comment for a pending reporting appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single appointment comment/alert or patient comment/alert (for the appointment's patient) when the appointment is in the PENDING REPORTING status.\n\nReturns 404 when the appointment is not found or is not in the PENDING REPORTING status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true},{"name":"commentGuid","in":"path","schemaId":"schema_71","description":"Comment GUID for the requested appointment/patient comment.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/comments/{commentGuid}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"},{"name":"commentGuid","in":"path","required":true,"example":"ed6ef45a-4e3d-41b2-8049-7aec53bb9ab1","schemaId":"schema_71"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/comments/{commentGuid}","href":"reporting/integrations_getpendingreportingappointmentcomment","openApiOperationId":"Integrations_GetPendingReportingAppointmentComment","summary":"Get a single comment for a pending reporting appointment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Comment metadata for the requested pending reporting appointment comment (appointment or patient).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentCommentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/PendingReportingAppointmentCommentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/200/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PendingReportingAppointmentCommentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentCommentResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/404/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting/integrations_getpendingreportingappointmentcomment"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/comments/{commentGuid}"},{"label":"Submit an editable draft or request normal report authorisation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reporting/integrations_submitpendingreportingappointmentreport","routeSlug":"/openapi/reporting/integrations_submitpendingreportingappointmentreport","metadata":{"seo":{"title":"Submit an editable draft or request normal report authorisation","description":"Requires an idempotency key and explicit delegation to an active QUBS clinician. Preliminary content enters the Typed worklist; final content follows normal authorisation. Accepts text/plain or strictly validated basic text/html report bodies for radiology appointments in PENDING REPORTING or TYPED. Unsupported HTML returns 400. Attachments are optional."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_SubmitPendingReportingAppointmentReport","name":"Submit an editable draft or request normal report authorisation","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit an editable draft or request normal report authorisation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Requires an idempotency key and explicit delegation to an active QUBS clinician. Preliminary content enters the Typed worklist; final content follows normal authorisation. Accepts text/plain or strictly validated basic text/html report bodies for radiology appointments in PENDING REPORTING or TYPED. Unsupported HTML returns 400. Attachments are optional.\n\nCreates or updates the linked editable QUBS report. preliminary returns 201 after saving; final returns 202 after requesting normal authorisation and finalisation. Requires interpretingClinicianEmail and explicit partner delegation plus normal clinician permissions. Updates require reportKey and expectedReportRevision. Idempotency-Key is mandatory (maximum 128 characters): identical retries replay the original outcome; changed original content or format under the same key returns 409. An unresolved operation returns 202 with operationId, status pending and a reconciliation message; do not use a new key to repeat it. A failed final submission may already have saved content. No partner endpoint currently retrieves the latest revision or reconciles pending operations; stop automatic writes and contact QUBS support with domain, appointmentId and operationId/correlation ID before creating another operation. Do not guess revisions. Workflow failures can return application/json with operationId, detail and workflowError rather than Problem Details.\n\nReturns 404 when the appointment is not found. New submissions require PENDING REPORTING or TYPED; an unavailable workflow state or revision conflict returns 409."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."},{"name":"Idempotency-Key","in":"header","schemaId":"schema_82","description":"Idempotency key for safely retrying POST requests. Use a stable ASCII token (recommend a UUID) up to 128 characters. Reuse the same key with the same request payload to receive the original response; reuse with a different payload returns 409 Conflict. For timeouts or transient errors, retry with the same key and exponential backoff.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentReportRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/plainTextDraft","paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/htmlDraft","paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/htmlFinal"]}},"schemaId":"components/schemas/PendingReportingAppointmentReportRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/plainTextDraft","paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/htmlDraft","paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/htmlFinal"],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/report","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"},{"name":"Idempotency-Key","in":"header","required":true,"example":"cd4a859c7a1f4b44b765a8fe17bb44c1","schemaId":"schema_82"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentReportRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/plainTextDraft","paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/htmlDraft","paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/htmlFinal"]}},"responseCodes":["201","202","400","401","403","404","409","422","429","500","503"],"pointer":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/report","href":"reporting/integrations_submitpendingreportingappointmentreport","openApiOperationId":"Integrations_SubmitPendingReportingAppointmentReport","summary":"Submit an editable draft or request normal report authorisation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"schemaId":"components/schemas/PendingReportingAppointmentReportRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/plainTextDraft","paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/htmlDraft","paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/htmlFinal"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentReportRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/plainTextDraft","paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/htmlDraft","paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/htmlFinal"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentReportResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/PendingReportingAppointmentReportResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/201/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"202","description":"Authorisation/finalisation accepted, or a prior operation is pending reconciliation. Inspect workflowStatus or status; do not assume delivery has completed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/202/content/application~1json/examples/authorisationAccepted","paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/202/content/application~1json/examples/pendingReconciliation"]}},"schemaId":"schema_84","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/202/content/application~1json/examples/authorisationAccepted","paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/202/content/application~1json/examples/pendingReconciliation"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/400/content/application~1problem+json/example"]},"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/400/content/application~1json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/403/content/application~1problem+json/example"]},"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/403/content/application~1json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/404/content/application~1problem+json/example"]},"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/404/content/application~1json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"409","description":"Conflict","mediaType":"application/problem+json","mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_83","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/409/content/application~1problem+json/example"]},"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/409/content/application~1json/example"]}},"schemaId":"schema_83","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/409/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"422","description":"Report workflow failure. Inspect Content-Type and retain operationId for QUBS support.","mediaType":"application/problem+json","mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"},"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/422/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/500/content/application~1problem+json/example"]},"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/500/content/application~1json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"503","description":"Report workflow failure. Inspect Content-Type and retain operationId for QUBS support.","mediaType":"application/problem+json","mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"},"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/503/content/application~1json/example"]}},"schemaId":"components/schemas/ProblemDetails"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PendingReportingAppointmentReportResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PendingReportingAppointmentReportResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/201/content/application~1json/example"]}}},{"code":"202","schemaId":"schema_84","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/202/content/application~1json/examples/authorisationAccepted","paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/202/content/application~1json/examples/pendingReconciliation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_84","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/202/content/application~1json/examples/authorisationAccepted","paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/202/content/application~1json/examples/pendingReconciliation"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/400/content/application~1problem+json/example"]},"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/403/content/application~1problem+json/example"]},"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/404/content/application~1problem+json/example"]},"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"schema_83","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/409/content/application~1problem+json/example"],"mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_83","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/409/content/application~1problem+json/example"]},"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/409/content/application~1json/example"]}}},{"code":"422","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"},"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/422/content/application~1json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/500/content/application~1problem+json/example"]},"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/500/content/application~1json/example"]}}},{"code":"503","schemaId":"components/schemas/ProblemDetails","mediaTypes":["application/problem+json","application/json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/ProblemDetails"},"application/json":{"schemaId":"schema_85","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/503/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting/integrations_submitpendingreportingappointmentreport"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/report"},{"label":"Create upload URLs for pending reporting report attachments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/reporting/integrations_creatependingreportingappointmentreportattachments","routeSlug":"/openapi/reporting/integrations_creatependingreportingappointmentreportattachments","metadata":{"seo":{"title":"Create upload URLs for pending reporting report attachments","description":"Creates optional attachment metadata and returns presigned upload URLs for report artifacts (PDF/DICOM SR) for a pending reporting appointment. Upload the raw file bytes with an HTTP PUT to uploadUrl; if contentType was provided, include the same Content-Type header in the upload. Constraints: max 20 items per request, fileName length <= 255 characters, and contentType must be application/pdf or application/dicom when provided. Uploads use a single PUT (supported size up to 2 MB; partners must enforce this limit because the presigned PUT does not enforce content length) and must complete before uploadUrlExpiresAtUtc (metadata is created immediately but content is available only after the PUT succeeds)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"Integrations_CreatePendingReportingAppointmentReportAttachments","name":"Create upload URLs for pending reporting report attachments","isWebhook":false,"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create upload URLs for pending reporting report attachments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates optional attachment metadata and returns presigned upload URLs for report artifacts (PDF/DICOM SR) for a pending reporting appointment. Upload the raw file bytes with an HTTP PUT to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uploadUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was provided, include the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header in the upload. Constraints: max 20 items per request, fileName length <= 255 characters, and contentType must be application/pdf or application/dicom when provided. Uploads use a single PUT (supported size up to 2 MB; partners must enforce this limit because the presigned PUT does not enforce content length) and must complete before "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uploadUrlExpiresAtUtc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (metadata is created immediately but content is available only after the PUT succeeds)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Report attachments are optional. Use this endpoint only when sending PDF/DICOM report artifacts; report text can be submitted without attachments. Preferred sequence: create upload URLs, PUT the file bytes, then submit report content."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Idempotency: supports the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Idempotency-Key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Best-effort process-local deduplication only, with a cache lifetime of up to 15 minutes. A cached identical request replays its response; a cached key with a different payload returns 409. Eviction, restarts, different instances or concurrent requests can still create duplicate metadata and upload URLs. Verify existing attachments after an uncertain outcome before retrying; retain the original key and payload."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upload guidance: send a single PUT to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uploadUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Length"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"contentType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was provided, include the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Upload URLs are intended for a single successful PUT; request a new URL if an upload fails or expires. Storage locations are managed by QUBS and are not supplied by clients."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 404 when the appointment is not found or is not in the PENDING REPORTING status."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Bearer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_43","description":"Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.","required":true},{"name":"appointmentId","in":"path","schemaId":"schema_59","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","required":true}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Correlation-Id","in":"header","schemaId":"schema_44","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."},{"name":"Idempotency-Key","in":"header","schemaId":"schema_82","description":"Optional key for best-effort process-local deduplication. Reuse the original key and payload, but duplicates remain possible after eviction, restarts, on another instance or with concurrent requests. See endpoint notes for cache lifetimes and recovery guidance."}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PendingReportingReportAttachmentsUploadRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/PendingReportingReportAttachmentsUploadRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/report/attachments","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"acme","schemaId":"schema_43"},{"name":"appointmentId","in":"path","required":true,"example":"200006","schemaId":"schema_59"}],"query":[],"querystring":[],"header":[{"name":"X-Correlation-Id","in":"header","example":"4b7f0a91b4f54f2a","schemaId":"schema_44"},{"name":"Idempotency-Key","in":"header","example":"cd4a859c7a1f4b44b765a8fe17bb44c1","schemaId":"schema_82"}],"cookie":[]},"security":[{"schemes":[{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PendingReportingReportAttachmentsUploadRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/requestBody/content/application~1json/example"]}},"responseCodes":["201","400","401","403","404","409","429","500"],"pointer":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/report/attachments","href":"reporting/integrations_creatependingreportingappointmentreportattachments","openApiOperationId":"Integrations_CreatePendingReportingAppointmentReportAttachments","summary":"Create upload URLs for pending reporting report attachments"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"schemaId":"components/schemas/PendingReportingReportAttachmentsUploadRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PendingReportingReportAttachmentsUploadRequest","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PendingReportingReportAttachmentsUploadResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/201/content/application~1json/example"]}},"schemaId":"components/schemas/PendingReportingReportAttachmentsUploadResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/201/content/application~1json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"400","description":"Bad Request","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/400/content/application~1problem+json/example"]}},"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/400/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/401/content/application~1problem+json/example"]}},"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/401/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"403","description":"Forbidden","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/403/content/application~1problem+json/example"]}},"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/403/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"404","description":"Not Found","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/404/content/application~1problem+json/example"]}},"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/404/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"409","description":"Conflict","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_83","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/409/content/application~1problem+json/example"]}},"schemaId":"schema_83","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/409/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"},{"code":"429","description":"Too Many Requests\n\nRate limit exceeded. No fixed numeric quota is published in this contract; honor the Retry-After response header when provided and use exponential backoff with jitter.","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/429/content/application~1problem+json/example"]}},"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/429/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}},"Retry-After":{"description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date.","schema":{"type":"string","example":"120"}}},"headerSchemaId":"schema_51"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/500/content/application~1problem+json/example"]}},"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/500/content/application~1problem+json/example"],"headers":{"X-Correlation-Id":{"description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.","schema":{"type":"string","example":"4b7f0a91b4f54f2a"}}},"headerSchemaId":"schema_46"}],"pointer":"/paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/PendingReportingReportAttachmentsUploadResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/201/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PendingReportingReportAttachmentsUploadResponse","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/201/content/application~1json/example"]}}},{"code":"400","schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/400/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_47","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/400/content/application~1problem+json/example"]}}},{"code":"401","schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/401/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_48","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/401/content/application~1problem+json/example"]}}},{"code":"403","schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/403/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_49","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/403/content/application~1problem+json/example"]}}},{"code":"404","schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/404/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_54","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/404/content/application~1problem+json/example"]}}},{"code":"409","schemaId":"schema_83","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/409/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_83","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/409/content/application~1problem+json/example"]}}},{"code":"429","schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/429/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_50","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/429/content/application~1problem+json/example"]}}},{"code":"500","schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/500/content/application~1problem+json/example"],"mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_52","exampleIds":["paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/500/content/application~1problem+json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reporting/integrations_creatependingreportingappointmentreportattachments"}],"panels":[]}]},"httpPath":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/report/attachments"}],"content":{"contentType":"group","meta":{"name":"Reporting"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reporting","showPageActions":true},{"nodeType":"markdoc","content":"Partner-facing endpoints for retrieving appointments that are pending reporting and submitting tele reporting content/artifacts. Appointments appear after QUBS moves them to PENDING REPORTING, typically when the scan/study is ended. Typical workflow: list pending reporting appointments, optionally create upload URLs for report artifacts, upload with PUT, then submit report text. Report text alone is sufficient; attachments are optional."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/integrations/v1/{domain}/reporting/appointments/pending","summary":"List pending reporting appointments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reporting/integrations_listpendingreportingappointments","deprecated":false},{"title":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}","summary":"Get a pending reporting appointment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reporting/integrations_getpendingreportingappointment","deprecated":false},{"title":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/attachments","summary":"List attachments for a pending reporting appointment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reporting/integrations_listpendingreportingappointmentattachments","deprecated":false},{"title":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/attachments/{attachmentGuid}","summary":"Get a single attachment for a pending reporting appointment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reporting/integrations_getpendingreportingappointmentattachment","deprecated":false},{"title":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/comments","summary":"List comments for a pending reporting appointment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reporting/integrations_listpendingreportingappointmentcomments","deprecated":false},{"title":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/comments","summary":"Create a comment for a pending reporting appointment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reporting/integrations_creatependingreportingappointmentcomment","deprecated":false},{"title":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/comments/{commentGuid}","summary":"Get a single comment for a pending reporting appointment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reporting/integrations_getpendingreportingappointmentcomment","deprecated":false},{"title":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/report","summary":"Submit an editable draft or request normal report authorisation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reporting/integrations_submitpendingreportingappointmentreport","deprecated":false},{"title":"/integrations/v1/{domain}/reporting/appointments/{appointmentId}/report/attachments","summary":"Create upload URLs for pending reporting report attachments","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reporting/integrations_creatependingreportingappointmentreportattachments","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AppointmentAttachmentResponse":{"id":"components/schemas/AppointmentAttachmentResponse","kind":"json-schema","title":"AppointmentAttachmentResponse","data":{"required":["guid"],"type":"object","properties":{"guid":{"type":"string","description":"Attachment GUID.","example":"123"},"appointmentId":{"type":"string","example":"123"},"category":{"type":"string","description":"Attachment category (e.g. Referral, Worksheet).","example":"Example category"},"fileName":{"type":"string","description":"Suggested filename for display/download.","example":"Example Name"},"fileExtension":{"type":"string","example":"Example fileExtension"},"addedDateTime":{"type":["null","string"],"description":"When the attachment was added (UTC).","format":"date-time","example":"2020-01-01T00:00:00Z"},"addedBy":{"description":"Who added the attachment when available.","$ref":"#/components/schemas/UserSummaryResponse"},"lastModifiedDateTime":{"type":["null","string"],"description":"When the attachment was last modified (UTC).","format":"date-time","example":"2020-01-01T00:00:00Z"},"lastModifiedBy":{"description":"Who last modified the attachment when available.","$ref":"#/components/schemas/UserSummaryResponse"},"url":{"type":["null","string"],"description":"Short-lived presigned URL for retrieving the attachment content when available.","example":"https://example.com"},"urlExpiresAtUtc":{"type":["null","string"],"description":"UTC expiry timestamp for the presigned URL when available.","format":"date-time","example":"2020-01-01T00:00:00Z"},"canPreview":{"type":"boolean","example":true},"previewUnavailableReason":{"type":"string","example":"Example previewUnavailableReason"}},"description":"Attachment metadata for an appointment, including an optional presigned URL for retrieving the underlying file."}},"components/schemas/AppointmentBillingResponse":{"id":"components/schemas/AppointmentBillingResponse","kind":"json-schema","title":"AppointmentBillingResponse","data":{"required":["domain","appointmentId"],"type":"object","properties":{"domain":{"type":"string","description":"Domain this appointment belongs to.","example":"Example domain"},"appointmentId":{"type":"string","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","example":"123"},"batchSk":{"type":"string","example":"Example batchSk"},"billingStatus":{"type":"string","description":"Billing status for the appointment.","example":"active"},"billingType":{"type":"string","description":"Billing type for the appointment.","example":"Example billingType"},"invoiceCreationError":{"type":"string","description":"Latest billing error when available.","example":"Example invoiceCreationError"},"invoiceNumber":{"type":"string","description":"Invoice number when available.","example":"Example invoiceNumber"},"invoiceSk":{"type":"string","description":"Invoice record key when available.","example":"Example invoiceSk"},"isBillingsChecked":{"type":"boolean","description":"Whether billing validation has been completed.","example":true},"medicareExpiryDate":{"type":["null","string"],"format":"date","example":"2020-01-01"},"medicareIrn":{"type":"string","example":"Example medicareIrn"},"medicareNumber":{"type":"string","example":"Example medicareNumber"},"providerNumber":{"type":"string","example":"Example providerNumber"},"serviceItemNumbers":{"type":"string","description":"Concatenated service item numbers when available.","example":"Example serviceItemNumbers"},"serviceItems":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentServiceItemResponse"},"description":"Service item details attached to the appointment."}},"description":"Billing appointment view within a domain, including invoice and service item details."}},"components/schemas/AppointmentCommentResponse":{"id":"components/schemas/AppointmentCommentResponse","kind":"json-schema","title":"AppointmentCommentResponse","data":{"required":["guid","commentType"],"type":"object","properties":{"guid":{"type":"string","description":"Comment GUID.","example":"123"},"commentType":{"enum":["AC","AA","PC","PA"],"type":"string","description":"Comment type. One of: AC (Appointment Comment), AA (Appointment Alert), PC (Patient Comment), PA (Patient Alert).","example":"AC"},"appointmentId":{"type":"string","description":"Opaque appointment identifier for appointment comments; empty for patient-level comments.","example":"123"},"patientId":{"type":"string","description":"Patient identifier associated with the comment when available.","example":"123"},"commentText":{"type":"string","description":"Comment text.","example":"Example commentText"},"commentDateTime":{"type":["null","string"],"description":"When the comment was created (UTC) when available.","format":"date-time","example":"2020-01-01T00:00:00Z"},"isAlert":{"type":"boolean","description":"Whether this comment should be treated as an alert.","example":true},"commentBy":{"description":"Who created the comment when available.","$ref":"#/components/schemas/UserSummaryResponse"},"lastModifiedDateTime":{"type":["null","string"],"description":"When the comment was last modified (UTC).","format":"date-time","example":"2020-01-01T00:00:00Z"},"lastModifiedBy":{"description":"Who last modified the comment when available.","$ref":"#/components/schemas/UserSummaryResponse"}},"description":"Comment metadata for an appointment, including both appointment-level and patient-level comments/alerts."}},"components/schemas/AppointmentExamCodeResponse":{"id":"components/schemas/AppointmentExamCodeResponse","kind":"json-schema","title":"AppointmentExamCodeResponse","data":{"required":["examCodeId","key","site","description"],"type":"object","properties":{"examCodeId":{"type":"string","description":"Unique exam code identifier.","example":"123"},"key":{"type":"string","description":"QUBS internal key for the exam code record.","example":"Example key"},"site":{"type":"string","description":"Site this exam code belongs to.","example":"Example site"},"description":{"type":"string","description":"Human-readable exam description.","example":"Example description"},"domain":{"type":"string","example":"Example domain"},"category":{"type":"string","example":"Example category"},"colour":{"type":"string","example":"Example colour"},"modality":{"type":"string","example":"Example modality"},"totalDuration":{"type":"integer","description":"Configured duration in minutes.","format":"int32","example":1},"gap":{"type":["null","integer"],"format":"int32","example":1},"showOnline":{"type":"boolean","description":"Whether this exam is visible/available online.","example":true},"lastModifiedDateTime":{"type":["null","string"],"format":"date-time","example":"2020-01-01T00:00:00Z"},"extraInfo":{"type":["null","string"],"example":"Example extraInfo"},"onlineInfo":{"type":["null","string"],"example":"Example onlineInfo"},"preparations1":{"type":["null","string"],"example":"Example preparations1"},"preparations2":{"type":["null","string"],"example":"Example preparations2"},"preparations3":{"type":["null","string"],"example":"Example preparations3"},"order":{"type":"integer","format":"int32","example":1},"worksheetId":{"type":["null","string"],"example":"123"}},"description":"Exam code details attached to an appointment."}},"components/schemas/AppointmentOperationalResponse":{"id":"components/schemas/AppointmentOperationalResponse","kind":"json-schema","title":"AppointmentOperationalResponse","data":{"required":["domain","appointmentId","scheduledSite","status"],"type":"object","properties":{"domain":{"type":"string","description":"Domain this appointment belongs to.","example":"Example domain"},"appointmentId":{"type":"string","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","example":"123"},"scheduledSite":{"type":"string","description":"Scheduled site name.","example":"Example scheduledSite"},"status":{"enum":["NOT ARRIVED","ARRIVED","DID NOT ATTEND","APPPOINTMENT CANCELLED","CANCELLATION LIST","DICTATION INPROGRESS","DICTATED","TYPED","AUTHORISING","AUTHORISED","TYPING INPROGRESS","PENDING REPORTING","STUDY INPROGRESS","SECOND REVIEW","FINALISED","REVIEW TYPED","PEER REVIEW","SECOND OPINION"],"type":"string","description":"Appointment status.","example":"NOT ARRIVED"},"appointmentDate":{"type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment date (ISO 8601, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the scheduled site's local timezone."},"children":[]}]}]}],"format":"date","example":"2020-01-01"},"startTime":{"pattern":"^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$","type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled start time (ISO 8601, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the scheduled site's local timezone."},"children":[]}]}]}],"example":"13:45:00"},"endTime":{"pattern":"^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$","type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled end time (ISO 8601, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the scheduled site's local timezone."},"children":[]}]}]}],"example":"13:45:00"},"modality":{"type":"string","example":"Example modality"},"studyDescription":{"type":"string","example":"Example description"},"room":{"type":"string","example":"Example room"},"priority":{"type":"string","example":"Example priority"},"arrivalDateTime":{"type":["null","string"],"format":"date-time","example":"2020-01-01T00:00:00Z"},"scanStartDateTime":{"type":["null","string"],"format":"date-time","example":"2020-01-01T00:00:00Z"},"scanEndDateTime":{"type":["null","string"],"format":"date-time","example":"2020-01-01T00:00:00Z"},"scanTotalTime":{"type":["null","number"],"format":"double","example":1.23},"waitingTotalTime":{"type":["null","number"],"format":"double","example":1.23},"examCodes":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentExamCodeResponse"},"description":"Exam codes attached to the appointment."}},"description":"Operational appointment view within a domain."}},"components/schemas/AppointmentServiceItemResponse":{"id":"components/schemas/AppointmentServiceItemResponse","kind":"json-schema","title":"AppointmentServiceItemResponse","data":{"required":["itemNo"],"type":"object","properties":{"itemNo":{"type":"string","description":"Service item number.","example":"Example itemNo"},"key":{"type":"string","example":"Example key"},"appointmentId":{"type":"string","description":"Opaque appointment identifier this item belongs to.","example":"123"},"afterCareOverrideInd":{"type":"string","example":"Example afterCareOverrideInd"},"bulkBillingSpecialist":{"type":["null","number"],"format":"double","example":1.23},"chargeAmount":{"type":["null","number"],"format":"double","example":1.23},"dateOfService":{"type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of service (ISO 8601, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date","example":"2020-01-01"},"distanceKilometres":{"type":"integer","format":"int32","example":1},"duration":{"type":["null","integer"],"description":"Optional duration (in minutes) associated with the service item.","format":"int32","example":1},"dvaSpecialist":{"type":["null","number"],"format":"double","example":1.23},"duplicateServiceOverrideInd":{"type":"string","example":"Example duplicateServiceOverrideInd"},"errorCode":{"type":"string","example":"ABC123"},"examCodeId":{"type":"string","example":"123"},"fieldQuantity":{"type":"string","example":"Example fieldQuantity"},"group":{"type":"string","example":"Example group"},"groupId":{"type":"string","example":"123"},"lastModifiedBy":{"$ref":"#/components/schemas/UserSummaryResponse"},"lastModifiedDateTime":{"type":["null","string"],"format":"date-time","example":"2020-01-01T00:00:00Z"},"lspn":{"type":"string","example":"Example lspn"},"medicareUuid":{"type":"string","example":"123"},"modality":{"type":"string","example":"Example modality"},"multipleProcedureOverrideInd":{"type":"string","example":"Example multipleProcedureOverrideInd"},"multipleProcedureOverrideText":{"type":"string","example":"Example multipleProcedureOverrideText"},"noOfPatientsSeen":{"type":"string","example":"Example noOfPatientsSeen"},"objectType":{"type":"string","example":"Example objectType"},"patientContribAmt":{"type":"number","format":"double","example":1.23},"restrictiveOverrideCde":{"type":"string","example":"Example restrictiveOverrideCde"},"selfDeemedCde":{"type":"string","example":"Example selfDeemedCde"},"serviceText":{"type":"string","example":"Example serviceText"},"shortDescription":{"type":"string","example":"Example description"},"site":{"type":"string","example":"Example site"},"status":{"type":"string","description":"Service item status.","example":"active"},"subGroup":{"type":"string","example":"Example subGroup"},"subGroupId":{"type":["null","integer"],"format":"int32","example":1},"timeDuration":{"type":"string","example":"Example timeDuration"},"uuid":{"type":"string","example":"123"}},"description":"Billing/service item details attached to an appointment."}},"components/schemas/AppointmentsOperationalPageResponse":{"id":"components/schemas/AppointmentsOperationalPageResponse","kind":"json-schema","title":"AppointmentsOperationalPageResponse","data":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentOperationalResponse"},"description":"Operational appointments in the current page."},"nextToken":{"type":["null","string"],"description":"Opaque continuation token to fetch the next page, when more results are available.","example":"Example nextToken"}},"description":"A single page of operational appointments plus an optional continuation token."}},"components/schemas/AppointmentsSummaryPageResponse":{"id":"components/schemas/AppointmentsSummaryPageResponse","kind":"json-schema","title":"AppointmentsSummaryPageResponse","data":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentSummaryResponse"},"description":"Appointment summaries in the current page."},"nextToken":{"type":["null","string"],"description":"Opaque continuation token to fetch the next page, when more results are available.","example":"Example nextToken"}},"description":"A single page of appointment summaries plus an optional continuation token."}},"components/schemas/AppointmentSummaryResponse":{"id":"components/schemas/AppointmentSummaryResponse","kind":"json-schema","title":"AppointmentSummaryResponse","data":{"required":["domain","appointmentId","scheduledSite","status"],"type":"object","properties":{"domain":{"type":"string","description":"Domain this appointment belongs to.","example":"Example domain"},"appointmentId":{"type":"string","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","example":"123"},"scheduledSite":{"type":"string","description":"Scheduled site name.","example":"Example scheduledSite"},"status":{"enum":["NOT ARRIVED","ARRIVED","DID NOT ATTEND","APPPOINTMENT CANCELLED","CANCELLATION LIST","DICTATION INPROGRESS","DICTATED","TYPED","AUTHORISING","AUTHORISED","TYPING INPROGRESS","PENDING REPORTING","STUDY INPROGRESS","SECOND REVIEW","FINALISED","REVIEW TYPED","PEER REVIEW","SECOND OPINION"],"type":"string","description":"Appointment status.","example":"NOT ARRIVED"},"appointmentDate":{"type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment date (ISO 8601, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the scheduled site's local timezone."},"children":[]}]}]}],"format":"date","example":"2020-01-01"},"startTime":{"pattern":"^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$","type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled start time (ISO 8601, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the scheduled site's local timezone."},"children":[]}]}]}],"example":"13:45:00"},"endTime":{"pattern":"^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$","type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled end time (ISO 8601, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the scheduled site's local timezone."},"children":[]}]}]}],"example":"13:45:00"},"modality":{"type":"string","example":"Example modality"},"studyDescription":{"type":"string","example":"Example description"}},"description":"Summary appointment view within a domain."}},"components/schemas/EmployeeSkillResponse":{"id":"components/schemas/EmployeeSkillResponse","kind":"json-schema","title":"EmployeeSkillResponse","data":{"required":["name","username"],"type":"object","properties":{"name":{"type":"string","description":"Display name of the staff member.","example":"Example Name"},"username":{"type":"string","description":"Unique username for the staff member.","example":"Example Name"},"scans":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ScanSkillResponse"},"description":"Map of exam key to scan skill details."}},"description":"Staff member information and their scan skills keyed by exam key."}},"components/schemas/ExamCodeResponse":{"id":"components/schemas/ExamCodeResponse","kind":"json-schema","title":"ExamCodeResponse","data":{"required":["examCodeId","key","site","description"],"type":"object","properties":{"examCodeId":{"type":"string","description":"Unique exam code identifier.","example":"123"},"key":{"type":"string","description":"QUBS internal key for the exam code record.","example":"Example key"},"site":{"type":"string","description":"Site this exam code belongs to.","example":"Example site"},"description":{"type":"string","description":"Human-readable exam description.","example":"Example description"},"category":{"type":"string","description":"Optional exam category.","example":"Example category"},"modality":{"type":"string","description":"Optional imaging modality.","example":"Example modality"},"totalDuration":{"type":"integer","description":"Configured duration in minutes.","format":"int32","example":1},"showOnline":{"type":"boolean","description":"Whether this exam code is visible/available online.","example":true},"lastModifiedDateTime":{"type":"string","description":"When the exam code was last updated.","format":"date-time","example":"2020-01-01T00:00:00Z"}},"description":"Exam code configuration for a site within a domain."}},"components/schemas/HeaderCommentResponse":{"id":"components/schemas/HeaderCommentResponse","kind":"json-schema","title":"HeaderCommentResponse","data":{"type":"object","properties":{"hasComment":{"type":"boolean","description":"Whether a comment is present for the header.","example":true},"comment":{"type":["null","string"],"description":"Optional comment text.","example":"Example comment"},"selectedMarker":{"type":["null","string"],"description":"Optional marker identifier.","example":"Example selectedMarker"},"markerColor":{"type":["null","string"],"description":"Optional marker color value.","example":"Example markerColor"}},"description":"Optional comment and marker metadata displayed in the staff skills grid header."}},"components/schemas/PatientSummaryResponse":{"id":"components/schemas/PatientSummaryResponse","kind":"json-schema","title":"PatientSummaryResponse","data":{"required":["domain","patientId","patientName"],"type":"object","properties":{"domain":{"type":"string","description":"Domain this patient belongs to.","example":"Example domain"},"patientId":{"type":"string","description":"Patient identifier.","example":"123"},"patientName":{"type":"string","description":"Patient display name.","example":"Example Name"},"firstName":{"type":"string","description":"Patient first name.","example":"Example Name"},"lastName":{"type":"string","description":"Patient last name.","example":"Example Name"},"gender":{"type":"string","description":"Patient gender/sex string as stored in QUBS. No enum is enforced by this API; values can be blank, so map blank, unknown, or unrecognized values to your local Unknown value if required.","example":"Example gender"},"dateOfBirth":{"type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Patient date of birth (ISO 8601, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date","example":"2020-01-01"}},"description":"Summary patient view within a domain."}},"components/schemas/PendingReportingAppointmentAttachmentResponse":{"id":"components/schemas/PendingReportingAppointmentAttachmentResponse","kind":"json-schema","title":"PendingReportingAppointmentAttachmentResponse","data":{"required":["guid"],"type":"object","properties":{"guid":{"type":"string","description":"Attachment GUID.","example":"123"},"category":{"type":"string","description":"Attachment category (e.g. Referral, Worksheet).","example":"Example category"},"fileName":{"type":"string","description":"Suggested filename for display/download.","example":"Example Name"},"addedDateTime":{"type":["null","string"],"description":"When the attachment was added (UTC).","format":"date-time","example":"2020-01-01T00:00:00Z"},"addedBy":{"description":"Who added the attachment when available.","$ref":"#/components/schemas/UserSummaryResponse"},"lastModifiedDateTime":{"type":["null","string"],"description":"When the attachment was last modified (UTC).","format":"date-time","example":"2020-01-01T00:00:00Z"},"url":{"type":["null","string"],"description":"Short-lived presigned URL for retrieving the attachment content when available.","example":"https://example.com"},"urlExpiresAtUtc":{"type":["null","string"],"description":"UTC expiry timestamp for the presigned URL when available.","format":"date-time","example":"2020-01-01T00:00:00Z"}},"description":"Attachment metadata for a pending reporting appointment."}},"components/schemas/PendingReportingAppointmentCommentCreateRequest":{"id":"components/schemas/PendingReportingAppointmentCommentCreateRequest","kind":"json-schema","title":"PendingReportingAppointmentCommentCreateRequest","data":{"required":["commentText"],"type":"object","properties":{"commentText":{"minLength":1,"type":"string","description":"Comment text. Required; blank values are rejected.","example":"Example commentText"},"commentType":{"enum":["AC","AA","PC","PA"],"type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional comment type. One of: AC (Appointment Comment), AA (Appointment Alert), PC (Patient Comment), PA (Patient Alert). Defaults to AA when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"isAlert"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true, otherwise AC."},"children":[]}]}]}],"example":"AC"},"isAlert":{"type":["null","boolean"],"description":"Whether this comment should be treated as an alert.","example":true},"commentDateTime":{"type":["null","string"],"description":"When the comment was created (UTC) when available.","format":"date-time","example":"2020-01-01T00:00:00Z"}},"description":"Comment creation payload for a pending reporting appointment."}},"components/schemas/PendingReportingAppointmentCommentResponse":{"id":"components/schemas/PendingReportingAppointmentCommentResponse","kind":"json-schema","title":"PendingReportingAppointmentCommentResponse","data":{"required":["guid","commentType"],"type":"object","properties":{"guid":{"type":"string","description":"Comment GUID.","example":"123"},"commentType":{"enum":["AC","AA","PC","PA"],"type":"string","description":"Comment type. One of: AC (Appointment Comment), AA (Appointment Alert), PC (Patient Comment), PA (Patient Alert).","example":"AC"},"appointmentId":{"type":"string","description":"Opaque appointment identifier for appointment comments; empty for patient-level comments.","example":"123"},"patientId":{"type":"string","description":"Patient identifier associated with the comment when available.","example":"123"},"commentText":{"type":"string","description":"Comment text.","example":"Example commentText"},"commentDateTime":{"type":["null","string"],"description":"When the comment was created (UTC) when available.","format":"date-time","example":"2020-01-01T00:00:00Z"},"isAlert":{"type":"boolean","description":"Whether this comment should be treated as an alert.","example":true},"commentBy":{"description":"Who created the comment when available.","$ref":"#/components/schemas/UserSummaryResponse"},"lastModifiedDateTime":{"type":["null","string"],"description":"When the comment was last modified (UTC).","format":"date-time","example":"2020-01-01T00:00:00Z"}},"description":"Comment metadata for a pending reporting appointment, including both appointment-level and patient-level comments/alerts."}},"components/schemas/PendingReportingAppointmentReportRequest":{"id":"components/schemas/PendingReportingAppointmentReportRequest","kind":"json-schema","title":"PendingReportingAppointmentReportRequest","data":{"required":["reportText","reportStatus","interpretingClinicianEmail"],"type":"object","properties":{"reportText":{"maxLength":2097152,"minLength":1,"type":"string","description":"Required report body, interpreted only according to reportFormat. Plain text is not inferred as HTML. Accepted HTML is canonicalised and a readable plain-text version is derived. Attachments are optional. The size limit applies to the original submitted content. ReportText must be 2097152 bytes or less when UTF-8 encoded.","example":"Example reportText"},"reportStatus":{"minLength":1,"enum":["preliminary","final"],"type":"string","description":"Case-insensitive: preliminary saves an editable draft in the Typed worklist; final requests normal QUBS authorisation and delivery on behalf of the specified clinician. A final submission is not an import of an already-authorised external document.","example":"preliminary"},"reportFormat":{"type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional: text/plain or text/html (case-insensitive). Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text/plain"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted. HTML must be a report-body fragment. Allowed tags: p, div, span, br, h1-h6, strong, b, em, i, u, ul, ol, li, table, thead, tbody, tfoot, tr, th, td, caption. Only colspan and rowspan attributes on td/th are permitted, with integer values 1-50. All other tags and attributes, CSS, images, links, scripts, comments, declarations and full HTML documents are rejected. Malformed HTML or content without readable text returns 400 before operation receipts, rendering or clinical writes. Errors identify the tag or attribute without echoing clinical text. QUBS templates control fonts, layout and signatures. In the editor, captions become editable paragraphs above their tables, preserving text and inline emphasis."},"children":[]}]}]}],"default":"text/plain","example":"text/plain"},"interpretingClinicianName":{"type":["null","string"],"description":"Interpreting clinician display name.","example":"Example Name"},"interpretingClinicianProviderNumber":{"type":["null","string"],"description":"Optional source clinician provider number. Does not select the authorising clinician or grant signing permission; QUBS uses the resolved clinician account.","example":"Example interpretingClinicianProviderNumber"},"interpretingClinicianEmail":{"minLength":1,"type":"string","description":"Required email of an active QUBS clinician in the requested tenant. The partner needs explicit clinician or domain-wide delegation, and the clinician must have normal QUBS permissions for the requested action. An email domain alone does not grant access.","example":"user@example.com"},"reportedAtUtc":{"type":["null","string"],"description":"Optional source timestamp (UTC). Does not override the QUBS authorisation timestamp.","format":"date-time","example":"2020-01-01T00:00:00Z"},"reportKey":{"type":["null","string"],"description":"Required when updating an existing draft. Treat this as an opaque value: copy the returned linked QUBS report key unchanged, without constructing or parsing it; a missing or mismatched key returns 409. Omit for first creation.","example":"Example reportKey"},"expectedReportRevision":{"type":["null","integer"],"description":"Required when updating an existing draft. Send its current report revision; stale or missing revisions return 409. First creation uses revision 0 when omitted. No partner endpoint currently returns the latest report revision. On conflict, stop automatic writes and contact QUBS support with domain, appointmentId and operationId/correlation ID. Do not guess revisions or use a new key to bypass the conflict; resume only after QUBS confirms the current state and revision.","format":"int64","example":1},"pathologyAcknowledgement":{"type":["null","string"],"description":"Acknowledgement required only when the normal QUBS authorisation workflow requests pathology acknowledgement.","example":"Example pathologyAcknowledgement"}},"description":"Report submission payload for a pending reporting appointment. Attachments are optional."}},"components/schemas/PendingReportingAppointmentReportResponse":{"id":"components/schemas/PendingReportingAppointmentReportResponse","kind":"json-schema","title":"PendingReportingAppointmentReportResponse","data":{"required":["reportGuid"],"type":"object","properties":{"reportGuid":{"type":"string","description":"Identifier of the linked QUBS report. Updating an existing draft does not create an unrelated report record.","example":"123"},"reportStatus":{"enum":["preliminary","final"],"type":"string","description":"Requested submission status: preliminary or final. Use workflowStatus for the QUBS workflow state.","example":"preliminary"},"reportedAtUtc":{"type":["null","string"],"description":"Source timestamp supplied in the request, when present.","format":"date-time","example":"2020-01-01T00:00:00Z"},"reportKey":{"type":"string","description":"Opaque linked QUBS report key. Copy unchanged for subsequent draft updates; do not construct or parse it.","example":"Example reportKey"},"reportRevision":{"type":"integer","description":"Report revision after this operation. Subsequent updates require the latest revision.","format":"int64","example":1},"workflowStatus":{"type":"string","description":"QUBS workflow state returned by the save or authorisation action; delivery may still be in progress.","example":"active"},"operationId":{"type":"string","description":"Durable submission operation identifier for tracing and reconciliation.","example":"123"}},"description":"Acknowledgement for a submitted pending reporting appointment report record."}},"components/schemas/PendingReportingAppointmentResponse":{"id":"components/schemas/PendingReportingAppointmentResponse","kind":"json-schema","title":"PendingReportingAppointmentResponse","data":{"required":["domain","appointmentId","status","scheduledSite"],"type":"object","properties":{"domain":{"type":"string","description":"Domain this appointment belongs to.","example":"Example domain"},"appointmentId":{"type":"string","description":"Opaque appointment identifier within the specified domain. Preserve the value exactly as returned; values may look numeric but are not guaranteed to be numeric, so do not parse as an integer.","example":"123"},"status":{"enum":["NOT ARRIVED","ARRIVED","DID NOT ATTEND","APPPOINTMENT CANCELLED","CANCELLATION LIST","DICTATION INPROGRESS","DICTATED","TYPED","AUTHORISING","AUTHORISED","TYPING INPROGRESS","PENDING REPORTING","STUDY INPROGRESS","SECOND REVIEW","FINALISED","REVIEW TYPED","PEER REVIEW","SECOND OPINION"],"type":"string","description":"Appointment status.","example":"NOT ARRIVED"},"scheduledSite":{"type":"string","description":"Scheduled site name.","example":"Example scheduledSite"},"appointmentDate":{"type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment date (ISO 8601, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the scheduled site's local timezone."},"children":[]}]}]}],"format":"date","example":"2020-01-01"},"startTime":{"pattern":"^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$","type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled start time (ISO 8601, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the scheduled site's local timezone."},"children":[]}]}]}],"example":"13:45:00"},"endTime":{"pattern":"^([01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$","type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduled end time (ISO 8601, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:mm:ss"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in the scheduled site's local timezone."},"children":[]}]}]}],"example":"13:45:00"},"patientId":{"type":"string","description":"Patient identifier when available.","example":"123"},"patientName":{"type":"string","description":"Patient display name.","example":"Example Name"},"firstName":{"type":"string","description":"Patient first name.","example":"Example Name"},"lastName":{"type":"string","description":"Patient last name.","example":"Example Name"},"dateOfBirth":{"type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Patient date of birth (ISO 8601, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yyyy-MM-dd"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"format":"date","example":"2020-01-01"},"gender":{"type":"string","description":"Patient gender/sex string as stored in QUBS. No enum is enforced by this API; values can be blank, so map blank, unknown, or unrecognized values to your local Unknown value if required.","example":"Example gender"},"modality":{"type":"string","description":"Exam modality string as stored in QUBS.","example":"Example modality"},"studyDescription":{"type":"string","description":"Study description as stored in QUBS.","example":"Example description"},"clinicalInfo":{"type":"string","description":"Clinical history/reason for study as stored in QUBS. Display this as clinical context for the reporting clinician when available.","example":"Example clinicalInfo"},"specialtyProfile":{"type":"boolean","example":true},"doctorName":{"type":"string","description":"Referring doctor display name.","example":"Example Name"},"clinicName":{"type":"string","description":"Referring clinic name when available.","example":"Example Name"},"priority":{"type":"string","description":"Appointment/reporting priority string as stored in QUBS.","example":"Example priority"},"reportNeededBy":{"type":["null","string"],"description":"Optional deadline timestamp for reporting (UTC, ISO 8601) when available.","format":"date-time","example":"2020-01-01T00:00:00Z"},"studyInstanceUid":{"type":"string","description":"PACS study instance UID when available. Use it for study/PACS correlation when your workflow needs it; this API does not require a specific PACS viewer integration.","example":"123"},"radiologistUser":{"description":"Radiologist user assigned to the appointment when available. Honour this assignment when your integration supports external assignment.","$ref":"#/components/schemas/UserSummaryResponse"},"serviceItems":{"type":"array","items":{"$ref":"#/components/schemas/PendingReportingServiceItemResponse"},"description":"Service items attached to the appointment."}},"description":"Tele reporting appointment view within a domain. Returned only while the appointment is in PENDING REPORTING."}},"components/schemas/PendingReportingAppointmentsPageResponse":{"id":"components/schemas/PendingReportingAppointmentsPageResponse","kind":"json-schema","title":"PendingReportingAppointmentsPageResponse","data":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/PendingReportingAppointmentResponse"},"description":"Tele reporting appointments in the current page."},"nextToken":{"type":["null","string"],"description":"Opaque continuation token to fetch the next page, when more results are available.","example":"Example nextToken"}},"description":"A single page of tele reporting appointments plus an optional continuation token."}},"components/schemas/PendingReportingReportAttachmentsUploadRequest":{"id":"components/schemas/PendingReportingReportAttachmentsUploadRequest","kind":"json-schema","title":"PendingReportingReportAttachmentsUploadRequest","data":{"required":["items"],"type":"object","properties":{"items":{"maxItems":20,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PendingReportingReportAttachmentUploadRequest"},"description":"Attachment upload request items. Each item creates a new attachment GUID and presigned upload URL. Up to 20 items per request. File names max 255 characters."}},"description":"Batch request to create upload URLs for report attachments."}},"components/schemas/PendingReportingReportAttachmentsUploadResponse":{"id":"components/schemas/PendingReportingReportAttachmentsUploadResponse","kind":"json-schema","title":"PendingReportingReportAttachmentsUploadResponse","data":{"required":["items"],"type":"object","properties":{"items":{"maxItems":20,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PendingReportingReportAttachmentUploadResponse"},"description":"Attachment upload response items."}},"description":"Batch response containing presigned upload URLs for report attachments."}},"components/schemas/PendingReportingReportAttachmentUploadRequest":{"id":"components/schemas/PendingReportingReportAttachmentUploadRequest","kind":"json-schema","title":"PendingReportingReportAttachmentUploadRequest","data":{"required":["fileName"],"type":"object","properties":{"fileName":{"maxLength":255,"minLength":1,"type":"string","description":"Required filename for the report attachment. Path segments are stripped; the resulting name must contain 1-255 characters. Blank names, including names that become blank after path stripping, return 400.","example":"Example Name"},"contentType":{"enum":["application/pdf","application/dicom"],"type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional content type for upload; when provided it must be application/pdf or application/dicom, and the PUT upload must include the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header. Supported report artifact content types: application/pdf, application/dicom (DICOM SR)."},"children":[]}]}]}],"example":"application/pdf"},"category":{"type":["null","string"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional attachment category. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"report"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when omitted."},"children":[]}]}]}],"default":"report","example":"report"}},"description":"Report attachment upload request item."}},"components/schemas/PendingReportingReportAttachmentUploadResponse":{"id":"components/schemas/PendingReportingReportAttachmentUploadResponse","kind":"json-schema","title":"PendingReportingReportAttachmentUploadResponse","data":{"required":["guid"],"type":"object","properties":{"guid":{"type":"string","description":"Attachment GUID.","example":"123"},"fileName":{"type":"string","description":"File name for the report attachment.","example":"Example Name"},"category":{"type":"string","description":"Attachment category.","example":"Example category"},"uploadUrl":{"type":"string","description":"Presigned URL to upload the attachment with an HTTP PUT request. Uploads use a single PUT request. The supported attachment size is at most 2 MB; partners must enforce this limit before upload because the current presigned PUT does not enforce a content-length limit. Include Content-Length with the byte size; if contentType is provided, send the same Content-Type header. Upload URLs are intended for a single successful PUT; request a new URL if an upload fails or expires.","example":"https://example.com"},"uploadUrlExpiresAtUtc":{"type":"string","description":"UTC expiry timestamp for the presigned upload URL; the upload must complete before this time.","format":"date-time","example":"2020-01-01T00:00:00Z"}},"description":"Presigned upload metadata for a report attachment."}},"components/schemas/PendingReportingServiceItemResponse":{"id":"components/schemas/PendingReportingServiceItemResponse","kind":"json-schema","title":"PendingReportingServiceItemResponse","data":{"required":["itemNo"],"type":"object","properties":{"itemNo":{"type":"string","description":"Service item number.","example":"Example itemNo"},"shortDescription":{"type":"string","description":"Human-readable service item description.","example":"Example description"}},"description":"Service item details required for tele reporting."}},"components/schemas/ProblemDetails":{"id":"components/schemas/ProblemDetails","kind":"json-schema","title":"ProblemDetails","data":{"type":"object","properties":{"type":{"type":["null","string"],"description":"Stable error type identifier (urn:qubs:integrations:...). For each response, the type matches the HTTP status.","example":"Example type"},"title":{"type":["null","string"],"description":"Short, human-readable summary of the error.","example":"Example title"},"status":{"type":["null","integer"],"description":"HTTP status code for this error response.","format":"int32","example":1},"detail":{"type":["null","string"],"description":"Detailed description of the error.","example":"Example detail"},"instance":{"type":["null","string"],"description":"Request path for this error.","example":"Example instance"},"requestId":{"type":"string","description":"Request correlation identifier for support. Also returned as the X-Correlation-Id response header.","example":"4b7f0a91b4f54f2a"}},"description":"Standard error envelope for failed requests."}},"components/schemas/ScanSkillResponse":{"id":"components/schemas/ScanSkillResponse","kind":"json-schema","title":"ScanSkillResponse","data":{"type":"object","properties":{"duration":{"type":["null","integer"],"description":"Configured duration (in minutes) for the staff member for this exam key when available.","format":"int32","example":1},"hasComment":{"type":"boolean","description":"Whether a comment is present for this exam key.","example":true},"comment":{"type":["null","string"],"description":"Optional comment text.","example":"Example comment"}},"description":"Scan skill details for a specific exam key."}},"components/schemas/SiteInfoResponse":{"id":"components/schemas/SiteInfoResponse","kind":"json-schema","title":"SiteInfoResponse","data":{"required":["domain","siteName"],"type":"object","properties":{"domain":{"type":"string","description":"Domain this site belongs to.","example":"Example domain"},"siteName":{"type":"string","description":"Site name.","example":"Example Site"}},"description":"A site that belongs to a domain and is available to the partner."}},"components/schemas/SiteSettingsResponse":{"id":"components/schemas/SiteSettingsResponse","kind":"json-schema","title":"SiteSettingsResponse","data":{"required":["domain","siteName","companyName"],"type":"object","properties":{"domain":{"type":"string","description":"Domain this site belongs to.","example":"Example domain"},"siteName":{"type":"string","description":"Site name.","example":"Example Site"},"companyName":{"type":"string","description":"Company name associated with the site.","example":"Example Name"},"siteTimeZoneId":{"type":"string","example":"123"},"timeZone":{"type":"string","description":"IANA or platform timezone identifier used by the site.","example":"Example timeZone"},"defaultBilling":{"type":"string","description":"Default billing type used when booking or invoicing.","example":"Example defaultBilling"},"defaultPriority":{"type":"string","description":"Default appointment priority.","example":"Example defaultPriority"},"appendStudyDescription":{"type":"boolean","description":"Whether to append the study description in downstream outputs where applicable.","example":true},"patientDobRequired":{"type":"boolean","description":"Whether date of birth is required for patients at this site.","example":true},"patientSexRequired":{"type":"boolean","description":"Whether patient sex is required for patients at this site.","example":true},"lastModifiedDateTime":{"type":"string","description":"When the site settings were last updated.","format":"date-time","example":"2020-01-01T00:00:00Z"},"lastModifiedBy":{"type":"string","description":"Who last updated the site settings.","example":"Example lastModifiedBy"}},"description":"Operational configuration settings for a specific site within a domain."}},"components/schemas/SiteSettingsSummaryResponse":{"id":"components/schemas/SiteSettingsSummaryResponse","kind":"json-schema","title":"SiteSettingsSummaryResponse","data":{"required":["domain","siteName","companyName"],"type":"object","properties":{"domain":{"type":"string","description":"Domain this site belongs to.","example":"Example domain"},"siteName":{"type":"string","description":"Site name.","example":"Example Site"},"companyName":{"type":"string","description":"Company name associated with the site.","example":"Example Name"},"siteTimeZoneId":{"type":"string","example":"123"},"timeZone":{"type":"string","description":"IANA or platform timezone identifier used by the site.","example":"Example timeZone"}},"description":"Summary configuration settings for a specific site within a domain."}},"components/schemas/StaffSkillsGridResponse":{"id":"components/schemas/StaffSkillsGridResponse","kind":"json-schema","title":"StaffSkillsGridResponse","data":{"type":"object","properties":{"examKeys":{"type":"array","items":{"type":"string","example":"Example examKeys"},"description":"Ordered list of exam keys used as columns in the grid."},"examDisplay":{"type":"object","additionalProperties":{"type":"string","example":"Example examDisplay"},"description":"Map of exam key to display label."},"headerComments":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/HeaderCommentResponse"},"description":"Map of exam key to optional header comment/marker metadata."},"employees":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeSkillResponse"},"description":"List of staff rows in the grid."},"examSites":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","example":"Example examSites"}},"description":"Map of exam key to list of sites where the exam is available."},"skToExamCodeId":{"type":"object","additionalProperties":{"type":"string","example":"123"},"description":"Map of internal exam key to examCodeId."},"examCodeSiteKeys":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string","example":"ABC123"}},"description":"Nested map of examCodeId to site name to internal key."}},"description":"Staff skill grid data for a site, including exam metadata, staff rows, and optional comments."}},"components/schemas/UserSummaryResponse":{"id":"components/schemas/UserSummaryResponse","kind":"json-schema","title":"UserSummaryResponse","data":{"required":["username"],"type":"object","properties":{"username":{"type":"string","description":"Stable unique username. Prefer this value for mapping assigned radiologists; name fields are display values.","example":"Example Name"},"firstName":{"type":"string","description":"User's first name.","example":"Example Name"},"initials":{"type":"string","description":"User's initials when available.","example":"Example initials"},"lastName":{"type":"string","description":"User's last name.","example":"Example Name"},"role":{"type":"string","description":"User role when available.","example":"Example role"}},"description":"A lightweight user identity summary."}},"schema_43":{"kind":"json-schema","data":{"type":"string","example":"acme"},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"string","example":"4b7f0a91b4f54f2a"},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SiteInfoResponse"}},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"object","properties":{"X-Correlation-Id":{"type":"string","example":"4b7f0a91b4f54f2a","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."}}},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"type":"object","properties":{"type":{"enum":["urn:qubs:integrations:bad-request"],"type":"string","example":"urn:qubs:integrations:bad-request"},"status":{"type":"integer","format":"int32","example":400}}}]},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"type":"object","properties":{"type":{"enum":["urn:qubs:integrations:unauthorized"],"type":"string","example":"urn:qubs:integrations:unauthorized"},"status":{"type":"integer","format":"int32","example":401}}}]},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"type":"object","properties":{"type":{"enum":["urn:qubs:integrations:forbidden"],"type":"string","example":"urn:qubs:integrations:forbidden"},"status":{"type":"integer","format":"int32","example":403}}}]},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"type":"object","properties":{"type":{"enum":["urn:qubs:integrations:too-many-requests"],"type":"string","example":"urn:qubs:integrations:too-many-requests"},"status":{"type":"integer","format":"int32","example":429}}}]},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"object","properties":{"X-Correlation-Id":{"type":"string","example":"4b7f0a91b4f54f2a","description":"Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided."},"Retry-After":{"type":"string","example":"120","description":"Suggested delay before retrying the request. May be a number of seconds or an HTTP date."}}},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"type":"object","properties":{"type":{"enum":["urn:qubs:integrations:server-error"],"type":"string","example":"urn:qubs:integrations:server-error"},"status":{"type":"integer","format":"int32","example":500}}}]},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"string","example":"Example Site"},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"type":"object","properties":{"type":{"enum":["urn:qubs:integrations:not-found"],"type":"string","example":"urn:qubs:integrations:not-found"},"status":{"type":"integer","format":"int32","example":404}}}]},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ExamCodeResponse"}},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"enum":["NOT ARRIVED","ARRIVED","DID NOT ATTEND","APPPOINTMENT CANCELLED","CANCELLATION LIST","DICTATION INPROGRESS","DICTATED","TYPED","AUTHORISING","AUTHORISED","TYPING INPROGRESS","PENDING REPORTING","STUDY INPROGRESS","SECOND REVIEW","FINALISED","REVIEW TYPED","PEER REVIEW","SECOND OPINION"],"type":"string","example":"NOT ARRIVED"},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"maximum":500,"minimum":1,"type":"integer","format":"int32","default":100,"example":100},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"string","example":"DDB_NEXT_TOKEN"},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"string","example":"200006"},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":"string","format":"date","example":"2025-01-01"},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"maximum":10000,"minimum":0,"type":"integer","format":"int32","default":0,"example":0},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentOperationalResponse"}},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentSummaryResponse"}},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"maximum":3600,"minimum":60,"type":"integer","format":"int32","default":900,"example":900},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"enum":["inline","attachment"],"type":"string","example":"inline"},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentAttachmentResponse"}},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"type":"string","example":"989dd0c7-13bb-4bba-b7a0-53a28bdf5155"},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentCommentResponse"}},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"string","example":"ed6ef45a-4e3d-41b2-8049-7aec53bb9ab1"},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"type":"string","example":"220000"},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"string"},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"type":"string","example":"Amandeep"},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"type":"string","example":"KAUR"},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"type":"string","format":"date","example":"1988-03-03"},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"type":"string","example":"user@example.com"},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"type":"string","example":"0435531162"},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PatientSummaryResponse"}},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PendingReportingAppointmentAttachmentResponse"}},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/PendingReportingAppointmentCommentResponse"}},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"type":"string","example":"cd4a859c7a1f4b44b765a8fe17bb44c1"},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"allOf":[{"$ref":"#/components/schemas/ProblemDetails"},{"type":"object","properties":{"type":{"enum":["urn:qubs:integrations:conflict"],"type":"string","example":"urn:qubs:integrations:conflict"},"status":{"type":"integer","format":"int32","example":409}}}]},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/PendingReportingAppointmentReportResponse"},{"required":["operationId","status","message"],"type":"object","properties":{"operationId":{"type":"string","example":"submission-operation-id"},"status":{"enum":["pending"],"type":"string","example":"pending"},"message":{"type":"string","example":"The prior submission is in progress or its outcome requires reconciliation. Do not resubmit using a different key."}}}]},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"anyOf":[{"required":["operationId","detail","workflowError"],"type":"object","properties":{"operationId":{"type":"string","example":"submission-operation-id"},"detail":{"type":"string","example":"Authorisation was not confirmed. Content may have been saved before the failure; check the current report before submitting another operation."},"workflowError":{"description":"Underlying workflow error, which may be null, a string or an object. Do not rely on a fixed structure."}}},{"description":"Other proxied workflow JSON error body."}],"description":"Final workflow failures contain operationId, detail and workflowError. Other proxied failures may have a different JSON body. Content may already have been saved: contact QUBS support before another operation."},"id":"schema_85"}},"exampleStore":{"paths/~1integrations~1v1~1{domain}~1sites/get/responses/200/content/application~1json/example":{"value":[{"domain":"acme","siteName":"Central Clinic"},{"domain":"acme","siteName":"North Clinic"}],"id":"paths/~1integrations~1v1~1{domain}~1sites/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1sites/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/200/content/application~1json/example":{"value":{"domain":"acme","siteName":"Central Clinic","companyName":"ACME Radiology","timeZone":"Australia/Sydney"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/200/content/application~1json/example":{"value":{"domain":"acme","siteName":"Central Clinic","companyName":"ACME Radiology","timeZone":"Australia/Sydney","defaultBilling":"bulk","defaultPriority":"Routine","appendStudyDescription":true,"patientDobRequired":true,"patientSexRequired":true,"lastModifiedDateTime":"2025-01-10T02:03:04Z","lastModifiedBy":"jsmith"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1operational/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/200/content/application~1json/example":{"value":[{"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"}],"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1exam-codes/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/200/content/application~1json/example":{"value":{"examKeys":["CT_CHEST"],"examDisplay":{"CT_CHEST":"CT Chest"},"headerComments":{"CT_CHEST":{"hasComment":true,"comment":"Requires contrast","selectedMarker":"FLAG","markerColor":"#F5A623"}},"employees":[{"name":"Sam Lee","username":"slee","scans":{"CT_CHEST":{"duration":20,"hasComment":false,"comment":null}}}],"examSites":{"CT_CHEST":["Central Clinic"]},"skToExamCodeId":{"CT_CHEST":"EC100"},"examCodeSiteKeys":{"EC100":{"Central Clinic":"CT_CHEST"}}},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1sites~1{siteName}~1staff-skills/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/200/content/application~1json/example":{"value":{"items":[{"domain":"acme","appointmentId":"200006","scheduledSite":"Central Clinic","status":"ARRIVED","appointmentDate":"2025-01-12","startTime":"13:45:00","endTime":"14:15:00","modality":"CT","studyDescription":"CT Chest","room":"Room 2","priority":"Routine","arrivalDateTime":"2025-01-12T03:40:00Z","scanStartDateTime":"2025-01-12T03:45:00Z","scanEndDateTime":"2025-01-12T04:05:00Z","scanTotalTime":20.5,"waitingTotalTime":5,"examCodes":[{"examCodeId":"EC100","key":"CT_CHEST","site":"Central Clinic","description":"CT Chest","domain":"acme","modality":"CT","totalDuration":15,"showOnline":true,"order":1}]}],"nextToken":"DDB_NEXT_TOKEN"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/200/content/application~1json/example":{"value":{"domain":"acme","appointmentId":"200006","scheduledSite":"Central Clinic","status":"ARRIVED","appointmentDate":"2025-01-12","startTime":"13:45:00","endTime":"14:15:00","modality":"CT","studyDescription":"CT Chest","room":"Room 2","priority":"Routine","arrivalDateTime":"2025-01-12T03:40:00Z","scanStartDateTime":"2025-01-12T03:45:00Z","scanEndDateTime":"2025-01-12T04:05:00Z","scanTotalTime":20.5,"waitingTotalTime":5,"examCodes":[{"examCodeId":"EC100","key":"CT_CHEST","site":"Central Clinic","description":"CT Chest","domain":"acme","modality":"CT","totalDuration":15,"showOnline":true,"order":1}]},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational~1by-id~1{appointmentId}/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/200/content/application~1json/example":{"value":[{"domain":"acme","appointmentId":"200006","scheduledSite":"Central Clinic","status":"ARRIVED","appointmentDate":"2025-01-12","startTime":"13:45:00","endTime":"14:15:00","modality":"CT","studyDescription":"CT Chest","room":"Room 2","priority":"Routine","arrivalDateTime":"2025-01-12T03:40:00Z","scanStartDateTime":"2025-01-12T03:45:00Z","scanEndDateTime":"2025-01-12T04:05:00Z","scanTotalTime":20.5,"waitingTotalTime":5,"examCodes":[{"examCodeId":"EC100","key":"CT_CHEST","site":"Central Clinic","description":"CT Chest","domain":"acme","modality":"CT","totalDuration":15,"showOnline":true,"order":1}]}],"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1operational/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/200/content/application~1json/example":{"value":{"items":[{"domain":"acme","appointmentId":"200006","scheduledSite":"Central Clinic","status":"ARRIVED","appointmentDate":"2025-01-12","startTime":"13:45:00","endTime":"14:15:00","modality":"CT","studyDescription":"CT Chest","room":"Room 2","priority":"Routine","arrivalDateTime":"2025-01-12T03:40:00Z","scanStartDateTime":"2025-01-12T03:45:00Z","scanEndDateTime":"2025-01-12T04:05:00Z","scanTotalTime":20.5,"waitingTotalTime":5,"examCodes":[{"examCodeId":"EC100","key":"CT_CHEST","site":"Central Clinic","description":"CT Chest","domain":"acme","modality":"CT","totalDuration":15,"showOnline":true,"order":1}]}],"nextToken":"DDB_NEXT_TOKEN"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/200/content/application~1json/example":{"value":[{"domain":"acme","appointmentId":"200006","scheduledSite":"Central Clinic","status":"ARRIVED","appointmentDate":"2025-01-12","startTime":"13:45:00","endTime":"14:15:00","modality":"CT","studyDescription":"CT Chest","room":"Room 2","priority":"Routine","arrivalDateTime":"2025-01-12T03:40:00Z","scanStartDateTime":"2025-01-12T03:45:00Z","scanEndDateTime":"2025-01-12T04:05:00Z","scanTotalTime":20.5,"waitingTotalTime":5,"examCodes":[{"examCodeId":"EC100","key":"CT_CHEST","site":"Central Clinic","description":"CT Chest","domain":"acme","modality":"CT","totalDuration":15,"showOnline":true,"order":1}]}],"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1operational/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/200/content/application~1json/example":{"value":{"items":[{"domain":"acme","appointmentId":"200006","scheduledSite":"Central Clinic","status":"ARRIVED","appointmentDate":"2025-01-12","startTime":"13:45:00","endTime":"14:15:00","modality":"CT","studyDescription":"CT Chest"}],"nextToken":"DDB_NEXT_TOKEN"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/200/content/application~1json/example":{"value":{"domain":"acme","appointmentId":"200006","scheduledSite":"Central Clinic","status":"ARRIVED","appointmentDate":"2025-01-12","startTime":"13:45:00","endTime":"14:15:00","modality":"CT","studyDescription":"CT Chest"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments/get/responses/200/content/application~1json/example":{"value":[{"domain":"acme","appointmentId":"200006","scheduledSite":"Central Clinic","status":"ARRIVED","appointmentDate":"2025-01-12","startTime":"13:45:00","endTime":"14:15:00","modality":"CT","studyDescription":"CT Chest"},{"domain":"acme","appointmentId":"A123457","scheduledSite":"North Clinic","status":"PENDING REPORTING","appointmentDate":"2025-01-13","startTime":"09:00:00","endTime":"09:30:00","modality":"XR","studyDescription":"XR Chest"}],"id":"paths/~1integrations~1v1~1{domain}~1appointments/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/200/content/application~1json/example":{"value":{"items":[{"domain":"acme","appointmentId":"200006","scheduledSite":"Central Clinic","status":"ARRIVED","appointmentDate":"2025-01-12","startTime":"13:45:00","endTime":"14:15:00","modality":"CT","studyDescription":"CT Chest"}],"nextToken":"DDB_NEXT_TOKEN"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer~1by-status~1{status}/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/200/content/application~1json/example":{"value":[{"domain":"acme","appointmentId":"200006","scheduledSite":"Central Clinic","status":"ARRIVED","appointmentDate":"2025-01-12","startTime":"13:45:00","endTime":"14:15:00","modality":"CT","studyDescription":"CT Chest"},{"domain":"acme","appointmentId":"A123457","scheduledSite":"North Clinic","status":"PENDING REPORTING","appointmentDate":"2025-01-13","startTime":"09:00:00","endTime":"09:30:00","modality":"XR","studyDescription":"XR Chest"}],"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1referrer/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/200/content/application~1json/example":{"value":{"domain":"acme","appointmentId":"200006","batchSk":"BATCH#202501","billingStatus":"active","billingType":"bulk","invoiceNumber":"INV-1001","invoiceSk":"INV#1001","isBillingsChecked":true,"medicareNumber":"1234567890","medicareIrn":"1","providerNumber":"1234567A","serviceItemNumbers":"XR001","serviceItems":[{"itemNo":"XR001","appointmentId":"200006","dateOfService":"2025-01-12","duration":15,"chargeAmount":120.5,"status":"active","modality":"CT","shortDescription":"CT Chest","lastModifiedBy":{"username":"kwhite","firstName":"Kai","initials":"KW","lastName":"White","role":"Billing"},"lastModifiedDateTime":"2025-01-12T05:00:00Z"}]},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1billing/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/200/content/application~1json/example":{"value":[{"guid":"989dd0c7-13bb-4bba-b7a0-53a28bdf5155","category":"Referral","fileName":"referral.pdf","addedDateTime":"2025-01-10T01:02:03Z","addedBy":{"username":"jchen","firstName":"Jesse","initials":"JC","lastName":"Chen","role":"Scheduler"},"lastModifiedDateTime":"2025-01-10T01:02:03Z","lastModifiedBy":{"username":"mbrown","firstName":"Maya","initials":"MB","lastName":"Brown","role":"Reception"},"url":"https://example.com/attachments/referral.pdf","urlExpiresAtUtc":"2025-01-10T01:17:03Z"}],"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/200/content/application~1json/example":{"value":{"guid":"989dd0c7-13bb-4bba-b7a0-53a28bdf5155","category":"Referral","fileName":"referral.pdf","addedDateTime":"2025-01-10T01:02:03Z","addedBy":{"username":"jchen","firstName":"Jesse","initials":"JC","lastName":"Chen","role":"Scheduler"},"lastModifiedDateTime":"2025-01-10T01:02:03Z","lastModifiedBy":{"username":"mbrown","firstName":"Maya","initials":"MB","lastName":"Brown","role":"Reception"},"url":"https://example.com/attachments/referral.pdf","urlExpiresAtUtc":"2025-01-10T01:17:03Z"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/200/content/application~1json/example":{"value":[{"guid":"ed6ef45a-4e3d-41b2-8049-7aec53bb9ab1","commentType":"AA","appointmentId":"200006","patientId":"220000","commentText":"Patient requires wheelchair access.","commentDateTime":"2025-01-10T02:03:04Z","isAlert":true,"commentBy":{"username":"mbrown","firstName":"Maya","initials":"MB","lastName":"Brown","role":"Reception"},"lastModifiedDateTime":"2025-01-10T02:03:04Z","lastModifiedBy":{"username":"jchen","firstName":"Jesse","initials":"JC","lastName":"Chen","role":"Scheduler"}}],"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/200/content/application~1json/example":{"value":{"guid":"ed6ef45a-4e3d-41b2-8049-7aec53bb9ab1","commentType":"AA","appointmentId":"200006","patientId":"220000","commentText":"Patient requires wheelchair access.","commentDateTime":"2025-01-10T02:03:04Z","isAlert":true,"commentBy":{"username":"mbrown","firstName":"Maya","initials":"MB","lastName":"Brown","role":"Reception"},"lastModifiedDateTime":"2025-01-10T02:03:04Z","lastModifiedBy":{"username":"jchen","firstName":"Jesse","initials":"JC","lastName":"Chen","role":"Scheduler"}},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/200/content/application~1json/example":{"value":{"domain":"acme","patientId":"220000","patientName":"Jane Doe","firstName":"Jane","lastName":"Doe","gender":"F","dateOfBirth":"1988-03-03"},"id":"paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1patients~1{patientId}/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1patients/get/responses/200/content/application~1json/example":{"value":[{"domain":"acme","patientId":"220000","patientName":"Jane Doe","firstName":"Jane","lastName":"Doe","gender":"F","dateOfBirth":"1988-03-03"},{"domain":"acme","patientId":"220001","patientName":"Alex Smith","firstName":"Alex","lastName":"Smith","gender":"M","dateOfBirth":"1990-04-04"}],"id":"paths/~1integrations~1v1~1{domain}~1patients/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1patients/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1patients/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1patients/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1patients/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1patients/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1patients/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1patients/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1patients/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1patients/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1patients/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/200/content/application~1json/example":{"value":{"items":[{"domain":"acme","appointmentId":"200006","status":"PENDING REPORTING","scheduledSite":"Central Clinic","appointmentDate":"2025-01-12","startTime":"13:45:00","endTime":"14:15:00","patientId":"220000","patientName":"Jane Doe","firstName":"Jane","lastName":"Doe","dateOfBirth":"1988-03-03","gender":"F","modality":"CT","studyDescription":"CT Chest","clinicalInfo":"Shortness of breath","doctorName":"Dr Smith","clinicName":"Example Clinic","priority":"Routine","reportNeededBy":"2025-01-13T02:00:00Z","studyInstanceUid":"1.2.840.113619.2.55.3.604688433.1234.20240101.123456","radiologistUser":{"username":"rsmith","firstName":"Rory","initials":"RS","lastName":"Smith","role":"Radiologist"},"serviceItems":[{"itemNo":"XR001","shortDescription":"CT Chest"}]}],"nextToken":"DDB_NEXT_TOKEN"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1pending/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/200/content/application~1json/example":{"value":{"domain":"acme","appointmentId":"200006","status":"PENDING REPORTING","scheduledSite":"Central Clinic","appointmentDate":"2025-01-12","startTime":"13:45:00","endTime":"14:15:00","patientId":"220000","patientName":"Jane Doe","firstName":"Jane","lastName":"Doe","dateOfBirth":"1988-03-03","gender":"F","modality":"CT","studyDescription":"CT Chest","clinicalInfo":"Shortness of breath","doctorName":"Dr Smith","clinicName":"Example Clinic","priority":"Routine","reportNeededBy":"2025-01-13T02:00:00Z","studyInstanceUid":"1.2.3.4.5","radiologistUser":{"username":"rsmith","firstName":"Rory","initials":"RS","lastName":"Smith","role":"Radiologist"},"serviceItems":[{"itemNo":"XR001","shortDescription":"CT Chest"}]},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/200/content/application~1json/example":{"value":[{"guid":"989dd0c7-13bb-4bba-b7a0-53a28bdf5155","category":"Referral","fileName":"referral.pdf","addedDateTime":"2025-01-10T01:02:03Z","addedBy":{"username":"jchen","firstName":"Jesse","initials":"JC","lastName":"Chen","role":"Scheduler"},"lastModifiedDateTime":"2025-01-10T01:02:03Z","url":"https://example.com/attachments/referral.pdf","urlExpiresAtUtc":"2025-01-10T01:17:03Z"}],"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/200/content/application~1json/example":{"value":{"guid":"989dd0c7-13bb-4bba-b7a0-53a28bdf5155","category":"Referral","fileName":"referral.pdf","addedDateTime":"2025-01-10T01:02:03Z","addedBy":{"username":"jchen","firstName":"Jesse","initials":"JC","lastName":"Chen","role":"Scheduler"},"lastModifiedDateTime":"2025-01-10T01:02:03Z","url":"https://example.com/attachments/referral.pdf","urlExpiresAtUtc":"2025-01-10T01:17:03Z"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1attachments~1{attachmentGuid}/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/200/content/application~1json/example":{"value":[{"guid":"ed6ef45a-4e3d-41b2-8049-7aec53bb9ab1","commentType":"AC","appointmentId":"200006","patientId":"220000","commentText":"Patient requires wheelchair access.","commentDateTime":"2025-01-10T02:03:04Z","isAlert":false,"commentBy":{"username":"mbrown","firstName":"Maya","initials":"MB","lastName":"Brown","role":"Reception"},"lastModifiedDateTime":"2025-01-10T02:03:04Z"}],"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/requestBody/content/application~1json/example":{"value":{"commentText":"Please prioritize this study.","commentType":"AA","isAlert":true,"commentDateTime":"2025-01-10T02:03:04Z"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/requestBody/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/201/content/application~1json/example":{"value":{"guid":"ed6ef45a-4e3d-41b2-8049-7aec53bb9ab1","commentType":"AA","appointmentId":"200006","patientId":"220000","commentText":"Please prioritize this study.","commentDateTime":"2025-01-10T02:03:04Z","isAlert":true,"commentBy":{"username":"mbrown","firstName":"Maya","initials":"MB","lastName":"Brown","role":"Reception"},"lastModifiedDateTime":"2025-01-10T02:03:04Z"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/201/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/409/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:conflict","title":"Conflict","status":409,"detail":"Idempotency-Key reuse with different request payload.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/409/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments/post/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/200/content/application~1json/example":{"value":{"guid":"ed6ef45a-4e3d-41b2-8049-7aec53bb9ab1","commentType":"AA","appointmentId":"200006","patientId":"220000","commentText":"Please prioritize this study.","commentDateTime":"2025-01-10T02:03:04Z","isAlert":true,"commentBy":{"username":"mbrown","firstName":"Maya","initials":"MB","lastName":"Brown","role":"Reception"},"lastModifiedDateTime":"2025-01-10T02:03:04Z"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/200/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1comments~1{commentGuid}/get/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/plainTextDraft":{"value":{"reportText":"No acute abnormality detected.","reportStatus":"preliminary","reportFormat":"text/plain","interpretingClinicianName":"Dr Smith","interpretingClinicianProviderNumber":"1234567A","interpretingClinicianEmail":"dr.smith@example.com","reportedAtUtc":"2025-01-10T03:04:05Z"},"key":"plainTextDraft","summary":"Create an editable plain-text draft","id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/plainTextDraft"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/htmlDraft":{"value":{"reportText":"

Findings

No acute abnormality.

Measurements
SideLength
Left12 mm

Conclusion

Normal examination.

","reportStatus":"preliminary","reportFormat":"text/html","interpretingClinicianName":"Dr Smith","interpretingClinicianProviderNumber":"1234567A","interpretingClinicianEmail":"dr.smith@example.com","reportedAtUtc":"2025-01-10T03:04:05Z"},"key":"htmlDraft","summary":"Create an editable HTML draft","id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/htmlDraft"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/htmlFinal":{"value":{"reportText":"

Findings

No acute abnormality.

Measurements
SideLength
Left12 mm

Conclusion

Normal examination.

","reportStatus":"final","reportFormat":"text/html","interpretingClinicianName":"Dr Smith","interpretingClinicianProviderNumber":"1234567A","interpretingClinicianEmail":"dr.smith@example.com","reportedAtUtc":"2025-01-10T03:04:05Z","reportKey":"PT|220000|9001|RT","expectedReportRevision":1},"key":"htmlFinal","summary":"Update a draft and request normal authorisation","id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/requestBody/content/application~1json/examples/htmlFinal"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/201/content/application~1json/example":{"value":{"reportGuid":"9001","reportStatus":"preliminary","reportKey":"PT|220000|9001|RT","reportRevision":1,"workflowStatus":"TYPED","operationId":"submission-operation-id","reportedAtUtc":"2025-01-10T03:04:05Z"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/201/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/202/content/application~1json/examples/authorisationAccepted":{"value":{"reportGuid":"9001","reportStatus":"final","reportKey":"PT|220000|9001|RT","reportRevision":2,"workflowStatus":"AUTHORISING","operationId":"submission-operation-id","reportedAtUtc":"2025-01-10T03:04:05Z"},"key":"authorisationAccepted","summary":"authorisationAccepted","id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/202/content/application~1json/examples/authorisationAccepted"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/202/content/application~1json/examples/pendingReconciliation":{"value":{"operationId":"submission-operation-id","status":"pending","message":"The prior submission is in progress or its outcome requires reconciliation. Do not resubmit using a different key."},"key":"pendingReconciliation","summary":"pendingReconciliation","id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/202/content/application~1json/examples/pendingReconciliation"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/400/content/application~1json/example":{"value":{"operationId":"submission-operation-id","detail":"Authorisation was not confirmed. Content may have been saved before the failure; check the current report before submitting another operation.","workflowError":null},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/400/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/403/content/application~1json/example":{"value":{"operationId":"submission-operation-id","detail":"Authorisation was not confirmed. Content may have been saved before the failure; check the current report before submitting another operation.","workflowError":null},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/403/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/404/content/application~1json/example":{"value":{"operationId":"submission-operation-id","detail":"Authorisation was not confirmed. Content may have been saved before the failure; check the current report before submitting another operation.","workflowError":null},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/404/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/409/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:conflict","title":"Conflict","status":409,"detail":"Idempotency-Key reuse with different request payload.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/409/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/409/content/application~1json/example":{"value":{"operationId":"submission-operation-id","detail":"Authorisation was not confirmed. Content may have been saved before the failure; check the current report before submitting another operation.","workflowError":null},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/409/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/422/content/application~1json/example":{"value":{"operationId":"submission-operation-id","detail":"Authorisation was not confirmed. Content may have been saved before the failure; check the current report before submitting another operation.","workflowError":null},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/422/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/500/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/500/content/application~1json/example":{"value":{"operationId":"submission-operation-id","detail":"Authorisation was not confirmed. Content may have been saved before the failure; check the current report before submitting another operation.","workflowError":null},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/500/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/503/content/application~1json/example":{"value":{"operationId":"submission-operation-id","detail":"Authorisation was not confirmed. Content may have been saved before the failure; check the current report before submitting another operation.","workflowError":null},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report/post/responses/503/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/requestBody/content/application~1json/example":{"value":{"items":[{"fileName":"report.pdf","contentType":"application/pdf","category":"report"}]},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/requestBody/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/201/content/application~1json/example":{"value":{"items":[{"guid":"989dd0c7-13bb-4bba-b7a0-53a28bdf5155","fileName":"report.pdf","category":"report","uploadUrl":"https://example.com/upload/report.pdf","uploadUrlExpiresAtUtc":"2025-01-10T03:19:05Z"}]},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/201/content/application~1json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/400/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:bad-request","title":"Bad Request","status":400,"detail":"Request validation failed.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/400/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/401/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:unauthorized","title":"Unauthorized","status":401,"detail":"Missing or invalid bearer token.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/401/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/403/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:forbidden","title":"Forbidden","status":403,"detail":"Caller is not authorized for the requested domain.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/403/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/404/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:not-found","title":"Not Found","status":404,"detail":"Requested resource was not found.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/404/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/409/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:conflict","title":"Conflict","status":409,"detail":"Idempotency-Key reuse with different request payload.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/409/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/429/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:too-many-requests","title":"Too Many Requests","status":429,"detail":"Too many requests. Retry after the specified delay.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/429/content/application~1problem+json/example"},"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/500/content/application~1problem+json/example":{"value":{"type":"urn:qubs:integrations:server-error","title":"Internal Server Error","status":500,"detail":"Unexpected server error.","instance":"/integrations/v1/acme/reporting/appointments/200006/report","requestId":"4b7f0a91b4f54f2a"},"id":"paths/~1integrations~1v1~1{domain}~1reporting~1appointments~1{appointmentId}~1report~1attachments/post/responses/500/content/application~1problem+json/example"}},"securitySchemeStore":{"Bearer":{"id":"Bearer","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT bearer token obtained via OAuth 2.0 client credentials from https://authenticate.qubs.io/oauth2/token. Cache and reuse it until close to the 60-minute expiry; do not request a token for every API call."}},"servers":[{"url":"/_mock/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://partners.qubs.io","description":"Production API"},{"url":"/","description":"Relative to the current host"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"QUBS Integrations API","description":"Partner-facing API providing read access to selected QUBS configuration and scheduling data, plus reporting submission endpoints for tele reporting workflows.\n\nAuthentication is via a bearer JWT in the `Authorization` header. Authorization is domain-scoped; all requests include a `{domain}` path parameter. Tokens are issued via the OAuth 2.0 client credentials flow (see Authentication below).\n\nMachine-to-machine token handling:\n- Access tokens expire after 60 minutes.\n- Cache and reuse the same access token for API calls until it is close to expiry; do not request a new token for every API request.\n- Request a replacement token around 50-55 minutes after issue, or after an authorization failure that indicates the token has expired.\n- The client credentials flow does not use refresh tokens. Token responses contain an `access_token`, `token_type`, and `expires_in`.\n\nScopes/audience: no additional scopes are required for current integrations; authorization is domain-scoped via claims. Audience is managed by QUBS; use the client credentials provisioned for your integration.\n\nSandbox: no public sandbox environment is currently available.\n\nBoundary errors use RFC7807 Problem Details (`application/problem+json`). Report workflow failures can instead use `application/json`; failed final submissions contain operationId, detail and workflowError. Inspect Content-Type before decoding errors. Retain X-Correlation-Id and any operationId for support; a requestId body field is not guaranteed for proxied workflow errors.\n\nData handling: responses may include PHI (patient name/date of birth). Treat all such data as sensitive, apply least-privilege access, and avoid logging or storing longer than required.\n\nDate/time conventions: `date` values use ISO 8601 `yyyy-MM-dd`. `time` values use `HH:mm:ss` in the scheduled site's local timezone (see `SiteSettings.timeZone`). `date-time` values are returned in UTC. Numeric values are JSON numbers (integers/decimals), not strings.\n\nPagination: cursor endpoints return page objects with `items` and `nextToken`, while offset endpoints return arrays. For cursor paging, stop when `nextToken` is empty/omitted; for offset paging, stop when the response count is less than `take`. Ordering is not guaranteed and should not be assumed to be chronological.\n\nRetry guidance: for 429 responses, honor the `Retry-After` header and use exponential backoff with jitter. GET requests are safe to retry. Report submissions require an `Idempotency-Key` (up to 128 characters) and retain a durable operation receipt: identical retries replay the recorded outcome, and changed payloads under the same key return 409 Conflict. For network retries, preserve the original key and payload. Comment and attachment-upload endpoints only provide best-effort process-local deduplication with cache lifetimes of up to 24 hours and 15 minutes respectively. Cache eviction, restarts, different instances, or concurrent requests can produce duplicates even when a key is supplied. Do not treat those lifetimes as durable guarantees; verify existing records after an uncertain outcome before retrying. A pending report operation requires reconciliation, not another submission with a new key.\n\nRate limits: no fixed quotas or standard rate-limit headers are guaranteed. Use 429 responses and Retry-After when present.\n\n## Getting started\n\n### Base URL\n\n- Production: https://partners.qubs.io\n\n### Authentication\n\n1. Request an access token using the OAuth 2.0 client credentials flow.\n2. Send it in the `Authorization` header as `Bearer `.\n\nToken endpoint: https://authenticate.qubs.io/oauth2/token\n\nToken request examples:\n\n```bash\ncurl -X POST \"https://authenticate.qubs.io/oauth2/token\" \\\n -H \"Content-Type: application/x-www-form-urlencoded\" \\\n --data-urlencode \"grant_type=client_credentials\" \\\n --data-urlencode \"client_id=\" \\\n --data-urlencode \"client_secret=\"\n```\n\n```java\nUnirest.setTimeouts(0, 0);\nHttpResponse response = Unirest.post(\"https://authenticate.qubs.io/oauth2/token\")\n .header(\"Content-Type\", \"application/x-www-form-urlencoded\")\n .field(\"grant_type\", \"client_credentials\")\n .field(\"client_id\", \"\")\n .field(\"client_secret\", \"\")\n .asString();\n```\n\n```csharp\nusing var client = new HttpClient();\nusing var request = new HttpRequestMessage(HttpMethod.Post, \"https://authenticate.qubs.io/oauth2/token\");\nrequest.Content = new FormUrlEncodedContent(new Dictionary\n{\n [\"grant_type\"] = \"client_credentials\",\n [\"client_id\"] = \"\",\n [\"client_secret\"] = \"\"\n});\nusing var response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nvar tokenPayload = await response.Content.ReadAsStringAsync();\n```\n\nUse the `access_token` value from the response as your bearer token. Cache that token and reuse it across API requests until it is close to the 60-minute expiry; do not request a token for each API call or each record.\n\nClient credentials token responses do not include a refresh-token workflow. When the cached access token is close to expiry, request a new access token with the same client credentials.\n\n### Example requests\n\n```bash\ncurl -X GET \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/pending?pageSize=1\" \\\n -H \"Authorization: Bearer \"\n```\n\n```bash\ncurl -X POST \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/200006/report\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Idempotency-Key: \" \\\n -d '{\"reportText\":\"Preliminary report text\",\"reportStatus\":\"preliminary\",\"interpretingClinicianEmail\":\"dr.smith@example.com\",\"reportedAtUtc\":\"2025-01-10T03:04:05Z\"}'\n```\n\n### Reporting workflow (example)\n\n1. List pending reporting appointments.\n\n```bash\ncurl -X GET \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/pending?pageSize=1\" \\\n -H \"Authorization: Bearer \"\n```\n\nExample response:\n\n```json\n{\n \"items\": [\n {\n \"domain\": \"acme\",\n \"appointmentId\": \"200006\",\n \"status\": \"PENDING REPORTING\",\n \"scheduledSite\": \"Central Clinic\",\n \"appointmentDate\": \"2025-01-12\",\n \"startTime\": \"13:45:00\",\n \"patientName\": \"Jane Doe\"\n }\n ],\n \"nextToken\": \"DDB_NEXT_TOKEN\"\n}\n```\n\n2. (Optional) Create an appointment comment/alert while the appointment is still PENDING REPORTING. This reporting endpoint returns 404 after the report moves to TYPED or an authorisation state.\n\n```bash\ncurl -X POST \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/200006/comments\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Idempotency-Key: \" \\\n -d '{\"commentText\":\"Partner report preparation started.\",\"commentType\":\"AC\",\"isAlert\":false}'\n```\n\n3. (Optional) Create report attachment upload URLs.\n\n```bash\ncurl -X POST \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/200006/report/attachments\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Idempotency-Key: \" \\\n -d '{\"items\":[{\"fileName\":\"report.pdf\",\"contentType\":\"application/pdf\"}]}'\n```\n\nExample response:\n\n```json\n{\n \"items\": [\n {\n \"guid\": \"989dd0c7-13bb-4bba-b7a0-53a28bdf5155\",\n \"fileName\": \"report.pdf\",\n \"category\": \"report\",\n \"uploadUrl\": \"https://example.com/upload/report.pdf\",\n \"uploadUrlExpiresAtUtc\": \"2025-01-10T03:19:05Z\"\n }\n ]\n}\n```\n\n4. Upload the report artifact bytes with a PUT to `uploadUrl`.\n\n```bash\ncurl -X PUT \"https://example.com/upload/report.pdf\" \\\n -H \"Content-Type: application/pdf\" \\\n --data-binary \"@report.pdf\"\n```\n\n5. Submit an editable preliminary report, or send reportStatus final to request normal QUBS authorisation. Supply an active clinician email and the required Idempotency-Key. The partner needs explicit delegation and the clinician needs normal permissions. Attachments are optional. For an existing draft, also send its current reportKey and expectedReportRevision; conflicts return 409. Preliminary saves return 201, while final requests return 202. Inspect workflowStatus; a 202 pending receipt requires reconciliation and must not be repeated with a new key.\n\n```bash\ncurl -X POST \"https://partners.qubs.io/integrations/v1/acme/reporting/appointments/200006/report\" \\\n -H \"Authorization: Bearer \" \\\n -H \"Content-Type: application/json\" \\\n -H \"Idempotency-Key: \" \\\n -d '{\"reportText\":\"No acute abnormality detected.\",\"reportStatus\":\"preliminary\",\"interpretingClinicianEmail\":\"dr.smith@example.com\",\"reportedAtUtc\":\"2025-01-10T03:04:05Z\"}'\n```\n\nExample response:\n\n```json\n{\n \"reportGuid\": \"9001\",\n \"reportKey\": \"PT|220000|9001|RT\",\n \"reportRevision\": 1,\n \"workflowStatus\": \"TYPED\",\n \"reportStatus\": \"preliminary\",\n \"reportedAtUtc\": \"2025-01-10T03:04:05Z\"\n}\n```\n\n### Conflict and pending-operation recovery\n\nKeep reportKey and reportRevision from successful submissions. The partner API currently has no endpoint to retrieve the latest report revision or reconcile a pending operation. After a revision conflict or an unresolved pending response, stop automatic writes and contact QUBS support with the domain, appointmentId, operationId (if returned) and X-Correlation-Id. Do not guess or increment revisions, and do not create a new idempotency key merely to bypass a conflict. Resume only after the current report state and revision have been confirmed through QUBS. Identical network retries must reuse the original key and payload.\n"}},"baseSlug":"/openapi","routesMapping":{}}