Árvore de páginas

Introdução

Sistemas Envolvidos

  • TOTVS Otimização Logística / TOTVS Roteirização e Entrega

  • Sistema Externo: ERPs que se conectam ou pretendem se conectar com 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

createMonitorableRequest, Integração SOAP, Síncrona

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

driverdriverNãoN/AMotorista associado a viagem
alternativeDriversdriver[]NãoN/ALista de motoristas alternativos da viagem
trackerDevicetrackerDeviceNãoN/AtrackerDevice deve ser fornecido para viabilizar o rastreamento
monitorablesmonitorable[]NãoN/ALista de monitoráveis
relationshipsrelationshipType[]NãoN/ALista de relação entre os monitoráveis

driver, tipo de dado utilizado nas integrações do TOL\TRE

NomeTipoObrigatórioTamanhoDescriçãoObservações
driver

entityDto

NãoN/AMotorista da viagem
identifierStringSimN/AIdentificação do motoristaEx: Cpf, Matricula
useruserNãoN/ADados de usuário e senha para acesso ao sistema

user, tipo de dado utilizado nas integrações do TOL\TRE

NomeTipoObrigatórioTamanhoDescriçãoObservações
passwordStringSimN/ASenha
emailStringSimN/AE-mail associado ao usuário
profileStringSimN/AProfile de acesso do usuário, ex: root

trackerDevice, tipo de dado utilizado nas integrações do TOL\TRE

NomeTipoObrigatórioTamanhoDescriçãoObservações
deviceIdstringSimN/AId do dispositivo
providerIDstringSimN/AProvedor do dispositivo

monitorable, tipo de dado utilizado nas integrações do TOL\TRE

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

sourceIdstringSimN/ACódigo do monitorávelDeve ser único ativo
typestringSimN/ADefine o tipo de monitorável que pode ser TRIP, LOAD, DOCUMENT e INVOICE
originlocalityTypeNãoN/ALocal de carregamento
shipperentityDtoNãoN/AEmbarcador do monitorável
destinationlocalityTypeNãoN/ALocal de descarregamento
custumerentityDtoNãoN/ACliente do monitorável
carrierentityDtoNãoN/ATransportadora do monitorável
vehicleentityDtoNãoN/AVeículo do monitorável
truckentityDtoNãoN/APlaca do monitorável
loadingSequenceintNãoN/ASequencia de carregamento
unloadingSequenceintNãoN/ASequencia de descarregamento
quantityintNãoN/AQuantidade de volumes do monitorável
valuedoubleNãoN/AValor do monitorável
volumedoubleNãoN/AVolume do monitorável
weightdoubleNãoN/APeso do monitorável
contactstringNãoN/AContato responsável pelo serviço
Itemsitem[]NãoN/ALista de itens dos monitoráveis quando elegíveis
transitionstransition[]NãoN/ALista de transições do monitorável
extensionsextension[]NãoN/ALista de dados adicionais específicos de cada implementação

entityDto, 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 da entidade


name

string

Não

N/A

Nome da entidade


description

string

Não

N/A

Descrição da entidade


localityType, tipo de dado utilizado nas integrações 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


address, tipo de dado utilizado nas integrações 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


geolocation, tipo de dado utilizado nas integrações do TOL\TRE

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

latitudedoubleNãoN/ALatitude do endereço
longitudedoubleNãoN/ALongitude do endereço

item, tipo de dado utilizado nas integrações do TOL\TRE

NomeTipo

Obrigatório

Tamanho

DescriçãoObservações
sourceIdStringSimN/ACódigo do item do monitorável
sequenceintNãoN/AQuantidade do item do monitorável
ProductentityDtoNãoN/AProduto do item do monitorável
quantityintNãoN/AQuantidade do item do monitorável
valuedoubleNãoN/AValor do item do monitorável
volumedoubleNãoN/AVolume do item do monitorável
weightdoubleNãoN/APeso do item do monitorável
extensionsextension[]NãoN/ALista de dados adicionais específicos de cada implementação

transitionAquisitionType, tipo de dado utilizado nas integrações do TOL\TRE

NomeTipo

Obrigatório

Tamanho

DescriçãoObservações
sourceIdstringSimN/ACódigo da transiçãoDeve ser único com o monitorável ativo
namestringSimN/ANome da transição
expectedTimestampdateTimeSimN/AData/Hora esperada para a transição
limitTimestampdateTimeNãoN/AData/Hora limite para a transição
locationlocalityTypeNãoN/ALocal da transição
extensionsextension[]NãoN/ALista de dados adicionais específicos de cada implementação

extension, tipo de dado utilizado nas integrações do TOL\TRE

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

keyStringSimN/ADescrição da extensão
textValueStringNãoN/AOpção para quando a extensão é uma string
floatValuedoubleNãoN/AOpção para quando a extensão é valor
integerValuelongNãoN/AOpção para quando a extensão é um valor inteiro
instantValuedatetimeNãoN/AOpção para quando a extensão é uma data e hora
booleanValuebooleanNãoN/AOpção para quando a extensão é uma lógica

relationship, tipo de dado utilizado nas integrações do TOL\TRE

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

parentSourceIdstringSimN/AMonitorável Pai
childrenchildrens[]SimN/ALista de monitoráveis Filhos

children, tipo de dado utilizado nas integrações do TOL\TRE

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

childSourceIdsstringSimN/AMonitoráveis filhos

Layout de Resposta

createMonitorableResponse, tipo de dado utilizado nas integrações do TOL\TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
messegesmessegeType[]SimN/ALista de respostas

messageType, tipo de dado utilizado nas integrações do TOL\TRE
NomeTipoObrigatórioTamanhoDescriçãoObservações
sourceIdstringSimN/ACódigo do monitorável
typestringSimN/A

Define o tipo do monitorável que pode ser TRIP, LOAD, DOCUMENT e INVOICE


resultbooleanSimN/A

Confirmação do sucesso ou falha do processo


codestringNãoN/ACódigo do erro
descriptionstringNãoN/A

Descrição do erro


Catalogo de mensagens

CódigoMensagemDescrição

Anexos

  Arquivo Modificado
Arquivo TRE_aquisicao_monitoravel draw.io diagram 06 jul, 2021 by Julio Vinicius Oliveira dos Santos
Arquivo PNG TRE_aquisicao_monitoravel.png TRE_aquisicao_monitoravel exported to image 06 jul, 2021 by Julio Vinicius Oliveira dos Santos
Arquivo XML monitorable.wsdl.xml 08 jul, 2021 by Jefferson Andrade

  • Sem rótulos