API Fogo Cruzado logo API Fogo Cruzado

Filtros


Definições

Os endpoints que são "filtráveis", serão marcados nessa documentação.

A API é preparada para receber filtros de acordo com os campos desejados na consulta. Para facilitar a descoberta dos campos, a aplicação dispõe para cada endpoint, um método que retorna os campos disponíveis.

Esse método é descrito na documentação do endpoint, se não estiver descrito na documentação o endpoint não é "filtrável".

Os tipos de filtros disponíveis são:

Tipo Representação Descrição
Equalidade Parâmetro padrão na URL É um parâmetro comum na URL, baseado nos campos disnívies no endpoint
Parcialidade lk É o LIKE do SQL, onde temos uma busca parcial de um conteúdo do tipo String
Agrupamento Parâmetro do tipo array na URL É o IN do SQL. Para que o sistema filtre nesse formato, é necessário enviar como array.
Maior Igual gt Define o início de um range de dados.
Menor Igual lt Define o fim de um range de dados.

Exemplos:

Equalidade

https://api.fogocruzado.org.br.com/api/v1/endpoint?parametro=valor

Parcialiade

https://api.fogocruzado.org.br.com/api/v1/endpoint?parametro[lk]=valor

Agrupamento

https://api.fogocruzado.org.br.com/api/v1/endpoint?parametro[]=valor1&parametro[]=valor2...

Maior Igual

https://api.fogocruzado.org.br.com/api/v1/endpoint?parametro[gt]=valor

Menor Igual

https://api.fogocruzado.org.br.com/api/v1/endpoint?parametro[lt]=valor

Between

https://api.fogocruzado.org.br.com/api/v1/endpoint?parametro[gt]=valor&parametro[lt]=valor

Campos

A API conta com a possibilidade de filtrar quais campos serão retornados. Para isso, é necessário enviar um parâmetro na url chamado field.

Somente endpoints "filtráveis" que podem ter seus campos definidos para retorno.

Exemplo: https://api.fogocruzado.org.br.com/api/v1/endpoint?field[]=campo_1&field[]=campo_2&...