Árvore de páginas

Versões comparadas

Chave

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

Introdução

draw.io Diagram
bordertrue
viewerToolbartrue
fitWindowfalse
diagramNameTPR_uso_sistema
simpleViewerfalse
width
diagramWidth348
revision1

Sistemas Envolvidos

  • TPR:

    • TOTVS Planejamento de Rotas

  • Sistema Externo:

    • Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico TOTVS.

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

TPRGeolocation
TPRRouteView: Integração rest,
Assincrona com a TPRGeolocationCB
sincrona
Path: .../v1/
trp
tpr-system-
geolocation 
usage Método: POST
CampoTipoObrigatórioTamanhoDescriçãoValidações
Exemplos
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
totalDistancedoubleSim
Distância total do plano de viagens, em kmMaior ou igual a zero
pointsTPRPoint[]Sim

Ao mínimo 2 pontos

Âncora
TPRPoint
TPRPoint

TPRPoint, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
latitudedoubleSim
Latitude do ponto geográficoEntre -90 e 90 inclusive;-23.45
longitudedoubleSim
Latitude do ponto geográficoEntre -180 e 180 inclusive;-46.32

Layout de Resposta

TPRRouteViewResponse, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
dateResponseDate TimeSim
Data do envio da resposta no TPRFormato ISO
Formato ISO8601
2021-01-21T10:01:00.0-03:00
YYYY-MM-DDThh:mm:ss.sTZD
system
versionString
Não
Sim4096
Identificador
Versão do
sistema
TPR que
fez a chamadaTexto LivreProtheusversionStringNão4096Versão do sistema externoTexto Livre12.36.1qualifiersObjectNão4096String chave valorFormato Json{"Usuário": "Pedro de Alcântara", "Perfil": "Analista"}

Layout de Resposta

executou a resposta-0.0.0.1
successBooleanSim
True se sucesso, false se falha-True
legsTPRLegs[]

Rota e distância entre dois pontos-
messageTPRMessage[]Não
Campo que deve ser exibido pelo sistema externo para o usuario-Tabela abaixo

Âncora
TPRLeg
TPRLeg

TPRLeg, tipo de dado utilizado nas integrações do TPR
CampoTipoObrigatórioTamanhoDescriçãoValidaçõesExemplos
distancedoubleSim
Distância percorrida entre as paradasMaior ou igual a zero, referente ao tipo de rota.122.56
pointsTPRPoint[]Sim
Pontos de rota desta pernaCaso não seja encontrada rota válida, o retorno contemplará apenas o ponto
de partida desta perna, exceto pela última leg, que contempla o ponto de chegada
também.

routeTypeStringSim
Tipo da rota realizada nesta perna.Valores possíveis: "ROAD", "GEODESIC"ROAD

Âncora
TPRMessage
TPRMessage

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

TPRVR0001
Catálogo de Mensagens


Anexos

Anexos