Genpact Cora Knowledge Center

Support

OCR GetStatus

Use the OCR GetStatus call to get the status of an OCR FileBatch process.

Method

POST

URL

https://{Sequence.Server}/SequenceServices/coraOcrIntegration_v1.0.0.asmx

Response Codes

Responses follow standard HTTP Status Codes.

Input Parameters

The MasterWorkflowInstanceId is sent in the SOAP header. The MasterWorkflowInstanceId is the ID of the OCR workflow.

Output Parameters

Name
Type
Description
Status
string
  • Queued
  • ProcessingInput
  • WaitingForOutput
  • Completed
  • Aborted
  • Failed
  • NotFound
ErrorCode
string
  • NoError
  • TimedOut
  • InputFileNotFound
  • InputFileExists
  • FailedToPutInputFile
  • OutputFileExists
  • FailedToPutOutputFile
  • RobotProfileNotFound
  • InternalError
ExternalContextstringAdditional process information.

SOAP 1.1 Sample

Request

POST /SequenceServices/coraOcrIntegration_v1.0.0.asmx HTTP/1.1
Host: admindev.pnmsoftlabs.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://genpact.com/cora/orchestration/ocr/1.0.0/api/GetStatus"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ActivityMetadata xmlns="http://genpact.com/cora/orchestration/ocr/1.0.0/api/">
      <WorkflowSpaceId>guid</WorkflowSpaceId>
      <WorkflowSpaceName>string</WorkflowSpaceName>
      <WorkflowId>guid</WorkflowId>
      <WorkflowName>string</WorkflowName>
      <WorkflowInstanceId>long</WorkflowInstanceId>
      <ActivityId>guid</ActivityId>
      <ActivityName>string</ActivityName>
      <ActivityInstanceId>long</ActivityInstanceId>
      <CallerId>int</CallerId>
      <MasterWorkflowInstanceId>long</MasterWorkflowInstanceId>
    </ActivityMetadata>
  </soap:Header>
  <soap:Body>
    <GetStatus xmlns="http://genpact.com/cora/orchestration/ocr/1.0.0/api/" />
  </soap:Body>
</soap:Envelope>

Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetStatusResponse xmlns="http://genpact.com/cora/orchestration/ocr/1.0.0/api/">
      <Output>
        <Status>Queued or ProcessingInput or WaitingForOutput or Completed or Aborted or Failed or NotFound</Status>
        <ErrorCode>NoError or TimedOut or InputFileNotFound or InputFileExists or FailedToPutInputFile or OutputFileExists or FailedToPutOutputFile or RobotProfileNotFound or InternalError</ErrorCode>
        <ExternalContext>string</ExternalContext>
      </Output>
    </GetStatusResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2 Sample

Request

POST /SequenceServices/coraOcrIntegration_v1.0.0.asmx HTTP/1.1
Host: admindev.pnmsoftlabs.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <ActivityMetadata xmlns="http://genpact.com/cora/orchestration/ocr/1.0.0/api/">
      <WorkflowSpaceId>guid</WorkflowSpaceId>
      <WorkflowSpaceName>string</WorkflowSpaceName>
      <WorkflowId>guid</WorkflowId>
      <WorkflowName>string</WorkflowName>
      <WorkflowInstanceId>long</WorkflowInstanceId>
      <ActivityId>guid</ActivityId>
      <ActivityName>string</ActivityName>
      <ActivityInstanceId>long</ActivityInstanceId>
      <CallerId>int</CallerId>
      <MasterWorkflowInstanceId>long</MasterWorkflowInstanceId>
    </ActivityMetadata>
  </soap12:Header>
  <soap12:Body>
    <GetStatus xmlns="http://genpact.com/cora/orchestration/ocr/1.0.0/api/" />
  </soap12:Body>
</soap12:Envelope>

Return

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length 

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetStatusResponse xmlns="http://genpact.com/cora/orchestration/ocr/1.0.0/api/">
      <Output>
        <Status>Queued or ProcessingInput or WaitingForOutput or Completed or Aborted or Failed or NotFound</Status>
        <ErrorCode>NoError or TimedOut or InputFileNotFound or InputFileExists or FailedToPutInputFile or OutputFileExists or FailedToPutOutputFile or RobotProfileNotFound or InternalError</ErrorCode>
        <ExternalContext>string</ExternalContext>
      </Output>
    </GetStatusResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP Sample

HTTP GET

GET /SequenceServices/coraOcrIntegration_v1.0.0.asmx/GetStatus? HTTP/1.1
Host: admindev.pnmsoftlabs.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<BatchOutput xmlns="http://genpact.com/cora/orchestration/ocr/1.0.0/api/">
  <Status>Queued or ProcessingInput or WaitingForOutput or Completed or Aborted or Failed or NotFound</Status>
  <ErrorCode>NoError or TimedOut or InputFileNotFound or InputFileExists or FailedToPutInputFile or OutputFileExists or FailedToPutOutputFile or RobotProfileNotFound or InternalError</ErrorCode>
  <ExternalContext>string</ExternalContext>
</BatchOutput>

HTTP POST

POST /SequenceServices/coraOCrIntegration_v1.0.0.asmx/GetStatus HTTP/1.1
Host: admindev.pnmsoftlabs.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<BatchOutput xmlns="http://genpact.com/cora/orchestration/ocr/1.0.0/api/">
  <Status>Queued or ProcessingInput or WaitingForOutput or Completed or Aborted or Failed or NotFound</Status>
  <ErrorCode>NoError or TimedOut or InputFileNotFound or InputFileExists or FailedToPutInputFile or OutputFileExists or FailedToPutOutputFile or RobotProfileNotFound or InternalError</ErrorCode>
  <ExternalContext>string</ExternalContext>
</BatchOutput>