Histórico da Página

Introdução

draw.io Diagram

border	false
viewerToolbar	true

fitWindow	false
diagramDisplayName
lbox	true
revision	4
diagramName	TRE_aquisicao_monitoravel
simpleViewer	false
width
links	auto
tbstyle	hidden
diagramWidth	362

Sistemas Envolvidos

TOTVS Otimização Logística / TOTVS Roteirização e Entrega
Sistema Externo: Todos os ERPs que se conectam ou pretendem se conectar com os produtos de planejamento logístico da TOTVS.TOL/TRE

Integração

Escopo

Criação de viagem, documento, nota fiscal, itens, motorista, transportadora, dispositivo de rastreamento e dispositivo mobile

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

Versões mínimas
- TOL\TRE: 6.4.0
- Protheus: ?
- Datasul: ?
Esta integração não demanda instalações ou atualizações adicionais.

Layout de Requisição

Aquisição de monitoravel Aquisição de monitoravelAquisição de monitoravelAquisição de monitoravel Aquisição de monitoravel

createMonitorablecreateMonitorableRequest, Integração SOAP, Síncrona
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
driver	driver	Não	N/A	Motorista associado a viagem
alternativeDrivers	driver[]	Não	N/A	Lista de motoristas alternativos da viagem
trackerDevice	trackerDevice	Não	N/A	trackerDevice ou mobileDevice deve ser fornecido para viabilizar o rastreamento
monitorables	monitorable[]	Não	N/A	Lista de monitoráveis
relationships	relationshipType[]	Não	N/A	Lista de relação entre os monitoráveis

Âncora

	driver
	driver

do Aquisição de monitoravel Aquisição de monitoravel

driver, tipo de dado utilizado nas integrações
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
driver	entityDto	Não	N/A	Motorista da viagem
identifier	String	Sim	N/A	Identificação do motorista	Ex: Cpf, Matricula
user	user	Não	N/A	Dados de usuário e senha para acesso ao sistema

Âncora

	user
	user

do

user, tipo de dado utilizado nas integrações
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
password	String	Sim	N/A	Senha
email	String	Sim	N/A	E-mail associado ao usuário
profile	String	Sim	N/A	Profile de acesso do usuário, ex: root

Âncora

	trackerDevice
	trackerDevice

trackerDevice, tipo de dado utilizado nas integrações do do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
deviceId	string	Sim	N/A	Id do dispositivo
providerID	string	Sim	N/A	Provedor do dispositivo

Âncora

	monitorable
	monitorable

driver do monitoravel ser TRIPAquisição de monitoravel Aquisição de monitoravelTipo complexo detalhado no linkAquisição de monitoravel Aquisição de monitoravelTipo complexo detalhado no linkAquisição de monitoravel Aquisição de monitoravel Aquisição de monitoravel do documento do documento do documento do documentoItemsItens monitorizáveis Aquisição de monitoravelDados

monitorable, tipo de dado utilizado nas integrações						do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
sourceId	string	Sim	N/A	Código do monitorável	Deve ser único ativo
type	string	Sim	N/A	Define o tipo de	monitorável que pode	ser TRIP, LOAD, DOCUMENT e INVOICE
origin	localityType	Não	N/A	Local de carregamento	Tipo complexo detalhado no link
shipper	entityDto	Não	N/A	Embarcador do monitorável
destination	localityType	Não	N/A	Local de descarregamento	Tipo complexo detalhado no link
custumer	entityDto	Não	N/A	Cliente do monitorável
carrier	entityDto	Não	N/A	Transportadora do monitorável	Tipo complexo detalhado no link
vehicle	entityDto	Não	N/A	Veículo do monitorável	Tipo complexo detalhado no link
truck	entityDto	Não	N/A	Placa do monitorável	Tipo complexo detalhado no link
loadingSequence	int	Não	N/A	Sequencia de carregamento
unloadingSequence	int	Não	N/A	Sequencia de descarregamento
quantity	int	Não	N/A	Quantidade de volumes	do monitorável
value	double	Não	N/A	Valor	do monitorável
volume	double	Não	N/A	Volume	do monitorável
weight	double	Não	N/A	Peso	do monitorável
contact	string	Não	N/A	Contato responsável pelo serviço
Items	item[]	Não	N/A	Lista de itens dos	monitoráveis quando elegíveis	Tipo complexo detalhado no link
transitions	transition[]	Não	N/A	Dados da transição	Tipo complexo detalhado no link	Lista de transições do monitorável
extensions	extension[]	Não	N/A	Lista de dados adicionais específicos de cada implementação	Tipo complexo detalhado no link

Âncora

	entityDto
	entityDto

entityDto, tipo de dado utilizado nas integrações do do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
sourceId	string	Sim	N/A	Código da entidade
name	string	Não	N/A	Nome da entidade
description	string	Não	N/A	Descrição da entidade

Âncora

	localityType
	localityType

localityType, tipo de dado utilizado nas integrações do do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
locality	entityDto[]	Não	N/A	Localidade onde a transição será efetuada
address	address[]	Não	N/A	Endereço onde a transição será efetuada

Âncora

	address
	address

address, tipo de dado utilizado nas integrações

do

do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
street	String	Sim	N/A	Rua do endereço
street	String	Sim	N/A	Rua do endereço
number	String	Não	N/A	Número do endereço
complement	String	Não	N/A	Complemento do endereço
district	String	Não	N/A	Bairro do endereço
city	String	Não	N/A	Cidade do endereço
state	String	Não	N/A	Estado do endereço
country	String	Não	N/A	Pais do endereço
zipCode	String	Sim	N/A	CEP do endereço
geolocation	geolocation

[]

Não

N/A

Latitude e Longitude

Âncora

	geolocation
	geolocation

geolocation, tipo de dado utilizado nas integrações

do

do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
latitude	double	Não	N/A	Latitude do endereço
longitude	double	Não	N/A	Longitude do endereço

items

Âncora

items

	item
	item

item, tipo de dado utilizado nas integrações do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
sourceId	String	Sim	N/A	Código do item do monitorável
sequence	int	Não	N/A	Quantidade do item do monitorável
Product

complex type

entityDto

Não

N/A

Produto do item do monitorável

Tipo complexo detalhado no link


quantity	int	Não	N/A	Quantidade do item do monitorável
value	double	Não	N/A	Valor do item do monitorável
volume	double	Não	N/A	Volume do item do monitorável
weight	double	Não	N/A	Peso do item do monitorável
extensions

complex type

extension[]

Não

N/A

Dados

Lista de dados adicionais específicos de cada implementação

Tipo complexo detalhado no link

Âncora

	transitionAquisitionType
	transitionAquisitionType

Aquisição de monitoravelTipo complexo detalhado no link

transitionAquisitionType, tipo de dado utilizado nas integrações do do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
sourceId	string	Sim	N/A	Código da transição	Deve ser único com o monitorável ativo
name	string	Sim	N/A	Nome da transição
expectedTimestamp	dateTime	Sim	N/A	Data/Hora esperada para a transição
limitTimestamp	dateTime	Não	N/A	Data/Hora limite para a transição
location	localityType	Não	N/A	Local da transição
extensions	extension[]	Não	N/A	Dados Lista de dados adicionais específicos de cada implementação	Tipo complexo detalhado no link

Âncora

	extension
	extension

extension, tipo de dado utilizado nas integrações

do

do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
key	String	Sim	N/A	Descrição da extensão
textValue	String	Não	N/A	Opção para quando a extensão é uma string
floatValue	double	Não	N/A	Opção para quando a extensão é valor
integerValue	long	Não	N/A	Opção para quando a extensão é um valor inteiro
instantValue	datetime	Não	N/A	Opção para quando a extensão é uma data e hora
booleanValue	boolean	Não	N/A	Opção para quando a extensão é uma lógica

Âncora

	relationshipType
	relationshipType

relationshipType do string

relationship, tipo de dado utilizado nas integrações
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
parentSourceId	string	Sim	N/A	Monitorável Pai
children	childrens[]	Sim	N/A	Lista de monitoráveis Filhos

Âncora

	childrenType
	childrenType

children, tipo de dado utilizado nas integrações do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
childSourceIds	string	Sim	N/A	Monitoráveis filhos

Layout de Resposta

createMonitorableResponse, tipo de dado utilizado nas integrações do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
messeges	messegeType[]	Sim	N/A	Lista de respostas

Âncora

	messageType
	messageType

messageType, tipo de dado utilizado nas integrações do TOL\TRE
Nome	Tipo	Obrigatório	Tamanho	Descrição	Observações
sourceId	string	Sim	N/A	Código do monitorável
type	string	Sim	N/A	Define o tipo do monitorável que pode ser TRIP, LOAD, DOCUMENT e INVOICE
result	boolean	Sim	N/A	Confirmação do sucesso ou falha do processo
code	string	Não	N/A	Código do erro
description	string	Não	N/A	Descrição do erro

Catalogo de mensagens

Âncora

	catmsg
	catmsg

Código

Mensagem

Descrição

Anexos

Anexos

Árvore de páginas

Versões comparadas

Versão antiga 10

Nova versão Atual

Chave

Introdução

Sistemas Envolvidos

Integração

Escopo

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

Layout de Requisição

Layout de Resposta

Catalogo de mensagens

Anexos