Group

Moduł odpowiedzialny za zarządzanie grupami - listowanie, tworzenie, modyfikacja, usuwanie.

Endpointy obsługujące żądanie:

• https://api.5ways.com

Pobieranie listy grup

GET /rest/group

Zwraca listę grup

Zwracane dane

HTTP/1.1 200 OK
{
    "Group": {
        "id": "1",
        "name": "Praktykanci",
        "created": "2018-10-08 11:06:53",
        "modified": "2018-10-08 11:06:53"
    }
},
{
    "Group": {
        "id": "2",
        "name": "Dyrektorzy",
        "created": "2018-10-08 11:07:38",
        "modified": "2018-10-08 11:07:38"
    }
}

Pobieranie listy grup złączonych z przypisanymi użytkownikami

GET /rest/group/user_group

Zwraca listę grup złączonych z użytkownikami

Zwracane dane

HTTP/1.1 200 OK
{
    "Group": {
        "id": "1",
        "name": "Praktykant",
        "created": "2018-10-08 11:06:53",
        "modified": "2018-10-08 11:06:53"
    },
    "UserGroup": [
        {
            "user_id": "122",
            "group_id": "1"
        }
    ]
},
{
    "Group": {
        "id": "2",
        "name": "Dyrektorzy",
        "created": "2018-10-08 11:07:38",
        "modified": "2018-10-08 11:07:38"
    },
    "UserGroup": []
}

Pobieranie wybranej grupy

GET /rest/group/{id}

Zwraca grupę

Zwracane dane

HTTP/1.1 200 OK
{
    "Group": {
        "id": "1",
        "name": "Praktykanci",
        "created": "2018-10-08 11:06:53",
        "modified": "2018-10-08 11:06:53"
    }
}

Tworzenie grupy

POST /rest/group

Tworzy nową grupę

Treść żądania

{
    "Group": {
        "name": "Praktykanci"
    }
}

Odpowiedź

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

Modyfikowanie grupy

PUT /rest/group/{id}

Modyfikuje dane grupy

Treść żądania

{
    "Group": {
        "name": "Dyrektorzy"
    }
}

Odpowiedź

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

Usuwanie grupy

DELETE /rest/group/{id}

Trwale usuwa grupę oraz wszystkie powiązania do niej.

Odpowiedź

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