Capítulo44

Serviço pesquisarAdiantamento

44.1 - Requisição

O serviço pesquisarAdiantamento realiza uma busca pelos adiantamentos, é possível realizar busca por datas finais e iniciais, registro inicial e quantidade de registros, fazendo assim o sistema realizar uma busca referente ao adiantamento no banco de dados.

Obs.: Para que haja qualquer interação com o sistema de Webservice e necessário informar o cabeçalho de autenticação. Vide cabeçalho de Autenticação.

Descrição dos campos de pesquisarAdiantamento

Tag

Descrição

Parent

Formato

Required

dataInicial

Data inicial do periodo no qual será realizada a busca

pesquisarAdiantamento

XMLGregorianCalendar

True

dataFinal

Data final do periodo no qual será realizada a busca

pesquisarAdiantamento

XMLGregorianCalendar

True

registroInicial

Primeiro registro relevante para a busca

pesquisarAdiantamento

String

True

quantidadeRegistros

Quantidade de registros que o serviço pode retornar por consulta *retorno maximo 50 registros

pesquisarAdiantamento

Inteiro

True

status

Adiantamento ativo?

pesquisarAdiantamento

Enum

False


44.2 - Exemplo

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ser="http://lemontech.com.br/selfbooking/wsselfbooking/services">
   <soapenv:Header>
      <ser:userPassword>senha</ser:userPassword>
      <ser:userName>usuário</ser:userName>
      <ser:keyClient>chave_da_empresa_cliente</ser:keyClient>
   </soapenv:Header>
   <soapenv:Body>
      <ser:pesquisarAdiantamento>
         <dataInicial>?</dataInicial>
         <dataFinal>?</dataFinal>
         <registroInicial>?</registroInicial>
         <!--Optional:-->
         <quantidadeRegistros>50</quantidadeRegistros>
         <!--Optional:-->
         <status>PENDENTE</status>
      </ser:pesquisarAdiantamento>
   </soapenv:Body>
</soapenv:Envelope>

44.3 - Resposta

A resposta do serviço é enviada com a tag PesquisarAdiantamentoResponse informando "Sucesso", caso a pesquisa seja efetuada corretamente, "Erro", caso ocorra algum problema com a pesquisa e "Alerta" caso ocorra algum problema não-crítico na pesquisa.

Descrição dos campos de PesquisarAdiantamentoResponse

Tag

Descrição

Parent

Formato

resultadoAcao

Informa: SUCESSO, ERRO ou ALERTA

PesquisarAdiantamentoResponse

resultadoAcao

numeroSolicitacoes

Informa o número de solicitacoes que a pesquisa retornou

PesquisarAdiantamentoResponse

Inteiro

solicitacao

Resultado da pesquisa

PesquisarAdiantamentoResponse

Solicitacao

mensagemRetorno

Mensagem que descreve o resultado da ação retornada

PesquisarAdiantamentoResponse

String

Descrição do campo ResultadoOperacao

Tag

Descrição

Parent

Formato

status

Se PENDENTE a pesquisa está sendo efetuada

Se LIBERADO a pesquisa foi efetuada

Se CANCELADO ocorreu algum problema crítico na pesquisa

resultadoOperacao

Enum


44.4 - Exemplo

<S:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ser="http://lemontech.com.br/selfbooking/wsselfbooking/services">
   <SOAP-ENV:Header/>
   <S:Body>
      <ns2:pesquisarAdiantamentoResponse>
         <resultadoOperacao>
            <status>SUCESSO</status>
         </resultadoOperacao>
      </ns2:pesquisarAdiantamentoResponse>
   </S:Body>
</S:Envelope>