ZEzenoti

Retrieve the list of forms associated with an appointment

This API helps you to fetch the list of forms that are available for the specified appointment.

You must specify appropriate details for the appointment_id parameter in the API request.

get/v1/appointments/{appointment_id}/forms

Request

Query parameters

appointment_idstring required

Mandatory Unique 32-character identifier of the appointment for which you want to retrieve the list of forms.

Response

200

appointment_idstring
form_idstring
service_nameunknown
service_displaynameunknown
namestring
is_filledboolean
is_submittedboolean
lastfilled_datestring
form_typeinteger
lastfilled_bystring
latest_versionunknown
is_viewonlyboolean
expiry_dateunknown
is_editableboolean
is_expiredboolean
owner_idunknown
display_orderinteger
is_service_formboolean
source_appointment_datestring

Example response

[
  {
    "appointment_id": "658423ef-5011-47e6-a617-19355a967tyu",
    "form_id": "658423ef-5011-47e6-a617-19355a967cdc",
    "name": "chiti",
    "is_filled": true,
    "is_submitted": true,
    "lastfilled_date": "2019-07-25T12:55:00",
    "form_type": 2,
    "lastfilled_by": "Owner fi L1",
    "form_history": [
      {
        "version_date": "2019-07-25T12:55:14.637",
        "version_id": "10154",
        "created_by": "Owner fi L1",
        "form_name": "chiti",
        "form_id": "658423ef-5011-47e6-a617-19355a967cdc"
      }
    ],
    "is_editable": true,
    "is_service_form": true,
    "source_appointment_date": "2019-07-12T09:10:00",
    "permissions": {
      "can_view": true,
      "can_edit": true
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.