WSConsultarStatusEvento - Consulta ao status dos eventos na base do e-Forms
As consultas de status dos eventos vinculados aos documentos, são realizadas pelo web service WSConsultarStatusEvento. Os status podem ser consultados pela chave de acesso ou através do protocolo de consulta. Caso seja usado o protocolo de consulta, o produto irá efetuar, primeiramente, uma pesquisa na base de protocolos de processamento para buscar as notas processadas e posteriormente, na base do e-Forms, assim como o WSConsultarStatus citado no item anterior.
É possível pesquisar eventos específicos para cada documento, filtrando-os por seu tipo, por exemplo: 110110 ou 110111, conforme informado no item 8 do detalhamento do schema.
O método utilizado na chamada deste web service é nomeado ConsultarStatus, como observa-se a seguir:
<XML retorno> ConsultarStatus(<XML consulta>)
|
Para efetuar o download do schema xsd clique aqui!
<eformsConsultarStatus 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>
<listaconsulta>
<consulta>
<chaveprotocolo>
<chaveacesso></chaveacesso>
</chaveprotocolo>
<statusatual></statusatual>
<codigoevento></codigoevento>
</consulta>
</listaconsulta>
</eformsConsultarStatus>
|
Detalhamento do schema eformsConsultarStatus
|
eformsConsultarStatus
|
#
|
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
|
|
listaconsulta
|
Lista de protocolos ou chaves de acesso que poderão ser consultadas.
|
G
|
S
|
1
|
|
|
3
|
2
|
consulta
|
Coleção de protocolos/chaves que poderão ser consultadas.
|
G
|
S
|
1..N
|
|
|
4
|
3
|
chaveprotocolo
|
Chave ou protocolo.
|
G
|
S
|
1
|
|
Este grupo somente poderá ter um protocolo ou uma chave de acesso.
|
5
|
4
|
chaveacesso
|
Chave de acesso a ser consultada.
|
C
|
S
|
1
|
44
|
|
6
|
4
|
protocolo
|
Protocolo de consulta.
|
N
|
S
|
1
|
1..14
|
A consulta quando realizada pelo protocolo, permite que sejam retornados todos os status referentes às chaves de acesso que foram processadas com o protocolo pesquisado.
|
7
|
3
|
statusatual
|
Status atual ou não.
|
N
|
N
|
1
|
1
|
1 = somente o status atual do documento constante na base de processamento;
2 = todos os status do documento durante o tempo de vida do mesmo na base de processamento.
OBS: Caso a tag não seja informada, o valor assumido será 1
|
8
|
3
|
codigoevento
|
Tipo do evento a ser pesquisado. Funcionalidade disponível apenas para o web service: WSConsultarStatusEvento.
|
N
|
S
|
1
|
1
|
Código do evento, por exemplo: 110110. 110111, 110115.
|
 Legenda do schema Web Services
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
|
|
|
Como retorno será apresentado uma lista das informações sobre os eventos encontrados na pesquisa, conforme os filtros enviados.
Visualizar modelo do retorno da chamada