Ordenação
A lista de viagens pode ser ordenada com o parâmetro sort. Os demais endpoints têm uma ordem fixa.
| Endpoint | Ordenação |
|---|---|
| Listar viagens | Escolhida com sort. Padrão: data de início, da mais próxima para a mais distante. |
| Listar depoimentos | Fixa: do mais antigo para o mais recente (a ordem em que foram cadastrados). |
O parâmetro sort
Informe um campo. Sem prefixo, a ordem é crescente; com o prefixo - (hífen), é decrescente.
| Valor | Ordem |
|---|---|
start_date | Data de início, da mais próxima para a mais distante (padrão). |
-start_date | Data de início, da mais distante para a mais próxima. |
end_date / -end_date | Data de fim, crescente / decrescente. |
price / -price | Preço, do menor para o maior / do maior para o menor. |
title / -title | Título, de A a Z / de Z a A. |
Exemplo — as viagens mais caras primeiro:
curl "https://minhaagencia.avoei.com.br/api/v1/travels?sort=-price" \
-H "Authorization: Bearer SEU_TOKEN"
Como funciona o desempate
Quando duas viagens têm o mesmo valor no campo de ordenação (por exemplo, começam no mesmo dia), elas aparecem na ordem em que foram cadastradas. Assim a ordem é sempre a mesma, e uma viagem não se repete nem some ao passar de uma página para a seguinte.
Valores inválidos
Só os valores da tabela acima são aceitos. Um campo desconhecido (como sort=vagas) ou mais de um campo (sort=title,price) resulta em erro 422:
{
"success": false,
"message": "The given data was invalid.",
"data": [],
"errors": {
"sort": ["O campo sort selecionado é inválido."]
},
"status": 422
}
Ordenando no seu sistema
A ordenação da API é aplicada antes da paginação: ela ordena o conjunto inteiro, não apenas a página que você recebeu. Se precisar de uma ordem que a API não oferece, leia todas as páginas (veja Paginação) e ordene no seu sistema.