Skip to main content

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)

clientenão CPFou
CHAVE
 DESCRIÇÃO
ticketdocumento
 Número do ticket.documento único, gerado automaticamente pela automação.
placatipo
Classificação do tipo do cliente. "AUT" para autorizado, "MEN" para mensalista, "HOR" para horista, "EXT" para tickets extraviados e "PER" para clientes controlados por períodos.
patio_codigoCódigo do pátio em que o cliente estacionou.
ticketNúmero do código de barras impresso no ticket.
veiculo_placa Placa do veículo.
 Essa informação está disponível quando a garagem possui câmera com OCR nas entradas e quando o tipo do cliente é "AUT" ou "MEN" e a placa do veículo está registrada no cadastro do credenciado.
credenciado_codigoCódigo único do credenciado.
entrada_datahora DataHorário e hora de registrolocal de entrada nodo estacionamento.veículo na garagem.
validade_datahoraentrada_terminal DataTerminal efísico horapor deonde validadeo paraveículo saídaentrou dona estacionamento.garagem.
tempo_permanenciasaida_datahoraHorário local de saída do veículo na garagem. Contém o valor null enquanto o veículo não sair da garagem.
saida_terminalTerminal físico por onde o veículo saiu da garagem. Contém o valor null enquanto o veículo não sair da garagem.
permanencia_minutos Tempo de permanênciancia, em segundos.minutos, do veículo na garagem. Contém o valor null enquanto o veículo não sair da garagem.
valor_totalcpf_cnpj ValorCPF totalou CNPJ declarado pelo cliente no momento da estadiaemissão desdedo entrada_datahoraRPS. atéContém o momento,valor incluindonull todosnos oscasos pagamentosem já realizados paraque o ticket.
descontoValor do desconto em reais. 
valor_pagoSoma de todos os valores pagos paradeclarou o ticket.
valor_devidoValor devido pelo cliente, calculado como valor_total menos valor_pago menos desconto.
valor_adquirenteValor que será cobrado do adquirente.
transacaoIdentificador único e temporário da transação de consulta quando valor_devido for maior que zero.
transacao_validade_datahoraData e hora de validade do identificador único e temporário da transação de consulta quando valor_devido for maior que zero.CNPJ.

RETORNO EM CASO DE SUCESSO DE CONSULTA POR TICKET

{
    "permanencia"permanencias": [
        {
            "documento": "2101000001",
            "tipo": "HOR",
            "patio_codigo": "01",
            "ticket": "1234567890"2100000019",
            "veiculo_placa": null,
            "credenciado_codigo": null,
            "entrada_datahora": "2021-01-02T10:00:00.000",
            "entrada_terminal": "M001",
            "saida_datahora": "2021-01-02T12:45:00.000",
            "saida_terminal": "M003",
            "permanencia_minutos": 165,
            "cpf_cnpj": "73048114718"
        },
        {
            "documento": "2101000001",
            "tipo": "MEN",
            "patio_codigo": "01",
            "ticket": null,
            "veiculo_placa": "ABC1234",
            "credenciado_codigo": "000001",
            "entrada_datahora": "2019-08-31T01:26:44-03:00"2021-01-02T10:30:00.000",
            "validade_datahora"entrada_terminal": "2019-08-31T02:26:44-03:00"M002",
            "tempo_permanencia": 3600,
        "valor_total"saida_datahora": "10.5"2021-01-02T18:00:00.000",
            "valor_pago"saida_terminal": "5.5"M004",
            "valor_devido"permanencia_minutos": "5.0",450,
            "valor_adquirente"cpf_cnpj": "5.0",
        "transacao": "ab12cd34",
        "transacao_validade_datahora": "2019-08-31T01:56:30-03:00",null
        },...
    }

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