UserGroup

Moduł odpowiedzialny za zarządzanie powiązaniami użytkownika z grupami - listowanie, tworzenie, modyfikacja, usuwanie.

Endpointy obsługujące żądanie:

  • https://api.5ways.com

Pobieranie listy powiązań użytkownika z grupami

GET /rest/user_group

Zwraca listę powiązań

Zwracane dane
HTTP/1.1 200 OK
{
    "UserGroup": {
        "id": "1",
        "customer_id": "82",
        "user_id": "122",
        "group_id": "1",
        "created": "2018-10-08 13:02:39",
        "modified": "2018-10-08 13:02:39"
    }
},
{
    "UserGroup": {
        "id": "2",
        "customer_id": "82",
        "user_id": "122",
        "group_id": "2",
        "created": "2018-10-08 13:02:43",
        "modified": "2018-10-08 13:02:43"
    }
}

Pobieranie wybranego powiązania użytkownika z grupą

GET /rest/user_group/{id}

Zwraca dane powiązania na podstawie podanego ID

Zwracane dane
HTTP/1.1 200 OK
{
    "UserGroup": {
        "id": "1",
        "customer_id": "82",
        "user_id": "122",
        "group_id": "1",
        "created": "2018-10-08 13:02:39",
        "modified": "2018-10-08 13:02:39"
    }
}

Tworzenie powiązania użytkownika z grupą

POST /rest/user_group

Tworzy nowe powiązanie

Treść żądania
{
    "UserGroup": {
        "user_id": "122",
        "group_id": "1"
    }
}
Odpowiedź
HTTP/1.1 201 Created
location: https://api.5ways.com/rest/user_group/{id}

Modyfikowanie powiązania użytkownika z grupą

PUT /rest/user_group/{id}

Modyfikuje dane powiązanie

Treść żądania
{
    "UserGroup": {
        "user_id": "123",
        "group_id": "2"
    }
}
Odpowiedź
HTTP/1.1 200 OK
{
    "status": "OK"
}

Usuwanie powiązania użytkownika z grupą

DELETE /rest/user_group/{id}

Trwale usuwa powiązanie.

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