| OCR SOAP API Developer's Guide | |
|
OCR Web Service SOAP API can be easily consumed by any programming languages or applications that accept web services integration. In this section, examples are shown for the following technologies.
Sample codes available here:
| |
|
Here you can find the description of SOAP API method:
| SOAP Service Function |
OCRWebServiceRecognize |
| WSDL location |
www.ocrwebservice.com/services/OCRWebService.asmx?WSDL |
| Service Endpoint |
www.ocrwebservice.com/services/OCRWebService.asmx |
| Method |
public
OCRWSResponse OCRWebServiceRecognize (
string user_name,
string license_code,
OCRWSInputImage input_image,
OCRWSSettings ocr_settings)
| | |
|
Input parameters:
| OCRWSInputImage |
| Parameter |
Type |
Description |
| fileName |
string |
Name of the uploaded file |
| fileData |
byte [] |
Data to upload |
| |
|
| OCRWSSettings |
| Parameter |
Type |
Description |
| ocrLanguages |
Language[] |
Specifies the recognition languages |
| outDocumentFormat |
OutputFormat[] |
Specifies the output file format |
| convertToBW |
bool |
Convert image to Black and White (recommend for color image and photo) |
| getOCRText |
bool |
If it is True the OCRed text will be returned |
| createOutDocument |
bool |
If it is True the output document will be created |
| ocrZones |
OCRZone[] |
Specifies blocks on the image for zonal OCR |
| multiPageDoc |
bool |
If it is TRUE the multipage document will be recognized. |
| pageNumbers |
string |
Enter page numbers and/or page ranges separated by commas. For example "1,3,5-12", "all pages" - all pages will be recognized. |
| ocrWords |
bool |
If it is TRUE the recognized word`s coordinates will be returned |
| Reserved |
string |
If it is "newline=1" the extracted text will be returned with new line (\n) character |
| |
|
Return value:
| OCRWSResponse |
| Parameter |
Type |
Description |
| ocrText |
string [][] |
Two dimension array that contains extracted text from each zone and page. OCRedText[z][p]: z-zone, p-pages |
| fileName |
string |
Contains tha output document name |
| fileData |
byte [] |
Contains the output document |
| ocrWSWords |
OCRWSWord [] |
Contains the output word coordinates |
| errorMessage |
string |
Error message if an error occured |
| AvailablePages |
string |
Available pages for the current subscription plan |
| ProcessedPages |
string |
The number of pages processed for the last task |
| |