Preferências do Usuários

Listar

Lista as preferências de um usuário.

Method URI Headers Authorization
GET /api/v3/users-preferences Content-Type:application/json Authorization: Bearer {token}

Parameters

_sort: 'id' (string) ('id') - "Define o campo de ordenação da lista."
_order: 'desc' (string) ('asc', 'desc') - "Define a ordem da lista com base no campo definido."
user_id: 1 (integer, required) - "Filtrar preferência do usuário pelo seu Id."
preference_id: 1 (integer) - "Filtrar preferência do usuário pelo Id da preferência."


Response

{success} Response 200 (application/json)

{
    "items": [
        {
            "id": 1,
            "value": -3,
            "preference": {
                "id": 1,
                "name": "Timezone"
            }
        }
    ]
}

{warning} Response 422 (application/json)

{
    "user_id": [
        "O campo user id é obrigatório."
    ]
}

{primary} Response 204 (application/json).

Quando os critérios de parâmetros não contiver registros a serem retornados.

Pegar

Seleciona a preferência do usuário pelo Id da configuração.

Method URI Headers Authorization
GET /api/v3/users-preferences/1 Content-Type:application/json Authorization: Bearer {token}

Parameters

userPreferenceId: 1 - (integer, required) - "Id da configuração da preferência do usuário"

Response

{success} Response 200 (application/json)

{
    "id": 1,
    "value": -3,
    "preference": {
        "id": 1,
        "name": "Timezone"
    }
}

{warning} Response 403 (application/json)

"Permissões insuficientes!"

{warning} Response 400 (application/json)

Quando ocorrer algum erro.

Criar

Cria uma preferência do usuário.

Method URI Headers Authorization
POST /api/v3/users-preferences Content-Type:application/json Authorization: Bearer {token}

{info} Permitido apenas uma configuração por usuário e preferência.

Attributes

user_id: 1 (integer) - "Id do Usuário."
preference_id: 1 (integer) - "Id da preferência."
value: -3 (tipo váriavel de acordo com a preferência, required) - "Valor da preferência."


Response

{success} Response 201 (application/json)

{
    "id": 1,
    "value": -3,
    "preference": {
        "id": 1,
        "name": "Timezone"
    }
}

{warning} Response 422 (application/json)

{
    "preference_id": [
        "O campo preference id já está sendo utilizado."
    ]
}

{warning} Response 400 (application/json)

Quando ocorrer algum erro.

Atualizar

Atualiza uma preferência do usuário.

Method URI Headers Authorization
PUT /api/v3/users-preferences/1 Content-Type:application/json Authorization: Bearer {token}

{info} Permitido apenas atualização do valor da preferência.

Attributes

value: 0 (tipo váriavel de acordo com a preferência, required) - "Valor da preferência."


Response

{success} Response 200 (application/json)

{
    "id": 1,
    "value": 0,
    "preference": {
        "id": 1,
        "name": "Timezone"
    }
}

{warning} Response 422 (application/json)

{
    "value": [
        "O campo value é obrigatório."
    ]
}

{warning} Response 400 (application/json)

Quando ocorrer algum erro.

Deletar

Exclui uma preferência do usuário.

Method URI Headers Authorization
DELETE /api/v3/users-preferences/1 Content-Type:application/json Authorization: Bearer {token}

Response

{primary} Response 204 (application/json). Quando registro foi excluido

{warning} Response 400 (application/json)

Quando ocorrer algum erro.