Skip to main content

Uprawnienia oraz grupy uprawnień

1. Pobranie listy utworzonych grup uprawnień

Metoda pozwala na pobranie listy istniejących grup uprawnień.

Metoda: GET
Adres URL: www.{twoja_nazwa}.ccrm.pl/publicApi/users/permissions/groups

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:

www.{twoja_nazwa}.ccrm.pl/public_api/users/permissions/groups?page=2

Struktura odpowiedzi

Właściwość

Wartość

Opis

success

bool


data

string


data.id

int

Ilość usuniętych rekordów.

data.uuid

uuid

Wartość identyfikująca rekord.

data.name

string

Nazwa grupy uprawnień.

data.permission

array

Zawiera informacje o uprawnieniach przypisanych do grupy.

data.permission.id

int

Identyfikator uprawnienia.

data.permission.value

string

Identyfikator systemowy uprawnienia.

data.permission.name

string

Nazwa uprawnienia.

data.permission.description

string

Opis uprawnienia.

user

array

Użytkownicy przypisani do grupy uprawnień.

user.uuid

uuid

Unikalny identyfikator użytkownika.

user.firstName

string

Imię użytkownika.

user.lastName

string

Nazwisko użytkownika.

otherData.totalCount

int

Ilość grup uprawnień.

message

string


Przykład odpowiedzi 
{
    "success":true,
    "data":[
        {
            "id":16,
            "uuid":"94176fe5-1893-4432-8322-995ee28ccbbb",
            "name":"Grupa testowa",
            "show":1,
            "permission":[
                {
                    "id":22,
                    "value":"PERMISSION_INDEX",
                    "name":"Wyświetlenie listy uprawnień",
                    "description":"Użytkownik może zobaczyć uprawnienia przydzielone do danej grupy."
                },
            "user":[
                {
                    "uuid":"fdf75d0c-fc9f-41dc-9a54-af2121ay756ys",
                    "firstName":"Jan",
                    "lastName":"Kowalski"
                }
            ]
        },


2. Pobranie listy możliwych uprawnień do przydzielenia

Metoda pozwala na pobranie kategorii i istniejących w ramach nich uprawnień. Poszczególne uprawnienia są następnie przydzielane do poszczególnych grup uprawnień.

Metoda: GET
Adres URL: www.{twoja_nazwa}.ccrm.pl/publicApi/users/permissions/categories

Struktura odpowiedzi

Właściwość

Wartość

Opis

success

bool


data

array


data.id

int

Unikalny identyfikator kategorii uprawnień.

data.name


Nazwa kategorii uprawnień.

data.group

array

Zawiera informacje o uprawnieniach przypisanych do danej kategorii.

data.group.id


Identyfikator uprawnienia.

data.group.value


Identyfikator systemowy uprawnienia.

data.group.name


Nazwa uprawnienia.

data.group.description


Opis uprawnienia.

message

string


Przykład odpowiedzi 
{
    "success":true,
    "data":[
        {
            "id":9,
            "name":"Uprawnienia",
            "group":[
                {
                    "id":22,
                    "value":"PERMISSION_INDEX",
                    "name":"Wyświetlenie listy uprawnień",
                    "description":"Użytkownik może zobaczyć uprawnienia przydzielone do danej grupy."
                },
                {
                    "id":23,
                    "value":"PERMISSION_ADD_EDIT",
                    "name":"Zarządzanie grupami uprawnień",
                    "description":"Użytkownik może tworzyć i modyfikować grupy uprawnień"
                },
                {
                    "id":24,
                    "value":"PERMISSION_DELETE",
                    "name":"Usuwanie grup uprawnień",
                    "description":"Użytkownik może usuwać utworzone grupy uprawnień."
                }
            ]
        },
    ],
    "otherData":{
        "totalCount":11
    },
    "message":"OK"
}


3. Stworzenie nowej grupy uprawnień

Metoda pozwala na utworzenie nowej grupy uprawnień.

Metoda: POST
Adres URL: www.{twoja_nazwa}.ccrm.pl/publicApi/users/permissions/groups

Struktura żądania

Właściwość

Wartość

Opis

Wymagane

name

string

Nazwa grupy uprawnień.

TAK

permissions

array

Lista uprawnień.


permissions.*

int

Identyfikator uprawnienia.


Przykład żądania 
{
    "name":"Grupa testowa",
    "permissions":[
        22
    ]
}

Struktura odpowiedzi

Właściwość

Wartość

Opis

success

bool


data.id

int

Identyfikator grupy uprawnień.

data.uuid

uuid

Wartość identyfikująca rekord.

data.name

string

Nazwa.

otherData

object


message

string


Przykład odpowiedzi 
{
    "success":true,
    "data":{
        "id":18,
        "uuid":"3094930a-1238-41ba-b3de-19df6d0d4s87",
        "name":"Grupa testowa",
    },
    "otherData":{
    },
    "message":"OK"
}


4. Edycja istniejącej grupy uprawnień

Metoda pozwala na edycję utworzonej uprzednio grupy uprawnień.

Metoda: PATCH
Adres URL: www.{twoja_nazwa}.ccrm.pl/publicApi/users/permissions/groups/{uuid}

Struktura żądania

Właściwość

Wartość

Opis

Wymagane

name

string

Nazwa grupy uprawnień.

TAK

permissions

array

Lista uprawnień.


permissions.*

int

Identyfikator uprawnienia.


Przykład żądania 
{
    "name":"Grupa testowa",
    "permissions":[
        22,
        36,
        39,
    ]
}

Struktura odpowiedzi

Właściwość

Wartość

success

bool

data

string

otherData

object

message

string
Przykład odpowiedzi 
{
    "success":true,
    "data":"OK",
    "otherData":{
    },
    "message":"OK"
}

5. Usunięcie istniejącej grupy uprawnień

Metoda pozwala na usunięcie utworzonej uprzednio grupy uprawnień.

Metoda: DELETE
Adres URL: www.{twoja_nazwa}.ccrm.pl/publicApi/users/permissions/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 
{
    "success":true,
    "data":"OK",
    "otherData":{
        "totalCount":1
    },
    "message":"OK"
}
Back to top