Versões comparadas

Chave

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

Introdução

draw.io Diagram
borderfalse
viewerToolbartrue
fitWindowfalse
diagramDisplayName
lboxtrue
revision6
diagramNameTRE_publicacao_transicao
simpleViewerfalse
width
linksauto
tbstylehidden
diagramWidth342

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

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

publishTransitionRequest, Integração SOAP, Síncrona

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

monitorableSourceId

string

Sim

N/A

Código do monitorável

Deve ser único por tipo

monitorableType

string

Sim

N/A

Define o tipo de

documento

monitorável que pode ser TRIP, DOCUMENT, INVOICE, LOAD


transitions

transition[]

Não

N/A

Dados da transição

Tipo complexo detalhado no link


Âncora
transition
transition

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

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

monitorableCode

string

Sim

N/A

Código do monitorável


monitorableType

string

Sim

N/A

Define o tipo de

documento

monitorável que pode ser TRIP, DOCUMENT, INVOICE e LOAD


locality

localityType

[]

Não

N/A

Local da transição

Tipo complexo detalhado no link


name

string

Sim

N/A

Nome da transição


serviceSequence

int

Sim

N/A

Sequencia de paradas


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


estimatedTimestamp

dateTime

Não

N/A

Data/Hora estimada para a transição


executedTimestamp

dateTime

Não

N/A

Data/Hora em que a transição foi executada


status

string

Sim

N/A

Status da transição pode ser FINALIZED, IN_EXECUTION e NOT_ACCOMPLISHED


extensions

extension[]

Não

N/A

Dados adicionais específicos de cada implementação

Tipo complexo detalhado no link


comments

comment[]

Não

N/A

Local

Comentários de

abertura de ocorrênciaTipo complexo detalhado no link

transições


anchor
Âncora
localityType
localityType

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

do endereçoTipo complexo detalhado no link

onde a transição será efetuada


address

address

complex type

Não

N/A

Endereço

para geocodificaçãoTipo complexo detalhado no link

onde a transição será efetuada


anchor
Âncora
entityDto
entityDto

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


Âncora
address
address

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

Nome

Tipo

ObrigatoriedadeTam. Máx.FormatoValor default

Obrigatório

Tamanho

Descrição

Observações

street

String

Sim

N/A

N/A

N/A

Rua do endereço


street

String

Sim

N/A

N/AN/A

Rua do endereço


number

String

Não

N/A

N/AN/ANumero

Número do endereço


complement

String

Não

N/A

N/AN/Acomplemento

Complemento do endereço


district

String

Não

N/A

N/AN/A

Bairro do endereço


city

String

Não

N/A

Cidade do endereço


state

String

Não

N/A

N/A

Cidade

Estado do endereço

state

country

String

Não

N/A

N/A

Pais do endereço


zipCode

String

Sim

N/A

Estado

CEP do endereço

country

geolocation

String

geolocation

Não

N/A

Latitude e Longitude


Âncora
geolocation
geolocation

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/A
Pais
Longitude do endereço
zipCode

Âncora
extension
extension

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/A
CEP do endereçogeolocationgeolocation[]
Opçã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/A
Latitude e Longitude
Âncorageolocationgeolocation Âncoraextensionextension
Opção para quando a extensão é uma lógica

Âncora
comment
comment

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

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

userstringsimN/AUsuário do comentário
contentstringsimN/AConteúdo do comentário
attachmentLinkstringnãoN/ALink para o anexo
Âncoracommentcomment

Layout de Resposta

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

Nome

Tipo

Obrigatório

Tamanho

Descrição

Observações

messages

message[]

Não

N/A

Lista de respostas

Tipo complexo detalhado no link


Âncora
message
message

message, 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 por tipo

type

string

Sim

N/A

Define o tipo de

documento

monitorável que pode ser TRIP, DOCUMENT, INVOICE e LOAD


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ódigoMensagemDescrição

Anexos

Anexos