Versões comparadas

Chave

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

Introdução

Sistemas Envolvidos

Integração

Escopo

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

Layout de Requisição

NomeTipoObrigatórioTamanhoDescriçãoObservações
monitorableSourceIdstringSimN/ACódigo do monitorável
monitorableTypestringSimN/ADefine o tipo de documento que pode ser TRIP, DOCUMENT, INVOICE, LOAD
transitionstransition[]NãoN/ADados da transiçãoTipo complexo detalhado no link

Âncora
transition
transition

NomeTipoObrigatórioTamanhoDescriçãoObservações
monitorableCodestringSimN/ACódigo do monitorável
monitorableTypestringSimN/ADefine o tipo de documento que pode ser TRIP, DOCUMENT, INVOICE e LOAD
localitylocalityType[]NãoN/ALocal da transiçãoTipo complexo detalhado no link
namestringSimN/ANome da transição
serviceSequenceintSimN/ASequencia de paradas
expectedTimestampdateTimeSimN/AData/Hora esperada para a transição
limitTimestampdateTimeNãoN/AData/Hora limite para a transição
estimatedTimestampdateTimeNãoN/AData/Hora estimada para a transição
executedTimestampdateTimeNãoN/AData/Hora em que a transição foi executada
statusstringSimN/AStatus da transição pode ser FINALIZED, IN_EXECUTION e NOT_ACCOMPLISHED
extensionsextension[]NãoN/ADados adicionais específicos de cada implementaçãoTipo complexo detalhado no link
commentscomment[]NãoN/ALocal de abertura de ocorrênciaTipo complexo detalhado no link

Âncora
localityType
localityType

NomeTipoObrigatórioTamanhoDescriçãoObservações
localityentityDto[]NãoN/ALocalidade do endereçoTipo complexo detalhado no link
addresscomplex typeNãoN/AEndereço para geocodificaçãoTipo complexo detalhado no link

Âncora
entityDto
entityDto

NomeTipoObrigatórioTamanhoDescriçãoObservações
sourceIdstringSimN/ACódigo da entidade
namestringNãoN/ANome da entidade
descriptionstringNãoN/ADescrição da entidade

Âncora
address
address

NomeTipoObrigatoriedadeTam. Máx.FormatoValor defaultDescriçãoObservações
streetStringSimN/AN/AN/ARua do endereço
streetStringSimN/AN/AN/ARua do endereço
numberStringNãoN/AN/AN/ANumero do endereço
complementStringNãoN/AN/AN/Acomplemento do endereço
districtStringNãoN/AN/AN/ABairro do endereço
cityStringNãoN/AN/AN/ACidade do endereço
stateStringNãoN/AN/AN/AEstado do endereço
countryStringNãoN/AN/AN/APais do endereço
zipCodeStringSimN/AN/AN/ACEP do endereço
geolocationgeolocation[]NãoN/AN/AN/ALatitude e Longitude

Âncora
geolocation
geolocation

Âncora
extension
extension

Âncora
comment
comment

Layout de Resposta

NomeTipoObrigatórioTamanhoDescriçãoObservações
messagesmessage[]NãoN/ALista de respostasTipo complexo detalhado no link

Âncora
message
message

NomeTipoObrigatórioTamanhoDescriçãoObservações
sourceIdstringSimN/ACódigo do monitorávelDeve ser único por tipo
typestringSimN/ADefine o tipo de documento que pode ser TRIP, DOCUMENT, INVOICE e LOAD
resultbooleanSimN/AConfirmação do sucesso ou falha do processo
codestringNãoN/ACódigo do erro
descriptionstringNãoN/ADescrição do erro

Catalogo de

erros

mensagens

Âncora
catmsg
catmsg

Anexos

Anexos