Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Introdução

Sistemas Envolvidos

  • API JavaScript
  • TPR:

    • TOTVS Planejamento de Rotas

Integração

  • Formato de entrada/saída: JSON

Escopo

  • Bla bla bla

Pré-requisitos instalação/implantação/utilização

  • Para clientes Protheus versão xxxxxx;
  • Para clientes Datasul versão xxxxxx;
  • Para clientes externos contratação do trial via TOTVS Store;

Layout de Requisição

TPRSystemUsage: Integração rest, sincrona

Path: .../v1/tpr-system-usage Método: POST
CampoTipoObrigatórioTamanhoDescriçãoValidações
dateCallDate TimeSim
Data da criação da chamada no sistema externoFormato ISO
systemStringNão4096Identificador do sistema que fez a chamadaTexto Livre
versionStringNão4096Versão do sistema externoTexto Livre
qualifiersObjectNão4096String chave valorFormato Json
timeWindowStartDate TimeNão
Inicio da janela a ser consultadaFormato ISO8601
TimeWindowStart deve ser anterior a TimeWindowEnd, se ambos preenchidos
Se vazio consuderaremos o mês corrente;
timeWindowEndDate TimeNão
Final da janela a ser consultadaFormato ISO8601
TimeWindowEnd deve ser posterior de TimeWindowStart, se ambos preenchidos
Se vazio consuderaremos o mês corrente;

Layout de Resposta

TPRSystemUsageResponse: Integração rest, sincrona
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
dateResponseDate TimeSim
Data do envio da resposta no TPRFormato ISO2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD
versionStringSim4096Versão do TPR que executou a resposta-0.0.0.1
successBooleanSim
True se sucesso, false se falha-True
routedSummaryTPRRoutedSummary[]Não

-Tabela abaixo
geolocationSummaryTPRGeolocationSummary[]Não

-Tabela abaixo
routeViewSummaryTPRRouteViewSummary[]Não

-Tabela abaixo
messageTPRMessage[]Não
Campo que deve ser exibido pelo sistema externo para o usuario-Tabela abaixo

Âncora
TPRRoutedSummary
TPRRoutedSummary

TPRRoutedSummary, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
submissonDateTimeDateTimeSim
Instante em que a request foi aceita pelo TPRFormato ISO86012021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD
totalTripsintegerSim
Quantidade total de viagens geradasMaior ou igual a zero332 [Viagens]
totalDistancedoubleSim
Distância total do plano de viagens, em kmMaior ou igual a zero3022 [km]
totalStopsintegerSim
Quantidade total de paradas do plano de viagensMaior ou igual a zero239 [Paradas]
totalVolumedoubleSim
Volume total em viagens, em m³Maior ou igual a zero50.000 [m³]
totalWeightdoubleSim
Peso total em viagens, em kgMaior ou igual a zero2.500.000 [kg]
totalDurationdoubleSim
Duração total do plano de viagens, em milissegundosMaior ou igual a zero57600000 [ms]
rejectedOrdersintegerSim
Quantidade de pedidos rejeitadosMaior ou igual a zero10 [Pedidos]
rejectedWeightdoubleSim
Total de peso rejeitado, em kgMaior ou igual a zero2.500.000 [kg]
rejectedVolumedoubleSim
Total de volume rejeitado, em m³Maior ou igual a zero50.000 [m³]

Âncora
TPRGeolocationSummary
TPRGeolocationSummary

TPRGeolocationSummary, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
submissionDateDateSim
Data em que as requests foram aceitas pelo TPR.Formato ISO86012021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD
totalGeolocationintegerSim
Total de localidades que foram geolocalizadas com sucesso.Maior que zero
totalGeolocationFailuresintegerSim
Total de localidades que não foram geolocalizadas nesta data.Maior ou igual a zero0, 1500
numberOfRequestsintegerSim
Total de requests recebidas e processadas nesta data.Maior que zero1, 1500
numberOfCallbackintegerSim
Total de callbacks de geolocalização realizadas nesta data.Maior ou igual a zero0, 1500
totalFailuresCallbackintegerSim
Total de callbacks de geolocalização que falharam nesta dataMaior ou igual a zero0, 1500

Âncora
TPRRouteViewSummary
TPRRouteViewSummary

TPRRouteViewSummary, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
submissionDateDateSim
Data em que as requests foram aceitas pelo TPR.Formato ISO86012021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD
totalRoutesintegerSim
Quantidade de viagens cuja rota foi geradaMaior que zero
totalLegsintegerSim
Quantidade total de pernas cuja rota foram geradasMaior que zero
Âncora
TPRMesssage
TPRMesssage
TPRMessage, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
messageCodeStringSim
Código de identificação da mensagemCódigo existente e validoTPR0001
messageStringSim4096Mensagem escritaTexto Livre"Email Invalído"

Catálogo de Mensagens

Código

Mensagem

Descrição

TPRUS0001

Anexos