API: Rejestracja (konta i profile): Różnice pomiędzy wersjami

Z DrRobert DOCS
Przejdź do nawigacji Przejdź do wyszukiwania
Nie podano opisu zmian
Nie podano opisu zmian
Linia 54: Linia 54:
'''JSON:'''
'''JSON:'''


<code><nowiki>{"auth":{"api_token":"2580f055d57a2a298cb899f8ede75edbb88f1c92","token_expire_dt":"2023-12-21T14:40:23"},"user":{"name":"Jan Testowy","email":"jankowalski@domena.pl"}}</nowiki></code>
<code><nowiki>{"error": "validation","validation":{"name": {"max": true},"phone": {"required": true},"email": {"email": true},"organization_id": [],"agreements": []}}</nowiki></code>
{| class="wikitable"
{| class="wikitable"
!Klucz
!Klucz
Linia 68: Linia 68:
|validation
|validation
|array
|array
|
|{"name": {"max": true},"phone": {"required": true},"email": {"email": true},"organization_id": [],"agreements": []}
|Tablica z błędami walidacji
|Tablica z błędami walidacji, lista pól i występujących błędów
|-
|validation.name
|string
|too_long
|"Wartość pola 'nazwa' zbyt długa
|-
|user
|array
|
|Tablica z danymi użytkownika
|-
|user.name
|string
|Jan Testowy
|Nazwa użytkownika
|-
|user.email
|string
|jankowalski@domena.pl
|E-mail użytkownika
|}
|}

Wersja z 12:40, 18 gru 2023

POST /user/signup

Endpoint służący utworzeniu konta użytkownika, zwraca token uwierzytelniania.

Parametry JSON

Klucz Typ Przykład Opis Wymagane Walidacja
name string Jan Kowalski Nazwa użytkownika: imię lub imię i nazwisko Tak Długość: 50
phone string +48 699 999 999 Telefon Tak Cyfry, spacja i znak +; Długość: 20
email string jankowalski@domena.pl E-mail Tak Adres email zgodny z RFC 5322 i RFC 6854
organization_id integer 1 Organizacja (Placówka POZ) Nie ID organizacji (lista w API: Zasoby publiczne i konfiguracje ogólne)
agreements array [1:true,2:true,3:false] Zgody prawne Nie Tablica z id zgody i wartością bool jej akceptacji (lista w API: Zasoby publiczne i konfiguracje ogólne)

Należy pamiętać o wymaganych parametrach: API: Parametry

Odpowiedź poprawna

Identyczna jak w API: Autoryzacja

Odpowiedź niepoprawna walidacja

JSON:

{"error": "validation","validation":{"name": {"max": true},"phone": {"required": true},"email": {"email": true},"organization_id": [],"agreements": []}}

Klucz Typ Przykład Opis
error string validation Informacja o typie błędu, tutaj walidacja
validation array {"name": {"max": true},"phone": {"required": true},"email": {"email": true},"organization_id": [],"agreements": []} Tablica z błędami walidacji, lista pól i występujących błędów