POST api/2/Update-file-results

Submits the results for a file that has been processed by the Stop App. All the results are inserted in the database mapped with the file details.

Request Information

URI Parameters

None.

Body Parameters

Contains the bunch of file parse results for a specific file detail. Also contains any error messages etc. generated

UpdateFileResultsModel

Name	Type	Additional information
FileId	integer	None.
FileParseResults	Collection of FileParseResultModel	None.
IsErrored	boolean	None.
ErrorMessage	string	None.
ErrorDetails	string	None.
Pages	integer	None.
SearchablePDFURL	string	None.
SearchablePDFMessage	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FileId": 1,
  "FileParseResults": [
    {
      "FileId": 1,
      "PageNumber": 2,
      "ParsedText": "sample string 3",
      "OverlayJSON": "sample string 4",
      "IsErrored": true,
      "ErrorMessage": "sample string 6",
      "ErrorDetails": "sample string 7",
      "TextOrientation": "sample string 8",
      "ParsedJSON": "sample string 9"
    },
    {
      "FileId": 1,
      "PageNumber": 2,
      "ParsedText": "sample string 3",
      "OverlayJSON": "sample string 4",
      "IsErrored": true,
      "ErrorMessage": "sample string 6",
      "ErrorDetails": "sample string 7",
      "TextOrientation": "sample string 8",
      "ParsedJSON": "sample string 9"
    }
  ],
  "IsErrored": true,
  "ErrorMessage": "sample string 3",
  "ErrorDetails": "sample string 4",
  "Pages": 5,
  "SearchablePDFURL": "sample string 6",
  "SearchablePDFMessage": "sample string 7"
}

application/xml, text/xml

Sample:

<UpdateFileResultsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common">
  <ErrorDetails>sample string 4</ErrorDetails>
  <ErrorMessage>sample string 3</ErrorMessage>
  <FileId>1</FileId>
  <FileParseResults>
    <FileParseResultModel>
      <ErrorDetails>sample string 7</ErrorDetails>
      <ErrorMessage>sample string 6</ErrorMessage>
      <FileId>1</FileId>
      <IsErrored>true</IsErrored>
      <OverlayJSON>sample string 4</OverlayJSON>
      <PageNumber>2</PageNumber>
      <ParsedJSON>sample string 9</ParsedJSON>
      <ParsedText>sample string 3</ParsedText>
      <TextOrientation>sample string 8</TextOrientation>
    </FileParseResultModel>
    <FileParseResultModel>
      <ErrorDetails>sample string 7</ErrorDetails>
      <ErrorMessage>sample string 6</ErrorMessage>
      <FileId>1</FileId>
      <IsErrored>true</IsErrored>
      <OverlayJSON>sample string 4</OverlayJSON>
      <PageNumber>2</PageNumber>
      <ParsedJSON>sample string 9</ParsedJSON>
      <ParsedText>sample string 3</ParsedText>
      <TextOrientation>sample string 8</TextOrientation>
    </FileParseResultModel>
  </FileParseResults>
  <IsErrored>true</IsErrored>
  <Pages>5</Pages>
  <SearchablePDFMessage>sample string 7</SearchablePDFMessage>
  <SearchablePDFURL>sample string 6</SearchablePDFURL>
</UpdateFileResultsModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UpdateFileResultsModel'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.