Disclaimer Form

The Disclaimer Form API is used to access, create, and modify the different disclaimer form objects and disclaimer form data objects on your business' account. The Disclaimer Form API is connected to the Clients and Calendar APIs, in that clients receive disclaimer forms about appointments they have attended.

On this page




Disclaimer Form API Endpoints

These are the endpoints that are available under the /disclaimerForm path, which lists all the different disclaimer forms and disclaimer form data you have added to your business account. The disclaimerForm objects represent the templates used for your business' disclaimer forms, whereas the disclaimerFormData objects represent the individual disclaimer forms sent to clients that are based on the disclaimerForm template.

Endpoint

Description

GET /disclaimerForm

Returns all disclaimerForm objects on an account in array format.

GET /disclaimerForm/{disclaimerFormId}

Returns a JSON object form the specified disclaimer form.

POST /disclaimerForm

Creates a new disclaimerForm object or updates an existing disclaimerForm object on an account.

Request body/payload:  Must pass a disclaimerForm object in the request body/payload. If the disclaimerForm object passed doesn't have the disclaimerFormId property filled, the call will create a new disclaimer form. If the disclaimerForm object passed has the disclaimerFormId property filled, the call will update the specified disclaimer form.

For these calls, you need to pass a disclaimerForm object with all required fields and any fields you want to set filled in the body of the payload. We have an example of a resource object in the responses section below and have indicated the required fields in the object values table at the bottom of this page.

POST /disclaimerForm/{disclaimerFormUuid}/to/{clientId}

Creates a disclaimerFormObject on a client object for the client to fill out.

DELETE /disclaimerForm/{disclaimerFormId}Removes a disclaimerForm object from view by setting its active property to false.
GET /disclaimerFormData/business/{disclaimerFormId}Returns all disclaimerFormData objects sent out by the business to clients for the disclaimerFormId passed in the URL in array format.
GET /disclaimerForm/client/{clientId}Returns all disclaimerFormData objects sent out to the specified client in array format.
GET /disclaimerFormData/client/{clientId}/form/{disclaimerFormId}Returns all disclaimerFormData objects sent out to the specified client that use the specified disclaimer form.
GET /disclaimerFormData/{disclaimerFormUUId}Returns a JSON object for disclaimerFormData that uses the specified disclaimer form.
POST /disclaimerFormData

Used by clients to submit disclaimer forms that have been sent.

Request body/payload:  Must pass a disclaimerFormData object in the request body/payload. 

For these calls, you need to pass a disclaimerFormData object with all required fields and any fields you want to set filled in the body of the payload. We have an example of a disclaimerFormData object in the responses section below and have indicated the required fields in the object values table at the bottom of this page.




Disclaimer Form API Parameters

Data points passed on in the request URL portion of the API call that are used to filter the data being requested. 

ParameterTypeEndpoints to be used withDescription
appointmentIdintegerPOST /disclaimerForm/{disclaimerFormId}/to/{clientId}Should be set as the calendarID corresponding to the appointment that specified disclaimer form is being sent for.



Disclaimer Form API Responses

GET /disclaimerForm
[{
    "active": true,
    "alreadySubmittedMsg": null,
    "businessId": 43111,
    "createdDate": 1541519350515,
    "createdUser": "JoeSchmo",
    "disclaimerFormId": 6324,
    "expiresInDays": 7,
    "formName": "Test form 1",
    "formSetupJson": "[{"fieldType":"description","label":null,"value":"<p>Sign here:_____</p>","dataType":"HTML","inputType":null,"sortOrder":1,"required":false}],
    "formType": "HTML",
    "modifiedDate": 1541709880238,
    "modifiedUser": "JoeSchmo",
    "required": true,
    "stylesheet": null,
    "thankYouMsg": "<p>Thank you for submitting the form to us!</p>"
}]
GET /disclaimerForm/{disclaimerFormId}
{
    "active": true,
    "alreadySubmittedMsg": "<p>You already did this!</p>",
    "businessId": 43111,
    "createdDate": 1542136205563,
    "createdUser": "JoeSchmo",
    "disclaimerFormId": 6654,
    "expiresInDays": 2,
    "formName": "Legal Disclaimer",
    "formSetupJson: "[{"fieldType":"formField","label":"Danger level","value":"","dataType":"RADIO","inputType":"text","sortOrder":1,"required":false,"fieldValues":"Low\nMedium\nHigh"}]",
    "formType": "HTML",
    "modifiedDate": 1542810845104,
    "modifiedUser": "JoeSchmo",
    "required": true,
    "stylesheet": "stylesheet2.css",
    "thankYouMsg": "<p>Thank you come again</p>"
}
POST /disclaimerForm
{
    "active": true,
    "alreadySubmittedMsg": null,
    "businessId": 43111,
    "createdDate": 1542136205563,
    "createdUser": "JoeSchmo",
    "disclaimerFormId": 6654,
    "expiresInDays": null,
    "formName": "Legal Disclaimer",
    "formSetupJson": "[{"fieldType":"formField","label":"Danger level","value":"","dataType":"RADIO","inputType":"text","sortOrder":1,"required":false,"fieldValues":"Low\nMedium\nHigh"}]",
    "formType": "HTML",
    "modifiedDate": 1542136355083,
    "modifiedUser": "JoeSchmo",
    "required": true,
    "stylesheet": "stylesheet.css",
    "thankYouMsg": null
}
POST /disclaimerForm/{disclaimerFormUuid}/to/{clientId}
{
    "businessId": 43111,
    "calendar": {Calendar object for calendar of disclaimer form - see Calendar API page},
    "client": {Client object for client being sent disclaimer form - see Clients API page},
    "createdDate": 1542138206956,
    "createdUser": "JoeSchmo",
    "dataJson": null,
    "dateSent": 1542138206956,
    "dateSubmitted": null,
    "disclaimerFormId": 6555,
    "disclaimerFormUuid": "14999c7a-032a-4d34-a113-a793a012186c",
    "expiresBy": 1543276800000,
    "ipAddress": null,
    "modifiedDate": 1542138206956,
    "modifiedUser": "JoeSchmo",
    "notes": null,
    "status": "OPEN",
    "waived": null
}
GET /disclaimerFormData/client/{clientId}
[{
    "datesent": 1542211477871,
    "datesubmitted": 1542211477871,
    "disclaimerformid": 6555,
    "disclaimerformuuid": "fb492d8b-a542-4f3c-b334-8ae3135d97be",
    "expiresby": null,
    "formname": "Parent's permission slip",
    "required": true,
    "status": "WAIVED",
    "waived": true
}]
GET /disclaimerFormData/client/{clientId}/form/{disclaimerFormId} (status = OPEN)
[{
    "businessId": 43111,
    "calendar": {Calendar object for appointment of disclaimer form - see Calendar API page},
    "client": {Client object for client being sent disclaimer form - see Clients API page},
    "createdDate": 1542207031792,
    "createdUser": "JoeSchmo",
    "dataJson": null,
    "dateSent": 1542207031995,
    "dateSubmitted": null,
    "disclaimerFormId": 6654,
    "disclaimerFormUuid": "4dc48a9a-fb20-4002-b208-08040f921a5b",
    "expiresBy": null,
    "ipAddress": null,
    "modifiedDate": 1542207031995,
    "modifiedUser": "JoeSchmo",
    "notes": null,
    "status": "OPEN",
    "waived": null
}]
GET /disclaimerFormData/client/{clientId}/form/{disclaimerFormId} (status = SUBMITTED)
[{
    "businessId": 43111,
    "calendar": {Calendar object for appointment of disclaimer form - see Calendar API page},
    "client": {Client object for client being sent disclaimer form - see Clients API page},
    "createdDate:" 1542207031792,
    "createdUser": "JoeSchmo",
    "dataJson: "[{"fieldType":"formField","label":"Danger level","value":"Medium","dataType":"RADIO","inputType":"text","sortOrder":1,"required":false,"fieldValues":"Low\nMedium\nHigh","htmlId":"field0","listItems":[{"listItemId":0,"listItemValue":"Low","active":false},{"listItemId":1,"listItemValue":"Medium","active":true},{"listItemId":2,"listItemValue":"High","active":false}]}]",
    "dateSent": 1542207031995,
    "dateSubmitted": 1542223272234,
    "disclaimerFormId": 6654,
    "disclaimerFormUuid": "4dc48a9a-fb20-4002-b208-08040f921a5b",
    "expiresBy": null,
    "ipAddress": null,
    "modifiedDate": 1542223272234,
    "modifiedUser": "",
    "notes": null,
    "status": "SUBMITTED",
    "waived": null
}]
GET /disclaimerFormData/{disclaimerFormUuid}
{
    "businessId": 43111,
    "calendar": {Calendar object for appointment of disclaimer form - see Calendar API page},
    "client": {Client object for client being sent disclaimer form - see Clients API page},
    "createdDate": 1542207031792,
    "createdUser": "JoeSchmo",
    "dataJson": "[{JSON of formSetupJson property from disclaimerForm object with value properties filled in}]",
    "dateSent": 1542207031995,
    "dateSubmitted": 1542223272234,
    "disclaimerFormId": 6654,
    "disclaimerFormUuid": "4dc48a9a-fb20-4002-b208-08040f921a5b",
    "expiresBy": null,
    "ipAddress": null,
    "modifiedDate": 1542223272234,
    "modifiedUser": "",
    "notes": null,
    "status": "SUBMITTED",
    "waived": null
}
POST /disclaimerFormData
{
    "businessId": 43111,
    "calendar": {Calendar object for appointment of disclaimer form - see Calendar API page},
    "client": {Client object for client being sent disclaimer form - see Clients API page},
    "createdDate": 1542225204909,
    "createdUser": "JoeSchmo",
    "dataJson": "[{JSON of formSetupJson property from disclaimerForm object with value properties filled in}]",
    "dateSent": 1542225205135,
    "dateSubmitted": 1542225360384,
    "disclaimerFormId": 6324,
    "disclaimerFormUuid": "56905553-d342-48eb-8f7f-950bfb3af4c0"
    "expiresBy": 1542758400000,
    "ipAddress": null,
    "modifiedDate": 1542225360384,
    "modifiedUser": "",
    "notes": null,
    "status": "SUBMITTED",
    "waived": null
}
POST /disclaimerForm/{disclaimerFormId}/to/{clientId}
{
    "businessId": 43111,
    "calendar": {Calendar object for appointment of disclaimer form - see Calendar API page},
    "client": {Client object for client being sent disclaimer form - see Clients API page},
    "createdDate": 1542224394224,
    "createdUser": "JoeSchmo",
    "dataJson": "[{JSON of formSetupJson property from disclaimerForm object with value properties filled in}]",
    "dateSent": 1542224394224,
    "dateSubmitted": null,
    "disclaimerFormId": 6654,
    "disclaimerFormUuid": "81293b09-1899-4f9a-81b5-6ec0ea7fe955",
    "expiresBy": null,
    "ipAddress": null,
    "modifiedDate": 1542224394224,
    "modifiedUser": "JoeSchmo",
    "notes": null,
    "status": "OPEN",
    "waived": null
}




Disclaimer Form Object Values

disclaimerForm

Property nameTypeRequiredDescription
activebooleanYesIndicates whether or not the specified disclaimer form should return on GET calls.
alreadySubmittedMsgstring
Displayed as the message that gets displayed if the specified disclaimer form has already been submitted.
businessIdintegerYesProvides unique numeric ID of the business to which specified disclaimer form belongs. 
createdDateinteger
Displays as the date the specified disclaimer form was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUserstring
Displays the username of user who created the specified disclaimer form.
disclaimerFormIdintegerYesProvides unique numeric ID for the specified disclaimer form.
expiresInDaysinteger
Displays as the number of days left before the the specified disclaimer form expires.
formNamestringYesDisplays as what is set as the name of the specified disclaimer form.
formSetupJsonstring
Displays as JSON text describing specified disclaimer form - for a list of properties listed in this object along with their descriptions, see table at the bottom of the page.
formTypestringYesDisplays as form type of the specified disclaimer form. Has acceptable values "HTML".

modifiedDate

integer


Displays as the date the specified disclaimer form was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.

modifiedUserstring

Displays the username of the user who last modified the specified disclaimer form.

requiredbooleanYesIndicates whether or not specified the disclaimer form is required.
stylesheetstring
Displays as the CSS stylesheet used to format the specified disclaimer form.
thankYouMsgstring
Displays as the thank you message that gets sent upon completion of the specified disclaimer form.

disclaimerFormData

Property nameTypeRequiredDescription
businessIdinteger
Provides unique numeric ID for the business to which the specified disclaimer form data belongs.
calendarobject
Displays the calendar object for calendar of the specified disclaimer form data - for more info, see Calendar API page.
clientobject
Displays the client object for client of the specified disclaimer form data - for more info, see Clients API page.
createdDateinteger
Displays as the date the specified disclaimer form data was created, in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. 
createdUserstring
Displays the username of user who created the specified disclaimer form data.
dataJsonstring
Displays as JSON object describing any fields on specified disclaimer form data in string form.
dateSentinteger
Displays as the date the specified disclaimer form data was sent in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
dateSubmittedinteger
Displays as the date the specified disclaimer form data was submitted in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
disclaimerFormIdintegerYesProvides unique numeric ID for the specified disclaimer form data.
disclaimerFormUuidstring
Provides unique alphanumeric ID for the specified disclaimer form data.
expiresByinteger
Displays as when the specified disclaimer form data is set to expire, in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
ipAddressinteger
Displays as the IP address associated with the specified disclaimer form data.
modifiedDateinteger
Displays as the date the specified disclaimer form data was last modified, in milliseconds elapsed since January 1, 1970 00:00:00 UTC form. 
modifiedUserstring
Displays the username of the user who last modified the specified disclaimer form data.
notesstring
Displays as the text of any notes attached to the specified disclaimer form data.
statusstring
Displays the status of specified disclaimer form. Has acceptable values "WAIVED", "SUBMITTED".
waivedboolean
Indicates whether or not the specified disclaimer form data has been waived by the business sending it.

formSetupJson

Property nameTypeDescription
fieldTypestringDisplays as the field type used for the specified disclaimer form data.
labelstringDisplays as the label appearing on the specified disclaimer form data.
valuestringDisplays as the type of value to be entered on the specified disclaimer form data.
dataTypestringDisplays as the data type used for the specified disclaimer form data.
inputTypestringDisplays as what the input is to fill out the specified disclaimer form data.
sortOrderintegerProvides a number that is used to determine the primacy of the forms.
requiredbooleanIndicates whether or not the specified disclaimer form data is required by the business.
formTypestringDisplays as the form type of the specified disclaimer form data.