Histórico da Página
Introdução
| draw.io Diagram | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Sistemas Envolvidos
- API JavaScript
TPR: TOTVS Planejamento de Rotas
Integração
- Formato de entrada/saída: JSON
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
| TPRRouteView: Integração rest, sincrona | ||||||
|---|---|---|---|---|---|---|
| Path: .../v1/tpr-system-usage Método: POST | ||||||
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| dateCall | Date Time | Sim | Data da criação da chamada no sistema externo | Formato ISO | ||
| system | String | Não | 4096 | Identificador do sistema que fez a chamada | Texto Livre | |
| version | String | Não | 4096 | Versão do sistema externo | Texto Livre | |
| qualifiers | Object | Não | 4096 | String chave valor | Formato Json | |
| points | TPRPoint[] | Sim | Ao mínimo 2 pontos | |||
Layout de Resposta
| TPRRouteViewResponse, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| dateResponse | Date Time | Sim | Data do envio da resposta no TPR | Formato ISO | 2021-01-21T10:01:00.0-03:00 YYYY-MM-DDThh:mm:ss.sTZD | |
| version | String | Sim | 4096 | Versão do TPR que executou a resposta | - | 0.0.0.1 |
| success | Boolean | Sim | True se sucesso, false se falha | - | True | |
| totalDistance | double | Sim | Distância total do plano de viagens, em km | Maior ou igual a zero | ||
| legs | TPRLegs[] | Rota e distância entre dois pontos | - | |||
| message | TPRMessage[] | Não | Campo que deve ser exibido pelo sistema externo para o usuário | - | Tabela abaixo | |
| Âncora | ||||
|---|---|---|---|---|
|
| TPRLeg, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| distance | double | Sim | Distância percorrida entre as paradas | Maior ou igual a zero, referente ao tipo de rota. | 122.56 | |
| points | TPRPoint[] | Sim | Pontos de rota desta perna | Caso 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. | ||
| routeType | String | Sim | Tipo da rota realizada nesta perna. | Valores possíveis: "ROAD", "GEODESIC" | ROAD | |
| Âncora | ||||
|---|---|---|---|---|
|
| TPRPoint, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| latitude | double | Sim | Latitude do ponto geográfico | Entre -90 e 90 inclusive; | -23.45 | |
| longitude | double | Sim | Latitude do ponto geográfico | Entre -180 e 180 inclusive; | -46.32 | |
| Âncora | ||||
|---|---|---|---|---|
|
| TPRMessage, tipo de dado utilizado nas integrações do TPR | ||||||
|---|---|---|---|---|---|---|
| Campo | Tipo | Obrigatório | Tamanho | Descrição | Validações | Exemplos |
| messageCode | String | Sim | Código de identificação da mensagem | Código existente e valido | TPR0001 | |
| message | String | Sim | 4096 | Mensagem escrita | Texto Livre | "E-mail Invalido" |
Catálogo de Mensagens
Âncora TPRCatMsg TPRCatMsg
Código | Mensagem | Descrição |
|---|---|---|
| TPRVR0001 |
Anexos
| Anexos |
|---|
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas