# Grupy użytkowników #### 1. Pobranie istniejących grup i podgrup użytkowników Metoda pozwala na pobranie listy utworzonych grup i podgrup użytkowników.

Metoda: **GET** Adres URL: **{twoja\_nazwa}.ccrm.pl/publicApi/users/groupsType**

Metoda stosuje stronicowanie powyżej 1000 rekordów. API zwróci zawsze maksymalnie 1000 rekordów, a o resztę należy zapytać dodając do adresu page={numer\_strony}. Przykładowo, dla sytuacji gdzie jest więcej niż 1000 rekordów stosujemy: ```JSON {twoja_nazwa}.ccrm.pl/publicApi/users/groupsType?page=2 ``` **Struktura odpowiedzi**
**Właściwość** **Wartość** **Opis**
success bool
data array
data.name string Nazwa grupy użytkowników.
data.uuid string Wartość identyfikująca rekord.
data.main int | in:0,1 Informacja czy grupa jest główną grupą użytkowników, obecnie jest to grupa Stanowisko.
data.groupCount int Ilość podgrup w grupie.
data.userGroup array Podgrupy użytkowników.
data.userGroup.name string Nazwa podgrupy.
data.userGroup.uuid uuid Wartość identyfikująca rekord.
data.userGroup.users array Lista użytkowników dodanych do podgrupy.
data.userGroup.users.firstName string Imię użytkownika.
data.userGroup.users.lastName string Nazwisko użytkownika.
data.userGroup.users.uuid uuid Wartość identyfikująca rekord.
otherData.totalCount int Ilość grup.
message string
Przykład odpowiedzi```JSON { "success":true, "data":[ { "name":"Grupa", "uuid":"1585e46c-f433-4cef-a02b-a763a404eaed", "main":0, "groupCount":1, "userCount":3, "userGroup":[ { "name":"Podgrupa 1", "uuid":"304ab289-12f7-4cd5-a081-ad1f391c23e5", "users":[ { "first_name":"Jan", "last_name":"Kowalski", "uuid":"633d9c10-e769-4869-b82a-4f1b769f5d3c" }, { "first_name":"Marian", "last_name":"Nowak", "uuid":"073fe413-1f64-4987-8b51-170bbd499373" }, { "first_name":"Damian", "last_name":"Bartosz", "uuid":"7bb2e17a-87f0-4825-aaca-16ac6beac038" } ] } ] }, ], "otherData":{ "totalCount":6 }, "message":"OK" } ```
#### 2. Stworzenie grupy użytkowników Metoda pozwala na dodanie nowej grupy użytkowników.

Metoda: **POST** Adres URL: **{twoja\_nazwa}.ccrm.pl/publicApi/users/groupsType**

**Struktura żądania**
**Właściwość** **Wartość** **Opis** **Wymagane**
name string Nazwa grupy. TAK
Przykład żądania```JSON { "name":"Grupa testowa" } ```
--- **Struktura odpowiedzi**
**Właściwość** **Wartość** **Opis**
success bool
data object
data.uuid int Wartość identyfikująca rekord.
data.name string Nazwa grupy.
otherData object
message string
Przykład odpowiedzi```JSON { "success":true, "data":{ "uuid":"8383aece-126a-40df-ba8e-281af2b03dea", "name":"Grupa testowa" }, "otherData":{ }, "message":"OK" } ```
#### 3. Edycja grupy użytkowników Metoda pozwala na edycję istniejącej grupy użytkowników.

Metoda: **PATCH** Adres URL: **{twoja\_nazwa}.ccrm.pl/publicApi/users/groupsType/{uuid}**

**Struktura żądania**
**Właściwość** **Wartość** **Opis** **Wymagane**
name string Nazwa grupy TAK
Przykład żądania```JSON { "name":"Grupa testowa 2" } ```
--- **Struktura odpowiedzi**
**Właściwość** **Wartość** **Opis**
success bool
data object
data.uuid int Wartość identyfikująca rekord.
data.name string Nazwa grupy.
otherData object
message string
Przykład odpowiedzi```JSON { "success":true, "data":{ "uuid":"8383aece-126a-40df-ba8e-281af2b03dea", "name":"Grupa testowa 2" }, "otherData":{ }, "message":"OK" } ```
#### 4. Usunięcie grupy użytkowników Metoda pozwala na usunięcie istniejącej grupy użytkowników.

Metoda: **DELETE** Adres URL: **{twoja\_nazwa}.ccrm.pl/publicApi/users/groupsType/{uuid}**

**Struktura odpowiedzi**
**Właściwość** **Wartość** **Opis**
success bool
data string
otherData.totalCount int Ilość usuniętych rekordów.
message string
Przykład odpowiedzi```JSON { "success":true, "data":"OK", "otherData":{ "totalCount":1 }, "message":"OK" } ```
#### 5. Stworzenie podgrupy użytkowników Metoda pozwala na stworzenie nowej podgrupy użytkowników.

Metoda: **POST** Adres URL: **{twoja\_nazwa}.ccrm.pl/publicApi/users/groups**

**Struktura żądania**
**Właściwość** **Wartość** **Opis** **Wymagane**
name string Nazwa podgrupy. TAK
userGroupType string Uuid grupy. TAK
Przykład żądania```JSON { "name":"Podgrupa 1", "userGroupType":"b67d124f-403b-4cf6-8297-6a26417c385a" } ```
--- **Struktura odpowiedzi**
**Właściwość** **Wartość** **Opis**
success bool
data string
data.uuid int Wartość identyfikująca rekord.
data.name string Nazwa grupy.
otherData object
message string
Przykład odpowiedzi```JSON { "success":true, "data":{ "name":"Podgrupa 1", "uuid":"90bfe570-ea16-4e54-bad3-c693907ea171" }, "otherData":{ }, "message":"OK" } ```
#### 6. Edycja podgrupy użytkowników Metoda pozwala na edycję istniejącej podgrupy użytkowników.

Metoda: **PATCH** Adres URL: **{twoja\_nazwa}.ccrm.pl/publicApi/users/groups/{uuid}**

**Struktura żądania**
**Właściwość** **Wartość** **Opis** **Wymagane**
name string Nazwa podgrupy. TAK
Przykład żądania```JSON { "name":"Podgrupa 2" } ```
--- **Struktura odpowiedzi**
**Właściwość** **Wartość** **Opis**
success bool
data string
data.uuid int Wartość identyfikująca rekord.
data.name string Nazwa podgrupy.
otherData object
message string
Przykład odpowiedzi```JSON { "success":true, "data":{ "name":"Podgrupa 12", "uuid":"90bfe570-ea16-4e54-bad3-c693907ea171" }, "otherData":{ }, "message":"OK" } ```
#### 7. Usunięcie podgrupy użytkowników Metoda pozwala na usunięcie istniejącej podgrupy użytkowników.

Metoda: **DELETE** Adres URL: **{twoja\_nazwa}.ccrm.pl/publicApi/users/groups/{uuid}**

**Struktura odpowiedzi**
**Właściwość** **Wartość** **Opis**
success bool
data string
otherData.totalCount int Ilość usuniętych rekordów.
message string
Przykład odpowiedzi```JSON { "success":true, "data":"OK", "otherData":{ "totalCount":1 }, "message":"OK" } ```