Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the data of an appointment form

This API helps you to retrieve the data for tag forms associated to the specified appointment. You must provide an appropriate identifier in the API request for the appointment_id parameter. You also need to specify the required details for three other parameters in the API request. Refer to the Request Parameters table for more information.

get/v1/appointments/{appointment_id}/forms_data?tag_Id={tag_id}&view_context={view_context}&version_no={version_no}

Path parameters

appointment_idstring required

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

Query parameters

tag_idstring required

Mandatory Unique 32-character identifier of the tag. If you want to retrieve a tag form, you must specify the specific guid of the tag in the API request.

view_contextinteger required

Mandatory Currently, this parameter is not functional. You must either pass 0 or an empty string ("") in the request for this API to work. Indicates the type of context from which you want to view the appointment form data. The view_context type can either be organization-level or center-level: 0 - organization and 1 - center.

version_nointeger required

Mandatory Currently, this parameter is not functional. You must either pass 0 or an empty string ("") in the request for this API to work. Indicates the version number of the appointment form. If you pass an integer value for this parameter in the API request, the form data of the specified appointment version will be returned in the API response.

Response

200

{"stackTrail":"paths:/v1/appointments/{appointment_id}/forms_data?tag_Id={tag_id}&view_context={view_context}&version_no={version_no}:get:responses:200:content:application/json:schema:properties:data","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/v1/appointments/{appointment_id}/forms_data?tag_Id={tag_id}&view_context={view_context}&version_no={version_no}:get:responses:200:content:application/json:schema:properties:guest_data","oasType":"schema","type":"unknown"}
is_form_submittedboolean
{"stackTrail":"paths:/v1/appointments/{appointment_id}/forms_data?tag_Id={tag_id}&view_context={view_context}&version_no={version_no}:get:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}