Introdução

Sistemas Envolvidos

  • 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.

Integração

Escopo

  • Finaliza e inicia a execução de monitorável atualizando se necessário motorista, 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

monitorableActionRequest, Integração SOAP, Síncrona

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

operationstringSimN/ADefine as operações suportadas que pode ser START e FINALIZE
sourceIdstringSimN/ACódigo do monitorávelDeve ser único ativo
typestringSimN/ADefine o tipo de monitorável que pode ser TRIP, LOAD, DOCUMENT e INVOICE
carrierentityDtoNãoN/ATransportadora do monitorável
vehicleentityDtoNãoN/AVeículo do monitorável
truckentityDtoNãoN/APlaca do monitorável
driverdriverNãoN/AMotorista associado a viagem
alternativeDriversdriverNãoN/ALista de motoristas alternativos da viagem
trackerDevicetrackerDeviceNãoN/AtrackerDevice deve ser fornecido para viabilizar o rastreamento

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

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


Layout de Resposta

monitorableActionResponse, 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_Operacao_monitoravel draw.io diagram 06 jul, 2021 by Julio Vinicius Oliveira dos Santos
Arquivo PNG TRE_Operacao_monitoravel.png TRE_Operacao_monitoravel exported to image 06 jul, 2021 by Julio Vinicius Oliveira dos Santos

  • Sem rótulos