Extrai dados de permanências

Extrai do banco de dados da garagem, os dados de permanências dos veículos, a partir de uma determinada data ou número de documento. Para não sobrecarregar o servidor da garagem, cada requisição de extração contém, no máximo, 1.000 registros. A partir da segunda requisição, o parâmetro 'inicio_datahora' deve conter o horário de entrada do registro mais recente, ou o parâmetro "ultimo_documento" com o número do documento mais recentemente recebido, que foi retornado na requisição anterior. Isso garante que todos registros são retornados em requisições subsequentes. Além disso, no caso de utilizar o número do último documento para a primeira carga de dados, caso não disponha de um número de documento inicial, você pode estimar qual será o número de documento, considerando que ele seguirá um formato padrão consistindo de 10 dígitos. Os dois primeiros dígitos representarão o ano, os dois seguintes o mês, seguidos por uma sequência de seis zeros. Isso permitirá uma identificação eficiente dos registros, mesmo na ausência de um número de documento inicial. Para não sobrecarregar as respostas geradas, o sistema faz automaticamente paginação dos dado. Caso os parâmetros page e per_page não sejam informados, os valores 1 e 20 são associados, respectivamente, aos parâmetros.

GET api/extratores/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.	NÃO
ultimo_documento	Define o último documento sequencial a ser incluído na consulta. A consulta considerará apenas documentos posteriores a este marco.	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
documento	Número do documento único, gerado automaticamente pela automação.
tipo	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_codigo	Código do pátio em que o cliente estacionou.
ticket	Nú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_codigo	Código único do credenciado.
entrada_datahora	Horário local de entrada do veículo na garagem.
entrada_terminal	Terminal físico por onde o veículo entrou na garagem.
saida_datahora	Horá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_terminal	Terminal 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ência, em minutos, do veículo na garagem. Contém o valor null enquanto o veículo não sair da garagem.
cpf_cnpj	CPF ou CNPJ declarado pelo cliente no momento da emissão do RPS. Contém o valor null nos casos em que o cliente não declarou o CPF ou CNPJ.
cortesia	1(true) ou 0(false)
cortesia_obs	Observação da cortezia

RETORNO EM CASO DE SUCESSO DE CONSULTA POR TICKET

{
    "permanencias": [
        {
            "documento": "2101000001",
            "tipo": "HOR",
            "patio_codigo": "01",
            "ticket": "2100000019",
            "veiculo_placa": null,
            "credenciado_codigo": null,
            "entrada_datahora": "2021-01-02T10:00:00+03:00",
            "entrada_terminal": "M001",
            "saida_datahora": "2021-01-02T12:45:00+03:00",
            "saida_terminal": "M003",
            "permanencia_minutos": 165,
            "cpf_cnpj": "73048114718",
            "cortesia": 0,
            "cortesia_obs": null
        },
        {
            "documento": "2101000002",
            "tipo": "MEN",
            "patio_codigo": "01",
            "ticket": null,
            "veiculo_placa": "ABC1234",
            "credenciado_codigo": "000001",
            "entrada_datahora": "2021-01-02T10:30:00+03:00",
            "entrada_terminal": "M002",
            "saida_datahora": "2021-01-02T18:00:00+03:00",
            "saida_terminal": "M004",
            "permanencia_minutos": 450,
            "cpf_cnpj": null,
            "cortesia": 1,
            "cortesia_obs": "MANUTENCAO"
        },...
    ]
}

OUTROS RETORNOS

CÓDIGO HTTP	DESCRIÇÃO
401	Caso as credenciais sejam inválidas.
404	Caso o ticket ou placa não seja encontrado no pátio