getBatches
Classe Java | |
---|---|
Requisição | web/wwwroot/ws/java/capture/GetBatchesRequestType.java |
Retorno | web/wwwroot/ws/java/capture/GetBatchesResponseType.java |
Este método possibilita a pesquisa de lotes de captura.
Requisição:
Identificador | Requerido | Descrição |
---|---|---|
CaptureSettingID | Identificador da configuração da captura | |
BatchID | Identificador do lote | |
BatchName | Título do lote | |
BatchStep | Etapa do lote: ▪ 1 - Captura; ▪ 2 - Controle de qualidade; ▪ 3 - Separação de documentos; ▪ 4 - Reconhecimento; ▪ 5 - Validação; ▪ 6 - Digitação; ▪ 7 - Relacionamento; ▪ 8 - Verificação; ▪ 9 - Indexação; ▪ 10 - Finalizado; ▪ 11 - Cancelado. | |
BeginInsertDate | Início da data de cadastro (formato: aaaa-mm-dd) | |
EndInsertDate | Fim da data de cadastro (formato: aaaa-mm-dd) | |
CreatorUserID | Matrícula do usuário de cadastro |
Estrutura da requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:capture">
<soapenv:Header/>
<soapenv:Body>
<urn:getBatches>
<!--You may enter the following 7 items in any order-->
<urn:CaptureSettingID>?</urn:CaptureSettingID>
<urn:BatchID>?</urn:BatchID>
<urn:BatchName>?</urn:BatchName>
<urn:BatchStep>?</urn:BatchStep>
<urn:BeginInsertDate>?</urn:BeginInsertDate>
<urn:EndInsertDate>?</urn:EndInsertDate>
<urn:CreatorUserID>?</urn:CreatorUserID>
</urn:getBatches>
</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 (registro criado com sucesso); ▪ 1 - Configuração de captura inexistente; ▪ 2 - Usuário de cadastro inexistente; ▪ 3 - Data de fim menor que a data de início; ▪ 4 - Valor inválido; |
Detail | Mensagem detalhando o erro ou sucesso na execução do método |
Records | Resultado da pesquisa: • Batches: Lista de lotes o CaptureSettingID: Identificador da configuração de captura; o BatchID: Identificador do lote; o BatchName: Título do lote; o StartDate: Data de início (formato: aaaa-mm-dd); o FinishDate: Data de fim (formato: aaaa-mm-dd); o FileCount: Quantidade de arquivos; o BatchStep: Etapa do lote: ▪ 1 - Captura; ▪ 2 - Controle de qualidade; ▪ 3 - Separação de documentos; ▪ 4 - Reconhecimento; ▪ 5 - Validação; ▪ 6 - Digitação; ▪ 7 - Relacionamento; ▪ 8 - Verificação; ▪ 9 - Indexação; ▪ 10 - Finalizado; ▪ 11 - Cancelado. |