Skip to content

Referenz anzeigen ​

Gibt die Details einer einzelnen Referenz einer Aufgabe zurück.

Request ​

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

HeaderWert
AuthorizationBearer {access_token}

URL-Parameter ​

ParameterTypPflichtBeschreibung
uuidstringJaEindeutige Aufgaben-ID
referenceUuidstringJaEindeutige Referenz-ID

Hinweis: Referenzen, deren Ziel der Client nicht sehen darf, liefert dieser Endpoint mit 404, auch wenn die Referenz existiert.

Response ​

Erfolg (200 OK) ​

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

Response-Felder ​

FeldTypBeschreibung
data.idstring (UUID)Eindeutige Referenz-ID
data.typestringTyp des verknüpften Ziels (siehe Erforderliche Scopes). Bei älteren Referenzen kann hier ein historischer Wert stehen (z.B. invoice oder MedicalReceiptPosition), den POST nicht akzeptiert – ein Neuanlegen der Referenz mit diesem Typ ist daher nicht möglich
data.targetstring (UUID) | nullUUID des verknüpften Datensatzes, ohne eingebettete Kurzbezeichnung. Für die Typen MedicalExternalLetter, MedicalMotherChildPass, MedicalPsychotherapy, MedicalReceipt, DVPReportEntry und Transmission gibt es keinen eigenen OAuth-Endpoint zum Nachladen – die UUID identifiziert das Ziel, ohne dass sie hier auflösbar ist
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}"
Parameter
Zuerst Token anfordern

Mögliche Fehler ​

StatusCodeBeschreibung
401invalid_clientUngültiger oder fehlender Access Token
403insufficient_scopeScope todos nicht vorhanden
404not_foundAufgabe oder Referenz nicht gefunden, oder Ziel für den Client nicht sichtbar

Offisy GmbH