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 20: Linia 20:
|phone
|phone
|string
|string
| +48 699 999 999
| +48699999999
|Telefon
|Telefon
|Tak
|Tak
|Cyfry, spacja i znak +; Długość: 20
|Cyfry i znak +; Długość: 20
|-
|-
|email
|email
Linia 30: Linia 30:
|E-mail
|E-mail
|Tak
|Tak
|Adres email zgodny z RFC 5322 i RFC 6854
|Adres email zgodny z RFC 5322 i RFC 6854, unikalny w skali serwisu
|-
|password
|string
|hasło plaintext
|Nadane hasło
|Tak
|Minimum 8 dowolnych znaków
|-
|-
|organization_id
|organization_id
Linia 68: Linia 75:
|validation
|validation
|array
|array
|{"name": {"max": true},"phone": {"required": true},"email": {"email": true},"organization_id": [],"agreements": []}
|{"name": {"max": true},"phone": {"required": true},"email": {"email": true,"unique":true},"password":{"min":true},"organization_id": [],"agreements": []}
|Tablica z błędami walidacji, lista pól i występujących błędów
|Tablica z błędami walidacji, lista pól i występujących błędów
|}
|}

Wersja z 13:37, 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 +48699999999 Telefon Tak Cyfry i znak +; Długość: 20
email string jankowalski@domena.pl E-mail Tak Adres email zgodny z RFC 5322 i RFC 6854, unikalny w skali serwisu
password string hasło plaintext Nadane hasło Tak Minimum 8 dowolnych znaków
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,"unique":true},"password":{"min":true},"organization_id": [],"agreements": []} Tablica z błędami walidacji, lista pól i występujących błędów