Consulta de estadias

Lista um ou mais estadias registradas através de filtros de seleção, que limitam o resultado e podem ser zero ou mais dentre período, localizado, documento do cliente e pátio. Os parâmetros inicio_datahora e fim_datahora limitam o resultado pelo campo registro_datahora. 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 eles não sejam informados, a resposta é gerada sem a aplicação dos filtros. Para não sobrecarregar as respostas geradas, o sistema faz automaticamente paginação dos dados. 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/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 dos pagamentos.	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	Nome e sobrenome do portador, separado por espaço simples.	NÃO
patio_id	Id do terminal a ser consultado	NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE	DESCRIÇÃO
id	Identificador único da transação de pagamento.
localizador	Localizador da estadia.
entrada_solicitada_em	Data e hora da entrada no estacionamento.
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
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",
        "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"
        },
        "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.