Skip to main content

Extrai dados de permanências

ConsultaExtrai informaçõesdo banco de dados da garagem, identificada pelo parâmetro <garagem_id>, dados de permanênciancias dos veículosculos, atravésa dopartir ticketde ouuma dadeterminada placadata. que se encontra dentro do pátio do estacionamento. Veículos que já saíram do estacionamentoPara não podemsobrecarregar sero consultados.servidor Aoda realizargaragem, cada requisição de extração contém, no máximo, 1.000 registros. Dessa forma, a consulta,partir éda realizadosegunda requisição o cálculoparâmetro inicio_datahora deve conter o horário de tabelaentrada de preços, de acordo com as regras definidas pela garagem, e caso o valor devido seja maior que zero, um identificadordo únicoltimo eregistro temporário da consulta, que deve ser utilizadoretornado na requisição deanterior. pagamento,Isso égarante gerado. 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,que todos tickets,registros com exceçãsão daquelesretornados 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. Asem requisições comsubsequentes. ticketsPara iniciadosnão pelosobrecarregar dígitoas “9”respostas geradas, o sistema faz automaticamente paginação dos dados e comfornece placasos iniciadaslinks pelapara letra “Z” retornarãnavegação códigoentre as páginas. Caso os parâmetros page e per_page não sejam informados, os valores 1 e 20 são associados, respectivamente, aos parâmetros. Os links de erronavegação 404são (notretornados found)no header, seguindo a especificação RFC-8288.

GET api/integradores/permanencias?ticket=extratores/garagens/<ticketgaragem_id>/permanencias


GET api/integradores/permanencias?ticket=<ticket>&desconto=<desconto>


GET api/integradores/permanencias?placa=<placa>

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
Content-Typeapplication/jsonTipo de conteúdo do requestSIM

PARÂMETROS QUERY STRING

CHAVE
 DESCRIÇÃO
 OBRIGATÓRIO
ticketinicio_datahora
 NúmeroHorário inicial do ticketperíodo de consulta.
 SIM
placapageNúmero da página da listagem.
 Placa do veículo
SIMNÃO
descontoper_page Valor ou porcentagemQuantidade de desconto.registros Opor desconto será aplicado mediante a configuração do usuário. No caso de porcentagem, deve ser utilizado um valor entre 0.00 e 1.página. NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
 DESCRIÇÃO
ticket
 Número do ticket.
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.
tempo_permanencia Tempo de permanência em segundos.
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_adquirente Valor que será cobrado do adquirente.
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 TICKET

{
    "permanencia": {
        "ticket": "1234567890",
        "entrada_datahora": "2019-08-31T01:26:44-03:00",
        "validade_datahora": "2019-08-31T02:26:44-03:00",
      	"tempo_permanencia": 3600,
        "valor_total": "10.5",
        "valor_pago": "5.5",
        "valor_devido": "5.0",
        "valor_adquirente": "5.0",
        "transacao": "ab12cd34",
        "transacao_validade_datahora": "2019-08-31T01:56:30-03:00",
    }
}

RETORNO EM CASO DE SUCESSO DE CONSULTA POR TICKET COM DESCONTO

{
    "permanencia": {
        "ticket": "1234567890",
        "entrada_datahora": "2019-08-31T01:26:44-03:00",
        "validade_datahora": "2019-08-31T02:26:44-03:00",
      	"tempo_permanencia": 3600,
        "valor_total": "10.5",
        "desconto": "2.0"
        "valor_pago": "5.5",
        "valor_devido": "3.0",
        "valor_adquirente": "5.0",
        "transacao": "ab12cd34",
        "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",
      	"tempo_permanencia": 3600,
        "valor_total": "10.5",
        "valor_pago": "5.5",
        "valor_devido": "5.0",
        "valor_adquirente": "5.0",
        "transacao": "ab12cd34",
        "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 <ticket> ou não tenha permissão para utilizar o <desconto>.
401
 Caso as credenciais sejam inválidas.
404
 Caso o ticket ou placa não seja encontrado no pátio

Back to top