TIPOS DE MENSAGENS

Os tipos de mensagens podem ser divididos em solicitações (request) e resposta (response) pela outra parte. O não envio da resposta em tempo hábil para uma mensagem do tipo “Request” poderá ocasionar seu repetido reenvio, em intervalos regulares por um número determinado de vezes. O tempo máximo de resposta (timeout), quantidade de repetições de envio e tempo de espera entre reenvio deverão ser configuráveis no sistema de controle de OSA.

Os seguintes tipos de mensagem estão disponíveis para uso pelos sistemas:

MENSAGEM	ENVIADA POR	SITUAÇÃO DE USO
MsgHandshake	ambos	Primeiro comunicação entre os sistemas
MsgPreEntryRequest	OSA	Solicitação de entrada
MsgPreEntryResponse	LINK	Resposta à solicitação de entrada
MsgPostEntryNotification	OSA	Confirmação de entrada
MsgPreExitrequest	OSA	Solicitação de saída
MsgPreExitResponse	LINK	Resposta à solicitação de saída
MsgExitAuthorization	OSA	Confirmação de saída
MsgPostExitNotification	LINK	Resposta à confirmação de saída
MsgCancelTicketRequest	LINK	Solicitação de cancelamento de entrada
MsgCancelTicketResponse	OSA	Confirmação de cancelamento de entrada

 

MsgHandshake

Esta mensagem deverá ser enviada uma única vez, no início da comunicação entre os sistemas.

CAMPO	TIPO	DESCRIÇÃO	EXEMPLO
DateTime	string	Data e hora local do sistema	20201230164505.000

{
  "DateTime":"20201230164505.000"
}

MsgPreEntryRequest

Esta mensagem deverá ser enviada sempre que o sistema de controle de OSA desejar realizar a entrada de um veículo.

CAMPO	TIPO	DESCRIÇÃO	EXEMPLO
DateTime	string	Data e hora local do sistema	20201230164505.000
Issuer	string	Entidade responsável pelo meio de pagamento	OSA
VehicleId	string	Placa do veículo	ABC1234
Lane	string	Identificação da pista na qual o veículo foi detectado e identificado	EN01
Message	string	Opcional. Mensagem de texto para ser exibida ao motorista do veículo, contendo, no máximo 20 caracteres	SALDO: 15,00

{
  "DateTime":"20201230164505.000",
  "Issuer":"OSA",
  "VehicleId":"ABC1234",
  "Lane":"EN01",
  "Message":"SALDO: 15,00"
}

 

MsgPreEntryResponse

Esta mensagem deverá ser enviada como resposta a uma solicitação de entrada.

CAMPO	TIPO	DESCRIÇÃO	EXEMPLO
DateTime	string	Data e hora local do sistema	20201230164505.000
VehicleId	string	Placa do veículo	ABC1234
CanContinue	boolean	Indica se a OSA tem autorização para continuar o processamento do veículo	true
Reason	string	Texto com o motivo da rejeição do veículo	null
TicketNumber	string	Número do ticket gerado pela LINK	2012123456

{
  "DateTime":"20201230164505.000",
  "VehicleId":"ABC1234",
  "CanContinue": true,
  "Reason":null,
  "TicketNumber":"2012123456"
}