POST api/ESB/ClassifyDocument

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
documentName	string	None.
documentBase64	string	None.
portfolioId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "documentName": "sample string 1",
  "documentBase64": "sample string 2",
  "portfolioId": 3
}

application/xml, text/xml

Sample:

<ClassifyDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels.ESB">
  <documentBase64>sample string 2</documentBase64>
  <documentName>sample string 1</documentName>
  <portfolioId>3</portfolioId>
</ClassifyDocumentRequest>

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 'ClassifyDocumentRequest'.

Response Information

Resource Description

ClassifyDocumentResponse

Name	Type	Additional information
TaxPinLetter	decimal number	None.
CryptoDeclaration	decimal number	None.
Success	boolean	None.
Messages	Collection of string	None.
ResponseCode	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "TaxPinLetter": 1.1,
  "CryptoDeclaration": 2.1,
  "Success": true,
  "Messages": [
    "sample string 1",
    "sample string 2"
  ],
  "ResponseCode": 4
}

application/xml, text/xml

Sample:

<ClassifyDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MercantileEventHandler.Core.API.AIOCR">
  <CryptoDeclaration>2.1</CryptoDeclaration>
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Messages>
  <ResponseCode>4</ResponseCode>
  <Success>true</Success>
  <TaxPinLetter>1.1</TaxPinLetter>
</ClassifyDocumentResponse>