SERVIÇO WEBSERVICE PARA CÁLCULO DOS CÓDIGOS DE BARRAS E IPTE DE UM BOLETO
Características do Requisito
Linha de Produto: | RM | ||||
Segmento: | Educacional | ||||
Módulo: | Totvs Gestão Educacional | ||||
Rotina: |
| ||||
Cadastros Iniciais: | 1) Boleto gerado; | ||||
| |||||
Ponto de Entrada: | N/A | ||||
Chamados Relacionados | TVXKWI | ||||
Requisito (ISSUE): | N/A | ||||
País(es): | Todos | ||||
Banco(s) de Dados: | Sql Server e Oracle | ||||
Tabelas Utilizadas: | N/A | ||||
Sistema(s) Operacional(is): | Windows 7 |
Descrição
Disponibilização de serviço, via webservice, para cálculo dos códigos de Barras e Ipte do boleto.
Procedimento para Implantação
Atualização do sistema com o Patch 11.82.45.107, ou superior, referente a implementação realizada e a instalação do TBC, caso se deseje utilizar o IIS.
Configuração WebService
Os serviços disponibilizados poderão ser acessados via WebService através da instalação do TBC e utilizando o IIS ou através do WebService disponibilizado pelo Host.
- Acesso ao WebService disponibilizado pela instalação do TBC:
Como expor os Web Services do RM através do IIS
- Acesso ao WebService disponibilizado pelo serviço do Host:
Como Expor os Web Services do RM através do Host
Procedimento para Utilização
Com a necessidade de um serviço para calcular os códigos de Barras e Ipte dos boletos gerados pelo Educacional, foram disponibilizados os serviços: CalculaCodigoBarrasBoleto e CalculaCodigoIpteBoleto através do WebService do Educacional.
Os dois serviços, para cálculo dos códigos, estão disponíveis através do WebService WsEdu:
Os parâmetros necessários para a utilização dos serviços são:
Cálculo do código de Barras:
Nome | Tipo | Descrição |
---|---|---|
IdBoleto | Id. do Boleto | Inteiro |
CodColigada | Código da coligada | Short |
CodUsuario | Código do usuário do RM | String |
DataCalculo | Data utilizada para cálculo do código de barras | DateTime |
Cálculo do Ipte:
Nome | Tipo | Descrição |
---|---|---|
IdBoleto | Id. do Boleto | Inteiro |
CodColigada | Código da coligada | Short |
CodUsuario | Código do usuário do RM | String |
DataCalculo | Data utilizada para cálculo do código de barras | DateTime |
Exemplo de XML para consumo do serviço para cálculo do código de barras do boleto:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/"> <soapenv:Header/> <soapenv:Body> <tot:CalculaCodigoBarrasBoleto> <!--Optional:--> <tot:IdBoleto>17149</tot:IdBoleto> <!--Optional:--> <tot:CodColigada>1</tot:CodColigada> <!--Optional:--> <tot:CodUsuario>mestre</tot:CodUsuario> <!--Optional:--> <tot:DataCalculo>2016-10-06</tot:DataCalculo> </tot:CalculaCodigoBarrasBoleto> </soapenv:Body> </soapenv:Envelope>
Exemplo de XML para consumo do serviço para cálculo do código de barras do boleto:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/"> <soapenv:Header/> <soapenv:Body> <tot:CalculaCodigoIpteBoleto> <!--Optional:--> <tot:IdBoleto>17149</tot:IdBoleto> <!--Optional:--> <tot:CodColigada>1</tot:CodColigada> <!--Optional:--> <tot:CodUsuario>mestre</tot:CodUsuario> <!--Optional:--> <tot:DataCalculo>2016-10-06</tot:DataCalculo> </tot:CalculaCodigoIpteBoleto> </soapenv:Body> </soapenv:Envelope>
O retorno dos dois serviços será um valor string com o código solicitado:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <CalculaCodigoIpteBoletoResponse xmlns="http://www.totvs.com/"> <CalculaCodigoIpteBoletoResult>34191.75009 01714.940549 65432.160003 1 66660000049980</CalculaCodigoIpteBoletoResult> </CalculaCodigoIpteBoletoResponse> </s:Body> </s:Envelope> <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <CalculaCodigoBarrasBoletoResponse xmlns="http://www.totvs.com/"> <CalculaCodigoBarrasBoletoResult>34191666600000499801750001714940546543216000</CalculaCodigoBarrasBoletoResult> </CalculaCodigoBarrasBoletoResponse> </s:Body> </s:Envelope>