GET:
http://localhost:9000/api/slps/generate-
report/2007/II/AKa/21/8009/03AGdBq248kfuqwHvKk1glIJudRXxD-gwQc-QLKtWkc5WtfA3P36Tlatgj7EaYIwElggKysJToQByBzEo_HhtiwoLOX4aeMdCuX0AwV6rDk4W OzpZGvXsGj9RZmDGpxEfDpkag5LGvZs6hsZEdshCPkwRbZXyzEbhF81_HabudU7ruoJQSo0fC
v4eUPGT090P0bOT6MHj5B5XGDK_HbF-iHWuZwU12tdzGdq-
r5RfGNCFQ_FdvVa4bE2pBnYROVNs_- akmKAySaFdqgwmt8eC5IM3ts7_Wjg4fkmOhR8R5VEBOp0lH6BAF2OWeiyNaP2tX9DrG7BY-
_W80facjL4Q0rZP81I-MHDx1dJepbos1-CpeYE5rxJiAJLldvilfvvIbT86Y-nTOyCr8yARVP4xTxLNJMwixvEhbYQ Body:
{
{ "reports" : [ {
"fileName" : "2021-04-21_50000084_[0]_II_AKa_8009_21.pdf", "base64EncodedFile" : "JVBERi0xLjQ … =="
} ] } }
Przeładowanie słownika sądów (SLPS)
Ścieżka /api/slps/dict/reload
Typ metody GET
Nazwa metody public ResponseEntity<String> reloadSlpsDict() Przeznaczenie biznesowe Przeładowywuje słownik z XML do pamięci Przyjmowane parametry
Zwracany typ String -> “Dictionary reloaded”
Wyrzucane błędy 400 body -> "Problem with reloading dictionary"
NoAccessException Przykład użycia:
GET: /api/slps/dict/reload Body:
{
“Dictionary reloaded”
}
Pobranie klucza do captcha
str.
87Ścieżka /api/captcha/key
Typ metody GET
Nazwa metody String getCaptchaKey() Przeznaczenie biznesowe Pobranie klucza do captcha Przyjmowane parametry
Zwracany typ String
Wyrzucane błędy
Przykład użycia:
GET: /api/slps/dict/reload Body:
{
6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI }
Opis obiektów (atrybuty):
CourtDTO – Informacje o sądzie
● Atrybuty:
o String name – Nazwa sądu - wyświetlana o Long zrskId – ID sądu – do przekazywania w API o
DepartmentDTO – Informacje o departamencie
● Atrybuty:
o String name – Nazwa sądu - wyświetlana
o Long zrskId – ID departamentu – do przekazywania w API
o String numer – numer rzymski dla departamentu – do przekazywania w API ReportSetDTO – Informacje o raportach
● Atrybuty:
o List<ReportDTO> reports - lista raportów ReportDTO – szczegóły raportu
● Atrybuty:
o String filename – nazwa pliku
o String base64EncodedFile – zawartość pliku zakodowana w base64.
Doręczenia – metody związane z doręczeniami
Ścieżka /api/deliveries
Typ metody GET
str.
88 Nazwa metody findDeliveriesBy(DeliveranceCriteria criteria, Pageablepageable)
Przeznaczenie biznesowe Pobranie listy doręczeń z możliwością filtrowania, sortowania oraz paginacji
Przyjmowane parametry DeliveranceCriteria, Pageable
Zwracany typ ResponseEntity<List<DeliveranceViewResponse>>
Wyrzucane błędy EntityNotFoundException NoAccessException Przykładowe użycie:
GET: /api/deliveries?page=0&size=50&sort=publicationDate,desc&sort=id
Ścieżka /deliveries/{id}/{withDelivery}
Typ metody GET
Nazwa metody findByIdAndDeliver(@PathVariable Long id, @PathVariable Boolean withDelivery)
Przeznaczenie biznesowe Pobranie szczegółów doręczenia. W celu odebrania
niedoręczonego doręczenia wymagane jest podanie atrybutu withDelivery=true.
Przyjmowane parametry Long id, Boolean withDelivery
Zwracany typ ResponseEntity<DeliveranceDetailsResponse>
Wyrzucane błędy EntityNotFoundException NoAccessException IllegalArgumentException Przykładowe użycie:
GET: /api/deliveries/750/true
Ścieżka /deliveries/{deliveranceId}/documents
Typ metody GET
Nazwa metody findAllDocumentsInDeliveranceWith(@PathVariable Long deliveranceId, DocumentDeliveranceViewCriteria criteria, Pageable pageable)
Przeznaczenie biznesowe Pobranie dokumentów związanych z doręczeniem o podanym id
Przyjmowane parametry Long deliveranceId,
DocumentDeliveranceViewCriteriacriteria, Pageable pageable
Zwracany typ ResponseEntity<List<DocumentInnerViewDto>>
Wyrzucane błędy EntityNotFoundException NoAccessException IllegalArgumentException Przykładowe użycie:
GET: /api/deliveries/750/documents?page=0&size=50&sort=id,asc
str.
89 Ścieżka /deliveries/{id}/should-deliverTyp metody GET
Nazwa metody isDelivered(@PathVariable Long id)
Przeznaczenie biznesowe Sprawdza, czy użytkownik powinien odebrać doręczenie Przyjmowane parametry Long id
Zwracany typ ResponseEntity<Boolean>
Wyrzucane błędy EntityNotFoundException NoAccessException Przykładowe użycie:
GET: /api/deliveries/750/should-deliver
Ścieżka /deliveries/request/{deliveranceId}/epok
Typ metody GET
Nazwa metody generateEPOKToken(@PathVariable Long deliveranceId,
@NotNull HttpServletRequest request) Przeznaczenie biznesowe Pobranie tokena EPOK dla danego doręczenia Przyjmowane parametry Long id
Zwracany typ ResponseEntity<EPOKRequestDTO>
Wyrzucane błędy EntityNotFoundException NoAccessException Przykładowe użycie:
GET: /api/deliveries/request/750/epok
Ścieżka /deliveries/{deliveranceId}/epok/{token}/{filename}
Typ metody GET
Nazwa metody generateEPOK(@PathVariable("deliveranceId") Long deliveranceId, @PathVariable("token") String token,
@PathVariable("filename") String filename, @NotNull HttpServletRequest request)
Przeznaczenie biznesowe Pobranie pliku EPOK. Służy do otwarcia PDF w nowej karcie przeglądarki.
Przyjmowane parametry Long deliveranceId String token String filename
HttpServletRequest request
Zwracany typ ResponseEntity<InputStreamResource>
Wyrzucane błędy EntityNotFoundException NoAccessException Przykładowe użycie:
GET:
/api/deliveries/1803/epok/UKYnEy9FeiiBisQtqp2EJyJh2pKnSZossebOG2vOH9YZFzZSBQ2YgkR B1SaQ/WR_D_0000001803_20211115_12_01_EPOK.pdf
Ścieżka /deliveries/start-date
str.
90Typ metody GET
Nazwa metody getDeliveranceStartDate()
Przeznaczenie biznesowe Zwraca datę uruchomienia nowego modelu doręczeń.
UWAGA
Od tego dnia, wywołanie metody /api/documents/downloads-info/{docId}?isFirstDownloads.equals=true na podstawie, której ustalana była data odczytania dokumentu (doręczenia dokumentu) 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
Zwracany typ ResponseEntity<Instant>
Wyrzucane błędy EntityNotFoundException NoAccessException Przykładowe użycie:
GET: /api/deliveries/start-date
Ścieżka /deliveries/undelivered/{lawsuitId}
Typ metody GET
Nazwa metody hasUndeliveredDeliveries(@PathVariable Long lawsuitId) Przeznaczenie biznesowe Sprawdzenie, czy w sprawie o podanym id są niedoręczne
pisma
Przyjmowane parametry Long lawsuitId
Zwracany typ ResponseEntity<Boolean>
Wyrzucane błędy EntityNotFoundException NoAccessException Przykładowe użycie:
GET: /api/deliveries/750/documents?page=0&size=50&sort=id,asc
str.
91 Ścieżka /lawsuits/{lawsuitId}/deliveriesTyp metody GET
Nazwa metody getLawsuitDeliveries(LawsuitDeliveranceCriteria criteria, Pageable pageable, @PathVariable Long lawsuitId)
Przeznaczenie biznesowe Pobranie doręczeń zalogowanego użytkownika w sprawie o podanym id
Przyjmowane parametry LawsuitDeliveranceCriteria criteria, Pageable pageable, Long lawsuitId
Zwracany typ ResponseEntity<List<DeliveranceViewResponse>>
Wyrzucane błędy EntityNotFoundException NoAccessException Przykładowe użycie:
GET:/api/lawsuits/9639486/deliveries?page=0&size=50&status.equals=UNDELIVERE D&sort=publicationDate,desc&sort=id
Opis obiektów (atrybuty):
DeliveranceCriteria – kryteria wyszukiwania doręczeń
● Atrybuty:
o LongFilter court – ID sądu
o LongFilter department – ID wydziału o StringFilter signature – Sygnatura
o StringFilter identifier - Identyfikator doręczenia o InstantFilter publicationDate - Data publikacji o InstantFilter deliveryDate - Data doręczenia
o InstantFilter returnDate - Data zwrotu do sądu informacji o niepodjętym doręczeniu (fikcja doręczenia)
o StringFilter recipient - Użytkownik (adresat) PESEL lub kod jednostki
o StringFilter recipientName - Użytkownik (adresat) imię i nazwisko lub nazwa o StringFilter receiverName - Odbiorca imię i nazwisko
o IntegerFilter attachmentsNumber - Liczba załączników o StringFilter status - Status pisma – wartość słownikowa Status pisma – słownik możliwych statusów pisma:
● Błedne (status=”INCORRECT”)
● Niedoręczone (status=”UNDELIVERED”)
● Doręczone (status=”DELIVERED”)
● Zwrot (status=”RETURN”)
Pageable – obiekt opisujący stronicowanie
str.
92● Atrybuty:
o page=0 - aktualna strona
o size=20 - ilość wynikow na strone
o sort=id,asc - sortowane pole, kierunek sortowania DeliveranceViewResponse – obiekt odpowiedzi
● Atrybuty:
o Long id - ID doręczenia
o String identifier - Identyfikator biznesowy doręczenia o String court - Nazwa sądu
o Long courtId - ID sądu
o String department - Nazwa wydziału o Long departmentId - ID wydziału
o Long lawsuitId - Identyfikator bazodanowy sprawy o String signature - Sygnatura sprawy
o String correspondencesNumber;
o Instant publicationDate - Data publikacji o Instant deliveryDate - Data doręczenia o Instant postdate - Data wysłania doręczenia o Instant returnDate - Data zwrotu
o Long recipientId - Identyfikator bazodanowy adresata o String recipient - Adresat Pesel/Kod jednostki
o String recipientName - Nazwa adresata o String receiverName - Odebrany przez o String receiverLogin - Login odbiorcy
o int attachmentsNumber - Liczba załączników o String annotation - Adnotacja
o String status - Status pisma – wartość słownikowa DeliveranceDetailsResponse – obiekt odpowiedzi
● Atrybuty:
o Long id - ID doręczenia
o String identifier - Identyfikator biznesowy doręczenia o String court - Nazwa sądu
o String department - Nazwa wydziału o String signature - Sygnatura sprawy
o Long lawsuitId - Identyfikator bazodanowy sprawy o Instant publicationDate - Data publikacji
o Instant deliveryDate - Data doręczenia o Instant returnDate - Data zwrotu
o String recipient - Adresat Pesel/Kod jednostki o String recipientName - Nazwa adresata o String receiverName - Odebrany przez o int attachmentsNumber - Liczba załączników o String annotation - Adnotacja
o String status - Status pisma – wartość słownikowa
str.
93 o boolean alreadyDelivered - Wartość logiczna, czy doręczenie było jużodebrane
DeliveranceDocumentsResponse – obiekt odpowiedzi
● Atrybuty:
o Long id - ID dokumentu
o Long deliveranceId - Identyfikator bazodanowy doręczenia
o Long recipientId - Identyfikator bazodanowy adresata dokumentu o Instant createDate - Data sporządzenia dokumentu
o Instant publicationDate - Data publikacji dokumentu w PI o Long documentType - Identyfikator typu dokumentu o String documentName - Nazwa pliku z dokumentem o String name - Nazwa biznesowa dokumentu
o Long lawsuitId - Identyfikator bazodanowy sprawy
o Boolean usersDownload - Informacja, czy zalogowany użytkownik pobierał dokument
DocumentInnerViewDto – obiekt odpowiedzi
o Atrybuty: private Long id – id dokumentu o private Instant createDate – data utworzenia o private Instant publicationDate – data publikacji o private String documentName – nazwa dokumentu o private String fileName – nazwa pliku
o private Long documentType – typ dokumentu
o private Boolean downloaded – informacja, czy został pobrany o private String documentChecksum – suma kontrola
DocumentDeliveranceViewCriteria – obiekt odpowiedzi
● Atrybuty:
o StringFilter documentName – nazwa dokumentu o LongFilter documentType – typ dokumentu o InstantFilter createDate – data utworzenia o InstantFilter publicationDate – data publikacji
EPOKRequestDTO – obiekt odpowiedzi
● Atrybuty:
o Long id - id
o String filename – nazwa pliku o String token - token
o Boolean pdf – informacja, czy pdf LawsuitDeliveranceCriteria – obiekt odpowiedzi
● Atrybuty:
o RecipientType recipientType – typ odbiorcy o LongFilter court – ID sądu
str.
94 o LongFilter department – ID wydziałuo StringFilter signature – Sygnatura
o StringFilter identifier - Identyfikator doręczenia o InstantFilter publicationDate - Data publikacji o InstantFilter deliveryDate - Data doręczenia
o InstantFilter returnDate - Data zwrotu do sądu informacji o niepodjętym doręczeniu (fikcja doręczenia)
o StringFilter recipient - Użytkownik (adresat) PESEL lub kod jednostki
o StringFilter recipientName - Użytkownik (adresat) imię i nazwisko lub nazwa o StringFilter receiverName - Odbiorca imię i nazwisko
o IntegerFilter attachmentsNumber - Liczba załączników o StringFilter status - Status pisma – wartość słownikowa RecipientType – słownik możliwych typów odbiorcy:
● Wszyscy (status=”ALL”)
● Użytkownik i rodzic (status=” USER_AND_PARENT”)