API Reference
Log In
API Reference

Plans

To ask someone (or many people) to provide you with specific information, first create a Plan. This is essentially the "form" you want someone to fill out.

In creating a Plan or "Info request", you can optionally create it in a multi-language format, giving the Plan name and description in various languages for different locales.

There are three main types of "Items", or sections of the Plan, that can be included:

  1. Content – This is content you provide without asking the recipient for any information. For example, this could be information or instructions you would like to give them.
  2. Records – This is where you ask the recipient to upload files.
  3. Fields – These are ways you can get information (other than a file) from the recipient. 

{
  "name": [
    {
      "locale": "en-CA",
      "value": "Request name",
      "description": ""
    }
  ],
  "description": [
    {
      "locale": "en-CA",
      "value": "My description",
      "description": "string"
    }
  ],
  "brandCode": "mybrand",
  "orderId": 0,
  "sidedrawerType": "business",
  "sidedrawerTypeOtherName": "",
  "public": true,
  "isTemplate": false,
  "reportTypeNames": [
    "string"
  ],
  "format": "multilanguage"
}

Plan 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
Number of the position of this Plan when the Plans are sorted in a list.

sidedrawerType string required
Drawer type. Default: individual.

sidedrawerTypeOtherName string
Drawer type if sidedrawerType = other.

public boolean
True if the Plan should be public. Default: false.

isTemplate boolean
True if the Plan is a template.

reportTypeNames array of strings
List of values of Report types.

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


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.