ConsultarDocumento
O web service de consulta WSConsultarColdSincrono com o método ConsultarDocumento efetua buscas de XML e PDF no e-Cold, porém, apenas um documento de autorização ou evento (NF-e, CT-e, MDF-e) pode ser solicitado à cada requisição. Quando consultados eventos de NF-e, CT-e ou MDF-e, este web service retorna todos os eventos em schemas próprios da NDDigital, separados por tipo do documento, denominados:
•Eventos NF-e: NDDprocEventos_v1.00.xsd;
•Eventos MDF-e: NDDprocEventosMDFe_v1.00.xsd.
•Eventos CT-e: procEventoCTe_v2.00.xsd
Ao realizar a consulta, caso não seja informado as conexões de saída cold, o web service irá localizar uma saída vinculada a chave processada na base de dados do Connector. No caso de documentos importados pelo Cold Importer ou filiais configuradas em um mesmo e-Forms ou Datacenter deve ser obrigatória esta tag para captura da máscara Cold correta
• WSConsultarColdSincrono não retorna PDF de CT-e de entrada na versão 1.04, pois a base do e-Forms não contém a informação necessária para a geração do PDF. • Para um alto desempenho na captura de documento no formato PDF, é aconselhado utilizar o appConnector ColdPDFImporter. Com a utilização do mesmo é necessário adicionar a tag <add key="useColdPdfTable" value="1"/><!--0 - Buscar PDF no COLD, 1 - Buscar PDF na tabela do WS --> no Config.xml normalmente localizado no diretório \\inetpub\\wwwroot\\eForms\\Webs\\WebServices\\Web.config |
▪Com a utilização dessa funcionalidade o PDF do documento retornado poderá ter o acréscimo da carta de correção, caso o evento exista. ▪Em caso de consultas especificas por código de evento solicitando PDF não será utilizado o processamento do appConnector ColdPDFImporter |
Utiliza o método chamado ConsultarDocumento:
<XML retorno> ConsultarDocumento(<XML consulta>)
|
Para efetuar o download do schema xsd clique aqui!
<eformsConsultarColdChaveAcesso 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>
<autenticacao>
<usuario></usuario>
<senha></senha>
<conexaoid></conexaoid>
</autenticacao>
<listaconexoescold>
<autenticacaocold>
<usuario></usuario>
<senha></senha>
<conexaoid></conexaoid>
</autenticacaocold>
</listaconexoescold>
<tiposervico></tiposervico>
<chaveacesso></chaveacesso>
</eformsConsultarColdChaveAcesso>
|
Detalhamento do Schema eformsColdChaveAcesso
|
eformsConsultarColdChaveAcesso
|
#
|
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
|
|
autenticacao
|
Autenticação do usuário na base do e-Cold.
|
G
|
N
|
1
|
|
O acesso ao e-Cold fica restrito, portanto para que possa consultá-lo é necessário que sejam passadas as informações de acesso e a conexão.
|
3
|
2
|
usuario
|
Nome do usuário.
|
C
|
S
|
1
|
1..100
|
Nome do usuário, conforme cadastrado na base do e-Forms.
|
4
|
2
|
senha
|
Senha do usuário.
|
C
|
S
|
1
|
1..100
|
Senha do usuário, conforme cadastrado na base do e-Forms.
|
5
|
2
|
conexaoid
|
Identificador da conexão e-Cold.
|
N
|
S
|
1
|
1..14
|
Identificador dado à conexão e-Cold.
|
6
|
|
listaconexoescold
|
Lista de conexões a base do e-Cold.
|
G
|
N
|
1
|
|
Lista de conexões e-Cold, caso se faça necessário fazer a busca em mais do que uma conexão.
|
7
|
6
|
autenticacaocold
|
Autenticação do usuário na base do e-Cold.
|
G
|
S
|
1..n
|
|
O acesso ao e-Cold fica restrito, portanto para que possa consultá-lo é necessário que sejam passadas as informações de acesso e a conexão.
|
8
|
7
|
usuario
|
Nome do usuário.
|
C
|
S
|
1
|
1..100
|
Nome do usuário, conforme cadastrado na base do e-Forms.
|
9
|
7
|
senha
|
Senha do usuário.
|
C
|
S
|
1
|
1..100
|
Senha do usuário, conforme cadastrado na base do e-Forms.
|
10
|
7
|
conexaoid
|
Identificador da conexão e-Cold.
|
N
|
S
|
1
|
1..14
|
Identificador dado à conexão e-Cold,
|
11
|
|
tiposervico
|
Tipo de serviço.
|
N
|
S
|
1
|
1
|
0 = PDF em Base64;
1 = Status;
2 = Xml Documento;
3 = Xml Autorização;
4 = Xml Documento mais a autorização;
5 = Xml Cancelamento;
6 = Xml Autorização cancelamento;
7 = Xml Cancelamento mais a autorização do cancelamento;
8 = Xml de evento;
9 = Xml de autorização de evento;
10 = Xml de evento mais a autorização.
|
12
|
|
chaveacesso
|
Chave de acesso do documento.
|
C
|
S
|
1
|
44
|
Chave de acesso.
|
13
|
|
marcadagua
|
Indica se o PDF a ser retornado conterá marca d’água para NF-e e CT-e canceladas e MDF-e encerradas
|
N
|
N
|
1
|
1
|
1= Sim
2= Não, ou não informar esta tag na consulta
|
14
|
|
codigoevento
|
Código do evento que será consultado.
|
N
|
N
|
1
|
6
|
Exemplo: 110110, 110111, 210210.
Se a tag 11 <tiposervico> possuir algum dos valores “8”, “9” ou “10”, esta será obrigatória. Obs: Na situação de a tag <tiposervico> estiver com valor "0", só será retornado o evento em PDF caso o <codigoevento> seja 110110.
|
15
|
|
retornarxml
|
Define o tipo de Retorno
|
N
|
N
|
1
|
1
|
Define se o Retorno será em XML ou em Base64.
1 = XML
0 ou Não Informar a tag = Base64
|
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
