• Nie Znaleziono Wyników

Wyrzucane błędy

Ścieżka /api/cookienotice

Typ metody GET

Nazwa metody public String getCookieNoticeUpdates() Przeznaczenie biznesowe Pobiera Politykę Cookies

Przyjmowane parametry

Zwracany typ String Wyrzucane błędy

Ścieżka /api/courtlistbuletin

Typ metody GET

Nazwa metody public String getCourtListBuletinUpdates() Przeznaczenie biznesowe Pobiera wykaz sądów

Przyjmowane parametry

Zwracany typ String Wyrzucane błędy

Kontekst apelacji – metody związane z obsługą kontekstu apelacji Ścieżka /api/change-appeal/store-user-data

Typ metody GET

Nazwa metody public void storeUserData()

Przeznaczenie biznesowe Zapisuje dane użytkownika na potrzeby zmiany apelacji Przyjmowane parametry

Zwracany typ void

Wyrzucane błędy

Ścieżka /api/change-appeal/restore-user-data

Typ metody POST

Nazwa metody public ResponseEntity<PortalUserCopy> restoreUserData() Przeznaczenie biznesowe Odtwarza dane użytkownika na potrzeby zmiany apelacji Przyjmowane parametry

Zwracany typ ResponseEntity<PortalUserCopy>

Wyrzucane błędy Exception

Ścieżka /api/change-appeal/new-user

Typ metody POST

str.

21 Nazwa metody public ResponseEntity<Void>

createPortalUser(@RequestBody PortalUser portalUser) Przeznaczenie biznesowe Tworzy użytkownika w innej apelacji

Przyjmowane parametry PortalUser Zwracany typ ResponseEntity Wyrzucane błędy URISyntaxException

UserAlreadyExistException Opis obiektów (atrybuty):

ResponseEntity<InputStreamResource> - zwracanie kodu odpowiedzi z obiektem InputStreamResource

ResponseEntity<PortalUserCopy> - zwracanie kodu odpowiedzi z obiektem PortalUserCopy ResponseEntity - zwracanie kodu odpowiedzi z możliwością zwracania innego obiektu

● Atrybuty:

o ze statusem odpowiedzi 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

o Boolean deleted - usunięty o Boolean autoAccess - autodostep

o String blockingJustification – uzasadnienie zablokowania o PortalUser parentUser – użytkownik nadrzędny

o PermissionGroup permissionGroup – id grupy uprawnień o Boolean regulationAccepted – akceptacja regulaminu

o UserPreferences userPreferences – preferencje użytkownika

str.

22 o String rpaStatus – status użytkownika w systemie RPA – AKTYWNY,

NIEAKTYWNY, NULL

o String bailiffCourt – rewiry komornicze Konfiguracje – metody związane z obsługą konfiguracji

Ścieżka /api/configuration/appeals-redirect-addresses

Typ metody GET

Nazwa metody public List<Pair<String, String>>

getAppealsRedirectAddresses() Przeznaczenie biznesowe Pobiera adresy apelacji

Zwracany typ List<Pair<String, String>>

Wyrzucane błędy

Opis obiektów (atrybuty):

List<Pair<String, String>> - lista par klucz wartość

Wydziały – metody związane z obsługą wydziałów sądów Ścieżka /api/court-departments

Typ metody GET

Nazwa metody public ResponseEntity<List<CourtDepartment>>

getAllCourtDepartments(Pageable pageable)

Przeznaczenie biznesowe Pobiera listę wydziałów na podstawie podanych kryteriów Przyjmowane parametry Pageable

Zwracany typ ResponseEntity<List<CourtDepartment>>

Ścieżka /api/court-departments/{id}

Typ metody GET

Nazwa metody public ResponseEntity<CourtDepartment>

getCourtDepartment(@PathVariable Long id) Przeznaczenie biznesowe Pobiera wydział o wskazanym identyfikatorze Przyjmowane parametry Long id - identyfikator wydziału

Zwracany typ ResponseEntity<CourtDepartment>

Wyrzucane błędy Przykład użycia:

GET: /api/court-departments/12

Ścieżka /api/court-departments/court/{courtId}

Typ metody GET

str.

23 Nazwa metody public ResponseEntity<List<CourtDepartmentDTO>>

getDepartmentsByCourtId(@PathVariable Long courtId) Przeznaczenie biznesowe Pobiera listę wydzałów danego sądu

Przyjmowane parametry Long courtId - identyfikator sądu

Zwracany typ ResponseEntity<List<CourtDepartment>>

Wyrzucane błędy Przykład użycia:

GET: /api/court-departments/court/12

Opis obiektów (atrybuty):

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 CourtDepartmentDTO - wydział

● Atrybuty:

o Long id – id

o String departmentNumber – numer wydziału o String name – nazwa wydziału

o String identifier – identyfikator

CourtDepartment – obiekt przychowujący dane wydziałów sądu

● Atrybuty:

o Long id – id obiektu

o String departmentNumber – numer wydziału o String name - nazwa

o String email – adres email o String eternalId – zewnętrzne id o String identifier - identyfikator

o Boolean applicatingBlocked – wnioskowanie zablokowane o Boolean published – czy jest opublikowany

o Court court – id sądu

ResponseEntity<List<CourtDepartmentDTO>> - zwracanie kodu odpowiedzi z listą obiektów CourtDepartmentDTO

ResponseEntity<CourtDepartment> - zwracanie kodu odpowiedzi z obiektem CourtDepartment

Sądy – metody związane z obsługą sądów

Ścieżka /api/courts

Typ metody GET

Nazwa metody public ResponseEntity<List<Court>>

getAllCourts(CourtCriteria criteria, Pageable pageable) Przeznaczenie biznesowe Pobiera listę sądów dla wskazanych kryteriów

Przyjmowane parametry CourtCriteria, Pageable

str.

24 Zwracany typ ResponseEntity<List<Court>>

Wyrzucane błędy Przykład użycia:

GET:/api/courts?name.contains=Wroc%C5%82aw&address2.contains=Gr%C3%B3jec ka&identifier.contains=1550

Ścieżka /api/courts/{id}

Typ metody GET

Nazwa metody public ResponseEntity<Court> getCourt(@PathVariable Long id)

Przeznaczenie biznesowe Pobiera sąd o wskazanym identyfikatorze Przyjmowane parametry Long

Zwracany typ ResponseEntity Wyrzucane błędy

Przykład użycia:

GET: /api/courts/12

Ścieżka /api/courts/active

Typ metody GET

Nazwa metody public ResponseEntity<List<Court>> getCourts() Przeznaczenie biznesowe Pobiera listę aktywnych sądów

Przyjmowane parametry

Zwracany typ ResponseEntity Wyrzucane błędy

Przykład użycia:

GET: /api/courts/12

Ścieżka /api/courts/nonresident

Typ metody GET

Nazwa metody public ResponseEntity<List<GlobalCourt>>

getAllNonresidentCourts()

Przeznaczenie biznesowe Pobiera listę sądów uczestniczących w rozprawach odmiejscowionych

Zwracany typ Lista obiektów typu GlobalCourt Wyrzucane błędy

Przykład użycia:

GET: /api/courts/nonresident

Opis obiektów (atrybuty):

ResponseEntity<List<Court>> - zwracanie kodu odpowiedzi z listą obiektów Court CourtCriteria

Pageable – obiekt opisujący stronicowanie

● Atrybuty:

o page=0 - aktualna strona

str.

25 o size=20 - ilość wynikow na strone

o sort=id,asc - sortowane pole, kierunek sortowania

ResponseEntity - zwracanie kodu odpowiedzi z możliwością zwracania innego obiektu

● Atrybuty:

o ze statusem odpowiedzi GlobalCourt - sąd odmiejscowiony

● Atrybuty:

o name - nazwa sądu

o identifier - identyfikator sądu

o nonresident - czy uczestniczy w rozprawach odmiejscowionych Court – model danych sadu

 Atrybuty:

o Long id – id

o String name – nazwa o String address1 – adres1 o String address2 – adres2 o String identifier – identyfikator o Boolean disabled – czy aktywny

Posiedzenia – metody związane z obsługą posiedzeń Ścieżka /api/court-sessions/lawsuit

Typ metody GET

Nazwa metody public ResponseEntity<List<LawsuitSessionDTO>>

getCourtSessionsByLawsuit(CourtSessionCriteria criteria, Pageable pageable)

Przeznaczenie biznesowe Pobiera posiedzenia dla danej sprawy Przyjmowane parametry CourtSessionCriteria, Pageable

Wymagane:

lawsuitId - identyfikator sprawy

Zwracany typ ResponseEntity<List<LawsuitSessionDTO>>

Wyrzucane błędy EntityNotFoundException - nie znaleziono sprawy

BadRequestAlertException - błędne parametry zapytania Przykład użycia:

GET:

/api/court-sessions/lawsuit?page=0&size=20&lawsuitId.equals=1&signature.contains=I%20C%20112/1 7&courtId.equals=1&procedure.equals=publikacja&dateFrom.greaterOrEqualThan=2018-09-06T18:16:46.407Z&sort=id,asc

Ścieżka /api/court-sessions/{id}

Typ metody GET

Nazwa metody public ResponseEntity<CourtSession>

getCourtSession(@PathVariable Long id)

Przeznaczenie biznesowe Pobiera posiedzenie o wskazanym identyfikatorze

str.

26

Powiązane dokumenty