Zasób zawiera ustawienia sidebaru, widoku dashboardu oraz poszczególnych modułów. Obiekt jest tworzony przy tworzeniu użytkownika, można go wyłącznie aktualizować.

Endpointy obsługujące żądanie:

• https://api.5ways.com

Pobranie danych

GET /rest/settings

Zwróci obiekt ustawień wraz z identyfikatorem, którego następnie można użyć do aktualizacji zasobu. Jeśli ustawienia zostały dopiero zainicjowane przez założenie konta, ustawienia modułów będą puste. Ilość modułów w odpowiedzi będzie zależna od ich aktualnej ilości w systemie.

Odpowiedź

// HTTP/1.1 200 OK
{
    "results": [
        {
            "Settings": {
                "id": "80",
                "customer_id": "150",
                "user_id": "1963",
                "sidebar": null,
                "dashboard": null,
                "created": "2024-03-07 13:10:04",
                "modified": "2024-03-07 13:10:04"
            }
        }
    ]
}

Klucze dashboard i sidebar zawierają ustawienia w formacie json.

Aktualizacja danych

PUT /rest/settings/{id}

Treść żądania

{
    "Settings": {
        "sidebar": {
            "caseManagement": {
                "visible": true
            },
            "chat": {
                "visible": true
            },
            "poll": {
                "visible": false
            }
        },
        "dashboard": null
    }
}

Odpowiedź

HTTP/1.1 200 OK
{
    "status": "OK"
}