POST api/ParseForm

Request Information

URI Parameters

None.

Body Parameters

FormRequest
NameDescriptionTypeAdditional information
DocID

string

None.

FileName

string

Required

FileData

string

Required

Request Formats

application/json, text/json

Sample:
{
  "DocID": "sample string 1",
  "FileName": "sample string 2",
  "FileData": "sample string 3"
}

application/xml, text/xml

Sample:
<FormRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParseForm.Models">
  <DocID>sample string 1</DocID>
  <FileData>sample string 3</FileData>
  <FileName>sample string 2</FileName>
</FormRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

FormDataWrapper
NameDescriptionTypeAdditional information
FormDataInfo

FormDataInfo

None.

FormData

Collection of FormData

None.

FormDataTable

Collection of FormDataTable

None.

Response Formats

application/json, text/json

Sample:
{
  "FormDataInfo": {
    "DocId": "sample string 1",
    "ProductType": "sample string 2",
    "FormMapConfigVersion": "sample string 3",
    "FormMapId": "sample string 4",
    "FormError": {
      "ErrorType": "sample string 1",
      "ErrorMessage": "sample string 2"
    }
  },
  "FormData": [
    {
      "AttrTable": "sample string 1",
      "AttrField": "sample string 2",
      "AttrValue": "sample string 3",
      "FormDetailError": {
        "ErrorType": "sample string 1",
        "ErrorMessage": "sample string 2"
      }
    },
    {
      "AttrTable": "sample string 1",
      "AttrField": "sample string 2",
      "AttrValue": "sample string 3",
      "FormDetailError": {
        "ErrorType": "sample string 1",
        "ErrorMessage": "sample string 2"
      }
    }
  ],
  "FormDataTable": [
    {
      "TableName": "sample string 1",
      "TableData": [
        {
          "Field": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Field": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "TableDataErrors": [
        {
          "ErrorType": "sample string 1",
          "ErrorMessage": "sample string 2"
        },
        {
          "ErrorType": "sample string 1",
          "ErrorMessage": "sample string 2"
        }
      ]
    },
    {
      "TableName": "sample string 1",
      "TableData": [
        {
          "Field": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Field": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "TableDataErrors": [
        {
          "ErrorType": "sample string 1",
          "ErrorMessage": "sample string 2"
        },
        {
          "ErrorType": "sample string 1",
          "ErrorMessage": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<FormDataWrapper xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParseForm.Models">
  <FormData>
    <FormData>
      <AttrField>sample string 2</AttrField>
      <AttrTable>sample string 1</AttrTable>
      <AttrValue>sample string 3</AttrValue>
      <FormDetailError>
        <ErrorMessage>sample string 2</ErrorMessage>
        <ErrorType>sample string 1</ErrorType>
      </FormDetailError>
    </FormData>
    <FormData>
      <AttrField>sample string 2</AttrField>
      <AttrTable>sample string 1</AttrTable>
      <AttrValue>sample string 3</AttrValue>
      <FormDetailError>
        <ErrorMessage>sample string 2</ErrorMessage>
        <ErrorType>sample string 1</ErrorType>
      </FormDetailError>
    </FormData>
  </FormData>
  <FormDataInfo>
    <DocId>sample string 1</DocId>
    <FormError>
      <ErrorMessage>sample string 2</ErrorMessage>
      <ErrorType>sample string 1</ErrorType>
    </FormError>
    <FormMapConfigVersion>sample string 3</FormMapConfigVersion>
    <FormMapId>sample string 4</FormMapId>
    <ProductType>sample string 2</ProductType>
  </FormDataInfo>
  <FormDataTable>
    <FormDataTable>
      <TableData>
        <TableData>
          <Field>sample string 1</Field>
          <Value>sample string 2</Value>
        </TableData>
        <TableData>
          <Field>sample string 1</Field>
          <Value>sample string 2</Value>
        </TableData>
      </TableData>
      <TableDataErrors>
        <FormError>
          <ErrorMessage>sample string 2</ErrorMessage>
          <ErrorType>sample string 1</ErrorType>
        </FormError>
        <FormError>
          <ErrorMessage>sample string 2</ErrorMessage>
          <ErrorType>sample string 1</ErrorType>
        </FormError>
      </TableDataErrors>
      <TableName>sample string 1</TableName>
    </FormDataTable>
    <FormDataTable>
      <TableData>
        <TableData>
          <Field>sample string 1</Field>
          <Value>sample string 2</Value>
        </TableData>
        <TableData>
          <Field>sample string 1</Field>
          <Value>sample string 2</Value>
        </TableData>
      </TableData>
      <TableDataErrors>
        <FormError>
          <ErrorMessage>sample string 2</ErrorMessage>
          <ErrorType>sample string 1</ErrorType>
        </FormError>
        <FormError>
          <ErrorMessage>sample string 2</ErrorMessage>
          <ErrorType>sample string 1</ErrorType>
        </FormError>
      </TableDataErrors>
      <TableName>sample string 1</TableName>
    </FormDataTable>
  </FormDataTable>
</FormDataWrapper>