Get reference

Returns the details of a single reference of a todo.

Request

GET /api/oauth/v2/resource/todos/{uuid}/references/{referenceUuid}

Header

Header	Value
Authorization	Bearer {access_token}

URL parameters

Parameter	Type	Required	Description
uuid	string	Yes	Unique todo ID
referenceUuid	string	Yes	Unique reference ID

Note: References whose target the client may not see are returned as 404 by this endpoint, even if the reference exists.

Response

Success (200 OK)

{
  "data": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "type": "MedicalDiagnosis",
    "target": "c3d4e5f6-a7b8-9012-cdef-234567890123"
  }
}

Response fields

Field	Type	Description
data.id	string (UUID)	Unique reference ID
data.type	string	Type of the linked target (see Required scopes). For older references this can be a historical value (e.g. invoice or MedicalReceiptPosition) that POST does not accept — recreating the reference with that type is therefore not possible
data.target	string (UUID) | null	UUID of the linked record, without an embedded short designation. For the types MedicalExternalLetter, MedicalMotherChildPass, MedicalPsychotherapy, MedicalReceipt, DVPReportEntry, and Transmission there is no dedicated OAuth endpoint to look them up — the UUID identifies the target without being resolvable here

Beispiele

bash

curl -X GET "https://my.offisy.at/api/oauth/v2/resource/todos/b2c3d4e5-f6a7-8901-bcde-f01234567890/references/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"

Server

Client-ID

Client-Secret

Parameter

uuid *string

referenceUuid *string

Zuerst Token anfordern

Possible errors

Status	Code	Description
401	invalid_client	Invalid or missing access token
403	insufficient_scope	Scope todos not present
404	not_found	Todo or reference not found, or target not visible to the client