UserRole

Moduł odpowiedzialny za zarządzanie rolami użytkowników - listowanie, tworzenie, modyfikacja, usuwanie.

Pobieranie listy ról użytkowników

GET /rest/user_role

Zwraca listę ról użytkowników

Zwracane dane

HTTP/1.1 200 OK
{
    "UserRole": {
        "id": "1",
        "customer_id": "1",
        "name": "Administrator",
        "created": "2018-03-02 12:01:55",
        "modified": "2018-03-02 12:01:55"
    }
},
{
    "UserRole": {
        "id": "2",
        "customer_id": "1",
        "name": "Ekspert",
        "created": "2018-03-02 13:01:55",
        "modified": "2018-03-02 15:01:55"
    }
}

Pobieranie wybranej roli użytkownika

GET /rest/user_role/{id}

Zwraca dane roli użytkownika na podstawie podanego ID

Zwracane dane

HTTP/1.1 200 OK
{
    "UserRole": {
        "id": "1",
        "customer_id": "1",
        "name": "Administrator",
        "created": "2018-03-02 12:01:55",
        "modified": "2018-03-02 12:01:55"
    }
}

Tworzenie roli użytkowników

POST /rest/user_role

Tworzy nową rolę dla użytkowników

Treść żądania

{
    "UserRole": {
        "name": "Praktykant"
    }
}

Odpowiedź

Zwraca obiekt z id nowo utworzonej roli użytkownika

HTTP/1.1 201 Created
location: https://api.5ways.com/rest/user_role/{id}
{
    "id": 115
}

Modyfikowanie roli użytkowników

PUT /rest/user_role/{id}

Modyfikuje dane roli użytkowników

Treść żądania

{
    "UserRole": {
        "name": "Super Administrator"
    }
}

Odpowiedź

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

Usuwanie roli użytkownika

DELETE /rest/user_role/{id}

Trwale usuwa role użytkowników

Odpowiedź

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