API: Pobieranie i zmiana danych konta i profili: Różnice pomiędzy wersjami

Z DrRobert DOCS
Przejdź do nawigacji Przejdź do wyszukiwania
Nie podano opisu zmian
Nie podano opisu zmian
 
(Nie pokazano 6 wersji utworzonych przez 2 użytkowników)
Linia 1: Linia 1:
== GET /user/$user_uuid/data ==
== GET /user/$user_uuid/data ==
Endpoint służący pobraniu danych użytkownika.
Endpoint służący pobraniu danych użytkownika lub profilu.
 
'''Odpowiedź JSON'''
'''Odpowiedź JSON'''
{| class="wikitable"
{| class="wikitable"
Linia 12: Linia 13:
|[[API: UserObject]]
|[[API: UserObject]]
|Obiekt użytkownika patrz: [[API: UserObject]]
|Obiekt użytkownika patrz: [[API: UserObject]]
|}
== GET /user/$user_uuid/profiles ==
Endpoint służący pobraniu listy profili użytkownika .
'''Odpowiedź JSON'''
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|profiles
|tablica z UserObject
|[[API: UserObject]]
|Tablica z obiektami profilów patrz: [[API: UserObject]]
|}
|}


== POST /user/$user_uuid/data ==
== POST /user/$user_uuid/data ==
Endpoint służący aktualizacji danych użytkownika.
Endpoint służący aktualizacji danych użytkownika lub profilu.
 
'''Parametry JSON'''
'''Parametry JSON'''
{| class="wikitable"
{| class="wikitable"
Linia 27: Linia 44:
|[[API: UserObject]]
|[[API: UserObject]]
|Obiekt użytkownika patrz: [[API: UserObject]] można wysłać cały, ale zaktualizowane będą jedynie pola edytowalne.
|Obiekt użytkownika patrz: [[API: UserObject]] można wysłać cały, ale zaktualizowane będą jedynie pola edytowalne.
|-
|delete
|bool
|true
|Gdy parametr jest równy 'true' następuje usunięcie profilu lub w przypadku użytkownika rozpoczyna się procedura usunięcia konta.
|}
== GET /user/$user_uuid/lang ==
Endpoint służący do pobierania kodu języka użytkownika.
{| class="wikitable"
|+
!Klucz
!Typ
!Przykład
!Opis
|-
|lang
|string
|pl
|Kod języka użytkownika.
|}
== POST /user/$user_uuid/lang ==
Endpoint służący do aktualizacji kodu języka użytownika.
{| class="wikitable"
|+
!Klucz
!Typ
!Przykład
!Opis
|-
|lang
|string
|pl
|Kod języka użytkownika.
|}
== GET /user/$user_uuid/avatar ==
Endpoint służący do pobierania avatara użytkownika.
{| class="wikitable"
|+
!Klucz
!Typ
!Przykład
!Opis
|-
|avatar
|File
|
|Avatar użytkownika.
|}
== POST /user/$user_uuid/avatar ==
Endpoint służący do aktualizacji avatara użytownika.
{| class="wikitable"
|+
!Klucz
!Typ
!Przykład
!Opis
|-
|avatar
|File
|
|Avatar użytkownika.
|}
|}

Aktualna wersja na dzień 09:56, 20 sie 2024

GET /user/$user_uuid/data

Endpoint służący pobraniu danych użytkownika lub profilu.

Odpowiedź JSON

Klucz Typ Przykład Opis
user UserObject API: UserObject Obiekt użytkownika patrz: API: UserObject

GET /user/$user_uuid/profiles

Endpoint służący pobraniu listy profili użytkownika .

Odpowiedź JSON

Klucz Typ Przykład Opis
profiles tablica z UserObject API: UserObject Tablica z obiektami profilów patrz: API: UserObject

POST /user/$user_uuid/data

Endpoint służący aktualizacji danych użytkownika lub profilu.

Parametry JSON

Klucz Typ Przykład Opis
user UserObject API: UserObject Obiekt użytkownika patrz: API: UserObject można wysłać cały, ale zaktualizowane będą jedynie pola edytowalne.
delete bool true Gdy parametr jest równy 'true' następuje usunięcie profilu lub w przypadku użytkownika rozpoczyna się procedura usunięcia konta.

GET /user/$user_uuid/lang

Endpoint służący do pobierania kodu języka użytkownika.

Klucz Typ Przykład Opis
lang string pl Kod języka użytkownika.

POST /user/$user_uuid/lang

Endpoint służący do aktualizacji kodu języka użytownika.

Klucz Typ Przykład Opis
lang string pl Kod języka użytkownika.

GET /user/$user_uuid/avatar

Endpoint służący do pobierania avatara użytkownika.

Klucz Typ Przykład Opis
avatar File Avatar użytkownika.

POST /user/$user_uuid/avatar

Endpoint służący do aktualizacji avatara użytownika.

Klucz Typ Przykład Opis
avatar File Avatar użytkownika.