DrRobert DOCS - Wkład użytkownika [pl]

API: Rejestracja (konta i profile)

2026-02-24T08:34:11Z

PawelM:

== POST /user/signup ==
Endpoint służący utworzeniu konta użytkownika, zwraca token uwierzytelniania.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
!Walidacja
|-
|name
|string
|Jan Kowalski
|Nazwa użytkownika: imię lub imię i nazwisko
|Nie
|Długość: 50
|-
|firstname
|string
|Jan
|Imię użytkownika
|Tak
|
|-
|lastname
|string
|Kowalski
|Nazwisko użytkownika
|Tak
|
|-
|pesel
|string
|99062873619
|PESEL użytkownika
|Nie
|czy prawidłowy pesel
|-
|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
|BardzoTrudneHasło123
|Nadane hasło
|Tak
|Minimum 8 dowolnych znaków
|-
|organisation_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]])
|-
|anonymous_token
|string
|2580f055d57a2a298cb899f8ede75edbb88f1c92
|Token autoryzacji użytkownika anonimowego, gdy prawidłowo podany zamiast dodawać nowego użytkownika nastąpi przekształcenie użytkownika anonimowego na pełnoprawnego.
|Nie
|
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]

==== Odpowiedź poprawna ====
Identyczna jak w [[API: Autoryzacja]]

==== Odpowiedź niepoprawna walidacja ====
'''JSON:'''

<code><nowiki>{"error": "validation","validation":{"name": {"max": true},"phone": {"required": true},"email": {"email": true},"organization_id": [],"agreements": []}}</nowiki></code>
{| class="wikitable"
!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
|}
== POST /user/profile ==
Endpoint służący utworzeniu profilu przypisanego do użytkownika, zwraca dane profilu.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
!Walidacja
|-
|name
|string
|Jan Kowalski
|Nazwa profilu: imię lub imię i nazwisko
|Tak
|Długość: 50; Gdy puste ale podane firstname i lastname to są one łączone do name
|-
|firstname
|string
|Jan
|Imię użytkownika
|Nie
|
|-
|lastname
|string
|Kowalski
|Nazwisko użytkownika
|Nie
|
|-
|pesel
|string
|99062873619
|PESEL użytkownika
|Nie
|czy prawidłowy pesel
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]

==== Odpowiedź poprawna ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|user
|UserObject
|[[API: UserObject]]
|Obiekt profilu patrz: [[API: UserObject]]
|}

API: UserObject

2026-02-13T09:45:22Z

PawelM:

== UserObject ==
Obiekt danych użytkownika lub profilu
{| class="wikitable"
|+
!Nazwa
!Użytkownik
!Profil
!Edytowalne
!Przykład
!Opis
!Wartości
|-
|uuid
|Tak
|Tak
|Nie
|3b0769ba-19f6-4dd1-af5b-b20416b8825a
|Unikatowe UUID użytkownika
|
|-
|type
|Tak
|Tak
|Nie
|user
|Typ profilu
|user,profile
|-
|relationship
|Nie
|Tak
|Nie
|''UserRelationshipObject''
|Obiekt opisujący relację z rodzicem
|Patrz poniżej do ''UserRelationshipObject''
|-
|lang
|Tak
|Tak
|Tak
|pl
|Kod języka
|pl, en, ua
|-
|name
|Tak
|Tak
|Tak
|Jan Testowy
|Nazwa (imię i/lub nazwisko)
|
|-
|firstname
|Tak
|Tak
|Tak
|Jan
|Imię użytkownika
|
|-
|lastname
|Tak
|Tak
|Tak
|Kowalski
|Nazwisko użytkownika
|
|-
|pesel
|Tak
|Tak
|Tak
|99062873619
|PESEL użytkownika
|
|-
|email
|Tak
|Nie
|Nie
|jantestowy@domena.pl
|Adres e-mail
|
|-
|phone
|Tak
|Nie
|Nie
| +48505444333
|Nr telefonu
|
|-
|birthdate
|Tak
|Tak
|Tak
|1965-07-20
|Data urodzenia
|
|-
|birthyear
|Tak
|Tak
|Nie
|1965
|Rok urodzenia
|
|-
|gender
|Tak
|Tak
|Tak
|male
|Płeć
|male, female
|-
|weight
|Tak
|Tak
|Tak
|75
|Waga w kg
|
|-
|height
|Tak
|Tak
|Tak
|175
|Wzrost w cm
|
|-
|waist
|Tak
|Tak
|Tak
|100
|Obwód pasa w cm
|
|-
|bmi
|Tak
|Tak
|Nie
|20.5
|Współczynnik BMI
|
|-
|smoking
|Tak
|Tak
|Nie
|1
|Status palenia tytoniu
|0-nie,1-tak
|-
|smoking_products
|Tak
|Tak
|Nie
|1,2,3
|Tablica z listą produktów
|1-papierosy,2-podrzewany tytoń,3-e-papierosy
|-
|smoking_packyears
|Tak
|Tak
|Nie
|23
|Liczba "paczkolat"
|
|-
|drinking
|Tak
|Tak
|Nie
|0
|Status spożycia alkoholu
|0-nie lub sporadycznie,1-regularnie
|-
|diabetes
|Tak
|Tak
|Nie
|1
|Status chorowania na cukrzyce
|0-nie choruje,1-choruje
|-
|hypertension
|Tak
|Tak
|Nie
|1
|Status chorowania na nadciśnienie
|0-nie choruje,1-choruje
|-
|hypercholesterolemia
|Tak
|Tak
|Nie
|1
|Status chorowania na hipercholesterolemie
|0-nie choruje,1-choruje
|-
|colon_cancer
|Tak
|Tak
|Nie
|1
|Status chorowania na raka jelita grubego
|0-brak,1-występowanie w rodzinie,2-obecność mutacji gen.
|}
Wykorzystywane w: [[API: Autoryzacja]], [[API: Rejestracja]], [[API: Pobieranie i zmiana danych konta i profili]]

== UserRelationshipObject ==
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|3dabcbd4-fab0-4ed6-b356-8d5df897d498
|UUID relacji
|-
|parent_uuid
|7dabcbd4-fab0-4ed6-b356-8d5df897d498
|UUID rodzica
|-
|children_uuid
|9dabcbd4-fab0-4ed6-b356-8d5df897d498
|UUID dziecka
|-
|type
|default
|typ relacji
|-
|date_start
|2023-12-20
|Data rozpoczęcia relacji
|-
|date_stop
|NULL
|Data zakończenia relacji
|}

API: Rejestracja (konta i profile)

2026-02-13T09:44:04Z

PawelM:

== POST /user/signup ==
Endpoint służący utworzeniu konta użytkownika, zwraca token uwierzytelniania.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
!Walidacja
|-
|name
|string
|Jan Kowalski
|Nazwa użytkownika: imię lub imię i nazwisko
|Nie
|Długość: 50
|-
|firstname
|string
|Jan
|Imię użytkownika
|Tak
|
|-
|lastname
|string
|Kowalski
|Nazwisko użytkownika
|Tak
|
|-
|pesel
|string
|99062873619
|PESEL użytkownika
|Nie
|czy prawidłowy pesel
|-
|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
|BardzoTrudneHasło123
|Nadane hasło
|Tak
|Minimum 8 dowolnych znaków
|-
|organisation_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]])
|-
|anonymous_token
|string
|2580f055d57a2a298cb899f8ede75edbb88f1c92
|Token autoryzacji użytkownika anonimowego, gdy prawidłowo podany zamiast dodawać nowego użytkownika nastąpi przekształcenie użytkownika anonimowego na pełnoprawnego.
|Nie
|
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]

==== Odpowiedź poprawna ====
Identyczna jak w [[API: Autoryzacja]]

==== Odpowiedź niepoprawna walidacja ====
'''JSON:'''

<code><nowiki>{"error": "validation","validation":{"name": {"max": true},"phone": {"required": true},"email": {"email": true},"organization_id": [],"agreements": []}}</nowiki></code>
{| class="wikitable"
!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
|}
== POST /user/profile ==
Endpoint służący utworzeniu profilu przypisanego do użytkownika, zwraca dane profilu.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
!Walidacja
|-
|name
|string
|Jan Kowalski
|Nazwa profilu: imię lub imię i nazwisko
|Tak
|Długość: 50
|-
|firstname
|string
|Jan
|Imię użytkownika
|Nie
|
|-
|lastname
|string
|Kowalski
|Nazwisko użytkownika
|Nie
|
|-
|pesel
|string
|99062873619
|PESEL użytkownika
|Nie
|czy prawidłowy pesel
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]

==== Odpowiedź poprawna ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|user
|UserObject
|[[API: UserObject]]
|Obiekt profilu patrz: [[API: UserObject]]
|}

API: Rejestracja (konta i profile)

2026-02-13T09:43:28Z

PawelM:

== POST /user/signup ==
Endpoint służący utworzeniu konta użytkownika, zwraca token uwierzytelniania.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
!Walidacja
|-
|name
|string
|Jan Kowalski
|Nazwa użytkownika: imię lub imię i nazwisko
|Nie
|Długość: 50
|-
|firstname
|string
|Jan
|Imię użytkownika
|Tak
|
|-
|lastname
|string
|Kowalski
|Nazwisko użytkownika
|Tak
|
|-
|pesel
|string
|99062873619
|PESEL użytkownika
|Nie
|czy prawidłowy pesel
|-
|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
|BardzoTrudneHasło123
|Nadane hasło
|Tak
|Minimum 8 dowolnych znaków
|-
|organisation_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]])
|-
|anonymous_token
|string
|2580f055d57a2a298cb899f8ede75edbb88f1c92
|Token autoryzacji użytkownika anonimowego, gdy prawidłowo podany zamiast dodawać nowego użytkownika nastąpi przekształcenie użytkownika anonimowego na pełnoprawnego.
|Nie
|
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]

==== Odpowiedź poprawna ====
Identyczna jak w [[API: Autoryzacja]]

==== Odpowiedź niepoprawna walidacja ====
'''JSON:'''

<code><nowiki>{"error": "validation","validation":{"name": {"max": true},"phone": {"required": true},"email": {"email": true},"organization_id": [],"agreements": []}}</nowiki></code>
{| class="wikitable"
!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
|}
== POST /user/profile ==
Endpoint służący utworzeniu profilu przypisanego do użytkownika, zwraca dane profilu.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
!Walidacja
|-
|name
|string
|Jan Kowalski
|Nazwa profilu: imię lub imię i nazwisko
|Tak
|Długość: 50
|-
|firstname
|string
|Jan
|Imię użytkownika
|Nie
|
|-
|lastname
|string
|Kowalski
|Nazwisko użytkownika
|Nie
|
|-
|pesel
|string
|99062873619
|PESEL użytkownika
|Nie
|czy prawidłowy pesel
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]

==== Odpowiedź poprawna ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|user
|UserObject
|[https://docs.doctorrobert.com/index.php?title=API:_UserObject API: UserObject]
|Obiekt profilu patrz: [https://docs.doctorrobert.com/index.php?title=API:_UserObject API: UserObject]
|}

API: Rejestracja (konta i profile)

2026-02-13T09:42:50Z

PawelM:

== POST /user/signup ==
Endpoint służący utworzeniu konta użytkownika, zwraca token uwierzytelniania.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
!Walidacja
|-
|name
|string
|Jan Kowalski
|Nazwa użytkownika: imię lub imię i nazwisko
|Nie
|Długość: 50
|-
|firstname
|string
|Jan
|Imię użytkownika
|Tak
|
|-
|lastname
|string
|Kowalski
|Nazwisko użytkownika
|Tak
|
|-
|pesel
|string
|99062873619
|PESEL użytkownika
|Nie
|czy prawidłowy pesel
|-
|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
|BardzoTrudneHasło123
|Nadane hasło
|Tak
|Minimum 8 dowolnych znaków
|-
|organisation_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]])
|-
|anonymous_token
|string
|2580f055d57a2a298cb899f8ede75edbb88f1c92
|Token autoryzacji użytkownika anonimowego, gdy prawidłowo podany zamiast dodawać nowego użytkownika nastąpi przekształcenie użytkownika anonimowego na pełnoprawnego.
|Nie
|
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]

==== Odpowiedź poprawna ====
Identyczna jak w [[API: Autoryzacja]]

==== Odpowiedź niepoprawna walidacja ====
'''JSON:'''

<code><nowiki>{"error": "validation","validation":{"name": {"max": true},"phone": {"required": true},"email": {"email": true},"organization_id": [],"agreements": []}}</nowiki></code>
{| class="wikitable"
!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
|}
== POST /user/profile ==
Endpoint służący utworzeniu profilu przypisanego do użytkownika, zwraca dane profilu.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
!Walidacja
|-
|name
|string
|Jan Kowalski
|Nazwa profilu: imię lub imię i nazwisko
|Tak
|Długość: 50
|-
|firstname
|string
|Jan
|Imię użytkownika
|Nie
|
|-
|lastname
|string
|Kowalski
|Nazwisko użytkownika
|Nie
|
|-
|pesel
|string
|99062873619
|PESEL użytkownika
|Nie
|czy prawidłowy pesel
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]

==== Odpowiedź poprawna ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|user
|UserObject
|[https://docs.doctorrobert.com/API:_UserObject API: UserObject]
|Obiekt profilu patrz: [https://docs.doctorrobert.com/API:_UserObject API: UserObject]
|}

API: Rejestracja (konta i profile)

2026-02-13T09:36:24Z

PawelM:

== POST /user/signup ==
Endpoint służący utworzeniu konta użytkownika, zwraca token uwierzytelniania.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
!Walidacja
|-
|name
|string
|Jan Kowalski
|Nazwa użytkownika: imię lub imię i nazwisko
|Nie
|Długość: 50
|-
|firstname
|string
|Jan
|Imię użytkownika
|Tak
|
|-
|lastname
|string
|Kowalski
|Nazwisko użytkownika
|Tak
|
|-
|pesel
|string
|99062873619
|PESEL użytkownika
|Nie
|czy prawidłowy pesel
|-
|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
|BardzoTrudneHasło123
|Nadane hasło
|Tak
|Minimum 8 dowolnych znaków
|-
|organisation_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]])
|-
|anonymous_token
|string
|2580f055d57a2a298cb899f8ede75edbb88f1c92
|Token autoryzacji użytkownika anonimowego, gdy prawidłowo podany zamiast dodawać nowego użytkownika nastąpi przekształcenie użytkownika anonimowego na pełnoprawnego.
|Nie
|
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]

==== Odpowiedź poprawna ====
Identyczna jak w [[API: Autoryzacja]]

==== Odpowiedź niepoprawna walidacja ====
'''JSON:'''

<code><nowiki>{"error": "validation","validation":{"name": {"max": true},"phone": {"required": true},"email": {"email": true},"organization_id": [],"agreements": []}}</nowiki></code>
{| class="wikitable"
!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
|}
== POST /user/profile ==
Endpoint służący utworzeniu profilu przypisanego do użytkownika, zwraca dane profilu.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
!Walidacja
|-
|name
|string
|Jan Kowalski
|Nazwa profilu: imię lub imię i nazwisko
|Tak
|Długość: 50
|-
|firstname
|string
|Jan
|Imię użytkownika
|Nie
|
|-
|lastname
|string
|Kowalski
|Nazwisko użytkownika
|Nie
|
|-
|pesel
|string
|99062873619
|PESEL użytkownika
|Nie
|czy prawidłowy pesel
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]

==== Odpowiedź poprawna ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|user
|UserObject
|[https://drrobert.it4u.company/docs/API:_UserObject API: UserObject]
|Obiekt profilu patrz: [https://drrobert.it4u.company/docs/API:_UserObject API: UserObject]
|}

API: Rejestracja (konta i profile)

2026-02-13T09:33:58Z

PawelM:

== POST /user/signup ==
Endpoint służący utworzeniu konta użytkownika, zwraca token uwierzytelniania.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
!Walidacja
|-
|name
|string
|Jan Kowalski
|Nazwa użytkownika: imię lub imię i nazwisko
|Nie
|Długość: 50
|-
|firstname
|string
|Jan
|Imię użytkownika
|Tak
|
|-
|lastname
|string
|Kowalski
|Nazwisko użytkownika
|Tak
|
|-
|pesel
|string
|99062873619
|PESEL użytkownika
|Nie
|czy prawidłowy pesel
|-
|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
|BardzoTrudneHasło123
|Nadane hasło
|Tak
|Minimum 8 dowolnych znaków
|-
|organisation_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]])
|-
|anonymous_token
|string
|2580f055d57a2a298cb899f8ede75edbb88f1c92
|Token autoryzacji użytkownika anonimowego, gdy prawidłowo podany zamiast dodawać nowego użytkownika nastąpi przekształcenie użytkownika anonimowego na pełnoprawnego.
|Nie
|
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]

==== Odpowiedź poprawna ====
Identyczna jak w [[API: Autoryzacja]]

==== Odpowiedź niepoprawna walidacja ====
'''JSON:'''

<code><nowiki>{"error": "validation","validation":{"name": {"max": true},"phone": {"required": true},"email": {"email": true},"organization_id": [],"agreements": []}}</nowiki></code>
{| class="wikitable"
!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
|}
== POST /user/profile ==
Endpoint służący utworzeniu profilu przypisanego do użytkownika, zwraca dane profilu.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
!Walidacja
|-
|name
|string
|Jan Kowalski
|Nazwa profilu: imię lub imię i nazwisko
|Tak
|Długość: 50
|-
|firstname
|string
|Jan
|Imię użytkownika
|Nie
|
|-
|lastname
|string
|Kowalski
|Nazwisko użytkownika
|Nie
|
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]

==== Odpowiedź poprawna ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|user
|UserObject
|[https://drrobert.it4u.company/docs/API:_UserObject API: UserObject]
|Obiekt profilu patrz: [https://drrobert.it4u.company/docs/API:_UserObject API: UserObject]
|}

API: Zalecenia

2025-09-02T11:17:06Z

PawelM:

== GET /recommendations ==
Lista wszystkich zaleceń, zwraca tablice elementów [[API: RecommendationObject]]

== GET /recommendation/$id ==
Dane zalecenia, zwraca element [[API: RecommendationObject]]

== GET /user/$user_uuid/recommendations ==
Lista zaleceń dla użytkownika, zwraca tablice elementów [[API: UserRecommendationObject]]

== POST /user/$user_uuid/recommendation/$recomendation_uuid ==
Wysłanie informacji o wykonaniu zalecenia.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
|-
|done_date
|date
|2024-01-01
|Data wykonania rekomendacji
|Tak
|}
== POST /user/$user_uuid/email_recommendations ==
Wysłanie emaila z PDF rekomendacji na adres użytkownika.

=== Parametry ===
{| class="wikitable"
|+
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
|-
|pdf_file
|pdf file
| -
|Plik pdf z rekomendacjami użytkownika
|Tak
|-
|language
|text
|pl
|Język pdf
|Nie
|}

== POST /user/$user_uuid/pdf_recommendations ==
Wysłanie PDF rekomendacji do systemu.

=== Parametry ===
{| class="wikitable"
|+
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
|-
|pdf_file
|pdf file
| -
|Plik pdf z rekomendacjami użytkownika
|Tak
|-
|language
|text
|pl
|Język pdf
|Nie
|}

API: UserRecommendationObject

2024-12-10T12:20:47Z

PawelM:

Obiekt danych rekomendacji dla użytkownika
{| class="wikitable"
|+
!Nazwa
!Przykład
!Opis
|-
|uuid
|3dabcbd4-fab0-4ed6-b356-8d5df897d498
|Wewnętrzne UUID rekomendacji
|-
|name
|Pomiar stężenia glukozy we krwi naczczo
|Nazwa rekomendacji
|-
|description
|Pomiar wykonuje się przy pomocy badania laboratoryjnego lub indywidualnego urządzenia monitorowania cukru we krwi
|Opis rekomendacji
|-
|image
|https://drrobert.it4u.company/cdn/985234875234984239834.jpg
|URL pliku
|-
|grouping
|true
|Grupowanie zaleceń
|-
|date
|2023-12-20
|Data najbliższego wykonania lub false gdy nie można ustalić daty (należy zapytać użytkownika kiedy ostatnio została wykonana rekomendacja)
|-
|frequency
|d1
|Częstotliwość, identycznie jak w [[API: RecommendationObject]]
|-
|i18n
|'''RecommendationI18nObject'''
|Tablica z obiektami tłumaczeń rekomendacji, identycznie jak w [[API: RecommendationObject]]
|}
Wykorzystywane w: [[API: Zalecenia]]

API: RecommendationObject

2024-12-10T10:39:00Z

PawelM:

Obiekt danych rekomendacji
{| class="wikitable"
|+
!Nazwa
!Przykład
!Opis
|-
|uuid
|e59be4f7-f263-4508-a314-506f06b7cd18
|Wewnętrzne UUID
|-
|name
|Pomiar stężenia glukozy we krwi naczczo
|Nazwa
|-
|type
|lab
|Typ badania
|-
|type_name
|Badanie labolatoryjne
|Nazwa typu badania
|-
|grouping
|true
|Grupowanie zaleceń
|-
|description
|Pomiar wykonuje się przy pomocy badania laboratoryjnego lub indywidualnego urządzenia monitorowania cukru we krwi
|Opis
|-
|image
|https://drrobert.it4u.company/cdn/985234875234984239834.jpg
|URL pliku
|-
|i18n
|Patrz poniżej: '''RecommendationI18nObject'''
|Tablica z obiektami tłumaczeń rekomendacji
|-
|triggers
|Patrz poniżej: '''RecommendationTriggerObject'''
|Tablica z obiektami wyzwalania rekomendacji
|}

== RecommendationTriggerObject ==
Obiekt wyzwalania rekomendacji.
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|37c7b885-ffa0-429f-a2a0-5fd735a70787
|Wewnętrzne UUID
|-
|field
|user.gender
|Klucz pola wymaganego do warunku: user.* dla danych profilu
|-
|condition
|equal
|Typ warunku: equal - równy, more - więcej, less - mniej, equal_more - więcej lub równy, equal_less - mniej lub równy
|-
|value
|male
|Wartość pola wymagana do wyzwolenia
|-
|frequency
|m36
|Częstotliwość rekomendacji:
once - jednorazowo
d1 - codziennie
w1 - co tydzień
w2 - co 2 tygodnie
m1 - co 1 miesiąc
m* - co * miesięcy
|}
Wykorzystywane w: [[API: Zalecenia]]

== RecommendationI18nObject ==
Obiekt tłumaczenia rekomendacji.
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|lang
|pl
|Kod języka
|-
|name
|Pomiar stężenia glukozy we krwi naczczo
|Nazwa
|-
|type_name
|Badanie labolatoryjne
|Nazwa typu badania
|-
|description
|Pomiar wykonuje się przy pomocy badania laboratoryjnego lub indywidualnego urządzenia monitorowania cukru we krwi
|Opis
|-
|image
|https://drrobert.it4u.company/cdn/985234875234984239834.jpg
|URL pliku
|}

API: Zasoby publiczne i konfiguracje ogólne

2024-09-16T10:14:09Z

PawelM:

Wszystkie dane w poniższych endpointach są publiczne (nie wymagają autoryzacji) należy jedynie pamiętać o parametrach obowiązkowych [[API: Parametry]]

== GET /global ==

== GET /global/config ==
==== Odpowiedź JSON ====
<code>{"logo":"http:\/\/drrobert.it4u.company\/img\/logo.png","register_survey_uuid":"49c1cfce-077c-47c8-bea4-4ec3a1e054da"}</code>

== GET /global/contents/$lang ==
Lista treści dla odpowiedniego języka $lang: pl - polski, en - angielski, ua - ukraiński

<code>{"start":"<nowiki><p>Witaj w dr robert</p></nowiki>"}</code>

== GET /global/organisations/$lang ==
Lista organizacji (Placówek POZ)

<code>{1:"bez organizacji"}</code>

== '''<code>[TODO]</code>''' GET /global/organisation/$id ==
Dane organizacji
'''Odpowiedź JSON'''
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|id
|int
|1
|ID organizacji
|-
|name
|string
|bez organizacji
|Nazwa główna
|-
|i18n
|array
|<code>{"pl":"bez organizacji","en":"no organisation"}</code>
|Nazwy w językach
|-
|color_light
|string
|#332255
|Kolor jasnego motywu
|-
|color_dark
|string
|#ffeedd
|Kolor ciemnego motywu
|-
|logo
|string
|<nowiki>http://doctorrobert.com/resources/data/organisations/1/logo.png</nowiki>
|URL loga organizacji
|}

== GET /global/agreements/$lang ==
Lista zgód prawnych

<code>{1:"<a href=\"https:\/\/...\">Regulamin</a>",2:"Przetwarzanie danych <a href=\"https:\/\/...\">osobowych</a>"}</code>

API: UserObject

2024-08-20T12:49:26Z

PawelM:

== UserObject ==
Obiekt danych użytkownika lub profilu
{| class="wikitable"
|+
!Nazwa
!Użytkownik
!Profil
!Edytowalne
!Przykład
!Opis
!Wartości
|-
|uuid
|Tak
|Tak
|Nie
|3b0769ba-19f6-4dd1-af5b-b20416b8825a
|Unikatowe UUID użytkownika
|
|-
|type
|Tak
|Tak
|Nie
|user
|Typ profilu
|user,profile
|-
|relationship
|Nie
|Tak
|Nie
|''UserRelationshipObject''
|Obiekt opisujący relację z rodzicem
|Patrz poniżej do ''UserRelationshipObject''
|-
|lang
|Tak
|Tak
|Tak
|pl
|Kod języka
|pl, en, ua
|-
|name
|Tak
|Tak
|Tak
|Jan Testowy
|Nazwa (imię i/lub nazwisko)
|
|-
|email
|Tak
|Nie
|Nie
|jantestowy@domena.pl
|Adres e-mail
|
|-
|phone
|Tak
|Nie
|Nie
| +48505444333
|Nr telefonu
|
|-
|birthdate
|Tak
|Tak
|Tak
|1965-07-20
|Data urodzenia
|
|-
|birthyear
|Tak
|Tak
|Nie
|1965
|Rok urodzenia
|
|-
|gender
|Tak
|Tak
|Tak
|male
|Płeć
|male, female
|-
|weight
|Tak
|Tak
|Tak
|75
|Waga w kg
|
|-
|height
|Tak
|Tak
|Tak
|175
|Wzrost w cm
|
|-
|waist
|Tak
|Tak
|Tak
|100
|Obwód pasa w cm
|
|-
|bmi
|Tak
|Tak
|Nie
|20.5
|Współczynnik BMI
|
|-
|smoking
|Tak
|Tak
|Nie
|1
|Status palenia tytoniu
|0-nie,1-tak
|-
|smoking_products
|Tak
|Tak
|Nie
|1,2,3
|Tablica z listą produktów
|1-papierosy,2-podrzewany tytoń,3-e-papierosy
|-
|smoking_packyears
|Tak
|Tak
|Nie
|23
|Liczba "paczkolat"
|
|-
|drinking
|Tak
|Tak
|Nie
|0
|Status spożycia alkoholu
|0-nie lub sporadycznie,1-regularnie
|-
|diabetes
|Tak
|Tak
|Nie
|1
|Status chorowania na cukrzyce
|0-nie choruje,1-choruje
|-
|hypertension
|Tak
|Tak
|Nie
|1
|Status chorowania na nadciśnienie
|0-nie choruje,1-choruje
|-
|hypercholesterolemia
|Tak
|Tak
|Nie
|1
|Status chorowania na hipercholesterolemie
|0-nie choruje,1-choruje
|-
|colon_cancer
|Tak
|Tak
|Nie
|1
|Status chorowania na raka jelita grubego
|0-brak,1-występowanie w rodzinie,2-obecność mutacji gen.
|}
Wykorzystywane w: [[API: Autoryzacja]], [[API: Rejestracja]], [[API: Pobieranie i zmiana danych konta i profili]]

== UserRelationshipObject ==
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|3dabcbd4-fab0-4ed6-b356-8d5df897d498
|UUID relacji
|-
|parent_uuid
|7dabcbd4-fab0-4ed6-b356-8d5df897d498
|UUID rodzica
|-
|children_uuid
|9dabcbd4-fab0-4ed6-b356-8d5df897d498
|UUID dziecka
|-
|type
|default
|typ relacji
|-
|date_start
|2023-12-20
|Data rozpoczęcia relacji
|-
|date_stop
|NULL
|Data zakończenia relacji
|}

API: Pobieranie i zmiana danych konta i profili

2024-08-20T09:56:13Z

PawelM:

== GET /user/$user_uuid/data ==
Endpoint służący pobraniu danych użytkownika lub profilu.

'''Odpowiedź JSON'''
{| class="wikitable"
!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'''
{| 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 ==
Endpoint służący aktualizacji danych użytkownika lub profilu.

'''Parametry JSON'''
{| class="wikitable"
!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.
{| 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.
|}

API: UserObject

2024-08-20T09:54:47Z

PawelM:

== UserObject ==
Obiekt danych użytkownika lub profilu
{| class="wikitable"
|+
!Nazwa
!Użytkownik
!Profil
!Edytowalne
!Przykład
!Opis
!Wartości
|-
|uuid
|Tak
|Tak
|Nie
|3b0769ba-19f6-4dd1-af5b-b20416b8825a
|Unikatowe UUID użytkownika
|
|-
|type
|Tak
|Tak
|Nie
|user
|Typ profilu
|user,profile
|-
|relationship
|Nie
|Tak
|Nie
|''UserRelationshipObject''
|Obiekt opisujący relację z rodzicem
|Patrz poniżej do ''UserRelationshipObject''
|-
|name
|Tak
|Tak
|Tak
|pl
|Kod języka
|pl, en, ua
|-
|name
|Tak
|Tak
|Tak
|Jan Testowy
|Nazwa (imię i/lub nazwisko)
|
|-
|email
|Tak
|Nie
|Nie
|jantestowy@domena.pl
|Adres e-mail
|
|-
|phone
|Tak
|Nie
|Nie
| +48505444333
|Nr telefonu
|
|-
|birthdate
|Tak
|Tak
|Tak
|1965-07-20
|Data urodzenia
|
|-
|birthyear
|Tak
|Tak
|Nie
|1965
|Rok urodzenia
|
|-
|gender
|Tak
|Tak
|Tak
|male
|Płeć
|male, female
|-
|weight
|Tak
|Tak
|Tak
|75
|Waga w kg
|
|-
|height
|Tak
|Tak
|Tak
|175
|Wzrost w cm
|
|-
|waist
|Tak
|Tak
|Tak
|100
|Obwód pasa w cm
|
|-
|bmi
|Tak
|Tak
|Nie
|20.5
|Współczynnik BMI
|
|-
|smoking
|Tak
|Tak
|Nie
|1
|Status palenia tytoniu
|0-nie,1-tak
|-
|smoking_products
|Tak
|Tak
|Nie
|1,2,3
|Tablica z listą produktów
|1-papierosy,2-podrzewany tytoń,3-e-papierosy
|-
|smoking_packyears
|Tak
|Tak
|Nie
|23
|Liczba "paczkolat"
|
|-
|drinking
|Tak
|Tak
|Nie
|0
|Status spożycia alkoholu
|0-nie lub sporadycznie,1-regularnie
|-
|diabetes
|Tak
|Tak
|Nie
|1
|Status chorowania na cukrzyce
|0-nie choruje,1-choruje
|-
|hypertension
|Tak
|Tak
|Nie
|1
|Status chorowania na nadciśnienie
|0-nie choruje,1-choruje
|-
|hypercholesterolemia
|Tak
|Tak
|Nie
|1
|Status chorowania na hipercholesterolemie
|0-nie choruje,1-choruje
|-
|colon_cancer
|Tak
|Tak
|Nie
|1
|Status chorowania na raka jelita grubego
|0-brak,1-występowanie w rodzinie,2-obecność mutacji gen.
|}
Wykorzystywane w: [[API: Autoryzacja]], [[API: Rejestracja]], [[API: Pobieranie i zmiana danych konta i profili]]

== UserRelationshipObject ==
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|3dabcbd4-fab0-4ed6-b356-8d5df897d498
|UUID relacji
|-
|parent_uuid
|7dabcbd4-fab0-4ed6-b356-8d5df897d498
|UUID rodzica
|-
|children_uuid
|9dabcbd4-fab0-4ed6-b356-8d5df897d498
|UUID dziecka
|-
|type
|default
|typ relacji
|-
|date_start
|2023-12-20
|Data rozpoczęcia relacji
|-
|date_stop
|NULL
|Data zakończenia relacji
|}

API: UserObject

2024-08-20T09:23:44Z

PawelM:

== UserObject ==
Obiekt danych użytkownika lub profilu
{| class="wikitable"
|+
!Nazwa
!Użytkownik
!Profil
!Edytowalne
!Przykład
!Opis
!Wartości
|-
|uuid
|Tak
|Tak
|Nie
|3b0769ba-19f6-4dd1-af5b-b20416b8825a
|Unikatowe UUID użytkownika
|
|-
|type
|Tak
|Tak
|Nie
|user
|Typ profilu
|user,profile
|-
|relationship
|Nie
|Tak
|Nie
|''UserRelationshipObject''
|Obiekt opisujący relację z rodzicem
|Patrz poniżej do ''UserRelationshipObject''
|-
|name
|Tak
|Tak
|Tak
|pl
|Kod języka
|pl, en, ua
|-
|name
|Tak
|Tak
|Tak
|Jan Testowy
|Nazwa (imię i/lub nazwisko)
|
|-
|email
|Tak
|Nie
|Nie
|jantestowy@domena.pl
|Adres e-mail
|
|-
|phone
|Tak
|Nie
|Nie
| +48505444333
|Nr telefonu
|
|-
|birthdate
|Tak
|Tak
|Tak
|1965-07-20
|Data urodzenia
|
|-
|birthyear
|Tak
|Tak
|Nie
|1965
|Rok urodzenia
|
|-
|gender
|Tak
|Tak
|Tak
|male
|Płeć
|male, female
|-
|weight
|Tak
|Tak
|Tak
|75
|Waga w kg
|
|-
|height
|Tak
|Tak
|Tak
|175
|Wzrost w cm
|
|-
|waist
|Tak
|Tak
|Tak
|100
|Obwód pasa w cm
|
|-
|bmi
|Tak
|Tak
|Nie
|20.5
|Współczynnik BMI
|
|-
|smoking
|Tak
|Tak
|Nie
|1
|Status palenia tytoniu
|0-nie,1-tak
|-
|smoking_products
|Tak
|Tak
|Nie
|1,2,3
|Tablica z listą produktów
|1-papierosy,2-podrzewany tytoń,3-e-papierosy
|-
|smoking_packyears
|Tak
|Tak
|Nie
|23
|Liczba "paczkolat"
|
|-
|drinking
|Tak
|Tak
|Nie
|0
|Status spożycia alkoholu
|0-nie lub sporadycznie,1-regularnie
|-
|diabetes
|Tak
|Tak
|Nie
|1
|Status chorowania na cukrzyce
|0-nie choruje,1-choruje
|-
|hypertension
|Tak
|Tak
|Nie
|1
|Status chorowania na nadciśnienie
|0-nie choruje,1-choruje
|-
|hypercholesterolemia
|Tak
|Tak
|Nie
|1
|Status chorowania na hipercholesterolemie
|0-nie choruje,1-choruje
|-
|colon_cancer
|Tak
|Tak
|Nie
|1
|Status chorowania na raka jelita grubego
|0-brak,1-występowanie w rodzinie,2-obecność mutacji gen.
|}
Wykorzystywane w: [[API: Autoryzacja]], [[API: Rejestracja]]

== UserRelationshipObject ==
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|3dabcbd4-fab0-4ed6-b356-8d5df897d498
|UUID relacji
|-
|parent_uuid
|7dabcbd4-fab0-4ed6-b356-8d5df897d498
|UUID rodzica
|-
|children_uuid
|9dabcbd4-fab0-4ed6-b356-8d5df897d498
|UUID dziecka
|-
|type
|default
|typ relacji
|-
|date_start
|2023-12-20
|Data rozpoczęcia relacji
|-
|date_stop
|NULL
|Data zakończenia relacji
|}

API: Środowiska

2024-08-05T07:19:35Z

PawelM:

== DEV: Środowisko testowe ==
API: <nowiki>https://drrobert.it4u.company/api-v1/</nowiki>

CMS: https://drrobert.it4u.company/_cms4u

CM: https://drrobert.it4u.company/cm

APP: https://drrobertapps.it4u.company/

== PROD: Środowisko produkcyjne ==
LANDING: https://doctorrobert.com/

API: <nowiki>https://api.doctorrobert.com/api-v1/</nowiki>

CMS: https://doctorrobert.com/_cms4u/

CM: https://doctorrobert.com/cm

API: Środowiska

2024-08-05T07:16:13Z

PawelM:

== DEV: Środowisko testowe ==
API: <nowiki>https://drrobert.it4u.company/api-v1/</nowiki>

CMS: https://drrobert.it4u.company/_cms4u

CM: https://drrobert.it4u.company/cm

APP: https://drrobertapps.it4u.company/

== PROD: Środowisko produkcyjne ==
LANDING: https://doctorrobert.com/

API: <nowiki>https://doctorrobert.com/api-v1/</nowiki>

CMS: https://doctorrobert.com/_cms4u/

CM: https://doctorrobert.com/cm

API: Środowiska

2024-08-05T07:15:43Z

PawelM:

== DEV: Środowisko testowe ==
API: <nowiki>https://drrobert.it4u.company/api-v1/</nowiki>

CMS: https://drrobert.it4u.company/_cms4u

CM: https://drrobert.it4u.company/cm

APP: https://drrobertapps.it4u.company/

== PROD: Środowisko produkcyjne ==
API: <nowiki>https://doctorrobert.com/api-v1/</nowiki>

CMS: https://doctorrobert.com/_cms4u/

CM: https://doctorrobert.com/cm

Strona główna

2024-06-19T13:56:06Z

PawelM:

'''Dokumentacja systemu DrRobert'''

== API aplikacji ==

* Ogólne
** [[API: Środowiska]]
** [[API: Parametry]]
* Zasoby
** [[API: Zasoby publiczne i konfiguracje ogólne]]
* Użytkownicy
** [[API: Autoryzacja|API]]<nowiki/>[[API: Autoryzacja|: Autoryzacja]] [<nowiki/>[[API: UserObject]]]
** [[API: Rejestracja (konta i profile)]]
** [[API: Pobieranie i zmiana danych konta i profili]] [<nowiki/>[[API: UserObject]]]
** [[API: Notyfikacje Push]]
* Pozostałe
** [[API: Ankiety|A]]<nowiki/>[[API: Ankiety|PI: An]]<nowiki/>[[API: Ankiety|kiety]] [<nowiki/>[[API: SurveyObject]]]
** [[API: Zalecenia]] [<nowiki/>[[API: RecommendationObject]], [[API: UserRecommendationObject]]]
** [[API: Kalendarz]] [<nowiki/>[[API: UserEventObject]]]
** [[API: Organizacje|API: Organizac]]<nowiki/>[[API: Organizacje|je]] [<nowiki/>[[API: UserOrganisationObject]], [[API: UserOrganisationMembership]]]
<nowiki/>
* [[API: TODO]]

== C<nowiki/>entrum Monitoringu ==
* [[CM: Dashboard]]
* [[CM: Użytkownicy]]
* [[CM: Ośrodki]]
* [[CM: Ankiety]]
* [[CM: Rekomendacje]]
* [[CM: Profil]]

== API edytora ankiet ==
* [[API edytora ankiet: Środowiska|Środowiska]]
* [[API edytora ankiet: Uwierzytelnianie|Uwierzytelnianie]]
* [[API edytora ankiet: Pobieranie danych ankiety|Pobieranie danych ankiety]]
* [[API edytora ankiet: Wysyłanie danych ankiety|Wysyłanie danych ankiety]]
* Obiekty: [[API edytora ankiet: SurveyObject|[SurveyObject]]]

== Baza danych ==
* [[Baza danych: Użytkownicy]]
* [[Baza danych: Ankiety]]
* [[Baza danych: Zalecenia]]
* [[Baza danych: Organizacje]]

CM: Rekomendacje

2024-06-18T08:50:18Z

PawelM:

== Lista rekomendacji ==
[[Plik:Lista Rekomendacji.png|alt=Lista Rekomendacji|brak|mały|1000x1000px|Lista Rekomendacji]]
Widok wszystkich Rekomendacji sortowanych po unikalnym ID. Centrum Monitoringu pozwala na dodanie, usunięcie oraz edycję Rekomendacji.

Przycisk 'Dodaj rekomendację' przekierowuje do pustego widoku rekomendacji w Centrum Monitoringu, który pozwala na wypełnienie danych. ID nowej Rekomendacji generuje się automatycznie przy zapisie danych.

Po naciśnięciu przycisku 'Usuń' nad listą pojawia się przycisk 'Przywróć usunięty element' pozwalający przywrócić właśnie usuniętą Rekomendację. Po naciśnięciu przycisku 'Przywróć usunięty element' następuje przekierowanie do widoku przywróconej Rekomendacji, a jej usunięcie zostało anulowane.

== Widok rekomendacji ==
Widok rekomendacji składa się z dwóch części. Formularza rekomendacji który pozwala na edycję danych oraz tabeli wyzwalaczy, które służą do przypisania użytkownikom odpowiedniej rekomendacji.

== Formularz rekomendacji ==
Pozwala na uzupełnienie nazwy oraz opisu badania po polsku oraz jego tłumaczenia w każdym dostępnym w aplikacji języku.

== Lista wyzwalaczy ==
[[Plik:Lista wyzwalaczy.png|alt=Lista wyzwalaczy|brak|mały|1000x1000px|Lista wyzwalaczy]]
Lista wyzwalaczy pozwala na przegląd oraz edycję wszystkich wyzwalaczy (również tych zagnieżdżonych), które wywołają przypisanie użytkownikowi danej rekomendacji.

== Widok edycji wyzwalacza ==
[[Plik:Formularz wyzwalacza głównego.png|alt=Formularz wyzwalacza głównego|mały|938x938px|Formularz wyzwalacza głównego|brak]]
[[Plik:Formularz wyzwalacza zagnieżdżonego.png|alt=Formularz wyzwalacza zagnieżdżonego|mały|939x939px|Formularz wyzwalacza zagnieżdżonego|brak]]
Widok wyzwalacza głównego składa się z dwóch części. Formularza edycji rekomendacji oraz lista powiązanych wyzwalaczy.

== Formularz wyzwalaczy rekomendacji ==
Formularz dla wyzwalaczy głównych oraz zagnieżdżonych wygląda identycznie za wyjątkiem przycisku 'Przejdź do wyzwalacza głównego' w formularzu wyzwalaczy zagnieżdżonych. Przycisk ten przekierowuje do wyzwalacza głównego, do którego wyzwalacz zagnieżdżony jest przypisany.

Wyzwalacze zagnieżdżone służą do tworzenia wyzwalacza, który wymaga spełnienia więcej niż jednego warunku, aby przypisać rekomendację do użytkownika. Ukazany wyzwalacz ma na celu przypisanie badania prostaty jedynie dla mężczyzn (warunek pierwszy) w wieku lat 50 lub wyższym (warunek drugi).

ID - unikalne ID wyzwalacza

ID rekomendacji - unikalne ID rekomendacji. wskazuje do jakiej rekomendacji przypisany jest wyzwalacz.

Nazwa - nazwa wyzwalacza

Powiązany wyzwalacz - pozwala zamienić obecny wyzwalacz w wyzwalacz zagnieżdżony innego wyzwalacza.

Pole danych - jakie pole danych będzie sprawdzane pod kątem podanej w wyzwalaczu wartości/odpowiedzi. Polem danych może być informacja podana w profilu użytkownika w aplikacji (płeć, waga, wzrost), wyliczona na podstawie danych w profilu użytkownika w aplikacji (wiek, BMI), bądź też odpowiedź na jakiekolwiek pytanie w ankiecie, którą wypełnił użytkownik.

==== W przypadku wybrania ankiety: ====
<blockquote>''Ankieta - wskazuje, do której z ankiet odnosił się będzie wyzwalacz.''

''Pytanie - na odpowiedź którego z pytań będzie wskazywał wyzwalacz.''

'''''W przypadku gdy pytanie jest otwarte:'''''

''Warunek - wyznacza, czy wartość podana w ankiecie powinna być mniejsza, równa, bądź też większa niż ta podana w wyzwalaczu''

''Wartość - wartość numeryczna do, której będzie porównywana wartość podana w ankiecie''

'''''W przypadku, gdy pytanie jest zamknięte:'''''

''Odpowiedź - odpowiedź na pytanie, które zaznaczone przez użytkownika, uruchomi wyzwalacz i przypisze mu wskazaną przez wyzwalacz rekomendację''</blockquote>

==== W przypadku wybrania wartości powiązanej z profilem użytkownika: ====
''Warunek - wyznacza, czy wartość podana w profilu użytkownika wartość powinna być mniejsza, równa, bądź też większa niż ta podana w wyzwalaczu''

''Wartość - wartość numeryczna do, której będzie porównywana wartość podana w profilu użytkownika.''

== Lista powiązanych wyzwalaczy: ==
Pozwala dodać, usunąć oraz edytować wyzwalacza zagnieżdżone przypisane do wyzwalacza głównego. Lista powiązań wyzwalaczy w widoku wyzwalacza zagnieżdżonego nie wskazuje na wyzwalacz główny, do którego wyzwalacz zagnieżdżony jest przypisany.

API: Zasoby publiczne i konfiguracje ogólne

2024-06-14T10:03:11Z

PawelM:

API: Notyfikacje Push

2024-06-03T13:06:46Z

PawelM: Utworzono nową stronę "== POST /user/push_instance == Endpoint służący dodaniu kluczy autoryzacji do wysyłki notifikacji PUSH '''Parametry JSON dla subskrypcji przeglądarki''' {| class="wikitable" !Klucz !Typ !Przykład !Opis |- |type |string |subscription |Typ instancji |- |endpoint |string |<nowiki>https://updates.push.services.mozilla.com/wpush/v2/gAAAAABmTcZgukiH9IODEr7Ve6WdY60sK4TSJJU8ioya1kXjgdt8yOtLvKrrh4Y9P6DBBpxo0ozXSUhQVaplW3FpefvwC8bi-c4_3DFVVXE0zXGpMABK5OUEJzwipj5OIXlHg…"

== POST /user/push_instance ==
Endpoint służący dodaniu kluczy autoryzacji do wysyłki notifikacji PUSH

'''Parametry JSON dla subskrypcji przeglądarki'''
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|type
|string
|subscription
|Typ instancji
|-
|endpoint
|string
|<nowiki>https://updates.push.services.mozilla.com/wpush/v2/gAAAAABmTcZgukiH9IODEr7Ve6WdY60sK4TSJJU8ioya1kXjgdt8yOtLvKrrh4Y9P6DBBpxo0ozXSUhQVaplW3FpefvwC8bi-c4_3DFVVXE0zXGpMABK5OUEJzwipj5OIXlHgHgWB1iF1OPSLDKzZh3LxiqZeNxG2DwAs7nEzrFpLaNqBxIEPTU</nowiki>
|Endpoint usługi push
|-
|public_key
|string
|BFyYMtZ-dg4mYUJaq1Xn4Fo0hVciExquBTT2zJhC9TRjmaKG5NDDVcuHW-FGbEbYzkrqtYKtwnFsSA1zX6PucRI
|Klucz publiczny
|-
|auth_token
|string
|OhUrddOix7gFP3vEgQ7_eg
|Token uwierzytelniania
|}
'''Parametry JSON dla Firebase'''
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|type
|string
|firebase
|Typ instancji
|-
|auth_token
|string
|BFyYMtZ-dg4mYUJaq1Xn4Fo0hVciExquBTT2zJhC9TRjmaKG5NDDVcuHW-FGbEbYzkrqtYKtwnFsSA1zX6PucRI
|Token firebase
|}

Strona główna

2024-06-03T12:58:37Z

PawelM:

'''Dokumentacja systemu DrRobert'''

== API aplikacji ==

* Ogólne
** [[API: Środowiska]]
** [[API: Parametry]]
** [[API: Obsługa i kody błędów]]
* Zasoby
** [[API: Zasoby publiczne i konfiguracje ogólne]]
* Użytkownicy
** [[API: Autoryzacja|API]]<nowiki/>[[API: Autoryzacja|: Autoryzacja]] [<nowiki/>[[API: UserObject]]]
** [[API: Rejestracja (konta i profile)]]
** [[API: Pobieranie i zmiana danych konta i profili]] [<nowiki/>[[API: UserObject]]]
** [[API: Notyfikacje Push]]
* Pozostałe
** [[API: Ankiety|A]]<nowiki/>[[API: Ankiety|PI: An]]<nowiki/>[[API: Ankiety|kiety]] [<nowiki/>[[API: SurveyObject]]]
** [[API: Zalecenia]] [<nowiki/>[[API: RecommendationObject]], [[API: UserRecommendationObject]]]
** [[API: Kalendarz]] [<nowiki/>[[API: UserEventObject]]]
** [[API: Organizacje|API: Organizac]]<nowiki/>[[API: Organizacje|je]] [<nowiki/>[[API: UserOrganisationObject]], [[API: UserOrganisationMembership]]]
<nowiki/>
* [[API: TODO]]

== C<nowiki/>entrum Monitoringu ==
* [[CM: TODO]]

== API edytora ankiet ==
* [[API edytora ankiet: Środowiska|Środowiska]]
* [[API edytora ankiet: Uwierzytelnianie|Uwierzytelnianie]]
* [[API edytora ankiet: Pobieranie danych ankiety|Pobieranie danych ankiety]]
* [[API edytora ankiet: Wysyłanie danych ankiety|Wysyłanie danych ankiety]]
* Obiekty: [[API edytora ankiet: SurveyObject|[SurveyObject]]]

== Aplikacja Svelte ==

* [[Wersje aplikacji Svelte|Wersje aplikacji]]
* [[TODO: porządki Svelte|TODO: zmiany i porządki]]

== Baza danych ==
* [[Baza danych: Użytkownicy]]
* [[Baza danych: Ankiety]]
* [[Baza danych: Zalecenia]]
* [[Baza danych: Organizacje]]

== Wikimedia ==
Zapoznaj się z [[mediawikiwiki:Special:MyLanguage/Help:Contents|Podręcznikiem użytkownika]] zawierającym informacje o tym jak korzystać z oprogramowania wiki.
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Lista ustawień konfiguracyjnych]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ Komunikaty o nowych wersjach MediaWiki (lista dyskusyjna)]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Przetłumacz MediaWiki na swój język]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Dowiedz się, jak walczyć ze spamem na swojej wiki]

API: Zalecenia

2024-06-03T11:09:59Z

PawelM:

API: Rejestracja (konta i profile)

2024-05-06T09:52:37Z

PawelM:

== POST /user/signup ==
Endpoint służący utworzeniu konta użytkownika, zwraca token uwierzytelniania.

=== Parametry JSON ===
{| class="wikitable"
!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
|BardzoTrudneHasło123
|Nadane hasło
|Tak
|Minimum 8 dowolnych znaków
|-
|organisation_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]])
|-
|anonymous_token
|string
|2580f055d57a2a298cb899f8ede75edbb88f1c92
|Token autoryzacji użytkownika anonimowego, gdy prawidłowo podany zamiast dodawać nowego użytkownika nastąpi przekształcenie użytkownika anonimowego na pełnoprawnego.
|Nie
|
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]

==== Odpowiedź poprawna ====
Identyczna jak w [[API: Autoryzacja]]

==== Odpowiedź niepoprawna walidacja ====
'''JSON:'''

<code><nowiki>{"error": "validation","validation":{"name": {"max": true},"phone": {"required": true},"email": {"email": true},"organization_id": [],"agreements": []}}</nowiki></code>
{| class="wikitable"
!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
|}
== POST /user/profile ==
Endpoint służący utworzeniu profilu przypisanego do użytkownika, zwraca dane profilu.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
!Wymagane
!Walidacja
|-
|name
|string
|Jan Kowalski
|Nazwa profilu: imię lub imię i nazwisko
|Tak
|Długość: 50
|}
Należy pamiętać o wymaganych parametrach: [[API: Parametry]]

==== Odpowiedź poprawna ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|user
|UserObject
|[https://drrobert.it4u.company/docs/API:_UserObject API: UserObject]
|Obiekt profilu patrz: [https://drrobert.it4u.company/docs/API:_UserObject API: UserObject]
|}

API: Środowiska

2024-04-19T07:11:15Z

PawelM:

API edytora ankiet: Środowiska

2024-04-19T07:00:17Z

PawelM:

== DEV: Środowisko testowe ==
API: <nowiki>https://drrobert.it4u.company/sapi/modules/surveys/editor_api/</nowiki>

APP: <nowiki>https://drrobert.it4u.company/sapi/modules/surveys/editor/</nowiki>

== PROD: Środowisko produkcyjne ==
Nie zostało jeszcze uruchomione

API edytora ankiet: Środowiska

2024-04-19T06:59:47Z

PawelM:

== DEV: Środowisko testowe ==
<nowiki>https://drrobert.it4u.company/sapi/modules/surveys/editor_api/</nowiki>

== PROD: Środowisko produkcyjne ==
Nie zostało jeszcze uruchomione

API edytora ankiet: Środowiska

2024-04-19T06:59:17Z

PawelM:

== DEV: Środowisko testowe ==
https://drrobert.it4u.company/sapi/modules/surveys/editor/

== PROD: Środowisko produkcyjne ==
Nie zostało jeszcze uruchomione

API edytora ankiet: Wysyłanie danych ankiety

2024-04-19T06:58:10Z

PawelM:

== POST /survey/$uuid ==
Zapisywanie danych ankiety

==== Parametry JSON ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|auth_token
|string
|2580f055d57a2a298cb899f8ede75edbb88f1c92
|Token autoryzacji patrz: [[API edytora ankiet: Uwierzytelnianie]]
|-
|survey
|object
|{uuid:...}
|Patrz [[API edytora ankiet: SurveyObject]]
|}

==== Odpowiedź ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|result
|string
|ok
|'ok' gdy przetworzono i zapisano, 'error' gdy błąd (patrz poniżej opis błędu)
|-
|error
|string
|bad_uuid
|Kod błędu:

* bad_token - błędny token lub brak uprawnień
* bad_uuid - nie znaleziono ankiety
* bad_survey_object - błędna struktura obiektu 'survey'
* no_survey_object - nie wysłano obiektu 'survey'
|}

API edytora ankiet: SurveyObject

2024-04-16T12:56:46Z

PawelM:

Obiekt danych ankiety
{| class="wikitable"
|+
!Nazwa
!Przykład
!Opis
|-
|uuid
|a6193cb2-a187-4fb7-bc58-48af9e26f9b5
|Wewnętrzne ID
|-
|name
|Ankieta rejestracyjna
|Nazwa
|-
|description
|Ankieta medyczna wypełniana po rejestracji
|Opis
|-
|image
|https://drrobert.it4u.company/cdn/985234875234984239834.jpg
|URL pliku
|-
|questions
|Patrz poniżej: '''SurveyQuestionObject'''
|Tablica z obiektami pytań
|}

== SurveyQuestionObject ==
Obiekt pytania
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|4af41076-d8c1-4523-bec0-488dd4d5927a
|Wewnętrzne ID
|-
|name
|cigarettes
|Nazwa
|-
|content
|Czy palisz papierosy / podgrzewany tytoń / e-papierosy ?
|Treść
|-
|type
|select
|Typ pola: select, text, number, radio, checkbox
|-
|unit
|NULL
|W przypadku type=number możliwe jednostki: integer, float, mililiter, liter, kilometer, meter, seconds, minutes, hours, days, months, years
|-
|validations
|Patrz poniżej: '''SurveyQuestionValidationObject'''
|Tablica z obiektami walidacji
|-
|triggers
|Patrz poniżej: '''SurveyQuestionTriggerObject'''
|Tablica z obiektami wyzwalania pytania, gdy brak pytanie jest zawsze pokazywane
|-
|answers
|Patrz poniżej: '''SurveyAnswerObject'''
|Tablica z odpowiedziami
|-
|sort
|1
|Numer porządkowy
|-
|delete
|false
|'true' oznacza usunięcie pytania
|}

== SurveyAnswerObject ==
Obiekt odpowiedzi
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|4af41076-d8c1-4523-bec0-488dd4d5927a
|Wewnętrzne ID
|-
|name
|yes
|Nazwa
|-
|content
|Tak
|Treść
|-
|subquestions
|Patrz: '''SurveyQuestionObject'''
|Tablica z podpytaniami
|-
|sort
|1
|Numer porządkowy
|-
|delete
|false
|true oznacza usunięcie odpowiedzi
|}

== SurveyQuestionValidationObject ==
TODO

== SurveyQuestionTriggerObject ==
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|37c7b885-ffa0-429f-a2a0-5fd735a70787
|Wewnętrzne UUID
|-
|field
|user.gender
|Klucz pola wymaganego do warunku: user.* dla danych profilu
|-
|condition
|equal
|Typ warunku: equal - równy, more - więcej, less - mniej, equal_more - więcej lub równy, equal_less - mniej lub równy
|-
|value
|male
|Wartość pola wymagana do wyzwolenia
|-
|required
|false
|Gdy wartość true wyzwalacz jest niezbędny do pokazania pytania, gdy false wystarczy że dowolny inny wyzwalacz jest spełniony
|}

API: SurveyObject

2024-04-16T12:08:32Z

PawelM:

Obiekt danych ankiety
{| class="wikitable"
|+
!Nazwa
!Przykład
!Opis
|-
|uuid
|a6193cb2-a187-4fb7-bc58-48af9e26f9b5
|Wewnętrzne ID
|-
|name
|Ankieta rejestracyjna
|Nazwa
|-
|description
|Ankieta medyczna wypełniana po rejestracji
|Opis
|-
|image
|https://drrobert.it4u.company/cdn/985234875234984239834.jpg
|URL pliku
|-
|questions
|Patrz poniżej: '''SurveyQuestionObject'''
|Tablica z obiektami pytań
|}

== SurveyQuestionObject ==
Obiekt pytania
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|4af41076-d8c1-4523-bec0-488dd4d5927a
|Wewnętrzne ID
|-
|name
|cigarettes
|Nazwa
|-
|content
|Czy palisz papierosy / podgrzewany tytoń / e-papierosy ?
|Treść
|-
|type
|select
|Typ pola pytania otwartego: text, number, date
Typ pola pytania zamkniętego (odpowiedzi do wyboru): select, radio, checkbox
|-
|unit
|NULL
|W przypadku type=number możliwe jednostki: integer, float, mililiter, liter, kilometer, meter, seconds, minutes, hours, days, months, years
|-
|validations
|Patrz poniżej: '''SurveyQuestionValidationObject'''
|Tablica z obiektami walidacji
|-
|triggers
|Patrz poniżej: '''SurveyQuestionTriggerObject'''
|Tablica z obiektami wyzwalania pytania, gdy brak pytanie jest zawsze pokazywane
|-
|answers
|Patrz poniżej: '''SurveyAnswerObject'''
|Tablica z odpowiedziami
|}

== SurveyAnswerObject ==
Obiekt odpowiedzi
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|4af41076-d8c1-4523-bec0-488dd4d5927a
|Wewnętrzne ID
|-
|name
|yes
|Nazwa
|-
|content
|Tak
|Treść
|-
|subquestions
|Patrz: '''SurveyQuestionObject'''
|Tablica z podpytaniami
|}
Wykorzystywane w: [[API: Ankiety]]

== SurveyQuestionValidationObject ==
TODO

== SurveyQuestionTriggerObject ==
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|37c7b885-ffa0-429f-a2a0-5fd735a70787
|Wewnętrzne UUID
|-
|field
|user.gender
|Klucz pola wymaganego do warunku: user.* dla danych profilu
|-
|condition
|equal
|Typ warunku: equal - równy, more - więcej, less - mniej, equal_more - więcej lub równy, equal_less - mniej lub równy
|-
|value
|male
|Wartość pola wymagana do wyzwolenia
|-
|required
|false
|Gdy wartość true wyzwalacz jest niezbędny do pokazania pytania, gdy false wystarczy że dowolny inny wyzwalacz jest spełniony
|}

API: SurveyObject

2024-04-16T11:56:20Z

PawelM:

Obiekt danych ankiety
{| class="wikitable"
|+
!Nazwa
!Przykład
!Opis
|-
|uuid
|a6193cb2-a187-4fb7-bc58-48af9e26f9b5
|Wewnętrzne ID
|-
|name
|Ankieta rejestracyjna
|Nazwa
|-
|description
|Ankieta medyczna wypełniana po rejestracji
|Opis
|-
|image
|https://drrobert.it4u.company/cdn/985234875234984239834.jpg
|URL pliku
|-
|questions
|Patrz poniżej: '''SurveyQuestionObject'''
|Tablica z obiektami pytań
|}

== SurveyQuestionObject ==
Obiekt pytania
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|4af41076-d8c1-4523-bec0-488dd4d5927a
|Wewnętrzne ID
|-
|name
|cigarettes
|Nazwa
|-
|content
|Czy palisz papierosy / podgrzewany tytoń / e-papierosy ?
|Treść
|-
|type
|select
|Typ pola: select, text, number, radio, checkbox
|-
|unit
|NULL
|W przypadku type=number możliwe jednostki: integer, float, mililiter, liter, kilometer, meter, seconds, minutes, hours, days, months, years
|-
|validations
|Patrz poniżej: '''SurveyQuestionValidationObject'''
|Tablica z obiektami walidacji
|-
|triggers
|Patrz poniżej: '''SurveyQuestionTriggerObject'''
|Tablica z obiektami wyzwalania pytania, gdy brak pytanie jest zawsze pokazywane
|-
|answers
|Patrz poniżej: '''SurveyAnswerObject'''
|Tablica z odpowiedziami
|}

== SurveyAnswerObject ==
Obiekt odpowiedzi
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|4af41076-d8c1-4523-bec0-488dd4d5927a
|Wewnętrzne ID
|-
|name
|yes
|Nazwa
|-
|content
|Tak
|Treść
|-
|subquestions
|Patrz: '''SurveyQuestionObject'''
|Tablica z podpytaniami
|}
Wykorzystywane w: [[API: Ankiety]]

== SurveyQuestionValidationObject ==
TODO

== SurveyQuestionTriggerObject ==
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|37c7b885-ffa0-429f-a2a0-5fd735a70787
|Wewnętrzne UUID
|-
|field
|user.gender
|Klucz pola wymaganego do warunku: user.* dla danych profilu
|-
|condition
|equal
|Typ warunku: equal - równy, more - więcej, less - mniej, equal_more - więcej lub równy, equal_less - mniej lub równy
|-
|value
|male
|Wartość pola wymagana do wyzwolenia
|-
|required
|false
|Gdy wartość true wyzwalacz jest niezbędny do pokazania pytania, gdy false wystarczy że dowolny inny wyzwalacz jest spełniony
|}

API: SurveyObject

2024-04-16T11:29:20Z

PawelM:

Obiekt danych ankiety
{| class="wikitable"
|+
!Nazwa
!Przykład
!Opis
|-
|uuid
|a6193cb2-a187-4fb7-bc58-48af9e26f9b5
|Wewnętrzne ID
|-
|name
|Ankieta rejestracyjna
|Nazwa
|-
|description
|Ankieta medyczna wypełniana po rejestracji
|Opis
|-
|image
|https://drrobert.it4u.company/cdn/985234875234984239834.jpg
|URL pliku
|-
|questions
|Patrz poniżej: '''SurveyQuestionObject'''
|Tablica z obiektami pytań
|}

== SurveyQuestionObject ==
Obiekt pytania
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|4af41076-d8c1-4523-bec0-488dd4d5927a
|Wewnętrzne ID
|-
|name
|cigarettes
|Nazwa
|-
|content
|Czy palisz papierosy / podgrzewany tytoń / e-papierosy ?
|Treść
|-
|type
|select
|Typ pola: select, text, number, radio, checkbox
|-
|unit
|NULL
|W przypadku type=number możliwe jednostki: integer, float, mililiter, liter, kilometer, meter, seconds, minutes, hours, days, months, years
|-
|validations
|Patrz poniżej: '''SurveyQuestionValidationObject'''
|Tablica z obiektami walidacji
|-
|triggers
|Patrz poniżej: '''SurveyQuestionTriggerObject'''
|Tablica z obiektami wyzwalania pytania
|-
|answers
|Patrz poniżej: '''SurveyAnswerObject'''
|Tablica z odpowiedziami
|}

== SurveyAnswerObject ==
Obiekt odpowiedzi
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|4af41076-d8c1-4523-bec0-488dd4d5927a
|Wewnętrzne ID
|-
|name
|yes
|Nazwa
|-
|content
|Tak
|Treść
|-
|subquestions
|Patrz: '''SurveyQuestionObject'''
|Tablica z podpytaniami
|}
Wykorzystywane w: [[API: Ankiety]]

== SurveyQuestionValidationObject ==
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|37c7b885-ffa0-429f-a2a0-5fd735a70787
|Wewnętrzne UUID
|-
|field
|user.gender
|Klucz pola wymaganego do warunku: user.* dla danych profilu
|-
|condition
|equal
|Typ warunku: equal - równy, more - więcej, less - mniej, equal_more - więcej lub równy, equal_less - mniej lub równy
|-
|value
|male
|Wartość pola wymagana do wyzwolenia
|-
|frequency
|m36
|Częstotliwość rekomendacji:
once - jednorazowo d1 - codziennie w1 - co tydzień w2 - co 2 tygodnie m1 - co 1 miesiąc m* - co * miesięcy
|}

== SurveyQuestionTriggerObject ==
{| class="wikitable"
!Nazwa
!Przykład
!Opis
|-
|uuid
|37c7b885-ffa0-429f-a2a0-5fd735a70787
|Wewnętrzne UUID
|-
|field
|user.gender
|Klucz pola wymaganego do warunku: user.* dla danych profilu
|-
|condition
|equal
|Typ warunku: equal - równy, more - więcej, less - mniej, equal_more - więcej lub równy, equal_less - mniej lub równy
|-
|value
|male
|Wartość pola wymagana do wyzwolenia
|-
|frequency
|m36
|Częstotliwość rekomendacji:
once - jednorazowo d1 - codziennie w1 - co tydzień w2 - co 2 tygodnie m1 - co 1 miesiąc m* - co * miesięcy
|}

API edytora ankiet: SurveyObject

2024-04-11T13:54:09Z

PawelM:

API edytora ankiet: Wysyłanie danych ankiety

2024-04-08T13:34:53Z

PawelM:

== POST /survey/$uuid ==
Zapisywanie danych ankiety

==== Parametry JSON ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|auth_token
|string
|2580f055d57a2a298cb899f8ede75edbb88f1c92
|Token autoryzacji patrz: [https://drrobert.it4u.company/docs/API_edytora_ankiet:_Uwierzytelnianie API edytora ankiet: Uwierzytelnianie]
|-
|survey
|object
|{uuid:...}
|Patrz [https://drrobert.it4u.company/docs/API_edytora_ankiet:_SurveyObject API edytora ankiet: SurveyObject]
|}

==== Odpowiedź ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|result
|string
|ok
|'ok' gdy przetworzono i zapisano, 'error' gdy błąd (patrz poniżej opis błędu)
|-
|error
|string
|bad_uuid
|Kod błędu:

* bad_token - błędny token lub brak uprawnień
* bad_uuid - nie znaleziono ankiety
* bad_survey_object - błędna struktura obiektu 'survey'
* no_survey_object - nie wysłano obiektu 'survey'
|}

API: Pobieranie i zmiana danych konta i profili

2024-04-04T08:47:10Z

PawelM:

API: Ankiety

2024-04-04T07:14:42Z

PawelM:

== GET /surveys ==
Lista wszystkich ankiet, wraca tablice składającą się z [[API: SurveyObject]]

== GET /survey/$uuid ==
Dane ankiety wraz z listą pytań i odpowiedzi, zwraca [[API: SurveyObject]]

== POST /user/$user_uuid/survey/$survey_uuid ==
Wysłanie udzielonych odpowiedzi użytkownika na ankietę o podanym ID.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|answers
|array
|[
{'question_uuid':'d2dade75-ebe4-4bad-a280-a11211dbfbe7','answer_uuid':'fdcd261b-d740-4b88-90bd-9cd2e7822776'},

{'question_uuid':'0e6381f7-23a0-4ff2-9885-9e2a306921a6','value':'10'},

{'question_uuid':'bbb84130-f11f-46c5-a706-24e4f85db02f','value':'test'},

{'question_uuid':'23582e46-b6b2-475a-af16-6b002139053a','answer_uuid':'8eccfa91-4a13-4532-85f1-9fc347af5488'},

]
|Tablica z obiektami odpowiedzi, klucze:
'''question_uuid''' uuid pytania,

'''answer_uuid''' uuid odpowiedzi (pytania zamkniete),

'''value''' wartość odpowiedzi (pytania otwarte)
|}
Odpowiedź jest taka sama jak w przypadku zapytania GET poniżej.

== GET /user/$user_uuid/survey/$survey_uuid ==
Pobranie ostatnich udzielonych odpowiedzi użytkownika na ankietę o podanym ID.

=== Odpowiedź JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|answers
|array
|[
{'question_uuid':'d2dade75-ebe4-4bad-a280-a11211dbfbe7','answer_uuid':'fdcd261b-d740-4b88-90bd-9cd2e7822776'},

{'question_uuid':'0e6381f7-23a0-4ff2-9885-9e2a306921a6','value':'10'},

{'question_uuid':'bbb84130-f11f-46c5-a706-24e4f85db02f','value':'test'},

{'question_uuid':'23582e46-b6b2-475a-af16-6b002139053a','answer_uuid':'8eccfa91-4a13-4532-85f1-9fc347af5488'},

]
|Tablica z obiektami odpowiedzi [patrz tabela wyżej]
|}

API: Ankiety

2024-04-03T14:01:00Z

PawelM:

== GET /surveys ==
Lista wszystkich ankiet, wraca tablice składającą się z [[API: SurveyObject]]

== GET /survey/$uuid ==
Dane ankiety wraz z listą pytań i odpowiedzi, zwraca [[API: SurveyObject]]

== POST /user/$user_uuid/survey/$survey_uuid ==
Wysłanie udzielonych odpowiedzi użytkownika na ankietę o podanym ID.

=== Parametry JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|answers
|array
|[
{'uuid':'d2dade75-ebe4-4bad-a280-a11211dbfbe7','value':null},

{'uuid':'0e6381f7-23a0-4ff2-9885-9e2a306921a6','value':'10'},

{'uuid':'bbb84130-f11f-46c5-a706-24e4f85db02f','value':'test'},

{'uuid':'23582e46-b6b2-475a-af16-6b002139053a','value':null},

]
|Tablica z obiektami odpowiedzi, klucze:
'''uuid''' pytania lub odpowiedzi,
'''value''' wartość odpowiedzi [null gdy uuid odpowiedzi lub int, float lub string gdy uuid pytania]
|}
Odpowiedź jest taka sama jak w przypadku zapytania GET poniżej.

== GET /user/$user_uuid/survey/$survey_uuid ==
Pobranie ostatnich udzielonych odpowiedzi użytkownika na ankietę o podanym ID.

=== Odpowiedź JSON ===
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|answers
|array
|[
{'uuid':'d2dade75-ebe4-4bad-a280-a11211dbfbe7','value':null},

{'uuid':'0e6381f7-23a0-4ff2-9885-9e2a306921a6','value':'10'},

{'uuid':'bbb84130-f11f-46c5-a706-24e4f85db02f','value':'test'},

{'uuid':'23582e46-b6b2-475a-af16-6b002139053a','value':null},

]
|Tablica z obiektami odpowiedzi [patrz tabela wyżej]
|}

API edytora ankiet: SurveyObject

2024-04-03T06:44:46Z

PawelM:

API edytora ankiet: SurveyObject

2024-04-03T06:40:18Z

PawelM:

API edytora ankiet: Wysyłanie danych ankiety

2024-04-02T12:27:40Z

PawelM:

== POST /survey/$uuid ==
Zapisywanie danych ankiety

==== Parametry JSON ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|auth_token
|string
|2580f055d57a2a298cb899f8ede75edbb88f1c92
|Token autoryzacji patrz: [https://drrobert.it4u.company/docs/API_edytora_ankiet:_Uwierzytelnianie API edytora ankiet: Uwierzytelnianie]
|-
|survey
|object
|{uuid:...}
|Patrz [https://drrobert.it4u.company/docs/API_edytora_ankiet:_SurveyObject API edytora ankiet: SurveyObject]
|}

==== Odpowiedź ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|result
|string
|ok
|'ok' gdy przetworzono i zapisano, 'error' gdy błąd (patrz poniżej opis błędu)
|-
|error
|string
|bad_uuid
|Kod błędu:

* bad_token - błędny token lub brak uprawnień
* bad_uuid - nie znaleziono ankiety
* bad_survey_object - błędna struktura obiektu survey
|}

API edytora ankiet: Pobieranie danych ankiety

2024-04-02T12:24:58Z

PawelM:

== GET /survey/$survey_uuid ==
Pobieranie danych ankiety, UUID jest pobierane z parametru odwołania '?survey_uuid=...'

==== Parametry JSON ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|auth_token
|string
|2580f055d57a2a298cb899f8ede75edbb88f1c92
|Token autoryzacji patrz: [[API edytora ankiet: Uwierzytelnianie]]
|}

==== Odpowiedź ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|survey
|object
|{uuid:...}
|Patrz [[API edytora ankiet: SurveyObject]]
|}

API edytora ankiet: Pobieranie danych ankiety

2024-04-02T12:22:41Z

PawelM:

Strona główna

2024-04-02T12:21:37Z

PawelM:

'''Dokumentacja systemu DrRobert'''

== API aplikacji ==

* Ogólne
** [[API: Środowiska]]
** [[API: Parametry]]
** [[API: Obsługa i kody błędów]]
* Zasoby
** [[API: Zasoby publiczne i konfiguracje ogólne]]
* Użytkownicy
** [[API: Autoryzacja|API]]<nowiki/>[[API: Autoryzacja|: Autoryzacja]] [<nowiki/>[[API: UserObject]]]
** [[API: Rejestracja (konta i profile)]]
** [[API: Pobieranie i zmiana danych konta i profili]] [<nowiki/>[[API: UserObject]]]
* Pozostałe
** [[API: Ankiety|A]]<nowiki/>[[API: Ankiety|PI: Ankiety]] [<nowiki/>[[API: SurveyObject]]]
** [[API: Zalecenia]] [<nowiki/>[[API: RecommendationObject]], [[API: UserRecommendationObject]]]
** [[API: Kalendarz]] [<nowiki/>[[API: UserEventObject]]]
** [[API: Organizacje|API: Organizac]]<nowiki/>[[API: Organizacje|je]] [<nowiki/>[[API: UserOrganisationObject]], [[API: UserOrganisationMembership]]]
<nowiki/>
* [[API: TODO]]

== C<nowiki/>entrum Monitoringu ==
* [[CM: TODO]]

== API edytora ankiet ==
* [[API edytora ankiet: Środowiska|Środowiska]]
* [[API edytora ankiet: Uwierzytelnianie|Uwierzytelnianie]]
* [[API edytora ankiet: Pobieranie danych ankiety|Pobieranie danych ankiety]]
* [[API edytora ankiet: Wysyłanie danych ankiety|Wysyłanie danych ankiety]]
* Obiekty: [[API edytora ankiet: SurveyObject|[SurveyObject]]]

== Aplikacja Svelte ==

* [[Wersje aplikacji Svelte|Wersje aplikacji]]
* [[TODO: porządki Svelte|TODO: zmiany i porządki]]

== Baza danych ==
* [[Baza danych: Użytkownicy]]
* [[Baza danych: Ankiety]]
* [[Baza danych: Zalecenia]]
* [[Baza danych: Organizacje]]

== Wikimedia ==
Zapoznaj się z [[mediawikiwiki:Special:MyLanguage/Help:Contents|Podręcznikiem użytkownika]] zawierającym informacje o tym jak korzystać z oprogramowania wiki.
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Lista ustawień konfiguracyjnych]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ Komunikaty o nowych wersjach MediaWiki (lista dyskusyjna)]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Przetłumacz MediaWiki na swój język]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Dowiedz się, jak walczyć ze spamem na swojej wiki]

API edytora ankiet: SurveyObject

2024-04-02T12:20:51Z

PawelM:

API edytora ankiet: SurveyObject

2024-04-02T12:20:20Z

PawelM: Utworzono nową stronę "Obiekt danych ankiety {| class="wikitable" |+ !Nazwa !Przykład !Opis |- |uuid |a6193cb2-a187-4fb7-bc58-48af9e26f9b5 |Wewnętrzne ID |- |name |Ankieta rejestracyjna |Nazwa |- |description |Ankieta medyczna wypełniana po rejestracji |Opis |- |image |https://drrobert.it4u.company/cdn/985234875234984239834.jpg |URL pliku |- |questions |Patrz poniżej: '''SurveyQuestionObject''' |Tablica z obiektami pytań |} == SurveyQuestionObject == Obiekt pytania {| class="wikita…"

API edytora ankiet: Pobieranie danych ankiety

2024-04-02T12:19:17Z

PawelM:

== GET /survey/$id ==
Pobieranie danych ankiety

==== Parametry JSON ====
{| class="wikitable"
!Klucz
!Typ
!Przykład
!Opis
|-
|auth_token
|string
|2580f055d57a2a298cb899f8ede75edbb88f1c92
|Token autoryzacji patrz: [[API edytora ankiet: Uwierzytelnianie]]
|}

==== Odpowiedź ====
Patrz [[API edytora ankiet: SurveyObject]]

API edytora ankiet: Uwierzytelnianie

2024-04-02T12:08:16Z

PawelM: Utworzono nową stronę "Do uwierzytelniania zapytań API wykorzystywany jest token który jest przekazywany w adresie wywołania aplikacji jako parametr '?auth_token='"

Do uwierzytelniania zapytań API wykorzystywany jest token który jest przekazywany w adresie wywołania aplikacji jako parametr '?auth_token='

Strona główna

2024-04-02T11:54:31Z

PawelM:

'''Dokumentacja systemu DrRobert'''

== API aplikacji ==

* Ogólne
** [[API: Środowiska]]
** [[API: Parametry]]
** [[API: Obsługa i kody błędów]]
* Zasoby
** [[API: Zasoby publiczne i konfiguracje ogólne]]
* Użytkownicy
** [[API: Autoryzacja|API]]<nowiki/>[[API: Autoryzacja|: Autoryzacja]] [<nowiki/>[[API: UserObject]]]
** [[API: Rejestracja (konta i profile)]]
** [[API: Pobieranie i zmiana danych konta i profili]] [<nowiki/>[[API: UserObject]]]
* Pozostałe
** [[API: Ankiety|A]]<nowiki/>[[API: Ankiety|PI: Ankiety]] [<nowiki/>[[API: SurveyObject]]]
** [[API: Zalecenia]] [<nowiki/>[[API: RecommendationObject]], [[API: UserRecommendationObject]]]
** [[API: Kalendarz]] [<nowiki/>[[API: UserEventObject]]]
** [[API: Organizacje|API: Organizac]]<nowiki/>[[API: Organizacje|je]] [<nowiki/>[[API: UserOrganisationObject]], [[API: UserOrganisationMembership]]]
<nowiki/>
* [[API: TODO]]

== C<nowiki/>entrum Monitoringu ==
* [[CM: TODO]]

== API edytora ankiet ==
* [[API edytora ankiet: Środowiska|Środowiska]]
* [[API edytora ankiet: Uwierzytelnianie|Uwierzytelnianie]]
* [[API edytora ankiet: Pobieranie danych ankiety|Pobieranie danych ankiety]]
* [[API edytora ankiet: Wysyłanie danych ankiety|Wysyłanie danych ankiety]]

== Aplikacja Svelte ==

* [[Wersje aplikacji Svelte|Wersje aplikacji]]
* [[TODO: porządki Svelte|TODO: zmiany i porządki]]

== Baza danych ==
* [[Baza danych: Użytkownicy]]
* [[Baza danych: Ankiety]]
* [[Baza danych: Zalecenia]]
* [[Baza danych: Organizacje]]

== Wikimedia ==
Zapoznaj się z [[mediawikiwiki:Special:MyLanguage/Help:Contents|Podręcznikiem użytkownika]] zawierającym informacje o tym jak korzystać z oprogramowania wiki.
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Lista ustawień konfiguracyjnych]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ Komunikaty o nowych wersjach MediaWiki (lista dyskusyjna)]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Przetłumacz MediaWiki na swój język]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Dowiedz się, jak walczyć ze spamem na swojej wiki]