POST FormulariosInteligentes/GetDynamicFormInputData

Request Information

URI Parameters

None.

Body Parameters

GetDynamicFormInputDataInput
NameDescriptionTypeAdditional information
DynamicForm

DynamicForm

None.

ChannelId

integer

None.

TenantId

string

None.

UserLanguage

integer

None.

UserName

string

None.

IpAddress

string

None.

Location

string

None.

Request Formats

application/json, text/json

Sample:
{
  "DynamicForm": {
    "DynamicFormName": "sample string 1",
    "DynamicFormBackendId": "sample string 2",
    "DynamicFormStepId": 3,
    "NextDynamicFormFromBackend": true,
    "DynamicFormInputData": [
      {
        "DataFieldName": "sample string 1",
        "DataTypeId": 2,
        "DataFieldTypeId": 3,
        "IsCatalog": true,
        "IsRequired": true,
        "InitializeFromBackend": true,
        "CatalogItems": [
          {
            "Value": "sample string 1"
          },
          {
            "Value": "sample string 1"
          }
        ],
        "Value": "sample string 7"
      },
      {
        "DataFieldName": "sample string 1",
        "DataTypeId": 2,
        "DataFieldTypeId": 3,
        "IsCatalog": true,
        "IsRequired": true,
        "InitializeFromBackend": true,
        "CatalogItems": [
          {
            "Value": "sample string 1"
          },
          {
            "Value": "sample string 1"
          }
        ],
        "Value": "sample string 7"
      }
    ],
    "DynamicFormOutputData": [
      {
        "DataFieldName": "sample string 1",
        "DataTypeId": 2,
        "DataFieldTypeId": 3,
        "IsCatalog": true,
        "IsRequired": true,
        "InitializeFromBackend": true,
        "CatalogItems": [
          {
            "Value": "sample string 1"
          },
          {
            "Value": "sample string 1"
          }
        ],
        "Value": "sample string 7"
      },
      {
        "DataFieldName": "sample string 1",
        "DataTypeId": 2,
        "DataFieldTypeId": 3,
        "IsCatalog": true,
        "IsRequired": true,
        "InitializeFromBackend": true,
        "CatalogItems": [
          {
            "Value": "sample string 1"
          },
          {
            "Value": "sample string 1"
          }
        ],
        "Value": "sample string 7"
      }
    ],
    "ClientBankIdentifiers": [
      "sample string 1",
      "sample string 2"
    ],
    "UserDocumentId": {
      "DocumentNumber": "sample string 1",
      "DocumentType": 2
    }
  },
  "ChannelId": 1,
  "TenantId": "sample string 2",
  "UserLanguage": 3,
  "UserName": "sample string 4",
  "IpAddress": "sample string 5",
  "Location": "sample string 6"
}

application/xml, text/xml

Sample:
<GetDynamicFormInputDataInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FBSBankingly.Models.Input">
  <ChannelId>1</ChannelId>
  <IpAddress>sample string 5</IpAddress>
  <Location>sample string 6</Location>
  <TenantId>sample string 2</TenantId>
  <UserLanguage>3</UserLanguage>
  <UserName>sample string 4</UserName>
  <DynamicForm>
    <ClientBankIdentifiers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </ClientBankIdentifiers>
    <DynamicFormBackendId>sample string 2</DynamicFormBackendId>
    <DynamicFormInputData>
      <DynamicFormDataField>
        <CatalogItems>
          <CatalogItem>
            <Value>sample string 1</Value>
          </CatalogItem>
          <CatalogItem>
            <Value>sample string 1</Value>
          </CatalogItem>
        </CatalogItems>
        <DataFieldName>sample string 1</DataFieldName>
        <DataFieldTypeId>3</DataFieldTypeId>
        <DataTypeId>2</DataTypeId>
        <InitializeFromBackend>true</InitializeFromBackend>
        <IsCatalog>true</IsCatalog>
        <IsRequired>true</IsRequired>
        <Value>sample string 7</Value>
      </DynamicFormDataField>
      <DynamicFormDataField>
        <CatalogItems>
          <CatalogItem>
            <Value>sample string 1</Value>
          </CatalogItem>
          <CatalogItem>
            <Value>sample string 1</Value>
          </CatalogItem>
        </CatalogItems>
        <DataFieldName>sample string 1</DataFieldName>
        <DataFieldTypeId>3</DataFieldTypeId>
        <DataTypeId>2</DataTypeId>
        <InitializeFromBackend>true</InitializeFromBackend>
        <IsCatalog>true</IsCatalog>
        <IsRequired>true</IsRequired>
        <Value>sample string 7</Value>
      </DynamicFormDataField>
    </DynamicFormInputData>
    <DynamicFormName>sample string 1</DynamicFormName>
    <DynamicFormOutputData>
      <DynamicFormDataField>
        <CatalogItems>
          <CatalogItem>
            <Value>sample string 1</Value>
          </CatalogItem>
          <CatalogItem>
            <Value>sample string 1</Value>
          </CatalogItem>
        </CatalogItems>
        <DataFieldName>sample string 1</DataFieldName>
        <DataFieldTypeId>3</DataFieldTypeId>
        <DataTypeId>2</DataTypeId>
        <InitializeFromBackend>true</InitializeFromBackend>
        <IsCatalog>true</IsCatalog>
        <IsRequired>true</IsRequired>
        <Value>sample string 7</Value>
      </DynamicFormDataField>
      <DynamicFormDataField>
        <CatalogItems>
          <CatalogItem>
            <Value>sample string 1</Value>
          </CatalogItem>
          <CatalogItem>
            <Value>sample string 1</Value>
          </CatalogItem>
        </CatalogItems>
        <DataFieldName>sample string 1</DataFieldName>
        <DataFieldTypeId>3</DataFieldTypeId>
        <DataTypeId>2</DataTypeId>
        <InitializeFromBackend>true</InitializeFromBackend>
        <IsCatalog>true</IsCatalog>
        <IsRequired>true</IsRequired>
        <Value>sample string 7</Value>
      </DynamicFormDataField>
    </DynamicFormOutputData>
    <DynamicFormStepId>3</DynamicFormStepId>
    <NextDynamicFormFromBackend>true</NextDynamicFormFromBackend>
    <UserDocumentId>
      <DocumentNumber>sample string 1</DocumentNumber>
      <DocumentType>2</DocumentType>
    </UserDocumentId>
  </DynamicForm>
</GetDynamicFormInputDataInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetDynamicFormInputDataResult
NameDescriptionTypeAdditional information
DynamicFormInputData

Collection of DynamicFormDataField

None.

BackendOperationResult

Collection of BackendOperationResult

None.

Response Formats

application/json, text/json

Sample:
{
  "DynamicFormInputData": [
    {
      "DataFieldName": "sample string 1",
      "DataTypeId": 2,
      "DataFieldTypeId": 3,
      "IsCatalog": true,
      "IsRequired": true,
      "InitializeFromBackend": true,
      "CatalogItems": [
        {
          "Value": "sample string 1"
        },
        {
          "Value": "sample string 1"
        }
      ],
      "Value": "sample string 7"
    },
    {
      "DataFieldName": "sample string 1",
      "DataTypeId": 2,
      "DataFieldTypeId": 3,
      "IsCatalog": true,
      "IsRequired": true,
      "InitializeFromBackend": true,
      "CatalogItems": [
        {
          "Value": "sample string 1"
        },
        {
          "Value": "sample string 1"
        }
      ],
      "Value": "sample string 7"
    }
  ],
  "BackendOperationResult": [
    {
      "IsError": true,
      "BackendMessage": "sample string 1",
      "BackendReference": "sample string 2",
      "BackendCode": "sample string 3",
      "TransactionIdentity": "sample string 4"
    },
    {
      "IsError": true,
      "BackendMessage": "sample string 1",
      "BackendReference": "sample string 2",
      "BackendCode": "sample string 3",
      "TransactionIdentity": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<GetDynamicFormInputDataResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FBSBankingly.Models.Result">
  <BackendOperationResult>
    <BackendOperationResult>
      <BackendCode>sample string 3</BackendCode>
      <BackendMessage>sample string 1</BackendMessage>
      <BackendReference>sample string 2</BackendReference>
      <IsError>true</IsError>
      <TransactionIdentity>sample string 4</TransactionIdentity>
    </BackendOperationResult>
    <BackendOperationResult>
      <BackendCode>sample string 3</BackendCode>
      <BackendMessage>sample string 1</BackendMessage>
      <BackendReference>sample string 2</BackendReference>
      <IsError>true</IsError>
      <TransactionIdentity>sample string 4</TransactionIdentity>
    </BackendOperationResult>
  </BackendOperationResult>
  <DynamicFormInputData xmlns:d2p1="http://schemas.datacontract.org/2004/07/FBSBankingly.Models.Input">
    <d2p1:DynamicFormDataField>
      <d2p1:CatalogItems>
        <d2p1:CatalogItem>
          <d2p1:Value>sample string 1</d2p1:Value>
        </d2p1:CatalogItem>
        <d2p1:CatalogItem>
          <d2p1:Value>sample string 1</d2p1:Value>
        </d2p1:CatalogItem>
      </d2p1:CatalogItems>
      <d2p1:DataFieldName>sample string 1</d2p1:DataFieldName>
      <d2p1:DataFieldTypeId>3</d2p1:DataFieldTypeId>
      <d2p1:DataTypeId>2</d2p1:DataTypeId>
      <d2p1:InitializeFromBackend>true</d2p1:InitializeFromBackend>
      <d2p1:IsCatalog>true</d2p1:IsCatalog>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Value>sample string 7</d2p1:Value>
    </d2p1:DynamicFormDataField>
    <d2p1:DynamicFormDataField>
      <d2p1:CatalogItems>
        <d2p1:CatalogItem>
          <d2p1:Value>sample string 1</d2p1:Value>
        </d2p1:CatalogItem>
        <d2p1:CatalogItem>
          <d2p1:Value>sample string 1</d2p1:Value>
        </d2p1:CatalogItem>
      </d2p1:CatalogItems>
      <d2p1:DataFieldName>sample string 1</d2p1:DataFieldName>
      <d2p1:DataFieldTypeId>3</d2p1:DataFieldTypeId>
      <d2p1:DataTypeId>2</d2p1:DataTypeId>
      <d2p1:InitializeFromBackend>true</d2p1:InitializeFromBackend>
      <d2p1:IsCatalog>true</d2p1:IsCatalog>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Value>sample string 7</d2p1:Value>
    </d2p1:DynamicFormDataField>
  </DynamicFormInputData>
</GetDynamicFormInputDataResult>