POST api/FODynamicForm/InitializeDynamicForm

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FormId	integer	None.
NextFormId	integer	None.
ReplacedQuery	string	None.
FormDescription	string	None.
FormName	string	None.
Data	Collection of Object	None.
Columns	Collection of FODynamicFormColumnModel	None.
Filters	Collection of FODynamicFormFilterModel	None.
SessionParameters	Collection of ParameterModel	None.

Request Formats

application/json, text/json

Sample:

{
  "FormId": 1,
  "NextFormId": 2,
  "ReplacedQuery": "sample string 3",
  "FormDescription": "sample string 4",
  "FormName": "sample string 5",
  "Data": [
    {},
    {}
  ],
  "Columns": [
    {
      "FormId": 1,
      "ColumnIndex": 2,
      "ColumnTypeId": 3,
      "Sequence": 4,
      "IsUnique": true,
      "IsHidden": true,
      "ParameterName": "sample string 7",
      "ColumnDescription": "sample string 8"
    },
    {
      "FormId": 1,
      "ColumnIndex": 2,
      "ColumnTypeId": 3,
      "Sequence": 4,
      "IsUnique": true,
      "IsHidden": true,
      "ParameterName": "sample string 7",
      "ColumnDescription": "sample string 8"
    }
  ],
  "Filters": [
    {
      "FilterId": 1,
      "FilterTypeId": 2,
      "FilterName": "sample string 3",
      "ParameterName": "sample string 4",
      "ValueId": "sample string 6",
      "DisplayName": "sample string 7",
      "IsOnline": true,
      "FilterDescription": "sample string 9",
      "SelectedValue": "sample string 10",
      "DefaultValue": "sample string 11",
      "FilterDataSource": [
        {
          "ValueId": "sample string 1",
          "DisplayName": "sample string 2"
        },
        {
          "ValueId": "sample string 1",
          "DisplayName": "sample string 2"
        }
      ]
    },
    {
      "FilterId": 1,
      "FilterTypeId": 2,
      "FilterName": "sample string 3",
      "ParameterName": "sample string 4",
      "ValueId": "sample string 6",
      "DisplayName": "sample string 7",
      "IsOnline": true,
      "FilterDescription": "sample string 9",
      "SelectedValue": "sample string 10",
      "DefaultValue": "sample string 11",
      "FilterDataSource": [
        {
          "ValueId": "sample string 1",
          "DisplayName": "sample string 2"
        },
        {
          "ValueId": "sample string 1",
          "DisplayName": "sample string 2"
        }
      ]
    }
  ],
  "SessionParameters": [
    {
      "ParName": "sample string 1",
      "ParValue": "sample string 2"
    },
    {
      "ParName": "sample string 1",
      "ParValue": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<FODynamicFormModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SonicAPI.Model">
  <Columns>
    <FODynamicFormColumnModel>
      <ColumnDescription>sample string 8</ColumnDescription>
      <ColumnIndex>2</ColumnIndex>
      <ColumnTypeId>3</ColumnTypeId>
      <FormId>1</FormId>
      <IsHidden>true</IsHidden>
      <IsUnique>true</IsUnique>
      <ParameterName>sample string 7</ParameterName>
      <Sequence>4</Sequence>
    </FODynamicFormColumnModel>
    <FODynamicFormColumnModel>
      <ColumnDescription>sample string 8</ColumnDescription>
      <ColumnIndex>2</ColumnIndex>
      <ColumnTypeId>3</ColumnTypeId>
      <FormId>1</FormId>
      <IsHidden>true</IsHidden>
      <IsUnique>true</IsUnique>
      <ParameterName>sample string 7</ParameterName>
      <Sequence>4</Sequence>
    </FODynamicFormColumnModel>
  </Columns>
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </Data>
  <Filters>
    <FODynamicFormFilterModel>
      <DefaultValue>sample string 11</DefaultValue>
      <DisplayName>sample string 7</DisplayName>
      <FilterDataSource>
        <FODynamicFilterDataSourceModel>
          <DisplayName>sample string 2</DisplayName>
          <ValueId>sample string 1</ValueId>
        </FODynamicFilterDataSourceModel>
        <FODynamicFilterDataSourceModel>
          <DisplayName>sample string 2</DisplayName>
          <ValueId>sample string 1</ValueId>
        </FODynamicFilterDataSourceModel>
      </FilterDataSource>
      <FilterDescription>sample string 9</FilterDescription>
      <FilterId>1</FilterId>
      <FilterName>sample string 3</FilterName>
      <FilterTypeId>2</FilterTypeId>
      <IsOnline>true</IsOnline>
      <ParameterName>sample string 4</ParameterName>
      <Query>sample string 5</Query>
      <SelectedValue>sample string 10</SelectedValue>
      <ValueId>sample string 6</ValueId>
    </FODynamicFormFilterModel>
    <FODynamicFormFilterModel>
      <DefaultValue>sample string 11</DefaultValue>
      <DisplayName>sample string 7</DisplayName>
      <FilterDataSource>
        <FODynamicFilterDataSourceModel>
          <DisplayName>sample string 2</DisplayName>
          <ValueId>sample string 1</ValueId>
        </FODynamicFilterDataSourceModel>
        <FODynamicFilterDataSourceModel>
          <DisplayName>sample string 2</DisplayName>
          <ValueId>sample string 1</ValueId>
        </FODynamicFilterDataSourceModel>
      </FilterDataSource>
      <FilterDescription>sample string 9</FilterDescription>
      <FilterId>1</FilterId>
      <FilterName>sample string 3</FilterName>
      <FilterTypeId>2</FilterTypeId>
      <IsOnline>true</IsOnline>
      <ParameterName>sample string 4</ParameterName>
      <Query>sample string 5</Query>
      <SelectedValue>sample string 10</SelectedValue>
      <ValueId>sample string 6</ValueId>
    </FODynamicFormFilterModel>
  </Filters>
  <FormDescription>sample string 4</FormDescription>
  <FormId>1</FormId>
  <FormName>sample string 5</FormName>
  <NextFormId>2</NextFormId>
  <Query>sample string 6</Query>
  <ReplacedQuery>sample string 3</ReplacedQuery>
  <SessionParameters>
    <ParameterModel>
      <ParName>sample string 1</ParName>
      <ParValue>sample string 2</ParValue>
    </ParameterModel>
    <ParameterModel>
      <ParName>sample string 1</ParName>
      <ParValue>sample string 2</ParValue>
    </ParameterModel>
  </SessionParameters>
</FODynamicFormModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json

Sample:

{}

application/xml, text/xml

Sample:

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />