v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

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

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

{"stackTrail":"paths:/v1/appointments/{appointment_id}/forms:get:responses:200:content:application/json:schema:items:properties:service_name","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/appointments/{appointment_id}/forms:get:responses:200:content:application/json:schema:items:properties:service_displayname","oasType":"schema","type":"unknown"}

namestring

is_filledboolean

is_submittedboolean

lastfilled_datestring

form_typeinteger

lastfilled_bystring

{"stackTrail":"paths:/v1/appointments/{appointment_id}/forms:get:responses:200:content:application/json:schema:items:properties:latest_version","oasType":"schema","type":"unknown"}

is_viewonlyboolean

{"stackTrail":"paths:/v1/appointments/{appointment_id}/forms:get:responses:200:content:application/json:schema:items:properties:expiry_date","oasType":"schema","type":"unknown"}

is_editableboolean

is_expiredboolean

{"stackTrail":"paths:/v1/appointments/{appointment_id}/forms:get:responses:200:content:application/json:schema:items:properties:owner_id","oasType":"schema","type":"unknown"}

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
    }
  }
]