Histórico da Página
Sumário
...
Índice | ||
---|---|---|
|
Objetivo
...
Esse documento tem o objetivo de exemplificar o uso da API utilizando todos os métodos implementados.
1 - Método
...
Foi implementados na API de Perfil somente o método GET.
1.1 - GET
...
1.1.1 - Get All (Recuperar todos os perfis cadastrados na coligada)
...
Informações | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||
|
1.1.2 - Order(Resultado Ordenado)
Informações | ||
---|---|---|
| ||
Order: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. O resultado com a ordem descendente deve ser precedida do caractere "-" (menos). Exemplo 1: ?order=campo1 (Ascendente) Exemplo 2: ?order=-campo1 (Descendente) Múltiplos campos de ordenação: ?order=[-]campo1, [-]campo2, [-]campo3 ... Padrão scim: SortBy: define o campo que será ordenado. SortOrder: parâmetro responsável pela ordenação do resultado, podendo ser ascendente ou descendente. Exemplo 1: ?sortBy=campo1&sortOrder=ascending (Ascendente) Exemplo 2: ?sortBy=campo1&sortOrder=descending (Descendente) |
...
Informações | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||
|
1.1.3 - Filter (Resultado filtrado)
...
Informações | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||
|
1.1.4 - Paginação
...
Informações | ||
---|---|---|
| ||
Page: Página que será apresentada. PageSize: Quantidade máxima de registros por página que serão apresentados. Exemplo: ?page=valor1&pageSize=1 Valores padrão: Caso não sejam preenchidos os parâmetros evidenciados acima serão preenchidos com valores padrão. Page: 1 PageSize: 20 Padrão scim: StartIndex: valor inicial do índice do registro que será retornado. Count: quantidade máxima de registros que serão apresentados. Exemplo 1: ?startIndex=2&count=2 |
Informações | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||
|
1.1.5 - Fields (Retorno de campos específicos no resultado)
...
Informações | ||
---|---|---|
| ||
Fields: parâmetro responsável pela especialização de campos em um resultado, ou seja, o usuário define quais campos serão apresentados no resultado. Exemplo: ?fields=campo1 Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ... Padrão scim: Attributes: define quais campos serão apresentados no resultado. Exemplo 1: ?attributes=campo1 Múltiplos campos de ordenação: ?fields=campo1, campo2, campo3 ... |
Informações | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||
|
1.1.6 - Fields &Order (Retornar os campos específicos em ordem)
...
Informações | ||
---|---|---|
| ||
Expand: Parâmetro responsável pela especialização e ordenação de campos em um resultado. Exemplo: ?fields=id&order=-id - Nesse exemplo, serão retornados o campo "id" de perfis e em ordem descendente. Padrão scim: Attributes: define quais campos serão apresentados no resultado. Exemplo 1: ?attributes=campo1&sortBy=campo2&sortOrder=descending |
...