Skip to content

Get transport certificate

Returns the details of a single transport certificate.

Request

GET /api/oauth/v2/resource/transports/{uuid}

HeaderValue
AuthorizationBearer {access_token}

URL parameters

ParameterTypeRequiredDescription
uuidstringYesUnique ID of the transport certificate

Response

Success (200 OK)

json
{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "diagnose": "M54.5",
    "publicTransport": false,
    "therapyPlaceWish": true,
    "transportWasRequired": true,
    "transportWasRequiredReason": "Patient unable to walk",
    "escort": true,
    "escortReason": "Escort medically required",
    "paramedic": false,
    "paramedicReason": null,
    "printed": false,
    "date": "2026-06-09",
    "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

FieldTypeDescription
data.idstring (UUID)Unique ID of the transport certificate
data.diagnosestring | nullDiagnosis (ICD code or free text)
data.publicTransportbooleanPublic transport
data.therapyPlaceWishbooleanPreferred therapy location requested
data.transportWasRequiredbooleanTransport was medically necessary
data.transportWasRequiredReasonstring | nullReason for necessity
data.escortbooleanEscort required
data.escortReasonstring | nullReason for escort
data.paramedicbooleanParamedic required
data.paramedicReasonstring | nullReason for paramedic
data.printedbooleanTransport certificate has been printed
data.datestring | nullDate of the transport certificate (YYYY-MM-DD)
data.customerobject | nullAssigned customer
data.customer.idstring (UUID)Customer ID
data.customer.firstNamestringCustomer first name
data.customer.lastNamestringCustomer last name
data.treatingUserobject | nullTreating user
data.treatingUser.idstring (UUID)User ID
data.treatingUser.firstNamestringFirst name
data.treatingUser.lastNamestringLast name
Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/transports/b2c3d4e5-f6a7-8901-bcde-f01234567890" \
  -H "Authorization: Bearer {access_token}"
Parameter
Zuerst Token anfordern

Possible errors

StatusCodeDescription
401invalid_clientInvalid or missing access token
403insufficient_scopeScope medicals not present
404not_foundTransport certificate not found

Offisy GmbH