API RELATÓRIOS

TRANSAÇÕES POR VEÍCULO

 Área:
TI – Frotas
Análise de Sistema Projeto:
Integração TCW

SUMÁRIO

1. Introdução......................................................................................................................................................3
2. Arquitetura de Integração..............................................................................................................................3
3. Detalhamento da API..................................................................................................................................... 3
Nome: Consulta Transações por Veículo ......................................................................................................... 3
POST /ticketlog-servicos/ebs/transacaoVeiculo/search .................................................................................... 3
3.1 Requisito 21 – Entrega 06 – Tarefa 607 – Relatórios Transações por Veículo – OSB ....................... 3
3.1.1 Método: listarPorVeiculo .............................................................................................................. 3

Criado por: Pág. 2 de 11

Aprovado por: Última Alteração: 16/4/2019 11:27
 Área:
TI – Frotas
Análise de Sistema Projeto:
Integração TCW

1. Introdução
Este documento tem por objetivo a definição das especificações necessárias para a utilização dos
serviços de consulta de veículos, motoristas e o cadastro de crédito em cartões do cliente.

2. Arquitetura de integração
Os Serviços disponibilizam as operações que serão utilizadas pelos aplicativos do cliente.
As URIs (Paths) dos Serviços são disponibilizadas pela Expers através de HTTPS.

O processo de utilização dos Serviços ocorre através de chamadas REST sobre HTTPS,
utilizando a notação JSON para representar os objetos e os verbos HTTP padrão POST (para
inclusão) e GET (para pesquisa).

A ocorrência de qualquer erro na validação dos dados recebidos resulta em uma response
JSON contendo os atributos sucesso (com o valor false), codigoErro (código do erro ocorrido) e
mensagem (descrição do erro).

A autenticação do serviço é executada através de um HTTP Basic Authorization Header em

base64 sobre HTTPS.

O usuário correspondente ao Authorization Header possui permissão para executar apenas

chamadas às operações descritas neste documento.

3. Detalhamento da API
Nome: Consulta Transações por Veículo

POST /ticketlog-servicos/ebs/transacaoVeiculo/search

Busca as transações por Veículo.

URL Produção:
https://srv1.ticketlog.com.br/ticketlog-servicos/ebs/transacaoVeiculo/search

URL Homologação:
https://serviceshml.ticketlog.com.br/ticketlog-servicos/ebs/transacaoVeiculo/search

3.1 Requisito 21 – Entrega 06 – Tarefa 607 – Relatórios Transações por Veículo – OSB
Desenvolver serviços que permitam consultar transações por Veículo.

3.1.1 Método: listarPorVeiculo

Detalhamento entrada do serviço:

Arquitetura/Protocolo REST

Webservice transacao

Operação listarPorVeiculo

Método POST

Criado por: Pág. 3 de 11

Aprovado por: Última Alteração: 16/4/2019 11:27
 Área:
TI – Frotas
Análise de Sistema Projeto:
Integração TCW

Mídia JSON

URL A DEFINIR

Descrição Busca as transações por Veículo.

Detalhamento do JSON de entrada

# Nome # Pai Tipo Ocor Tamanho Descrição

I1 codigoCliente - Inteiro 1 - Código do cliente

I2 codigoTipoCartao - Inteiro 1 - Código do Tipo de Cartão

I3 dataTransacaoInicial - Data 1 - Data inicial da consulta

I4 dataTransacaoFinal - Data 1 - Data final da consulta

I5 numeroCartao - Texto 0-1 16 Número do cartão

I6 codigoServico - Inteiro 0-1 - Código do serviço

I7 descricaoModelo - Texto 0-1 40 Modelo do veículo

I8 fabricanteModelo - Texto 0-1 40 Fabricante do veículo

I9 placa - Texto 0-1 7 Placa do veículo

I10 codigoTipoCombustivel - Inteiro 0-1 - Código do tipo de combustível

I11 codigoTipoFrota - Inteiro 0-1 - Código do tipo de frota

I12 codigoEstabelecimento - Inteiro 0-1 - Código do estabelecimento

I13 numeroFrota

considerarTransacao Utiliza a Informação Adicional que está na

I14 - Texto 0-1 1 Transação (“T”) ou a que está no Veículo

(“V”)

I15 nomeCidade - Texto 0-1 50 Nome da cidade

I16 codigoCidadeIBGE Inteiro 0-1 - Código IBGE da cidade

I17 uf - Texto 0-1 2 UF

tipoEstabelecimento Leva em consideração se:

I18 - Texto 0-1 1 I – Estabelecimentos Internos

E – Estabelecimentos Externos
P – Estabelecimentos Proprios
I19 codigoGrupoRestricao - Inteiro 0-1 - Código do Grupo de Restrição

informacoesAdicionais Informações Adicionais que irão compor o

I20 - Raiz 0-N -
filtro de busca

I21 labelIA I20 Texto 1 30

I22 codigoIA I20 Inteiro 1 -

tipoFamiliaVeiculo Família do veículo

I23 - Texto 0-1 3 Valores possíveis

Valor Descrição

Criado por: Pág. 4 de 11

Aprovado por: Última Alteração: 16/4/2019 11:27
 Área:
TI – Frotas
Análise de Sistema Projeto:
Integração TCW

CAP CAMINHAO PESADO

CSP CAMINHAO SEMI
PESADO
CAM CAMINHÃO
CAR CARRETA
QUE EQUIPAMENTO
JEE JEEP
LEV LEVE
MCO MICRO ONIBUS
MOT MOTO
ONI ONIBUS
OUT OUTROS
PCL PICKUP LEVE
PCM PICKUP MEDIA
PCP PICKUP PESADA
VAN VAN

I24 codigoFamiliaVeiculo - Inteiro 0-1 - Código da Família do veículo

I25 codigoResponsavel - Inteiro 0-1 - Código do responsável

I26 controlaHorimetro - Texto 0-1 1 Controla horímetro (S/N)

I27 controlaHodometro - Texto 0-1 1 Controla hodômetro (S/N)

ordem Ordem:

I28 - Texto 1 1 T – Transacao

S – Servico
C – Cidade

Detalhamento da Saída do serviço:

Arquitetura/Protocolo REST

Webservice transacao

Operação listarPorVeiculo

Mídia JSON

Descrição Retorno obtido após a consulta de transações por veículo.

Detalhamento do JSON de saída

# Nome # Tipo Ocor Tamanho Descrição

Pai

Retorno verdadeiro quando o processamento foi

O1 sucesso - Boolean 1 - realizado com sucesso e falso quando da
ocorrência de alguma falha.

O2 codigoErro - Texto 0-1 7 Código atribuído ao erro

Criado por: Pág. 5 de 11

Aprovado por: Última Alteração: 16/4/2019 11:27
 Área:
TI – Frotas
Análise de Sistema Projeto:
Integração TCW

O3 mensagem - Texto 0-1 - Mensagem de erro capturada

O4 transacoes - Raiz 0-N Raíz de transações retornadas

O5 codigoTransacao O4 Inteiro 1 - Código da transação

O6 dataTransacao O4 Data 0-1 - Data da transação

O7 numeroCartao O4 Texto 1 16 Número do cartão

O8 placa O4 Texto 0-1 8 Placa do veículo

O9 numeroFrota O4 Texto 0-1 20 Número da frota

010 tipoFrota 04 Texto 0-1 40 Tipo de Frota

O11 veiculoModelo O4 Texto 0-1 40 Modelo do veículo

O12 responsavel O4 Texto 0-1 60 Responsável

O13 quilometragemInicial O4 Inteiro 0-1 - Quilometragem inicial

O14 tipoCombustivel 04 Texto 0-1 40 Tipo de combustível

O15 servico O4 Texto 0-1 40 Serviço

O16 codigoServico O4 Inteiro 0-1 - Código do serviço

O17 nomeMotorista O4 Texto 0-1 50 Nome do motorista

018 numeroMatricula O4 Long 0-1 - Número de matrícula

O19 codigoUsuarioCartao O4 Inteiro 0-1 - Código do usuário de cartão

O20 quilometragem O4 Inteiro 0-1 - Quilometragem

O21 veiculoFabricante O4 Texto 0-1 40 Fabricante doveículo

O22 ano O4 Inteiro 0-1 - Ano do veículo

O23 cor O4 Texto 0-1 40 Cor do veículo

O24 litros O4 Número 0-1 10,2 Litros

O25 quilometrosPorLitro O4 Número 0-1 10,2 Quilometros por litro

O26 quilometrosRodados O4 Número 0-1 10,2 Quilometros rodados

O27 controleDesempenho O4 Texto 0-1 10 Hodometro / Horimetro

O28 valorLitro O4 Número 0-1 10,3 Valor litro

O29 valorTransacao O4 Número 1 10,2 Valor transação

O30 exibeMediaQuilometragem O4 Texto 0-1 1 Se exibe a média de quilometragem (S/N)

O31 uf O4 Texto 1 2 UF

O32 nomeCidade O4 Texto 1 50 Cidade

O33 nomeReduzidoEstabelecimento O4 Texto 1 50 Estabelecimento

O34 motivoAlteracaoHodometro O4 Texto 0-1 60 Motivo de alteração do hodômetro

O35 quilometragemAntesDaTroca O4 Inteiro 0-1 - Quilometragem antes da troca

O36 quilometragemDepoisDaTroca O4 Inteiro 0-1 - Quilometragem depois da troca

Criado por: Pág. 6 de 11

Aprovado por: Última Alteração: 16/4/2019 11:27
 Área:
TI – Frotas
Análise de Sistema Projeto:
Integração TCW

O37 informacoesAdicionais O4 Raiz 0-5 - Informações Adicionais

O38 labelIA O37 Texto 1 30 Label da Informação Adicional

O39 codigoIA O37 Inteiro 1 - Código da Informação Adicional

O40 ordem O4 Texto 1 255 Ordem/quebra do relatório

O41 codigoOrdemServico O4 Inteiro 0-1 - Código da ordem de serviço

O42 codigoServicoOrdemServico O4 Inteiro 0-1 - Código do serviço

O43 codigoTipoCombustivel O4 Texto 0-1 3 Tipo de combustível

O44 principal O4 Texto 0-1 1 Principal

O45 codigoLiberacaoRestricao O4 Inteiro 0-1 - Código liberação restrição

O46 controlaHorimetro O4 Texto 0-1 1 Controla horímetro (S/N)

O47 controlaHodometro O4 Texto 0-1 1 Controla hodômetro (S/N)

O48 codigoVeiculoCliente O4 Inteiro 0-1 - Código do veículo do cliente

O49 grupoRestricaoVeiculo O4 Texto 0-1 50 Grupo restrição veículo

O50 grupoRestricaoTransacao O4 Texto 0-1 50 Grupo restrição transação

O51 valorSaldoAnterior O4 Número 0-1 10,2 Saldo anterior

O52 codigoFamiliaVeiculo O4 Inteiro 0-1 - Código da Família do veículo

O53 familiaVeiculo O4 Texto 0-1 255 Família veículo (descrição completa)

Processamento:

a. Criar um objeto ConsultaTransacoesPorVeiculo, setando valores nos atributos conforme segue:

Atributo na classe
Recebe
ConsultaTransacoesPorVeiculo

codigoCliente codigoCliente
codigoTipoCartao codigoProduto
dataTransacaoInicial dataTransacaoInicial
dataTransacaoFinal dataTransacaoFinal
numeroCartao numeroCartao
codigoServico codigoServico
fabricanteModelo fabricanteModelo
descricaoModelo descricaoModelo
placa placa
codigoTipoCombustivel Se codigoTipoCombustivel = ARL, então 20
Se codigoTipoCombustivel = BDI, então 14
Se codigoTipoCombustivel = DIE, então 4
Se codigoTipoCombustivel = DIA, então 6

Criado por: Pág. 7 de 11

Aprovado por: Última Alteração: 16/4/2019 11:27
 Área:
TI – Frotas
Análise de Sistema Projeto:
Integração TCW

Se codigoTipoCombustivel = DSA, então 19

Se codigoTipoCombustivel = DSC, então 18
Se codigoTipoCombustivel = ETN, então 3
Se codigoTipoCombustivel = ETA, então 17
Se codigoTipoCombustivel = GAS, então 9
Se codigoTipoCombustivel = GAA, então 2
Se codigoTipoCombustivel = GAC, então 1
Se codigoTipoCombustivel = GLP, então 11
Se codigoTipoCombustivel = QUR, então 15
codigoTipoFrota codigoTipoFrota
codigoEstabelecimento codigoEstabelecimento
numeroFrota numeroFrota
considerarTransacao considerarTransacao
nomeCidade nomeCidade
codigoCidadeIBGE codigoCidadeIBGE
uf uf
tipoEstabelecimento tipoEstabelecimento
codigoGrupoRestricao codigoGrupoRestricao
Se ‘informacoesAdicionais’ foi informado, para cada par label / código, popular na lista informações adicionais

labelInformacaoAdicional labelInformacaoAdicional
codigoInformacaoAdicional codigoInformacaoAdicional

codigoFamiliaVeiculo Se familiaVeiculo = CAP, então 12

Se familiaVeiculo = CSP, então 8
Se familiaVeiculo = CAM, então 9
Se familiaVeiculo = CAR, então 15
Se familiaVeiculo = QUE, então 11
Se familiaVeiculo = JEE, então 14
Se familiaVeiculo = LEV, então 1
Se familiaVeiculo = MCO, então 16
Se familiaVeiculo = MOT, então 2
Se familiaVeiculo = ONI, então 10
Se familiaVeiculo = OUT, então 17
Se familiaVeiculo = PCL, então 4
Se familiaVeiculo = PCM, então 5
Se familiaVeiculo = PCP, então 6
Se familiaVeiculo = VAN, então 3
codigoResponsavel codigoResponsavel
controlaHorimetro SE controleDesempenho IGUAL ‘HOR’ ENTÃO retornar ‘S’
controlaHodometro SE controleDesempenho IGUAL ‘HOD’ ENTÃO retornar ‘S’
ordem ordem

Criado por: Pág. 8 de 11

Aprovado por: Última Alteração: 16/4/2019 11:27
 Área:
TI – Frotas
Análise de Sistema Projeto:
Integração TCW

b. Chamar o método TransacoesPorVeiculoFacade.listarPorVeiculo passando o objeto criado por

parâmetro.

c. Após a execução, popular JSON de saída conforme o objeto

ConsultaTransacoesPorVeiculoRetornoIntegracao retornado pelo método:

Valor de saída Recebe

codigoErro codigoErro

sucesso sucesso

mensagem mensagem

Se a lista “listaTransacoesPorVeiculo" não estiver vazia, para cada valor encontrado, atribuir:

codigoTransacao codigoTransacao
dataTransacao dataTransacao
numeroCartao numeroCartao
placa placa
numeroFrota numeroFrota
tipoFrota tipoFrota
veiculoModelo veiculoModelo
responsavel responsavel
quilometragemInicial quilometragemInicial
descricaoTipoCombustivel tipoCombustivel
servico servico
codigoServico codigoServico
nomeMotorista nomeMotorista
numeroMatricula numeroMatricula
codigoUsuarioCartao codigoUsuarioCartao
quilometragem quilometragem
veiculoFabricante veiculoFabricante
ano ano
cor cor
litros litros
quilometrosPorLitro quilometrosPorLitro
quilometrosRodados quilometrosRodados
controleDesempenho controleDesempenho
valorLitro valorLitro
valorTransacao valorTransacao
exibeMediaQuilometragem exibeMediaQuilometragem
uf uf

Criado por: Pág. 9 de 11

Aprovado por: Última Alteração: 16/4/2019 11:27
 Área:
TI – Frotas
Análise de Sistema Projeto:
Integração TCW

nomeCidade nomeCidade
nomeReduzidoEstabelecimento nomeReduzidoEstabelecimento
motivoAlteracaoHodometro motivoAlteracaoHodometro
quilometragemAntesDaTroca quilometragemAntesDaTroca
quilometragemDepoisDaTroca quilometragemDepoisDaTroca
Se ‘informacoesAdicionais’ foi informado, para cada par label / código, popular na lista
informações adicionais:

labelInformacaoAdicional labelInformacaoAdicional
codigoInformacaoAdicional codigoInformacaoAdicional

ordem ordem
codigoOrdemServico codigoOrdemServico
codigoServicoOrdemServico codigoServicoOrdemServico
codigoTipoCombustivel Se codigoTipoCombustivel = 20 então ARL
Se codigoTipoCombustivel = 14 então BDI
Se codigoTipoCombustivel = 4 então DIE
Se codigoTipoCombustivel = 6 então DIA
Se codigoTipoCombustivel = 19 então DSA
Se codigoTipoCombustivel = 18 então DSC
Se codigoTipoCombustivel = 3 então ETN
Se codigoTipoCombustivel = 17 então ETA
Se codigoTipoCombustivel = 9 então GAS
Se codigoTipoCombustivel = 2 então GAA
Se codigoTipoCombustivel = 1 então GAC
Se codigoTipoCombustivel = 11 então GLP

Se codigoTipoCombustivel = 15 então QUR

principal principal
codigoLiberacaoRestricao codigoLiberacaoRestricao
controlaHorimetro controlaHorimetro
controlaHodometro controlaHodometro
codigoVeiculoCliente codigoVeiculoCliente
grupoRestricaoVeiculo grupoRestricaoVeiculo
grupoRestricaoTransacao grupoRestricaoTransacao
valorSaldoAnterior valorSaldoAnterior
familiaVeiculo Se codigoFamiliaVeiculo = 12 então CAP
Se codigoFamiliaVeiculo = 8 então CSP
Se codigoFamiliaVeiculo = 9 então CAM
Se codigoFamiliaVeiculo = 15 então CAR
Se codigoFamiliaVeiculo = 11 então QUE
Se codigoFamiliaVeiculo = 14 então JEE
Se codigoFamiliaVeiculo = 1 então LEV

Criado por: Pág. 10 de 11

Aprovado por: Última Alteração: 16/4/2019 11:27
 Área:
TI – Frotas
Análise de Sistema Projeto:
Integração TCW

Se codigoFamiliaVeiculo = 16 então MCO

Se codigoFamiliaVeiculo = 2 então MOT
Se codigoFamiliaVeiculo = 10 então ONI
Se codigoFamiliaVeiculo = 17 então OUT
Se codigoFamiliaVeiculo = 4 então PCL
Se codigoFamiliaVeiculo = 5 então PCM
Se codigoFamiliaVeiculo = 6 então PCP

Se codigoFamiliaVeiculo = 3 então VAN

descricaoFamiliaVeiculo familiaVeiculo

Criado por: Pág. 11 de 11

Aprovado por: Última Alteração: 16/4/2019 11:27