Przyjmowane parametry Long
Zwracany typ ResponseEntity<UserEvent>
Wyrzucane błędy Przykład użycia:
GET: /api/user-events/3
Ścieżka /api/user-events/{id}
Typ metody DELETE
Nazwa metody public ResponseEntity<Void>
deleteUserEvent(@PathVariable Long id) Przeznaczenie biznesowe Usuwa wydarzenie o wskazanym id Przyjmowane parametry Long
Zwracany typ ResponseEntity Wyrzucane błędy
Przykład użycia:
DELETE: /api/user-events/2
Opis obiektów (atrybuty):
UserEvent – wydarzenie w kalendarzu użytkownika
● Atrybuty:
o Long id – id obiektu o String title – tytuł o String description – opis o Instant startTime – data od o Instant endTime – data do o PortalUser user – użytkownik
UserEventCriteria – kryteria wyszukiwania wydarzeń w kalendarzu użytkownika
● Atrybuty:
o LongFilter id – id obiektu o StringFilter title - tytuł o StringFilter description - opis o InstantFilter startTime – data od o InstantFilter endTime – data do o LongFilter userId – id użytkownika
ResponseEntity<UserEvent> - zwracanie kodu odpowiedzi z obiektem UserEvent
ResponseEntity<List<UserEvent>> - zwracanie kodu odpowiedzi z listą obiektów UserEvent Pageable – obiekt opisujący stronicowanie
● Atrybuty:
o page=0 - aktualna strona
o size=20 - ilość wynikow na strone
o sort=id,asc - sortowane pole, kierunek sortowania
str.
78Zarządzanie autentykacją – metody związane z zarządzaniem autentykacją użytkowników
Ścieżka /api/authenticate/login-as/{token}
Typ metody GET
Nazwa metody ResponseEntity<JWTToken>
loginAsAnotherUser(@PathVariable String token)
Przeznaczenie biznesowe Zalogowuje użytkownika PA, na konto użytkownika PI, za pomocą tokena wygenerowanego po stronie PA
Przyjmowane parametry String token
Zwracany typ ResponseEntity<JWTToken>
Wyrzucane błędy EntityNotFoundException
Ścieżka /api/authenticate
Typ metody POST
Nazwa metody public ResponseEntity<JWTToken> authorize(@Valid
@RequestBody LoginVM loginVM)
Przeznaczenie biznesowe Autentykuje użytkownika na podstawie danych logowania w systemie
Przyjmowane parametry LoginVM
Zwracany typ ResponseEntity<JWTToken>
Wyrzucane błędy
Ścieżka /api/authenticate/epuap
Typ metody POST
Nazwa metody public ResponseEntity<JWTToken>
authorizeWithEpuap(@RequestBody String samlArt)
Przeznaczenie biznesowe Autentykuje użytkownika na podstawie tokena zwróconego z systemu epuap
Przyjmowane parametry String
Zwracany typ ResponseEntity<JWTToken>
Wyrzucane błędy TransformerException TpUserInfoException MarshallingException JAXBException
EntityNotFoundException
Ścieżka /api/authenticate/change-context
Typ metody POST
Nazwa metody public ResponseEntity<JWTToken>
changeUserContext(@Valid @RequestBody String username) Przeznaczenie biznesowe Zmienia kontekst zalogowanego użytkownika na kontekst
wskazanego użytkownika Przyjmowane parametry String
Zwracany typ ResponseEntity<JWTToken>
str.
79 Wyrzucane błędy EntityNotFoundExceptionNoAccessException Opis obiektów (atrybuty):
LoginVM – dane logowania użytkownika
● Atrybuty:
o String username – nazwa użytkownika o String password - hasło
ResponseEntity<JWTToken> - zwracanie kodu odpowiedzi z obiektem JWTToken
Przykład użycia:
POST: /api/authenticate Body:
{
"username" : "83040707012",
"password" : "Haslo"
}
Ustawienia konta użytkownika – metody związane z obsługą ustawień kont użytkowników (np. powiadomienia, czcionki, kontrasty)
Ścieżka /api/user-preferences
Typ metody POST
Nazwa metody public ResponseEntity<UserPreferences>
createUserPreferences(@RequestBody UserPreferences userPreferences)
Przeznaczenie biznesowe Tworzy obiekt preferencji dla danego użytkownika Przyjmowane parametry UserPreferences
Zwracany typ ResponseEntity<UserPreferences>
Wyrzucane błędy URISyntaxException BadRequestAlertException EntityNotFoundException Ścieżka /api/user-preferences
Typ metody PUT
Nazwa metody public ResponseEntity<UserPreferences>
updateUserPreferences(@RequestBody UserPreferences userPreferences)
Przeznaczenie biznesowe Aktualizuje obiekt preferencji dla danego użytkownika Przyjmowane parametry UserPreferences
Zwracany typ ResponseEntity<UserPreferences>
Wyrzucane błędy URISyntaxException BadRequestAlertException EntityNotFoundException
str.
80 Ścieżka /api/user-preferences/{userId}Typ metody GET
Nazwa metody public ResponseEntity<UserPreferences>
getUserPreferences(@PathVariable Long userId) Przeznaczenie biznesowe Pobiera obiekt preferencji danego użytkownika Przyjmowane parametry Long
Zwracany typ ResponseEntity<UserPreferences>
Wyrzucane błędy NoAccessException Opis obiektów (atrybuty):
ResponseEntity<UserPreferences> - zwracanie kodu odpowiedzi z obiektem UserPreferences
UserPreferences – preferencje użytkownika
● Atrybuty:
o Long id – id obiektu
o Boolean applicationStatusChangedEmail – zmieniony status wniosku email o Boolean applicationStatusChangedSms – zmieniony status wniosku sms o Boolean newFileAttachedToLawsuitEmail – plik zalaczony do sprawy email o Boolean newFileAttachedToLawsuitSms – plik zalaczony do sprawy sms o Boolean lawsuitChangedEmail – zmieniona sprawa email
o Boolean lawsuitChangedSms – zmieniona sprawa sms
o Boolean proceedingChangedEmail – zmieniona czynność email o Boolean proceedingChangedSms – zmieniona czynność sms o Boolean sessionChangedEmail – zmienione posiedzenie email o Boolean sessionChangedSms – zmienione posiedzenie sms o Boolean systemEventEmail – zdarzenie systemowe email o Boolean systemEventSms – zdarzenie systemowe sms o Boolean passwordResetEmail - reset hasła email o Boolean passwordResetSms – reset hasła sms o Integer font - czcionka
o Integer contrast - kontrast
Profil użytkownika – metody związane z obsługą profilu użytkownika
Ścieżka /api/user-profile
Typ metody POST
Nazwa metody public ResponseEntity<PortalUser>
createPortalUser(@RequestBody PortalUser portalUser) Przeznaczenie biznesowe Tworzy nowego użytkownika
Przyjmowane parametry PortalUser
Zwracany typ ResponseEntity<PortalUser>
Wyrzucane błędy URISyntaxException BadRequestAlertException
Ścieżka /api/user-profile
Typ metody PUT
str.
81 Nazwa metody public ResponseEntity<PortalUser>updatePortalUser(@RequestBody PortalUser portalUser) Przeznaczenie biznesowe Aktualizuje dane użytkownika
Przyjmowane parametry PortalUser
Zwracany typ ResponseEntity<PortalUser>
Wyrzucane błędy URISyntaxException BadRequestAlertException CustomParameterizedException Przykład użycia:
PUT: /api/user-profile Body:
str.
82 }Ścieżka /api/user-profile/{id}
Typ metody GET
Nazwa metody public ResponseEntity<PortalUser>
getPortalUser(@PathVariable Long id) Przeznaczenie biznesowe Pobiera użytkownika na podstawie id Przyjmowane parametry Long id - id użytkownika
Zwracany typ ResponseEntity<PortalUser>
Ścieżka /api/user-profile/bylogin/{login}
Typ metody GET
Nazwa metody public ResponseEntity<PortalUser>
getPortalUserByLogin(@PathVariable String login) Przeznaczenie biznesowe Pobiera użytkownika na podstawie loginu
Przyjmowane parametry String login - login użytkownika Zwracany typ ResponseEntity<PortalUser>
Wyrzucane błędy NoAccessException
Opis obiektów (atrybuty):
PortalUser - użytkownik
● Atrybuty:
o Long id – id obiektu o String firstName - imie
o String secondName – drugie imię o String lastName - nazwisko
o String idNumber – numer dokumentu tożsamości o String pesel - pesel
o Instant birthDate – data urodzenia o String birthPlace – mijesce urodzenia o String fathersName – imie ojca o String mothersName – imie matki o String email – adres email
o String phone telefon o String fax - fax
o Boolean notifyAboutChanges – powiadamiaj o zmianach o Long accountStatus – status konta
o Instant registerDate – data rejestracji o String cardNumber – numer legitymacji o Boolean foreigner - obcokrajowiec o String login - login
o String country - kraj
o String unitNumber – kod jednostki o String name - nazwa