GET v1/pages/{id}/form?formId={formId}

Use this method to associate an organization form with an existing dynamic page. This method also adds all form elements referencing the dynamic form added.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Dynamic Page Unique Identifier

 string

Required
formId

Dynamic Form Unique Identifier

 string

Required

Body Parameters

None.

Response Information

Resource Description

Returns the updated dynamic page with the form associated including all the added elements.

DynamicPage
NameDescriptionTypeAdditional information
message

Use this property to control the message shown to the user when a form is successfully submitted to the web service.

 string

None.
error

Use this property to control the message shown to the user when an error occur when submitting a form.

 string

None.
formId

Use this property to specify the form template UUID the page is associated with.

 string

None.
id

Dynamic Page Unique Identifier.

 string

None.
title

Use this property to set the display title of a dynamic page.

 string

None.
disabled

This property is used to disable a page from been published.

 boolean

None.
columns

Page column layout

 ColumnLayout

None.
category

Category associated to a page.

 PageCategory

None.
privateLobby

Use this property to specify that this page is meant to be the lobby or home page while in the private (authenticated) section of the application.

 boolean

None.
publicLobby

Use this property to mark this page as the Home page or Lobby for an application.

 boolean

None.
content

Collection of ContentItem

None.
bkColor

Use this property to specify the background color of a page. The format should be an comma delimited rgba value all elements within 0-1 range. for example: 1,1,1,1 The example above would specify the color white.

 string

None.
properties

Use this property to store additional UI View information. Examples of values been stored as page properties are background Image, Page Inserts (Margin) and much more.

 Collection of ContentSetting

None.

Response Formats

application/json, text/json

Sample: 
{
  "message": "sample string 1",
  "error": "sample string 2",
  "formId": "sample string 3",
  "id": "sample string 4",
  "title": "sample string 5",
  "disabled": true,
  "columns": {
    "id": "sample string 1",
    "name": "sample string 2",
    "columns": 3,
    "widths": [
      1.1,
      2.1
    ]
  },
  "category": {
    "id": "sample string 1",
    "text": "sample string 2",
    "default": true
  },
  "privateLobby": true,
  "publicLobby": true,
  "content": [
    {
      "parentItem": "sample string 1",
      "id": "sample string 2",
      "type": "sample string 4",
      "imageId": "sample string 5",
      "selImageId": "sample string 6",
      "pageLink": "sample string 7",
      "title": "sample string 8",
      "text": "sample string 9",
      "disabled": true,
      "order": 1,
      "phoneNumber": "sample string 11",
      "url": "sample string 12",
      "buttonType": "sample string 13",
      "arg1": "sample string 14",
      "arg2": "sample string 15",
      "arg3": "sample string 16",
      "arg4": "sample string 17",
      "arg5": "sample string 18",
      "arg6": "sample string 19",
      "properties": [
        {
          "id": "sample string 2",
          "name": "sample string 3",
          "value": "sample string 4"
        },
        {
          "id": "sample string 2",
          "name": "sample string 3",
          "value": "sample string 4"
        }
      ],
      "precache": true,
      "buttonMode": 1,
      "carouselItems": [
        {
          "id": "sample string 1",
          "carousel": "sample string 2",
          "page": "sample string 3",
          "order": 1
        },
        {
          "id": "sample string 1",
          "carousel": "sample string 2",
          "page": "sample string 3",
          "order": 1
        }
      ]
    },
    {
      "parentItem": "sample string 1",
      "id": "sample string 2",
      "type": "sample string 4",
      "imageId": "sample string 5",
      "selImageId": "sample string 6",
      "pageLink": "sample string 7",
      "title": "sample string 8",
      "text": "sample string 9",
      "disabled": true,
      "order": 1,
      "phoneNumber": "sample string 11",
      "url": "sample string 12",
      "buttonType": "sample string 13",
      "arg1": "sample string 14",
      "arg2": "sample string 15",
      "arg3": "sample string 16",
      "arg4": "sample string 17",
      "arg5": "sample string 18",
      "arg6": "sample string 19",
      "properties": [
        {
          "id": "sample string 2",
          "name": "sample string 3",
          "value": "sample string 4"
        },
        {
          "id": "sample string 2",
          "name": "sample string 3",
          "value": "sample string 4"
        }
      ],
      "precache": true,
      "buttonMode": 1,
      "carouselItems": [
        {
          "id": "sample string 1",
          "carousel": "sample string 2",
          "page": "sample string 3",
          "order": 1
        },
        {
          "id": "sample string 1",
          "carousel": "sample string 2",
          "page": "sample string 3",
          "order": 1
        }
      ]
    }
  ],
  "bkColor": "sample string 6",
  "properties": [
    {
      "id": "sample string 2",
      "name": "sample string 3",
      "value": "sample string 4"
    },
    {
      "id": "sample string 2",
      "name": "sample string 3",
      "value": "sample string 4"
    }
  ]
}