getBatchData
Este método possibilita a consulta de todos os dados de um lote de captura.
| Classe Java | |
|---|---|
| Requisição | web/wwwroot/ws/java/capture/GetBatchDataRequestType.java |
| Retorno | web/wwwroot/ws/java/capture/GetBatchDataResponseType.java |
Requisição:
| Identificador | Requerido | Descrição |
|---|---|---|
| BatchID | X | Identificador do lote |
Estrutura da requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:capture">
<soapenv:Header/>
<soapenv:Body>
<urn:getBatchData>
<urn:BatchID>?</urn:BatchID>
</urn:getBatchData>
</soapenv:Body>
</soapenv:Envelope>
Retorno:
| Identificador | Descrição |
|---|---|
| Status | FAILURE (em caso de falha) SUCCESS (em caso de sucesso) |
| Code | Código do erro: • 0 - Nenhum erro (consulta realizada com sucesso); • 1 - Lote inexistente; • 2 - Este usuário não possui permissão para esta operação. |
| Detail | Mensagem detalhando o erro ou sucesso na execução do método |
| BatchData | Dados do lote consultado: • CaptureSettingID: Identificador da configuração de captura; • BatchID: Identificador do lote; • BatchName: Título do lote; • StartDate: Data de início (formato: aaaa-mm-dd); • FinishDate: Data de fim (formato: aaaa-mm-dd); • FileCount: Quantidade de arquivos; • BatchStep: Etapa do lote: o 1 - Captura o 2 - Controle de qualidade o 3 - Separação de documentos o 4 - Reconhecimento o 5 - Validação o 6 - Digitação o 7 - Relacionamento o 8 - Verificação o 9 - Indexação o 10 - Finalizado o 11 - Cancelado • BatchDocuments: Documentos do lote o DocumentCode: Código do documento; o CategoryID: Identificador da categoria; o DocumentID: Identificador do documento; o DocumentTitle: Título do documento; o FileCount: Quantidade de arquivos no documento; o DocumentIndexes: Índices do documento: ▪ IndexName: Nome do índice; ▪ IndexValue: Valor do índice; o DocumentFiles: ▪ FileCode: Código do arquivo; ▪ FileName: Nome do arquivo; ▪ FileSize: Tamanho do arquivo; ▪ FileURL: URL para download do arquivo; ▪ FileIsBlank: Arquivo em branco: 1 - Sim; 2 - Não; ▪ FileIsInvalid: Arquivo inválido: 1 - Sim; 2 - Não; •BatchFiles: Arquivos do lote: o FileCode: Código do arquivo; o FileName: Nome do arquivo; o FileSize: Tamanho do arquivo; o FileURL: URL para download do arquivo; o FileIsBlank: Arquivo em branco: 1 - Sim; 2 - Não; o FileIsInvalid: Arquivo inválido: 1 - Sim; 2 - Não; |