WSConsultarColdStatus - Consulta do status das pesquisas no ColdSearch
O web service WSConsultarColdStatus é responsável por realizar buscas na base de dados de processamento de consultas do e-Cold, passando o protocolo retornado através dos web services WSConsultarCold e WSConsultarColdExclusive e retornando o status do protocolo pesquisado, informando assim a quantidade de documentos encontrados, a quantidade de documentos processados, a percentagem e o tempo restante para o término do processamento.
O método de chamada utilizado por este web service é nomeado ConsultarStatusProtocolo, conforme abaixo observado:
<XML retorno> ConsultarStatusProtocolo(<XML consulta>)
|
O parâmetro XML consulta irá conter o protocolo a ser consultado.
Para efetuar o download do schema xsd clique aqui!
<eformsConsultarColdStatus xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.nddigital.com.br/connector">
<versao></versao>
<protocolo></protocolo>
<autenticacao>
<usuario></usuario>
<senha></senha>
<conexaoid></conexaoid>
</autenticacao>
</eformsConsultarColdStatus>
|
Detalhamento do Schema eformsConsultarColdStatus
|
eformsConsultarColdStatus
|
#
|
Pai
|
Campo
|
Descrição
|
Tipo
|
Obrigatório
|
Ocorrências
|
Tamanho
|
Observações
|
1
|
|
versao
|
Versão do schema.
|
C
|
S
|
1
|
4
|
Versão do schema.
|
2
|
|
protocolo
|
Protocolo da consulta.
|
N
|
S
|
1
|
1..14
|
Protocolo de consulta.
|
3
|
|
autenticacao
|
Autenticação do usuário na base do e-Cold.
|
G
|
S
|
1
|
|
O acesso ao e-Cold fica restrito, portanto, para que se possa consultá-lo é necessário que sejam passadas as informações de acesso e a conexão.
|
4
|
3
|
usuario
|
nome do usuário.
|
C
|
S
|
1
|
1..100
|
Nome do usuário conforme cadastrado na base do e-Forms.
|
5
|
3
|
senha
|
senha do usuário.
|
C
|
S
|
1
|
1..100
|
Senha do usuário conforme cadastrado na base do e-Forms.
|
6
|
3
|
conexaoid
|
Identificador da conexão e-Cold.
|
N
|
S
|
1
|
1..14
|
ID da conexão e-Cold configurada no e-Connector que será consultada cadastrada no sistema.
|
Legenda
|
Item pai
|
Número do item que agrupa este elemento.
|
|
Campo
|
Nome do campo conforme está no schema.
|
|
Descrição
|
Descrição rápida dos campos.
|
|
Tipo
|
Tipo de dado no campo.
|
N = Numérico
C = Alfanumérico
D = Data no formato AAAA-MM-DD HH:MM:SS
G = Grupo que conterá outros elementos filhos
|
Obrigatório
|
Indica se o campo é obrigatório ou não
|
S = Obrigatório
N = Não é obrigatório
|
Ocorrência
|
Indica a quantidade de ocorrências possíveis de determinado elemento
|
1 = Apenas 1 vez
1..N = Pode ser de 1 a vários elementos
0..N = Pode ser de nenhum a vários elementos
|
Tamanho
|
Indica o tamanho aceitável do campo
|
1 = Apenas 1 caractere ou número
1..N = Entre 1 caractere ou número ou vários até o valor final definido
|
Observação
|
Observações adicionais sobre o campo
|
|
|
Visualizar modelo do retorno da chamada
