Extrai dados de permanências

Extrai do banco de dados da garagem, identificada pelo parâmetro <garagem_id>, dados de permanências dos veículos, a 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 último registro retornado na requisição anterior. Isso garante que todos registros são retornados em requisições subsequentes. 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 navegação são retornados no header, seguindo a especificação RFC-8288.

GET api/extratores/garagens/<garagem_id>/permanencias

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-Type	application/json	Tipo de conteúdo do request	SIM

PARÂMETROS QUERY STRING

CHAVE	DESCRIÇÃO	OBRIGATÓRIO
inicio_datahora	Horário inicial do período de consulta.	SIM
page	Número da página da listagem.	NÃO
per_page	Quantidade de registros por 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