Skip to main content

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_entrada e fim_datahora_entrada limitam o resultado pelo campo entrada_solicitada_em.

Os parâmetros inicio_datahora_saida e fim_datahora_saida limitam o resultado pelo campo 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_entrada

Horário inicial do período de consulta no campo: entrada_solicitada_em

 NÃO

fim_datahora_entrada

Horário final do período de consultano campo: entrada_solicitada_em

 NÃO

inicio_datahora_saida

Horário inicial do período de consulta no campo: saida_confirmada_em

 NÃO

fim_datahora_saida

Horário final do período de consultano campo: saida_confirmada_em

 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
estadias[]
Lista das estadias.
estadias[].id
Identificador único da estadia.
estadias[].localizador
Localizador da estadia.
estadias[].entrada_solicitada_em
Data e hora da entrada no estacionamento.
estadias[].entrada_veiculo_placa
Placa do veículo na entrada
estadias[].saida_confirmada_em
Data e hora da saída no estacionamento.
estadias[].parceiro.id
Código do parceiro.
estadias[].parceiro.identificacao
Identificação do parceiro.
estadias[].patio.id
Código do pátio.
estadias[].patio.identificacao
Identificação do pátio.
estadias[].pessoa.id Código da pessoa
estadias[].pessoa.nome Nome da pessoa
estadias[].plano.id Código do plano
estadias[].plano.identificacao Identificação do plano
estadias[].status Status da estadia
estadias[].terminal_entrada.id
Código do terminal de entrada.
estadias[].terminal_entrada.identificacao
Identificação do terminal de entrada.
estadias[].via_entrada.id
Código do via de entrada.
estadias[].via_entrada.identificacao
Identificação do via de entrada.
estadias[].terminal_saida.id
Código do terminal de entrada.
estadias[].terminal_saida.identificacao
Identificação do terminal de entrada.
estadias[].via_saida.id
Código do via de entrada.
estadias[].via_saida.identificacao
Identificação do via de entrada.
metadata
Retorno de outras informações sobre a consulta
metadata.page
Página atual.
metadata.per_page
Quantidade de registro por página.
metatada.total_page
Total de páginas.
metatada.total_items
Total de registros.

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": "PARCEIRO PADRÃO",
        },
        "pessoa": {
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
          "nome": "FULANO",
        },
        "plano": {          
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
          "identificacao": "MENSAL"
        },
        "patio": {          
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
          "identificacao": "CARRO"
        },
        "status": "saida_confirmada",
        "terminal_entrada": {
          "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "identificacao": "ENTRADA 1"
        },
        "via_entrada": {
          "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "identificacao": "VIA ENTRADA 1"
        },
        "terminal_saida": {
          "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "identificacao": "SAÍDA 1"
        }
        "via_saida": {
          "id": "fdbf9bab-a0f9-4924-817b-671b396f622f",
          "identificacao": "VIA SAÍDA 1"
        }
    }, …
    ],
    "metadata": {
      "page": 1,
      "per_page": 20,
      "total_page": 10,
      "total_items": 197
    }
}

OUTROS RETORNOS

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

Back to top