Dokumentacja API Portalu Informacyjnego Sądów Powszechnych

(1)

Dokumentacja API Portalu

Informacyjnego Sądów

Powszechnych

COMP S.A.

Wersja dokumentu 1.18 (10.12.2021 r.)

(2)

str.

1 Tabela zamian

Wersja Data Zmiana

1.3 14.05.2019 r. Pobieranie e-protokołów – metody związane z pobieraniem e- protokołów – zmiana w metodzie pobierania plików audio lub wideo.

1.4 13.11.2019 r. Dodano informacje o statusie pełnomocnika profesjonalnego.

1.5 15.11.2019 r. Dodano informacje o statusie pełnomocnika w systemie RPA 1.6 05.02.2021 r. Uzupełnienie:

- metod modułu Biuro Podawcze - atrybutów rejestracji Komornika

- metoda pobierania adresu URL do podpisu wniosku PZ 1.7 22.04.2021 Uzupełnienie informacji o ważność tokenu w rozdziale

Informacje ogólne.

1.8 05.05.2021 Korekta dokumentacji w zakresie metody

/api/subusers/{isUsualSubuser} - uzupełnienie listy parametrów.

1.9 11.06.2021 r. Uzupełnienie w dokumentacji w zakresie /api/documents (atrybuty: usersDownload, publicatinDate) i

nieudokumentowaniej wcześniej metody /api/documents/downloads-info.

1.10 22.06.2021 Doprecyzowanie rozdział „Pisma wpływające do sądu– metody związane z obsługą modułu Biuro Podawcze”

1.11 06.07.2021 Aktualizacja metod związanych z Dokumentami.

Wprowadzenie możliwości pobrania listy dokumentów ze wszystkich sparw /api/documents/delivery-info.

Pobranie informacji o dokumencie /api/documents/{id}

1.12 16.07.2021 Aktualizacja opisów metod związanych z Dokumentami.

1.13 06.09.2021 Dodano do dokumentacji słowniki typów wniosków, statusów wniosków, rodzajów powiązań, typów dokumentów, formatów dokumentów.

Dodano do dokumentacji adresy API poszczególnych apelacji.

1.14 09.09.2021 Skorygowano dokumentacje w zakresie modelu sprawy LawsuitView było „List<Party> parties” jest

„List<LawsuitPartyDTOParty> parties” – lista obiektów Party (podmiotów w sprawie)

Dodano endpointy opisane w rozdziale Doręczenia – metody związane z doręczeniami

1.15 15.11.2021 Dodanie funkcjonalności Doręczeń

1.16 23.11.2021 Aktualizacja metody /api/documents/delivery-info

1.17 23.11.2021 Dodnie w delivery-info i w /deliveries/start-date zozszerzonego opisu przeznaczenia metody.

1.18 10.12.2021 Aktualizacja dokumentacji dla metody /api/documents o obiekty przyjmowane i zwracane w metodzie. Dostosowanie dokumentacji do funkcjonującej metody.

(3)

str.

2

Spis treści

1. Informacje ogólne 5

Łączenie do API 5

Bazowa ścieżka, np.: https://{host apelacji}/api/ 5

Metoda PUT 5

Metoda POST 6

Metoda DELETE 6

Metoda GET 6

2. Dokumentacja Dossier API 7

Konto użytkownika – metody związane z kontem użytkownika 7

Opis obiektów (atrybuty): 8

Adres - metody związane z adresami użytkowników 9

Wnioski – metody związane z wnioskami 11

Informacje – metody związane z pobieraniem podstawowych informacji o portalu

informacyjnym 18

Kontekst apelacji – metody związane z obsługą kontekstu apelacji 20

Konfiguracje – metody związane z obsługą konfiguracji 22

Wydziały – metody związane z obsługą wydziałów sądów 22

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

Posiedzenia – metody związane z obsługą posiedzeń 25

Posiedzenia (widok) – metody związane z obsługą posiedzeń sądu 27

Dashboard – metody związane z obsługą dashboardu 29

Wydziały – metoda związana z pobieraniem wydziałów do których użytkownik ma dostęp 29

Słowniki – metody związane z obsługą słowników 30

(4)

str.

3

Dokumenty – metody związane z obsługą dokumentów 31

Pobieranie e-protokołów – metody związane z pobieraniem e-protokołów 38

Odtwarzacz e-protokołów – metody związane z obsługą odtwarzania e-protokołów 38

Słowniki – metody związane z obsługą słówników 40

Sprawy – metody związane z obsługą spraw 41

Powiadomienia – metody związane z obsługą powiadomień 44

Strony postępowania – metody związane z obsługą stron postępowania 46

Użytkownicy – metody związane z obsługą użytkowników 47

Czynności – metody związane z obsługą czynności 54

Widok czynności – metody związane z obsługą widoku czynności 55

Pisma wpływające do sądu– metody związane z obsługą modułu Biuro Podawcze 57

Powiązania w sprawach – metody związane z obsługą powiązań w sprawach 63

Repertoria – metody związane z obsługą repertoriów 66

Zgłaszanie błędów – metody związane z obsługą zgłaszania błędów 67

Role w sprawie – metody związane z obsługą ról w sprawie 69

Ustawienia – metody związane z obsługą ustawień (między innymi formularzy wniosków) 69

Zarządzanie upoważnieniami – metody związane z zarządzaniem upoważnieniami dla

subkont 69

Subkonta – metody związane z obsługą subkont 72

(5)

str.

4

Wydarzenia w kalendarzu użytkownika – metody związane z obsługą wydarzeń w

kalendarzu użytkownika 75

Zarządzanie autentykacją – metody związane z zarządzaniem autentykacją użytkowników 78

Ustawienia konta użytkownika – metody związane z obsługą ustawień kont użytkowników

(np. powiadomienia, czcionki, kontrasty) 79

Profil użytkownika – metody związane z obsługą profilu użytkownika 80

Biuro Podawcze – metody związane z obsługą biura Podawczego 83 Profil użytkownika – metody związane z obsługą profilu użytkownika 83

Raporty SLPS = metody związane z obsługą raportów SLPS 83

Pobranie Listy sądów słownikowych 83

Pobranie listy departamentów 84

Pobranie listy repertoriów 84

Pobranie listy dokumentów z SLPS 85

Przeładowanie słownika sądów (SLPS) 86

Pobranie klucza do captcha 86

(6)

str.

5

1. Informacje ogólne

Aplikacja udostępnia usługę interfejsów API dla portali informacyjnych, aplikacji

mobilnych, a także zewnętrznych systemów. Niniejszy dokument opisuje dostępne metody oraz wymieniane obiekty, ich atrybuty oraz przykłady wywołań. Interfejsy oparte są na wzorcu REST API.

Do większości metod wymaga jest autoryzacja za pomocą interfejsu JWT.

Json Web Token (JWT) to rodzaj tokena przechowywanego po stronie klienta opartego na formacie JSON. Token jest zaszyfrowany po stronie serwera i tylko serwer ma klucz pozwalający na zweryfikowanie autentyczności tokenu.

JWT składa się z trzech części. Wszystkie dane w tokenie są zakodowane algorytmem Base64 i w takiej postaci przechowywane.

Każde autoryzowane zapytanie do API (z użyciem prawidłowego tokena) generuje i zwraca nowy token. Token jest ważny dla wykorzystania tylko jeden raz, w odpowiedzi od API jest zwracany nowy token.

Łączenie do API

Bazowa ścieżka, np.: https://{host apelacji}/api/

Uwierzytelnianie:

● Metoda: /authenticate

● Parametry to username oraz password, a w odpowiedzi otrzymujemy id_token.

Wartość z id_token jest następnie wykorzystywana do odpytywania pozostałych końcówek.

Do każdego zapytania musi być dołączony nagłówek : Authorization: Bearer <token>.

Metody API wykorzystują 4 podstawowe typy zapytań:

Metoda PUT

Realizuje funkcjonalności modyfikacji wybranego elementu systemu np.:

PUT /api/lawsuits/message Request headers:

Accept:

application/json, text/plain, */*

Authorization:

Bearer <token>

Request payload:

{"id":"74150", description":"Wiadomość testowa","partyId":571242,

"eprotocolEnabled":false}

(7)

str.

6

Metoda POST

Realizuje funkcjonalności dodawania wybranego elementu systemu np.:

POST /api/applications/check Request headers:

Accept:

application/json, text/plain, */*

Authorization:

Bearer <token>

Request payload:

{"comments":"uwagi do

sprawy","roleInLawsuit":"pełnomocnik","courtId":6,"courtName":"Sąd Okręgowy w Legnicy","lawsuitNumber":12,"department":"I","departmentFullName":"Wydział I Cywilny","repertory":"C","repertoryId":1216,"year":2015,"type":"LAWSUIT" } Metoda DELETE

Realizuje funkcjonalności usuwania wybranego elementu systemu np.:

DETELE /api/addresses/12 Request headers:

Authorization:

Bearer <token>

Metoda GET

Realizuje funkcjonalności pobrania informacji o elemencie/liście elementów systemu np.:

/api/lawsuits/page=0&size=20&signature.contains=RC&court.equals=6&judgeName.contain s=Jan%20Kowalski&receiptDate.greaterOrEqualThan=2018-08-

12T22:00:00.000Z&receiptDate.lessOrEqualThan=2018-08-

30T22:00:00.000Z&finishDate.specified=false&sort=id,asc&sort=receiptDate Request headers:

Authorization:

Bearer <token>

(8)

str.

7

2. Dokumentacja Dossier API

API Portalu Informacyjnego jest ogólnie dostępne w sieci Internet pod adresami:

portal.bialystok.sa.gov.pl portal.gdansk.sa.gov.pl portal.katowice.sa.gov.pl portal.krakow.sa.gov.pl portal.lublin.sa.gov.pl portal.lodz.sa.gov.pl portal.poznan.sa.gov.pl portal.rzeszow.sa.gov.pl portal.szczecin.sa.gov.pl portal.waw.sa.gov.pl portal.wroclaw.sa.gov.pl

Konto użytkownika – metody związane z kontem użytkownika

Ścieżka /api/authenticate

Typ metody GET

Nazwa metody public String isAuthenticated(HttpServletRequest request) Przeznaczenie biznesowe Sprawdza czy użytkownik jest zalogowany (nie służy do

zalogowania użytkownika) Przyjmowane parametry

Zwracany typ String Wyrzucane błędy

Ścieżka /api/account

Typ metody GET

Nazwa metody public UserDTO getAccount()

Przeznaczenie biznesowe Pobiera informacje o koncie zalogowanego użytkownika Przyjmowane parametry

Zwracany typ UserDTO

Wyrzucane błędy InternalServerErrorException

Ścieżka /apite hange-password

Typ metody POST

Nazwa metody public ResponseEntity changePassword(@RequestBody PasswordChangeDTO passwordChangeDto)

Przeznaczenie biznesowe Zmienia hasło użytkownika Przyjmowane parametry PasswordChangeDTO Zwracany typ ResponseEntity Wyrzucane błędy NoAccessException Przykład użycia:

POST: /api/account/change-password Body:

(9)

str.

8 {

"currentPassword":"qySZTamc20IPY6rPpChc",

"newPassword":"2wsx#EDC"

}

Ścieżka /api/account/reset-password/init

Typ metody POST

Nazwa metody public void requestPasswordReset(@RequestBody String mail)

Przeznaczenie biznesowe Inicjalizuje resetowanie hasła Przyjmowane parametry String

Zwracany typ void

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

POST: /api/account/reset-password/init Body:

{

email_uzytkownika@domena.pl - jako czysty tekst, nie jako obiekt }

Ścieżka /api/account/reset-password/finish

Typ metody POST

Nazwa metody public ResponseEntity finishPasswordReset(@RequestBody KeyAndPasswordVM keyAndPassword)

Przeznaczenie biznesowe Finalizuje resetowanie hasła Przyjmowane parametry KeyAndPasswordVM

Zwracany typ ResponseEntity

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

POST: /api/account/reset-password/finish Body:

{

"key":"beb14517bb91446da5e4e4ad0e39e6",

"newPassword":"qwert6"

}

Opis obiektów (atrybuty):

PasswordChangeDTO - dane dotyczące zmiany hasła

● Atrybuty:

o String currentPassword – obecne hasło o String newPassword – nowe hasło UserDTO - obiekt przechowujący dane użytkownika

● Atrybuty:

o Long id - id

o String login - login o String firstName - imię

(10)

str.

9 o String lastName - nazwisko

o String pesel - pesel

o String email – adres email

o String imageUrl – adres URL zdjęcia

o boolean activated = false – czy użytkownik jest aktywny o String langKey – klucz języka

o String createdBy – stworzony przez o Instant createdDate – data stworzenia

o String lastModifiedBy – użytkownik wykonujacy ostatnią modyfikację o Instant lastModifiedDate – data ostatniej modyfikacji

o Set<String> authorities – lista uprawnień

o Boolean rpaInactive – flaga określająca czy użytkownik został zablokowany w systemie RPA

KeyAndPasswordVM - dane nowego hasła

● Atrybuty:

o String key - klucz

o String newPassword – nowe hasło

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

● Atrybuty:

o ze statusem odpowiedzi

Adres - metody związane z adresami użytkowników

Ścieżka /api/addresses

Typ metody POST

Nazwa metody public ResponseEntity<Address>

createAddress(@RequestBody Address address) Przeznaczenie biznesowe Tworzy adres

Zwracany typ ResponseEntity<Address>

Wyrzucane błędy BadRequestAlertException - błędne parametry zapytania EntityNotFoundException - nie znaleziono encji

NoAccessException - brak dostępu Przykład użycia:

POST: /api/addresses Body :

{

"type" : { "id" : 2 },

"street" : "ulica",

"bldgNumber" : "numer budynku",

"apartmentNumber" : "numer mieszkania", "postCode" : "kod pocztowy w formacie XX-XXX", "city" : "miasto",

"councilName" : "nazwa kancelarii, opcjonalnie w zależności od typu adresu" , "user" : {

"id" : 8

(11)

str.

10 }

}

Ścieżka /api/addresses

Typ metody PUT

Nazwa metody public ResponseEntity<Address>

updateAddress(@RequestBody Address address) Przeznaczenie biznesowe Aktualizuje adres

Przyjmowane parametry Address - obiekt akdresu Zwracany typ ResponseEntity<Address>

Wyrzucane błędy NoAccessException

BadRequestAlertException Przykład użycia:

PUT: /api/addresses Body :

{

"id" : 25327, "type" : { "id" : 2 },

"street" : "nazwa ulicy",

"bldgNumber" : "numer budynku",

"apartmentNumber" : "numer mieszkania", "postCode" : "02-101",

"city" : "Miasto",

"councilName" : "Nazwa kancelarii" , "user" : {

"id" : 8 }

}

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

Typ metody GET

Nazwa metody public ResponseEntity<Address> getAddress(@PathVariable Long id)

Przeznaczenie biznesowe Pobiera adres o określonym identyfikatorze Przyjmowane parametry Long id - identyfikator adresu z bazy danych Zwracany typ ResponseEntity<Address>

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

GET: /api/addresses/1

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

Typ metody DELETE

Nazwa metody public ResponseEntity<Void> deleteAddress(@PathVariable Long id)

(12)

str.

11 Przeznaczenie biznesowe Usuwa adres po określonym identyfikatorze

Przyjmowane parametry Long id - identyfikator adresu z bazy danych Zwracany typ ResponseEntity

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

DELETE: /api/addresses/1

Address - obiekt przechowujący adres użytkownika

● Atrybuty:

o Long id – id obiektu o Dictionary type - id typu o String street - ulica

o String bldgNumber – numer domu

o String apartmentNumber – numer mieszkania o String postCode – kod pocztowy

o String city - miejscowość

o String councilName – nazwa kancelarii o PortalUser user – użytkownik

ResponseEntity<Address> - zwracanie kodu odpowiedzi z obiektem adresu

● Atrybuty:

o ze statusem odpowiedzi Wnioski – metody związane z wnioskami

Ścieżka /api/applications

Typ metody POST

Nazwa metody public ResponseEntity<ApplicationDTO>

submitApplication(@RequestBody ApplicationDTO application)

Przeznaczenie biznesowe Wysyła wniosek Przyjmowane parametry ApplicationDTO

Zwracany typ ResponseEntity<ApplicationDTO>

Wyrzucane błędy URISyntaxException

NoPrivilegeException - brak uprawnień

EntityNotFoundException - nie znaleziono obiektu Przykład użycia:

POST: /api/applications Body:

{

applicationId:null, comments:"asd",

complaintConsiderationDate:null, complaintDate:null,

(13)

str.

12 considerationDate:null,

courtId:1,

courtName:"Sąd Apelacyjny we Wrocławiu", courtSessionDate:null,

courtSessionId:null, department:"II",

departmentFullName:"Wydział II Karny", lawsuitId:1616035,

lawsuitNumber:"1", pzUrl:null,

registerDate:null, repertory:"AKa", repertoryId:1145, roleInLawsuit:"test", signature:"II AKa 1/14", type:"LAWSUIT", year:2014

}

Ścieżka /api/applications/dto/{sessionId}

Typ metody GET

getApplicationDTOForSession(@PathVariable Long sessionId) Przeznaczenie biznesowe Inicjalizuje wstępne dane do wniosku na podstawie

wybranego posiedzenia Przyjmowane parametry Long sessionId -

Wyrzucane błędy EntityNotFoundException - nie znaleziono obiektu NoAccessException - brak dostępu

Przykład użycia:

POST: /api/applications/dto/1564256

Ścieżka /api/applications/check

Typ metody POST

checkApplication(@RequestBody ApplicationDTO application)

Przeznaczenie biznesowe Sprawdza wniosek pod kątem poprawności danych oraz przygotowuje do złożenia

Przyjmowane parametry ApplicationDTO

Wymagane parametry:

courtId - id sądu

courtName - nazwa sądu department - wydział repertory - repertorium

repertoryId - identyfikator repertorium

(14)

str.

13 courtSessionDate -wnioskowana data posiedzenia (nie

dotyczy wniosku o dostęp do sprawy) year - rok

roleInLawsuit - rola w sprawie lawsuitNumber - numer sprawy

departmentFullName - nazwa wydziału type - typ wniosku (

LAWSUIT - o dostęp do sprawy

NONRESIDENT - o rozprawę odmiejscowioną AUTOTRANSCRIPTION - o autotransktypcję STREAM - o strumieniowanie posiedzenia DOSSIER - o dostęp do akt i nagrań w czytelni EPROTOCOL - o udostępnienie eprotokołu

Wyrzucane błędy NoPrivilegeException - brak uprawnień Przykład użycia:

POST: /api/applications/check

Body:

{

"comments":"test uwag",

"roleInLawsuit":"rola",

"courtId":6,

"courtName":"Sąd Okręgowy w Legnicy",

"lawsuitNumber":112,

"department":"I",

"departmentFullName":"Wydział I Cywilny",

"repertory":"C",

"repertoryId":1216,

"year":2011,

"courtSessionDate":

"2018-09-19T22:00:00.000Z",

"type":"DOSSIER"

}

Ścieżka /api/applications

Typ metody GET

Nazwa metody public ResponseEntity<List<ApplicationView>>

getAllApplications(ApplicationViewCriteria criteria, Pageable pageable)

Przeznaczenie biznesowe Pobiera listę wniosków na podstawie wskazanych kryteriów Przyjmowane parametry ApplicationViewCriteria, Pageable

Zwracany typ ResponseEntity<List<ApplicationView>>

(15)

str.

14 Przykład użycia:

GET: /api/applications?page=0&size=20&sort=registerDate,desc&sort=id Ścieżka /api/applications/{id}

Typ metody GET

Nazwa metody public ResponseEntity<ApplicationDetailsDTO>

getApplication(@PathVariable Long id)

Przeznaczenie biznesowe Pobiera dane wniosku o danym identyfikatorze Przyjmowane parametry Long id - identyfikator wniosku

Zwracany typ ResponseEntity<ApplicationDetailsDTO>

Wyrzucane błędy NoPrivilegeException - brak uprawnień Przykład użycia:

GET: /api/applications/12

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

Typ metody DELETE

Nazwa metody public ResponseEntity<Void>

deleteApplication(@PathVariable Long id) Przeznaczenie biznesowe Usuwa wybrany wniosek

Przyjmowane parametry Long id - identyfikator wniosku Zwracany typ ResponseEntity

Wyrzucane błędy NoPrivilegeException - brak uprawnień NoAccessException - brak dostępu Przykład użycia:

DELETE: /api/applications/12

Ścieżka /api/applications/resign/{id}

Typ metody GET

Nazwa metody public ResponseEntity<Void>

resignApplication(@PathVariable Long id)

Przeznaczenie biznesowe Rezygnacja z terminu (dotyczy wniosku o dostęp do nagrań i akt w czytelni)

Przyjmowane parametry Long - identyfikator wniosku Zwracany typ ResponseEntity

Wyrzucane błędy NoPrivilegeException EntityNotFoundException NoAccessException Przykład użycia:

GET: /api/applications/12

Ścieżka /applications/pz-url/{id}

Typ metody GET

Nazwa metody public ResponseEntity<SingPZUrlDTO>

getApplicationPZUrl(@PathVariable Long id)

Przeznaczenie biznesowe Pobranie linku do podpisu wniosku Profilem Zaufanym Przyjmowane parametry Long - identyfikator wniosku

(16)

str.

15 Zwracany typ ResponseEntity<SingPZUrlDTO>

GET: /api/applications/pz-url/12

Ścieżka /applications/print/{id}

Typ metody GET

Nazwa metody public ResponseEntity<ApplicationDetailsDTO>

printApplication(@PathVariable Long id)

Przeznaczenie biznesowe Pobranie szczegółów wniosku na potrzeby funkcjonalności wydruku

Przyjmowane parametry Long - identyfikator wniosku

Zwracany typ ResponseEntity< ApplicationDetailsDTO >

GET: /api/applications/print/12

ApplicationDTO – obiekt przechowujący dane wniosków

● Atrybuty:

o String comments - komentarze o String roleInLawsuit – rola w sprawie o Long courtId – id sądu

o Long lawsuitId – id sprawy

o String lawsuitNumber – numer sprawy o String department - wydział

o String repertory - repertorium o ApplicationType type - typ

o Long repertoryId – id repertorium

o Long courtSessionId – id posiedzenia sądu o Instant courtSessionDate – data posiedzenia o String signature - sygnatura

o Long year - rok

o private Long applicationId - id wniosku o private String pzUrl - adres do PZ

o private String autotranscriptionType - typ autotranskrypcji o private String participantName - imie uczestnika;

o private String participantSurname - nazwisko uczestnika;

o private String participantEmail - email uczestnika;

o private Instant sessionStart - data od;

o private Instant sessionEnd - data do;

o private String courtRoom - sala;

o private String applicationNumber - numer wniosku;

(17)

str.

16 o private String errorMessage - treść błędu

o private String nonresidentCourt - identyfikator sądu dla rozprawy odmiejscowionej

o private Instant nonresidentDate - data dla rozprawy odmiejscowionej o private Boolean paperApplication - czy akta papierowe

o private Boolean eprotocolApplication - czy eprotokół ApplicationDetailsDTO – obiekt przechowuje szczegółowe dane wniosku

● Atrybuty:

o Long id – id obiektu o Long status - status

o Instant registerDate – data rejestracji o String roleInLawsuit – rola w sprawie o ApplicationType type - typ

o String commentForUser – komentarz dla użytkownika

o String commentForCourtEmployee – komentarz dla pracownika sądu o String firstName - imię

o String secondName – drugie imię o String lastName - nazwisko

o String documentNumber – numer dokumentu o String login - login

o String pesel - pesel

o Instant birthDate – data urodzenia o String birthPlace – miejsce urodzenia o String fathersName – imię ojca o String mothersName – imię matki o String addresses - adres

o Long userStatus – status użytkownika

o boolean signRequired - wymaganie rejestracji

o boolean documentSigned - czy jest podpisany profilem zaufanym o String applicationNumber – numer wniosku

o LawsuitDetailsDto lawsuitDetails – szczegóły sprawy o private String applicationState - status wniosku CRCS o private Boolean reservation - czy rezerwacja

o private String reservationInformatiom - informacje o rezerwacji o private String token - token do czytelni

o private String availableTerm - dostępne terminy czytelni (oddzielone przecinkiem)

o private Boolean decision - decyzja (tak/nie)

o private String remoteHearingSubstantiation - uzsadnienie (odmiejscowiona) o private String remoteHearingInformation - informacje o rozprawie

odmiejscowionej

o private String streamingSubstantiation - uzasadnienie (streaming) o private String streamingInformation - informacje o streamingu;

o private String streamingLink - link do streamingu

o private Integer transcriptionWaitTime - czas oczekiwania na transkrypcję o private String transcriptionInformation - informacja o transkrypcji

(18)

str.

17 o private String transcriptionQuality - jakośc transkrypcji

o private String rejectMessage - powód odrzucenia o private String comment - komentarz

ResponseEntity<ApplicationDTO> - zwracanie kodu odpowiedzi z obiektem ApplicationDTO ResponseEntity<List<ApplicationView>> - zwracanie kodu odpowiedzi z listą obiektów ApplicationView

ResponseEntity<ApplicationDetailsDTO> - zwracanie kodu odpowiedzi z obiektem ApplicationDetailsDTO

● Atrybuty:

o ze statusem odpowiedzi ApplicationView – dane wniosku

● Long id – id obiektu

● String comments – komentarze

● String roleInLawsuit – rola w sprawie

● String commentary – uwagi

● Long status – status

● Instant registerDate – data rejestracji

● Instant considerationDate – data rozstrzygnięcia

● String commentaryForEmployee – komentarz dla pracownika

● String represented – reprezentowany

● Instant complaintDate – data reklamacji

● Instant complaintConsiderationDate – data rozpatrzenia reklamacji

● String court – sad

● Long courtId – id sadu

● String department - wydział

● Long departmentId – numer wydziału

● String signature – sygnatura

● Long lawsuitId – id sprawy

● Long userId – id użytkownika

● String applicant – wnioskodawca

● String unitNumber – kod jednostki

● String name – nazwa

● String referent – referent

● Long signId – podpis id

● String statusString – status_t

● ApplicationType type – typ

ApplicationViewCriteria - kryteria wyszukiwania wniosków

● LongFilter id – id obiektu

● StringFilter comments - komentarze

● StringFilter roleInLawsuit – rola w sprawie

● StringFilter commentary - uwagi

● LongFilter status - status

● InstantFilter registerDate – data rejestracji

● InstantFilter considerationDate – data rozstrzygnięcia

(19)

str.

18

● StringFilter commentaryForEmployee – komentarz dla pracownika

● StringFilter represented - reprezentowany

● InstantFilter complaintDate – data reklamacji

● InstantFilter complaintConsiderationDate – data rozpatrzenia reklamacji

● StringFilter court - sąd

● LongFilter courtId – id sądu

● StringFilter department - departament

● LongFilter departmentId – id departamentu

● StringFilter signature - sygnatura

● StringFilter applicant - wnioskodawca

● StringFilter referent - referent

● ApplicationTypeFilter type - typ

● LongFilter lawsuitId – id sprawy

● LongFilter userId – id użytkownika

SingPZUrlDTO – obiekt informacji zwrotnej z linkiem do podpisu wniosku Profilem Zaufanym

● Atrybuty:

o String url – link przekierowania do Profilu Zaufanego do podpisu danego wniosku

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 ApplicationType type – słownik typów wniosków

 AUTOTRANSCRIPTION - wniosek o ARM

 EPROTOCOL - wniosek o nagranie wideo eProtokołu

 LAWSUIT - wniosek o dostęp do sprawy

 NONRESIDENT - wniosek o rozprawę odmiejscowioną Long status – słownik statusów wniosków

 5 – odrzucony

 7 – zaakceptowany

 10 – zarejestrowany

 13 – usunięty

 14 - reklamowany

 15 - reklamowany – zaakceptowany

 16 - reklamowany – odrzucony

Informacje – metody związane z pobieraniem podstawowych informacji o portalu informacyjnym

Ścieżka /api/statute/{courtId:.+}/{fileName:.+}

Typ metody GET

(20)

str.

19 Nazwa metody public ResponseEntity<InputStreamResource>

download(@PathVariable("courtId") String courtId,

@PathVariable("fileName") String fileName) Przeznaczenie biznesowe Pobiera regulamin danego sądu

Przyjmowane parametry String, String

Zwracany typ ResponseEntity<InputStreamResource>

Wyrzucane błędy IOException

Ścieżka /api/faq

Typ metody GET

Nazwa metody public String getFAQ() Przeznaczenie biznesowe Pobiera FAQ

Przyjmowane parametry

Ścieżka /api/help

Typ metody GET

Nazwa metody public String getHelp() Przeznaczenie biznesowe Pobiera treść pomocy Przyjmowane parametry

Ścieżka /api/maininfo

Typ metody GET

Nazwa metody public String getMainInfo()

Przeznaczenie biznesowe Pobiera informację dla użytkowników dostępną na ekranie logowania

Ścieżka /api/infoforupdates

Typ metody GET

Nazwa metody public String getInfoForUpdates() Przeznaczenie biznesowe Pobiera informacje o aktulizacjach Przyjmowane parametry

(21)

str.

20 Zwracany typ String

Wyrzucane błędy

Ścieżka /api/cookienotice

Typ metody GET

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

Ścieżka /api/courtlistbuletin

Typ metody GET

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

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

Ś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

(22)

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

(23)

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>>

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>

GET: /api/court-departments/12

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

Typ metody GET

(24)

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>>

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

● Atrybuty:

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

(25)

str.

24 Zwracany typ ResponseEntity<List<Court>>

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

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

Zwracany typ ResponseEntity Wyrzucane błędy

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

GET: /api/courts/nonresident

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

● Atrybuty:

(26)

str.

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

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

● 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

(27)

str.

26 Przyjmowane parametry Long - identyfikator posiedzenia

Zwracany typ ResponseEntity<CourtSession>

Wyrzucane błędy EntityNotFoundException - nie znaleziono posiedzenia NoAccessException - brak dostępu

GET : /api/court-sessions/12 Opis obiektów (atrybuty):

CourtSessionCriteria – kryteria wyszukiwania posiedzeń

● Atrybuty:

o LongFilter id – id obiektu

o InstantFilter dateFrom – data od o InstantFilter dateTo – data do o StringFilter result - wynik

o StringFilter procedure - procedura o StringFilter room - sala

o StringFilter protocolId – id protokołu o StringFilter externalId – zewnętrzne id o StringFilter protocolFile – plik e-protokołu o StringFilter roomMPKCode – kod MPK sali

o StringFilter departmentMPKCode – kod MPK wydziału o LongFilter lawsuitId – id sprawy

o LongFilter judgeId – id sędziego CourtSession – model posiedzenia

● Atrybuty:

o Long id – id

o Instant dateFrom – data od o Instatnt dateTo – data do o String result – wynik

o String procedure – procedura o String room – sala

o String protocolId – id protokołu o String externalId – zewnętrzne id o String protocolFile – plik e-protokołu o String roomMPKCode – kod MPK Sali

o String departmentMPKCode – kod MPK wydziału o String videoFile – plik video

o Instant videoArchivizationDate – data archiwizacji video o Lawsuit lawsui – id sprawy

o Judge judge – id sedziego Pageable – obiekt opisujący stronicowanie

● Atrybuty:

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

(28)

str.

27 LawsuitSessionDTO – posiedzenie

 Long id – id

 String signature – sygnatura

 String court – sad

 Instatnt date – data

 String room – pokój

 String procedure – procedura

 String judge – sędzia

 String subject – temat

 String value – wartość

 String eprotocol – e-prokotół

 String eprotocolId – id e-protokołu

 String eprotocolVideoPath – ścieżka do e-protokołu

 String result – wynik

 Instatnt videoArchivizationDate – data zapisania video

 Boolean transcriptionFilesPresent – transkrypcja pliku

ResponseEntity<CourtSession> - zwracanie kodu odpowiedzi z obiektem CourtSession Posiedzenia (widok) – metody związane z obsługą posiedzeń sądu

Ścieżka /api/court-session-views

Typ metody GET

Nazwa metody public ResponseEntity<List<? extends CourtSessionView>>

getAllCourtSessionViews(CourtSessionViewCriteria criteria, Pageable pageable)

Przeznaczenie biznesowe Pobiera posiedzenia sądu dla wskazanych kryteriów Przyjmowane parametry CourtSessionViewCriteria, Pageable

Zwracany typ ResponseEntity<List<? extends CourtSessionView>>

GET: /api/court-session-

views/lawsuit?page=0&size=20&lawsuitId.equals=1&signature.contains=I%20C%20112/17&

courtId.equals=1&procedure.equals=publikacja&dateFrom.greaterOrEqualThan=2018-09- 06T18:16:46.407Z&sort=id,asc

Ścieżka /api/court-session-views/{id}

Typ metody GET

Nazwa metody public ResponseEntity<CourtSessionView>

getCourtSessionView(@PathVariable Long id) Przeznaczenie biznesowe Pobiera posiedzenie o wskazanym identyfikatorze Przyjmowane parametry Long id - identyfikator posiedzenia

Zwracany typ ResponseEntity<CourtSessionView>

Wyrzucane błędy EntityNotFoundException - nie znaleziono posiedzenia NoAccessException - brak dostępu

GET: /api/court-session-views/12

(29)

str.

28 Opis obiektów (atrybuty):

CourtSessionViewCriteria – kryteria wyszukiwania posiedzeń

● Atrybuty:

o LongFilter id – id obiektu o LongFilter caseId – id sprawy o StringFilter signature - sygnatura o StringFilter procedure - procedura o StringFilter room - sala

o StringFilter subject – przedmiot sprawy o StringFilter value - wartość

o StringFilter result - wynik

o InstantFilter dateFrom – data od o InstantFilter dateTo – data dp o LongFilter courtId – id sądu

o StringFilter courtName – nazwa sądu o StringFilter judge - sędzia

o StringFilter party – podmiot postępowania

o LongFilter partyUserId – id użytkownika w podmiocie postępowania Pageable – obiekt opisujący stronicowanie

● Atrybuty:

ResponseEntity<List<? extends CourtSessionView>> - zwracanie kodu odpowiedzi z listą obiektów CourtSessionView

ResponseEntity<CourtSessionView> - zwracanie kodu odpowiedzi z obiektem CourtSessionView

CourtSessionView – dane posiedzenia

 Atrybuty:

o Long id – id

o Long caseId – id sprawy o String signature – sygnatura

o String procedure – tryb postępowania o String room – sala posiedzenia

o String subject – przediot sprawy o String value – wartość

o String caseResult – rozstrzygnięcie o String result – wynik

o Instant dateFrom – data od o Instant dateTo – data do o Long courtId – id sadu o String courtName – sad o String judge – sedzia

o String party – nazwa podmiotu o String protocolId – id protokołu

(30)

str.

29 o Long partyUserId – id uzytkownika, podmiotu

o Long department – id wydziału

Dashboard – metody związane z obsługą dashboardu Ścieżka /api/dashboard/lawsuits

Typ metody GET

Nazwa metody public List<DashboardLawsuitDTO> getLastLawsuits() Przeznaczenie biznesowe Pobiera ostatnie sprawy zalogowanego użytkownika Zwracany typ List<DashboardLawsuitDTO>

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

GET: /api/dashboard/lawsuits

Ścieżka /api/dashboard/sessions

Typ metody GET

Nazwa metody public List<DashboardCourtSessionDTO>

getUpcomingSessions()

Przeznaczenie biznesowe Pobiera najbliższe posiedzenia zalogowanego użytkownika Zwracany typ List<DashboardCourtSessionDTO>

GET: /api/dashboard/sessions

Ścieżka /api/dashboard/proceedings

Typ metody GET

Nazwa metody public List<DashboardProceedingDTO> getLastProceedings() Przeznaczenie biznesowe Pobiera ostatnie czynności zalogowanego użytkownika Zwracany typ List<DashboardProceedingDTO>

GET: /api/dashboard/proceedings

List<DashboardLawsuitDTO> - lista obiektów DashboardLawsuitDTO

List<DashboardCourtSessionDTO> - lista obiektów DashboardCourtSessionDTO List<DashboardProceedingDTO> - lista obiektów DashboardProceedingDTO

Wydziały – metoda związana z pobieraniem wydziałów do których użytkownik ma dostęp

Ścieżka /api/department-employees/user/{userId}

Typ metody GET

(31)

str.

30 Nazwa metody public List<DepartmentEmployee>

getDepartmentEmployeeByUserId(@PathVariable Long userId)

Przeznaczenie biznesowe Pobiera wydziały do których podany użytkownik ma dostęp Przyjmowane parametry Long userId - identyfikato użytkownika

Zwracany typ List<DepartmentEmployee>

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

GET: /api/department-employees/user/12

List<DepartmentEmployee> - lista obiektów DepartmentEmployee DepartmentEmployee – model pracownika w wydziale

 Atrybuty:

o Long id – id

o CourtDepartment – id wydziału o PortalUser – id użytkownika

Słowniki – metody związane z obsługą słowników

Ścieżka /api/dictionaries

Typ metody GET

Nazwa metody public ResponseEntity<List<Dictionary>>

getAllDictionaries(DictionaryCriteria criteria, Pageable pageable)

Przeznaczenie biznesowe Pobiera wszystkie słowniki Przyjmowane parametry DictionaryCriteria, Pageable Zwracany typ ResponseEntity<List<Dictionary>>

GET:/api/dictionaries?key.equals=klucz&language.equals=pl&description.contains=o pis

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

Typ metody GET

Nazwa metody public ResponseEntity<Dictionary>

getDictionary(@PathVariable Long id)

Przeznaczenie biznesowe Pobiera słownik o wskazanym identyfikatorze Przyjmowane parametry Long id - identyfikator słownika

Zwracany typ ResponseEntity<Dictionary>

GET: /api/dictionaries/12

(32)

str.

31 Opis obiektów (atrybuty):

ResponseEntity<List<Dictionary>> - zwracanie kodu odpowiedzi z listą obiektów Dictionary DictionaryCriteria – kryteria wyszukiwania typu adresu

● Atrybuty:

o LongFilter id – id obiektu o StringFilter type – typ o StringFilter key - klucz o StringFilter language - język o StringFilter description - opis Pageable – obiekt opisujący stronicowanie

● Atrybuty:

ResponseEntity<Dictionary> - zwracanie kodu odpowiedzi z obiektem Dictionary Dictionary – model słownika

 Atrybuty:

o Long id – id o String type – typ o String key – klucz o String language – język o String description - opis

Dokumenty – metody związane z obsługą dokumentów Ścieżka /api/documents?lawsuitId.equals=

Typ metody GET

Nazwa metody public ResponseEntity<List<DocumentInnerViewDto>>

findLawsuitDocuments(DocumentLawsuitViewCriteria criteria, Pageable pageable)

Przeznaczenie biznesowe Zwraca listę dokumentów zgodnych z podanymi kryteriami wyszukiwania

Przyjmowane parametry DocumentLawsuitViewCriteria criteria, Pageable pageable Zwracany typ ResponseEntity<List<DocumentInnerViewDto>>

Wyrzucane błędy NoAccessException

Wymagania Dostęp do sprawy w której znajdują się dokumenty Przykład użycia:

GET: /api/documents?lawsuitId.equals=5431301

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

Typ metody GET

Nazwa metody public ResponseEntity<DocumentDTO>

getDocument(@PathVariable Long id) Przeznaczenie biznesowe Zwraca informacja o dokumencie Przyjmowane parametry Long id – id dokumentu

Zwracany typ ResponseEntity<DocumentDTO>

(33)

str.

32 Wyrzucane błędy NoAccessException, EntityNotFoundException

Wymagania Dostęp do sprawy w której znajdują się dokumenty

Ścieżka /api/documents/download/{documentId}

Typ metody GET

Nazwa metody public ResponseEntity<InputStreamResource>

download(@PathVariable("documentId") Long documentId) Przeznaczenie biznesowe Pobiera plik dokumentu o wskazanym identyfikatorze w

formacie źródłowym

Przyjmowane parametry Long documentId - identyfikator dokumentu Zwracany typ ResponseEntity<InputStreamResource>

Wyrzucane błędy IOException, NoAccessException, FileNotFoundException, UnknownHostException, FileCantBeDownloaded

Wymagania Dostęp do dokumentu

GET: /api/documents/download/144

Ścieżka /api/documents/download/{documentId}/pdf

Typ metody GET

downloadPdfDirectly(@PathVariable("documentId") Long documentId, @RequestHeader(value = "Mobile", required = false) String isMobile)

Przeznaczenie biznesowe Pobiera plik dokumentu o wskazanym identyfikatorze jako PDF (konwersja z pliku źródłowego na pdf). Wykorzystywana w aplikacji mobilnej.

Przyjmowane parametry Long documentId - identyfikator dokumentu Zwracany typ ResponseEntity<InputStreamResource>

Wyrzucane błędy IOException, NoAccessException, FileNotFoundException, UnknownHostException

Wymagania Dostęp do dokumentu

GET: /api/documents/download/144/pdf

Ścieżka /api/documents/download/request/{documentId}/pdf

Typ metody GET

Nazwa metody public ResponseEntity< DocumentRequestDTO>

downloadPdf(@PathVariable("documentId") Long documentId)

Przeznaczenie biznesowe Pobiera plik PDF dokumentu o wskazanym identyfikatorze (konwersja z pliku źródłowego na pdf). Zwraca m.in.

(34)

str.

33 identyfikator dokumentu, token i nazwę pliku, które służą do wywołania

/api/documents/download/{documentId}/pdf/{token}/{filena me} Ten endpoint pozwalajacy otworzyć document pdf w nowej karcie przeglądarki.

Przyjmowane parametry Long documentId - identyfikator dokumentu Zwracany typ ResponseEntity< DocumentRequestDTO>

Wyrzucane błędy NoAccessException,

FileFormatNotConvertibleToPDFException, FileCantBeDownloaded

Wymagania Dostęp do dokumentu, możliwy do konwersji na PDF Przykład użycia:

GET: /api/documents/download/request/144/pdf

Ścieżka /api/documents/downloads-

info/{docId}?isFirstDownloads.equals=

Typ metody GET

Nazwa metody public

ResponseEntity<List<DocumentDeliveryDetailsViewWitho utLoginDTO>>

getDocumentDownloadsInfo(@PathVariable("docId") Long Ścieżka /api/documents/download/{documentId}/pdf/{token}/{filena

me}

Typ metody GET

downloadPdf(HttpServletRequest request,

@PathVariable("documentId") Long documentId,

@PathVariable("token") String token,

@PathVariable("filename") String filename,

@RequestHeader(value = "Mobile", required = false) String isMobile)

Przeznaczenie biznesowe Pobiera plik dokumentu jako PDF (konwersja z pliku źródłowego na pdf). Służy do otwarcia PDF w nowej karcie przegladarki

Przyjmowane parametry Long documentId - identyfikator dokumentu, String token – jednorazowy token, String filename – nazwa dokumentu, String isMobile – informacja czy request wysłany z telefonu Zwracany typ ResponseEntity<InputStreamResource>

Wyrzucane błędy IOException, NoAccessException, FileNotFoundException, UnknownHostException

Wymagania Dostęp do dokumentu, ważny token

(35)

str.

34 id, DocumentDeliveryDetailsCriteria criteria, Pageable

pageable)

Przeznaczenie biznesowe Zwraca informacje o doręczenie dokumentu.

UWAGA

Funkcjonuje do dnia zwracanego po wywołaniu /deliveries/start-date, czyli od uruchomienia nowego model realizacji doręczeń.

Od tego dnia, wywołanie metody zwróci zamiast danych komunikat AFTER_DELIVERANCE_START.

Od tego dnia data doręczenia będzie ustalana na podstawie pola deliveryDate z metody /api/deliveries/.

Data doręczenia będzie ustalana na podstawie daty odbioru doręczenia (odpowiednik koperty tradycyjnej), z którym skojarzone sąd dokumenty – załączniki doręczenia (odpowiedniki pism znajdujących się w kopercie). Doręczenie będzie skierowane tylko do jednego adresata identyfikowanego numerem PESEL lub kodem jednostki instytucji. Doręczenie wskaże adresatowi, które z dokumentów powinien przeczytać, gdyż podlegają doręczeniu. Pozostałe dokumenty są wyłącznie publikowane informacyjne.

Przyjmowane parametry @PathVariable("docId") Long id - identyfikator dokumentu, DocumentDeliveryDetailsCriteria criteria, Pageable pageable Zwracany typ ResponseEntity<List< DocumentDeliveryDetailsView >>

Wyrzucane błędy NoAccessException, EntityNotFoundException Wymagania Dostęp do sprawy w której znajdują się dokumenty Przykład użycia:

GET: /api/documents/downloads-info/133?isFirstDownloads.equals=true Ścieżka /api/documents/delivery-info

Typ metody GET

Nazwa metody public ResponseEntity<List< DocumentViewDto>>

getAllUserDocuments (DocumentViewCriteria criteria, Pageable pageable)

Przeznaczenie biznesowe Zwraca informacje o odczytaniu dokumentu Przyjmowane parametry DocumentViewCriteria criteria, Pageable pageable Zwracany typ ResponseEntity<List< DocumentViewDto >>

Wyrzucane błędy NoAccessException, EntityNotFoundException Wymagania Dostęp do sprawy w której znajdują się dokumenty Przykład użycia:

GET: api/documents/delivery-info?page=0&size=20&sort=publicationDate,desc Opis obiektów (atrybuty):

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

(36)

str.

35 DocumentInnerViewDto

● Atrybuty:

o Long id – id dokumentu

o Instant createDate – data utworzenia o Instant publicationDate – data publikacji o String documentName – ścieżka do dokumentu o String fileName – nazwa dokumentu

o Long documentType – typ dokumentu o Boolean downloaded – czy został pobrany

o documentChecksum – suma kontrolna dokumentu documentFormat – słownik formatów dokumentów

Najczęściej spotykane formaty dokumentów*:

 .rtf (documentFormat = 0),

 .doc (documentFormat = 1),

 .docx (documentFormat = 2),

 .pdf (documentFormat = 3),

Uwaga: pole budowane dynamicznie na podstawie rozszerzenia pliku w atrybucie documentName, więc lista możliwych formatów jest znacznie dłuższa.

documentType – słownik typów dokumentów

• Nieznany (documentType = 0),

• Protokół (documentType = 1),

• Wyrok (documentType = 2),

• Uzasadnienie (documentType = 3),

• Wyrok i uzasadnienie (documentType = 4),

• Wniosek (documentType = 5),

• Korespondencja (documentType = 6),

• Postanowienie (documentType = 7),

• Zarządzenie (documentType = 8),

• Dokument I instancji (documentType = 9)

• Nieznany (documentType = 19

Uwga: Obserwujemy często, że w dokumentach otrzymywanych z sądu treść dokumentu merytorycznie nie pokrywa się z typem dokumentu i rozważamy usunięcie tej informacji z API.

DocumentLawsuitViewCriteria – kryteria wyszukiwania dokumentu

● Atrybuty:

o StringFilter documentName - ścieżka do dokumentu o LongFilter documentType – typ dokumentu

o InstantFilter createDate – data utworzenia o InstantFilter publicationDate – data publikacji o LongFilter lawsuitId – id sprawy

o InstantFilter downloadDate

(37)

str.

36 DocumentViewDto – obiekt odpowiedzi dot. odczytań dokumentów

 Atrybuty:

o Long documentId – id dokumentu

o String documentName – biznesowa nazwa dokumentu o String courtName – nazwa sądu

o String fileName – nazwa pliku o String signature – sygnatura sprawy

o Instant createDate – data utworzenia dokumentu

o Instant publicationDate – data publikacji dokumentu w PI

o Instant downloadDate – data pobrania dokumentu przez zalogowanego użytkownika

o boolean downloaded – czy dokument został odczytany przez zalogowanego użytkownika

DocumentViewCriteria – kryteria wyszukiwania odczytań dokumentów

 Atrybuty

o LongFilter courtId – identyfikator sądu

o LongFilter repertoryId – identyfikator repertorium o LongFilter departmentId – identyfikator wydziału o InstantFilter createDate – data utworzenia dokumentu

o InstantFilter publicationDate – data publikacji dokumentu w PI

o InstantFilter downloadDate – data pobrania dokumentu przez zalogowanego użytkownika

o StringFilter documentName – biznesowa nazwa dokumentu o StringFilter signature – sygnatura sprawy

DocumentDeliveryDetailsCriteria– kryteria wyszukiwania pobrań dokumentu

● Atrybuty:

o LongFilter id - id

o LongFilter documentId – id dokumentu o LongFilter userId – id uzytkownika

o BooleanFilter isFirstDownloads – czy tylko pierwsze pobrania DocumentRequestDTO

● Atrybuty:

o String filename – nazwa dokumentu

o String token – jednorazowy token na pobranie dokumentu o Boolean pdf – informacja, czy plik jest pdf

● DocumentDTO – infromacje o dokumencieAtrybuty:

o Instant createDate – data utworzenia o Instant modifyDate – data modyfikacji o Instant publicationDate – data publikacji o Long documentFormat – format dokumentu