Consulta de estadias (histórico de estadias)

Lista uma ou mais estadias registradas por meio de filtros de seleção, que limitam o resultado e podem ser zero ou mais entre: período, localizado, documento do cliente e pátio.

Os parâmetros inicio_datahora e fim_datahora limitam o resultado pelos campos: entrada_solicitada_em e saida_confirmada_em. 

O parâmetro localizador limita o resultado pelo campo localizador.

O parâmetro documento do cliente limita o resultado pelo campo documento do cliente que esteja vinculado a estadia.

O parâmetro patio_id limita o resultado pelo campo patio_id.

Caso esses parâmetros não sejam informados, a resposta será gerada sem a aplicação de filtros.

Para evitar sobrecarga nas respostas, o sistema realiza automaticamente a paginação dos dados. Caso os parâmetros page e per_page não sejam informados, serão utilizados, respectivamente, os valores padrão 1 e 20.

*OBS: Para acessar  esse endpoint, será necessário habilitar a permissão para o usuário no FOKUS.

GET api/estadias

* Esse endpoint substituirá o endpoint: https://info.linkc.dev.br/books/fokus/page/consulta-estadias. 

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
page	Número da página da listagem	NÃO
per_page	Quantidade de registros por página	NÃO
inicio_datahora	Horário inicial do período de consulta	NÃO
fim_datahora	Horário final do período de consulta	NÃO
localizador	Localizador da estadia	NÃO
documento	Documento do cliente	NÃO
patio_id	ID do pátio a ser consultado	NÃO
status	Status da estadia	NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE	DESCRIÇÃO
id	Identificador único da estadia.
localizador	Localizador da estadia.
entrada_solicitada_em	Data e hora da entrada no estacionamento.
entrada_veiculo_placa	Placa do veículo na entrada
saida_confirmada_em	Data e hora da saída no estacionamento.
parceiro.id	Código do parceiro.
parceiro.identificacao	Identificação do parceiro.
pessoa.id	Código da pessoa
pessoa.nome	Nome da pessoa
plano.id	Código do plano
plano.identificacao	Identificação do plano
status	Status da estadia
terminal_entrada.id	Código do terminal de entrada.
terminal_entrada.identificacao	Identificação do terminal de entrada.
via_entrada.id	Código do via de entrada.
via_entrada.identificacao	Identificação do via de entrada.
terminal_saida.id	Código do terminal de entrada.
terminal_saida.identificacao	Identificação do terminal de entrada.
via_saida.id	Código do via de entrada.
via_saida.identificacao	Identificação do via de entrada.

EXEMPLO DE RETORNO EM CASO DE SUCESSO (200 – OK)

{
    "estadias_faturamentos": [
        {
        "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "localizador": "1234567890",
        "entrada_solicitada_em": "2019-08-30T18:35:25.000000-03:00",
        "entrada_veiculo_placa": "ABC1234"
        "saida_confirmada_em": "2019-08-30T20:49:20.000000-03:00",
        "parceiro": {
            "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
            "identificacao": "DÉBITO",
        },
        "pessoa": {
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
          "nome": "FULANO",
        },
        "plano": {          
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
          "plano": "MENSAL"
        },
        "patio": {          
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
          "plano": "MENSAL"
        },
        "status": "saida_confirmada",
        "terminal_entrada": {
          "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "identificacao": "ATM"
        },
        "via_entrada": {
          "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "identificacao": "ATM"
        },
        "terminal_saida": {
          "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "identificacao": "ATM"
        }
        "via_saida": {
          "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "identificacao": "ATM"
        }
    }, …
    ]
}

OUTROS RETORNOS

CÓDIGO HTTP	DESCRIÇÃO
401	Caso as credenciais sejam inválidas.