POST api/ESB/GetOCRData

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
transactionId		string	None.

Request Formats

application/json, text/json

Sample:

{
  "transactionId": "sample string 1"
}

application/xml, text/xml

Sample:

<GetOcrDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels.ESB">
  <transactionId>sample string 1</transactionId>
</GetOcrDataRequest>

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

Response Information

Resource Description

GetOcrDataResponse

Name	Type	Additional information
success	boolean	None.
message	string	None.
transactionId	string	None.
taxPinLetters	Collection of TaxPinInfo	None.
cryptoDeclarations	Collection of CryptoDeclarationInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "message": "sample string 2",
  "transactionId": "sample string 3",
  "taxPinLetters": [
    {
      "documentName": "sample string 1",
      "name": "sample string 2",
      "pin": "sample string 3",
      "pinExpiryDate": "sample string 4",
      "purposeOfRequest": "sample string 5",
      "submissionDate": "sample string 6",
      "taxReferenceNumber": "sample string 7"
    },
    {
      "documentName": "sample string 1",
      "name": "sample string 2",
      "pin": "sample string 3",
      "pinExpiryDate": "sample string 4",
      "purposeOfRequest": "sample string 5",
      "submissionDate": "sample string 6",
      "taxReferenceNumber": "sample string 7"
    }
  ],
  "cryptoDeclarations": [
    {
      "documentName": "sample string 1",
      "calendarYear": "sample string 2",
      "date": "sample string 3",
      "iDNumber": "sample string 4",
      "nameSurname": "sample string 5",
      "signature": true
    },
    {
      "documentName": "sample string 1",
      "calendarYear": "sample string 2",
      "date": "sample string 3",
      "iDNumber": "sample string 4",
      "nameSurname": "sample string 5",
      "signature": true
    }
  ]
}

application/xml, text/xml

Sample:

<GetOcrDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MercantileEventHandler.ViewModels.ESB">
  <cryptoDeclarations>
    <GetOcrDataResponse.CryptoDeclarationInfo>
      <calendarYear>sample string 2</calendarYear>
      <date>sample string 3</date>
      <documentName>sample string 1</documentName>
      <iDNumber>sample string 4</iDNumber>
      <nameSurname>sample string 5</nameSurname>
      <signature>true</signature>
    </GetOcrDataResponse.CryptoDeclarationInfo>
    <GetOcrDataResponse.CryptoDeclarationInfo>
      <calendarYear>sample string 2</calendarYear>
      <date>sample string 3</date>
      <documentName>sample string 1</documentName>
      <iDNumber>sample string 4</iDNumber>
      <nameSurname>sample string 5</nameSurname>
      <signature>true</signature>
    </GetOcrDataResponse.CryptoDeclarationInfo>
  </cryptoDeclarations>
  <message>sample string 2</message>
  <success>true</success>
  <taxPinLetters>
    <GetOcrDataResponse.TaxPinInfo>
      <documentName>sample string 1</documentName>
      <name>sample string 2</name>
      <pin>sample string 3</pin>
      <pinExpiryDate>sample string 4</pinExpiryDate>
      <purposeOfRequest>sample string 5</purposeOfRequest>
      <submissionDate>sample string 6</submissionDate>
      <taxReferenceNumber>sample string 7</taxReferenceNumber>
    </GetOcrDataResponse.TaxPinInfo>
    <GetOcrDataResponse.TaxPinInfo>
      <documentName>sample string 1</documentName>
      <name>sample string 2</name>
      <pin>sample string 3</pin>
      <pinExpiryDate>sample string 4</pinExpiryDate>
      <purposeOfRequest>sample string 5</purposeOfRequest>
      <submissionDate>sample string 6</submissionDate>
      <taxReferenceNumber>sample string 7</taxReferenceNumber>
    </GetOcrDataResponse.TaxPinInfo>
  </taxPinLetters>
  <transactionId>sample string 3</transactionId>
</GetOcrDataResponse>