Skip to main content

Consulta estadias

Consulta informações de estadia dos veículos através do localizador ou da placa que se encontra dentro do pátio do estacionamento. Veículos que já saíram do estacionamento não podem ser consultados. Ao realizar a consulta, é realizado o cálculo de tabela de preços, de acordo com as regras definidas pela garagem, e caso o valor devido seja maior que zero, um identificador único e temporário da consulta, que deve ser utilizado na requisição de pagamento, é gerado. Caso o usuário tenha acessa a dois ou mais parceiros, o id do parceiro poderá se informado no parâmetro query string, <parceiro_id>. Cada garagem possui configuração própria do tempo de validade do identificador entre a consulta e a confirmação do pagamento. Após o tempo de validade, a transação não é mais válida e não poder ser mais utilizada na requisição de pagamento. Neste caso, deve ser requisitada uma nova consulta e gerada nova transação. Em ambiente de desenvolvimento, todos localizadores, com exceção daqueles iniciados pelo dígito “9” e todas as placas, com exceção daquelas iniciadas pela letra “Z”, serão encontrados e possuirão entrada_datahora gerada aleatoriamente. As requisições com tickets iniciados pelo dígito “9” e com placas iniciadas pela letra “Z” retornarão código de erro 404 (not found).

* Na consulta de parceiro do tipo: OSA, só é permitido nas estadias que o veículo tenha registrado a entrada através do próprio parceiro e a consulta seja através do localizador. 

GET api/estadias?localizador=<localizador>

GET api/estadias?localizador=<localizado>&parceiro_id=<parceiro_id>

GET api/estadias?placa=<placa>

GET api/estadias?placa=<placa>&parceiro_id=<parceiro_id>

HEADERS

CHAVE
 VALOR
 DESCRIÇÃO
 OBRIGATÓRIO
Accept
 application/vnd.linkc.com.br; version=1 Versão da API. SIM
Authorization
 Bearer <TOKEN>
 Token obtido na autenticação
 SIM

PARÂMETROS QUERY STRING

CHAVE
 DESCRIÇÃO
 OBRIGATÓRIO
localizador
 Localizador da estadia
 SIM
placa
 Placa do veículo
 SIM
parceiro_id
 Id do parceiro, pode ser consultado no endpoint de listagem de parceiros, no caso do valor não for informado, a API assumirá o parceiro padrão do usuário
 NÃO

RETORNO EM CASO DE SUCESSO, QUANDO O PARCEIRO FOR DO TIPO: OSA (200 – OK)

CHAVE
 DESCRIÇÃO
localizador
 Localizador da estadia.
status
 Status da estadia. Status possíveis:
  • CANCELADA Indica que a estadia foi cancelada.
  • ABERTA Indica que a estadia ainda não teve registro de saída.
  • FINALIZADA Indica que essa estadia possui um registro de saída e portanto não consta mais no pátio.
entrada_datahora Data e hora de registro de entrada no estacionamento.
validade_datahora Data e hora de validade para saída do estacionamento.
valor_total Valor total da estadia desde entrada_datahora até o momento, incluindo todos os pagamentos já realizados para o ticket.

RETORNO EM CASO DE SUCESSO, QUANDO O PARCEIRO NÃO FOR DO TIPO: OSA (200 – OK)

CHAVE
 DESCRIÇÃO
localizador
 Localizador da estadia.
placa
 Placa do veículo.
entrada_datahora Data e hora de registro de entrada no estacionamento.
validade_datahora Data e hora de validade para saída do estacionamento.
valor_total Valor total da estadia desde entrada_datahora até o momento, incluindo todos os pagamentos já realizados para o ticket.
desconto Valor do desconto em reais. 
valor_pago Soma de todos os valores pagos para o ticket.
valor_devido Valor devido pelo cliente, calculado como valor_total menos valor_pago menos desconto.
valor_parceiro Valor que será cobrado do parceiro.
transacao Identificador único e temporário da transação de consulta quando valor_devido for maior que zero.
transacao_validade_datahora Data e hora de validade do identificador único e temporário da transação de consulta quando valor_devido for maior que zero.

RETORNO EM CASO DE SUCESSO DE CONSULTA POR LOCALIZADOR E PARCEIRO DO TIPO: OSA

{
    "movimento": {
        "documento": "1234567890",
        "status": "FINALIZADO"
        "entrada_datahora": "2019-08-31T01:26:44-03:00",
        "saida_datahora": "2019-08-31T02:26:44-03:00",
        "valor_total": "10.5"
    }
}

RETORNO EM CASO DE SUCESSO DE CONSULTA POR LOCALIZADOR

{
    "estadia_calculo": {
        "localizador": "1234567890",
        "entrada_datahora": "2019-08-31T01:26:44-03:00",
        "validade_datahora": "2019-08-31T02:26:44-03:00",
        "valor_total": "10.5",
        "valor_pago": "5.5",
        "valor_devido": "5.0",
        "valor_adquirente": "5.0",
        "transacao": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "transacao_validade_datahora": "2019-08-31T01:56:30-03:00",
    }
}

RETORNO EM CASO DE SUCESSO DE CONSULTA POR PLACA

{
    "permanencia": {
        "placa": "ABC1234",
        "entrada_datahora": "2019-08-31T01:26:44-03:00",
        "validade_datahora": "2019-08-31T02:26:44-03:00",
        "valor_total": "10.5",
        "valor_pago": "5.5",
        "valor_devido": "5.0",
        "valor_adquirente": "5.0",
        "transacao": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "transacao_validade_datahora": "2019-08-31T01:56:30-03:00",
    }
}

OUTROS RETORNOS

CÓDIGO HTTP
 DESCRIÇÃO
400
 Caso não seja recebido o parâmetro <localizador>/<placa>  ou não tenha permissão para utilizar o <parceiro>.
401
 Caso as credenciais sejam inválidas.
404
 Caso o localizador ou placa não seja encontrado no pátio

Back to top