WebService Object (Web Services API)
This object allows you to exchange XML-based messages with ABBYY FineReader Server to process recognition jobs.
Methods
Name | Description |
GetVersion | Returns information about the current version of ABBYY FineReader Server. |
GetReleaseVersion | Returns information about the current version of the Web Services API. |
GetWorkflows |
Returns a set of available workflow names on the FineReader Server with specified location. Note. Only workflow names with the following types of Input Folder are available: shared folder, FTP folder. |
GetWorkflowsSettings |
Returns set of available workflow settings: the workflow name, the paths to the Input folder and the Exception folder, and the export parameters on the FineReader Server with specified location. Note. Only workflow settings with the following types of Input Folder are available: shared folder, FTP folder. |
ProcessFile | Uses the parameters of the specified workflow to recognize the specified input image in synchronous mode. |
StartProcessFile | Uses the parameters of the specified workflow to recognize the specified input image in asynchronous mode. |
CreateTicket | Creates an XmlTicket object based on the specified workflow. |
ProcessTicket | Uses the parameters of the XmlTicket object and the specified workflow to recognize the input image in synchronous mode. |
StartProcessTicket | Uses the parameters of the XmlTicket object and the specified workflow to recognize the input image in asynchronous mode. |
GetJobState | Returns the state of the specified job. |
GetJobStateInfo | Returns information about the state of the specified job and percent completed. |
GetJobResult | Returns the XML-result of a successfully completed or failed job that was started before in asynchronous mode via the StartProcessFile or StartProcessTicket method. |
GetJobResultEx | Returns the XML-result ofa successfully completed or failed job that was started before in asynchronous mode via the StartProcessFile or StartProcessTicket method with the ability to set up the behavior of the method. |
GetOutputFormat | Returns the default settings for the specified output format. |
GetOutputFormats | Returns a list of available output formats and their default settings. |
GetJobStateInfos | Returns the state of the specified jobs. |
DeleteJob | Completely deletes the specified job. |
DeleteJobs | Completely deletes the specified jobs. |
See also
26.03.2024 13:49:49