Użytkownicy

Struktura danych JSON

Obiekt User

  • id – (readonly) ID w bazie danych
  • login – login do aplikacji
  • pass – (writeonly) hasło – przesyłane do serwera tylko przy zmianie hasła
  • email – adres e-mail
  • tel – telefon
  • name – nazwa (np imię i nazwisko)
  • organization – (readonly) obiekt JSON zawierający dane organizacji
    • id – ID organizacji
    • registerDate – data rejestracji organizacji
    • prefix – prefix organizacji
    • name – nazwa organizacji
    • taxId – NIP organizacji
    • address – adres
    • postCodeCity – kod pocztowy i miejscowość
    • countryCode – kod kraju (np. PL)
  • permissions – uprawnienia oddzielone średnikiem (;)

Pobieranie wszystkich użytkowników

GET

/users

Odpowiedź JSON - zawiera tablicę obiektów User
{
    "users": [
        ...
    ]
}

Pobieranie użytkownika

GET

/users

Parametry w ścieżce zapytania
  • id – ID użytkownika
/users?id=1
Odpowiedź JSON
{
	"id":1,
	"login":"xxxxx_yyyyy",
	"email":"xxxxxxx@yyyyy",
	"tel":"000000000",
	"name":"Imie i nazwisko",
	"organization":{
		"id":1,
		"registerDate":"2022-04-16T13:09:00Z",
		"prefix":"xxxxx",
		"name":"Nazwa organizacji",
		"taxId":"1234",
		"address":"Długa 9999",
		"postCodeCity":"00-000 Kraków",
		"countryCode":"PL"
	},
	"permissions":"main.admin;main.plugin.install;main.users.show"
}

Dodawanie użytkownika

POST

/users

Dane JSON w zapytaniu (body)

Należy przekazać obiekt User. Pola readonly są pomijane, nie trzeba ich przekazywać.

Dane odpowiedzi JSON

W odpowiedzi zwrócony zostanie nowo utworzony obiekt User zawierający ID.

Edycja użytkownika

PUT

/users

Dane JSON w zapytaniu (body)

Należy przekazać obiekt User do edycji. Pole ID należy przekazać, reszta pól readonly jest pomijana.

Pola które można pominąć:
  • login (pominięcie spowoduje zostawienie aktualnego loginu, natomiast przekazanie innego spowoduje zmianę loginu)
  • pass (to pole przekazywane jest do serwera TYLKO podcas zmiany hasła)
  • permissions (można pominąć, przekazanie tego pola spowoduje zmianę uprawnień)
Dane odpowiedzi JSON

W odpowiedzi zwrócony zostanie obiekt User.

Usuwanie użytkownika

DELETE

/users

Parametry w ścieżce zapytania
  • id – ID użytkownika do usunięcia
/users?id=1
Odpowiedź - 204 No Content