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ênciapermanências dos veículosveículos, atravésa partir de uma determinada data. Para não sobrecarregar o servidor da garagem, cada requisição de extração contém, no máximo, 1.000 registros. Dessa forma, a partir da segunda requisição o parâmetro inicio_datahora deve conter o horário de entrada do ticketúltimo ouregistro 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 utilizadoretornado na requisição deanterior. pagamento,Isso égarante gerado.que Cadatodos garagemregistros possuisão configuraçãoretornados própriaem dorequisições temposubsequentes. Para não sobrecarregar as respostas geradas, o sistema faz automaticamente paginação dos dados e fornece os links para navegação entre 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 validadenavegação dosão identificadorretornados entreno header, seguindo a consultaespecificação 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 tickets, 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)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