WSRetornarDocumentosCold - Retorno dos documentos consultados no e-Cold
Este web service denominado por WSRetornarDocumentosCold, retorna os documentos pesquisados através dos web services WSConsultarCold e WSConsultarColdExclusive. Utiliza o método RetornarDocumentos para a realização das chamadas, como exposto abaixo:
<XML retorno> RetornarDocumentos(<XML consulta>)
|
Para efetuar o download do schema xsd clique aqui!
<eformsColdDocumento 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>
<protocolo></protocolo>
<tiporetorno></tiporetorno>
<protocoloretorno></protocoloretorno>
<totaldocumentos></totaldocumentos>
</eformsColdDocumento>
|
Detalhamento do Schema eformsColdDocumento
|
eformsColdDocumento
|
#
|
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
|
S
|
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
|
ID da conexão e-Cold configurada no e-Connector que será consultada,
|
6
|
|
protocolo
|
Protocolo da consulta.
|
N
|
S
|
1
|
1..14
|
Protocolo de consulta.
|
7
|
|
retornarChave
|
Retorna chave do documento
|
N
|
N
|
1
|
1
|
1 = Será retornado a chave do documento no XML de retorno
2 = Não será retornado a chave do documento no XML de retorno
|
8
|
|
tiporetorno
|
Tipo de retorno desejado.
|
N
|
N
|
1
|
1
|
1 = Documento XML;
2 = PDF.
Se não for informado o padrão utilizado é 1.
|
9
|
|
protocoloretorno
|
Protocolo a partir de qual elemento deverá ser retornado.
|
N
|
N
|
1
|
1..14
|
Este protocolo faz a conexão entre os documentos que deverão ser retornados. Por exemplo, em uma base de 1000 documentos pesquisados ele deverá retorná-los de 50 em 50, sendo assim, o protocolo de retorno conterá sempre o próximo documento inicial a ser retornado pelo bloco de consulta.
|
10
|
|
totaldocumentos
|
Total de documentos a serem retornados.
|
N
|
N
|
1
|
1..2
|
No máximo serão retornados 50 documentos, porém a quantidade entre 1 e 50 variável.
|
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