str. 31Opis obiektów (atrybuty): - Dokumentacja API Portalu Informacyjnego Sądów Powszechnych

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:

o page=0 - aktualna strona

o size=20 - ilość wynikow na strone

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

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>

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

Przykład użycia:

GET: /api/documents/download/144

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

Typ metody GET

Nazwa metody public ResponseEntity<InputStreamResource>

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

Przykład użycia:

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.

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

Nazwa metody public ResponseEntity<InputStreamResource>

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

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

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 = 10),

• Nieznany (documentType = 14),

• Nieznany (documentType = 15),

• Nieznany (documentType = 16),

• Nieznany (documentType = 18),

• 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

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 Long id – id dokumentu

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 Long id – id dokumentu

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

str.

W dokumencie Dokumentacja API Portalu Informacyjnego Sądów Powszechnych (Stron 32-38)