Web service Com.senior.g5.co.int.geral.relatorio

Tipo de execução

Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.

Autenticação

Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificar o tipo no parâmetro <encryption>, conforme seus valores possíveis.

Campos numéricos

Orientação válida para qualquer campo de web service que possui objetivo de receber valores, independentemente do seu tipo ser Integer, Double e String. Estas orientações devem ser seguidas nas requisições efetuadas via SOAP e em execuções efetuadas através do SGI, relatórios e regras LSP.

Campos que representam valores monetários, quantidade e percentual e estão declarados como String
  • Envio no formato ZZZZ,ZZ
  • É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
  • Obrigatória a utilização do separador decimal com vírgula, e não com ponto
  • Obrigatória a utilização do zero a direita. Por exemplo, se o valor for 350,20, a requisição deve ser enviada com este exato valor. Se o valor enviado for enviado como 350,2, o sistema não irá interpretar a requisição adequadamente
Exemplo:

number(005,2) = 350,20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;

number(015,2): 35000,20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;

number(008,4) = 3200,2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.

Campos que representam valores monetários, quantidade e percentual e não estão declarados como String
  • Envio no formato ZZZZ.ZZ
  • É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
  • Obrigatória a utilização do separador decimal com ponto, e não com vírgula
Exemplo:
  • number(005,2) = 350.20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
  • number(015,2): 35000.20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
  • number(008,4) = 3200.2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.

WSDL

Portas

IniciarGeracao

Integrações - Geral - Relatórios - Inicia Geração

**Necessita autenticação:**Sim

Situação de versão: Atual

**Versão:**1

Requisição:

<soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br"> <soapenv:Body> <ser:IniciarGeracao> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <sigInt>String</sigInt> </parameters> </ser:IniciarGeracao> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

sigInt

Opcional

String

(Obrigatório) - String(15) - Sigla do Sistema de Integração

Resposta:
Observação

Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada “result” com o valor “OK”, se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.

<soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br"> <soapenv:Body> <ser:IniciarGeracaoResponse> <result> <mensagemRetorno>String</mensagemRetorno> <seqRel>Integer</seqRel> <erroExecucao>String</erroExecucao> </result> </ser:IniciarGeracaoResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

erroExecucao

Opcional

String

  • Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:
    • Vazio ou nulo, indicando que a execução foi feita com sucesso
    • A mensagem do erro ocorrido no servidor
  • Só impede a gravação quando o retorno.tipRet for igual a “2”

mensagemRetorno

Opcional

String

(Obrigatório) - String(1000) - Mensagem de Retorno de Processamento

seqRel

Opcional

Integer

(Obrigatório) - Number(013) - Sequência do Relatório

ObterSituacao

Integrações - Geral - Relatórios - Obter Situação

**Necessita autenticação:**Sim

Situação de versão: Atual

**Versão:**1

Requisição:

<soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br"> <soapenv:Body> <ser:ObterSituacao> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <seqRel>Integer</seqRel> <sigInt>String</sigInt> </parameters> </ser:ObterSituacao> </soapenv:Body> </soapenv:Envelope>

Parâmetros da requisição:

Nome

Preenchimento

Tipo

Descrição

seqRel

Opcional

Integer

(Obrigatório) - Number(013) - Sequência do relatório. Código único gerado para controle da geração de relatórios.

sigInt

Opcional

String

(Obrigatório) - String(15) - Sigla do Sistema de Integração

Resposta:
Observação

Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada “result” com o valor “OK”, se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.

<soapenv:Envelope xmlns:soapenv=“http://schemas.xmlsoap.org/soap/envelope/” xmlns:ser=“http://services.senior.com.br"> <soapenv:Body> <ser:ObterSituacaoResponse> <result> <mensagemRetorno>String</mensagemRetorno> <sitCgr>String</sitCgr> <urlRel>String</urlRel> <erroExecucao>String</erroExecucao> </result> </ser:ObterSituacaoResponse> </soapenv:Body> </soapenv:Envelope>

Atributos da resposta:

Nome

Preenchimento

Tipo

Descrição

erroExecucao

Opcional

String

  • Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:
    • Vazio ou nulo, indicando que a execução foi feita com sucesso
    • A mensagem do erro ocorrido no servidor
  • Só impede a gravação quando o retorno.tipRet for igual a “2”

mensagemRetorno

Opcional

String

(Obrigatório) - String(1000) - Mensagem de Retorno de Processamento

sitCgr

Opcional

String

(Obrigatório) - Char(001) - Situação do relatório. P (pendente), E (em processamento) e F (finalizado).

urlRel

Opcional

String

(Opcional) - String(255) - URL para o sistema terceiro efetuar download.

Este artigo ajudou você?