Web service Com.senior.g5.co.ger.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.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- 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
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- 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
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- 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.
Importante
Ao utilizar este web service para realizar o envio de e-mail, sempre será utilizada as configurações do SeniorConfigCenter.
WSDL
- Síncrono: http://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_ger_relatorio?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_ger_relatorio?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_ger_relatorio?wsdl
Portas
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Necessita autenticação: sim.
Situação de versão: atual.
Versão: 1.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Executar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <prPrintDest>String</prPrintDest> <prRemetente>String</prRemetente> <prDir>String</prDir> <prExecFmt>String</prExecFmt> <prDest>String</prDest> <prFileName>String</prFileName> <prRelatorio>String</prRelatorio> <prCC>String</prCC> <prFileExt>String</prFileExt> <prEntrada>String</prEntrada> <prCCo>String</prCCo> <prUniqueFile>String</prUniqueFile> <prOrder>String</prOrder> <prAssunto>String</prAssunto> <prTypeBmp>String</prTypeBmp> <prRetorno>Blob</prRetorno> <prMensagem>String</prMensagem> <prFileLayout>String</prFileLayout> <prLOG>String</prLOG> <prAnexoBool>String</prAnexoBool> <prLayoutEXCEL>String</prLayoutEXCEL> <prLayoutSAGA>String</prLayoutSAGA> <prSaveFormat>String</prSaveFormat> <prEntranceIsXML>String</prEntranceIsXML> </parameters> </ser:Executar> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Tipo | Descrição |
---|---|---|
prPrintDest | String | Indica qual impressora será utilizada. Utilizar com o formato de saída: tefPrint |
prRemetente | String | Indica o remetente do e-mail. Utilizar com o formato de saída: tefMail |
prDir | String | Diretório em que será salvo o arquivo. |
prExecFmt | String | Indica qual será o tipo de saída do modelo. Valores possíveis:
|
prDest | String | Indica o destinatário do e-mail. Utilizar com o formato de saída: tefMail |
prFileName | String | Nome do arquivo que será gerado. Caso o nome possua pontos, é necessário incluir a extensão do arquivo ao nome. Por exemplo, um arquivo no formato PDF com o nome ponto.no.nome, deverá ser informado da seguinte maneira: ponto.no.nome.PDF. |
prRelatorio | String | Nome do modelo (arquivo) que será utilizado para a execução do relatório. |
prCC | String | Indica o endereço para cópia do e-mail. Utilizar com o formato de saída: tefMail |
prFileExt | String | Indica a extensão do arquivo, este parâmetro não é obrigatório para execução via regra. Utilizar com o formato de saída: tefFile. |
prEntrada | String | Parâmetros de entrada do relatório. Este parâmetro do serviço deve seguir a formatação adequada conforme o tipo de execução. Para as regras LSP, não é recomendável que a tag XML <![CDATA[]]> seja utilizada para passagem de valores nos parâmetros de entrada. Pois, a sua utilização pode causar comportamentos indesejados, como por exemplo, a perda de dados. |
prCCo | String | Indica o endereço de cópia oculta do e-mail. Utilizar com o formato de saída: tefMail |
prUniqueFile | String | Indica se imagens serão geradas como uma imagem única. Valores possíveis:
|
prOrder | String | Define a ordenação que será utilizada na geração do relatório. Este parâmetro não está disponível para ser utilizado através da execução do web service via regra ou através da chamada via sistema de terceiros (síncrono ou assíncrono). Este parâmetro é utilizado apenas internamente para execução de um relatório, como, por exemplo, ao clicar no botão Imprimir de uma rotina específica, em que é possível determinar a ordenação do relatório na passagem dos parâmetros no código-fonte da rotina. |
prAssunto | String | Assunto do e-mail. Utilizar com o formato de saída: tefMail |
prTypeBmp | String | Indica se o tipo da imagem será Bitmap |
prRetorno | Blob | Campo Blob para armazenamento do relatório. |
prMensagem | String | Texto da Mensagem do e-mail. Utilizar com o formato de saída: tefMail. Para que seja feito envio do e-mail do relatório no formato HTML, sem quebra, acesse Central de Configurações Senior > Conexões de rede > Envio de e-mail e habilite as opções Utilizar SSL, Usar STARTTLS e o comando de inicialização EHLO. |
prFileLayout | String | Indica o layout do arquivo. |
prLOG | String | Indica o log do relatório. |
prAnexoBool | String | Indica se o relatório será enviado como anexo ou corpo de mensagem:
|
prLayoutEXCEL | String | Layout utilizado quando o formato de saída for Excel. |
prLayoutSAGA | String | Layout utilizado quando o formato de saída for Saga. |
prSaveFormat | String |
Indica o formato do arquivo salvo em arquivo. Valores possíveis:
|
prEntranceIsXML | String | Indica se o parâmetro de entrada será na formatação XML (uso interno do sistema) ou na formatação aberta para regra. Para a execução do web service de relatório via regra é necessário preencher o parâmetro prEntranceIsXML com o valor "F - Falso" e o parâmetro prEntrada, caso seja necessário, com a seguinte formatação: <nome_ variável1 =valor_variável1><nome_ variável2 =valor_variável2>. Por exemplo: <ECodEmp=1><ENumCad=12345>. O valor "V - Verdadeiro" é restrito para uso dos sistemas. |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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:ExecutarResponse> <result> <prRetorno>String</prRetorno> <prLOG>String</prLOG> <erroExecucao>String</erroExecucao> </result> </ser:ExecutarResponse> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Tipo | Descrição |
---|---|---|
erroExecucao | 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 sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
prRetorno | Blob | Campo Blob para armazenamento do relatório |
prLOG | String |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Este web service permite gerar o relatório de bloquetos financeiros das seguintes formas:
- Envio diretamente para impressora:
- Nessa opção, o parâmetro "impressora" precisa ser informado, os parâmetros "formato" e "caminhoArq" não devem ser informados e o parâmetro "arquivo" do retorno ficará nulo.
- Gerar o relatório em um diretório específico:
- Nessa opção, os parâmetros "formato" e "caminhoArq" precisam ser informados e o parâmetro "arquivo" do retorno ficará nulo.
- Retornar o relatório via string (no formato base64) junto com o retorno do web service:
- Nessa opção, o parâmetro "formato" precisa ser informado, o parâmetro "caminhoArq" não deve ser informado e o parâmetro "arquivo" do retorno irá conter a string com o arquivo do relatório gerado no formado base64.
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:BloquetoFinanceiro> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <modelo>String</modelo> <codSnf>String</codSnf> <codTpt>String</codTpt> <wheCla>String</wheCla> <numNfv>String</numNfv> <numTit>String</numTit> <mens01>String</mens01> <codEmp>String</codEmp> <codPor>String</codPor> <mens02>String</mens02> <codCrt>String</codCrt> <mens03>String</mens03> <mens04>String</mens04> <formato>String</formato> <qualidade>String</qualidade> <caminhoArq>String</caminhoArq> <impressora>String</impressora> <nosNum>String</nosNum> </parameters> </ser:BloquetoFinanceiro> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Tipo | Descrição |
---|---|---|
modelo | String | (Obrigatório) - String - Nome do modelo (.blo). |
codSnf | String | (Opcional) - String(003) - Série da nota fiscal. Obrigatório para bloquetos do comercial. |
codTpt | String | (Opcional) - String(003) - Código do tipo de título. Obrigatório para bloquetos do financeiro. |
wheCla | String |
(Opcional) - String - Filtro para cláusula WHERE. Este campo substitui a cláusula WHERE montada com os demais parâmetros informados (NumTit, CodTpt, CodSnf, NumNfv). É necessário informar o filtro completo neste campo, inclusive empresa e filial. |
numNfv | Number | (Opcional) - Number(009) - Número da nota fiscal. Obrigatório para bloquetos do comercial. |
numTit | Number | (Opcional) - Number(015) - Número do título. Obrigatório para bloquetos do financeiro. |
mens01 | String | (Opcional) - String - Texto da mensagem 1. |
codEmp | Number | (Obrigatório) - Number(004) - Código da Empresa. |
codFil | Number | (Obrigatório) - Number(005) - Código da Filial. |
codPor | String | (Obrigatório) - String(004) - Código do portador. |
mens02 | String | (Opcional) - String - Texto da mensagem 2. |
codCrt | String | (Obrigatório) - String(002) - Código da carteira. |
mens03 | String | (Opcional) - String - Texto da mensagem 3. |
mens04 | String | (Opcional) - String - Texto da mensagem 4. |
formato | String | (Opcional) - String(004) - Informar valor "JPEG" ou “PDF”. Não é necessário quando for enviado diretamente para impressora. |
qualidade | Number | (Opcional) - Number(003) - Qualidade do JPEG (0-100; valor padrão: 75). |
caminhoArq | String | (Opcional) - String - Caminho onde será gerado o bloqueto (imagem ou pdf). Se informado, não será retornado o blob do relatório no parâmetro "Arquivo", mas sim o nome do arquivo gerado nesse mesmo parâmetro. |
impressora | String | (Opcional) - String - Nome ou compartilhamento da impressora, caso desejar enviar diretamente para a impressora. Se informado, não será retornado o blob do relatório no parâmetro "Arquivo", nem será retornado o nome do arquivo no parâmetro "CaminhoArq". |
nosNum | Number | (Opcional) - Number - Nosso número. Apenas quando requerido, se não informar, gravará “0” como último nosso número. |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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:BloquetoFinanceiroResponse> <result> <arquivo>Blob</arquivo> <caminhoArq>String</caminhoArq> <retorno>String</retorno> <erroExecucao>String</erroExecucao> </result> </ser:BloquetoFinanceiroResponse> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Tipo | Descrição |
---|---|---|
arquivo | Blob | (Opcional) - Blob - Irá retornar o arquivo do relatório gerado em formato Base64. Esse campo ficará nulo se os parâmetros "CaminhoArq" ou "Impressora" forem informados. |
caminhoArq | String | (Opcional) - String - Caminho onde será gerado o bloqueto (imagem ou pdf). Se informado, não será retornado o blob do relatório no parâmetro "Arquivo", mas sim o nome do arquivo gerado nesse mesmo parâmetro. |
retorno | String | (Obrigatório) - String - Irá retornar "OK" (Execução do serviço sem erros) ou uma mensagem de erro. |
erroExecucao | 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 sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
Observação
As configurações de e-mail presentes na Central de Configurações Senior serão utilizadas para o envio de e-mail a partir deste Web service.