API Reference
Log In
API Reference

Smart Forms

A Smart Form is a Plan or Info Request that has been delivered to a User and is now specific to them. The User can now fill out this Smart Form they have received.


{
  "name": [
    {
      "locale": "en-CA",
      "value": "My Plan",
      "description": ""
    }
  ],
  "description": [
    {
      "locale": "en-CA",
      "value": "This is what my plan is for",
      "description": ""
    }
  ],
  "brandCode": "mybrand",
  "orderId": 0,
  "sidedrawerType": "business",
  "sidedrawerTypeOtherName": "",
  "isPublic": true,
  "isTemplate": false,
  "reportTypeNames": [
    ""
  ],
  "format": "multilanguage",
  "roles": [
    {
      "displayName": [
        {
          "locale": "en-CA",
          "value": "",
          "description": ""
        }
      ],
      "name": "",
      "routingOrder": 0
    }
  ]
}

Smart Form (smartForms) entity

name array of Display Value entities required
List of name values to display depending on the language.

description array of Optional Display Value entities required
List of description values to display depending on the language.

brandCode string
Branding code.

orderId number
Priority.

sidedrawerType string required
Drawer type. Default: individual.

sidedrawerTypeOtherName string
Drawer type if sidedrawerType = other.

isPublic boolean
True if Smart Form is public. Default: false.

isTemplate boolean
True if Smart Form is a template.

reportTypeNames array of strings
List of Report types.

format enum
Format. Possible values: multilanguage, legacy, flow.

roles array of Tenant Smart Form Roles entities required
List of form roles.


Display Value (displayValue) entity

locale enum required
Locale.
Possible values: en-CA, fr-CA, en-US, es-US.

value string required
Value of display.

description string
Description.


Optional Display Value (optionalDisplayValue) entity

locale enum required
Locale. Possible values: en-CA, fr-CA, en-US, es-US.

value string
Value of display.

description string
Description.


Tenant Smart Form Roles (roles) entity

displayName array of Display Value entities required
List of names to display depending on the language.

name string required
Role name.

routingOrder number
Routing order.