Skip to main content

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 a 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"
}

MsgPostEntryNotification

Esta mensagem deverá ser enviada pela OSA após o recebimento de uma mensagem MsgPreEntryResponse com CanContinue=true, para informar a confirmação do processamento do veículo. A LINK não responde essa mensagem.

CAMPO TIPO DESCRIÇÃO EXEMPLO
VehicleId string Placa do veículo ABC1234
TicketNumber string Número do ticket gerado pela LINK 2012123456
Lane string Identificação da pista na qual o veículo foi detectado e identificado EN01 
{
  "VehicleId":"ABC1234",
  "TicketNumber":"2012123456",
  "Lane":"EN01"
}

MsgPreExitRequest

Esta mensagem deverá ser enviada sempre que a OSA desejar realizar a saída 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
TicketNumber string Número do ticket gerado pela LINK 2012123456 
{
  "DateTime":"20201230164505.000",
  "Issuer":"OSA",
  "VehicleId":"ABC1234",
  "Lane":"EN01",
  "Message":"SALDO: 15,00",
  "TicketNumber":"2012123456"
}

MsgPreExitResponse

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

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
TotalAmountDue decimal Valor total da tarifa devida, já calculados os descontos 123.45
Discount decimal Valor total dos descontos concedidos 0.00
DiscountReason decimal Texto explicando os descontos null
StayTimeMinutes integer Tempo de permanência em minutos 123 
{
  "DateTime":"20201230164505.000",
  "VehicleId":"ABC1234",
  "CanContinue": true,
  "Reason":null,
  "TicketNumber":"2012123456",
  "TotalAmountDue":123.45,
  "Discount":0.00
  "DiscountReason":null,
  "StayTimeMinutes":123
}

MsgExitAuthorization

Esta mensagem deverá ser enviada pela OSA em resposta a uma mensagem MsgPreExitResponse. Sua função é informar à LINK a respeito do processamento da saída do veículo. Esta mensagem é enviada após a OSA determinar se o veículo tem saldo para o pagamento da tarifa informada na mensagem MsgPreEntryResponse e informa à LINK sobre a autorização para liberação do controle de acesso físico (cancela). Sendo assim, a LINK abrirá a cancela somente após o recebimento e processamento desta mensagem, caso ela contenha uma autorização positiva.

CAMPO TIPO DESCRIÇÃO EXEMPLO
TicketNumber string Número do ticket gerado pela LINK 2012123456
Lane string Identificação da pista na qual o veículo foi detectado e identificado EN01
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":"2012123456",
  "Lane":"EN01",
  "CanContinue":true,
  "Reason":null
}

MsgPostExitAuthorization

Esta mensagem deverá ser enviada pela LINK em resposta a uma mensagem MsgExitAuthorization.

CAMPO TIPO DESCRIÇÃO EXEMPLO
TicketNumber string Número do ticket gerado pela LINK 2012123456 
{
  "TicketNumber":"2012123456"
}

MsgCancelTicketRequest

Esta mensagem deverá ser enviada pela LINK solicitando à OSA o cancelamento de um ticket que ainda não realizou a saída.

CAMPO TIPO DESCRIÇÃO EXEMPLO
TicketNumber string Número do ticket gerado pela LINK 2012123456
Plate string Placa do veículo ABC1234
Reason string Texto com o motivo da rejeição do veículo CLIENTE APERTOU O BOTAO DO EQUIPAMENTO 
{
  "TicketNumber":"2012123456",
  "Plate":"ABC1234",
  "Reason":"CLIENTE APERTOU BOTAO DO EQUIPAMENTO"
}

MsgCancelTicketResponse

Esta mensagem deverá ser enviada pela OSA em resposta a uma mensagem do tipo MsgCancelTicketRequest. Sua função é informar à outra parte sobre o resultado da solicitação de cancelamento de ticket recebida.

CAMPO TIPO DESCRIÇÃO EXEMPLO
TicketNumber string Número do ticket gerado pela LINK 2012123456
Canceled boolean Informa se o ticket foi cancelado true
Reason string Texto com o motivo da rejeição do veículo CLIENTE APERTOU O BOTAO DO EQUIPAMENTO 
{
  "TicketNumber":"2012123456",
  "Canceled":true,
  "Reason":"CLIENTE APERTOU BOTAO DO EQUIPAMENTO"
}

Back to top