Skip to content

Create referral

Creates a new referral.

Note: This endpoint requires a user-scoped OAuth token. A pure client_credentials token without user context will be rejected. The treating user is automatically derived from the token and cannot be set manually.

Request

POST /api/oauth/v2/resource/referrals

HeaderValue
AuthorizationBearer {access_token}
Content-Typeapplication/json

Body parameters

FieldTypeRequiredDescription
customerUuidstringYesUUID of the assigned customer
servicesstringNoRequested services
diagnosestringNoDiagnosis on the referral
receiverNamestringNoName of the receiving party
receiverStreetstringNoStreet of the receiving party
receiverZipstringNoPostal code of the receiving party
receiverCitystringNoCity of the receiving party
datestringNoReferral date (YYYY-MM-DD, default: today)
printedbooleanNoWhether the referral has been printed

Response

Success (201 Created)

json
{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "services": "Blood count, ECG",
    "diagnose": "Hypertension (I10)",
    "receiverName": "Dr. Thomas Berger",
    "receiverStreet": "Hauptstraße 12",
    "receiverZip": "4020",
    "receiverCity": "Linz",
    "date": "2026-06-09",
    "printed": false,
    "customer": {
      "id": "f0e1d2c3-b4a5-6789-fedc-ba9876543210",
      "firstName": "Anna",
      "lastName": "Muster"
    },
    "treatingUser": {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "firstName": "Dr. Maria",
      "lastName": "Huber"
    }
  }
}

Response fields

See Get referral for the full field description.

Beispiele
bash
curl -X POST "https://my.offisy.at/api/oauth/v2/resource/referrals" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "customerUuid": "b2c3d4e5-f6a7-8901-bcde-f01234567890",
    "services": "beispiel",
    "diagnose": "beispiel",
    "receiverName": "Muster GmbH",
    "receiverStreet": "Musterstraße 1",
    "receiverZip": "4020",
    "receiverCity": "Linz",
    "date": "2026-04-15T10:00:00",
    "printed": "beispiel"
  }'
Parameter
Zuerst Token anfordern

Possible errors

StatusCodeDescription
400validation_errorInvalid request data (e.g. customerUuid missing)
401invalid_clientInvalid or missing access token
403insufficient_scopeScope medicals not present
404not_foundCustomer not found

Offisy GmbH