Wprowadzenie
W systemie SAOS dostępne są serwisy, które nie zostały dotychczas włączone do oficjalnego API, a które są dostępne jako serwisy REST. Z serwisów tych korzysta moduł webowy SAOS. Jeśli któryś z tych serwisów chciałbyś wykorzystać, nie ma ku temu przeszkód. Musisz jednak mieć świadomość, że dopóki nie są one częścią oficjalnego API, mogą się zmieniać, a niektóre zmiany (jak np. url lub struktura json odpowiedzi) mogą spowodować, że twój kod korzystający z tych serwisów przestanie działać. Ryzyko zmian niżej opisanych serwisów jest na razie skrajnie małe, ale być może kiedyś w przyszłości zostaną one włączone do oficjalnego API i wtedy pewne zmiany (np. url) nastąpią.
Lista sądów powszechnych
Adres
https://www.saos.org.pl/cc/courts/list
Opis
Pozwala na pobranie listy sądów powszechnych z podstawowymi danymi (id, nazwa, typ). Przykład zastosowania: lista rozwijana wyboru sądu powszechnego.
Odpowiedź
ścieżka | typ | możliwe wartości | opis |
---|---|---|---|
id | Liczba całkowita | >0 | Identyfikator sądu w systemie SAOS |
name | Tekst | Nazwa sądu | |
type | Słownik |
APPEAL // sąd apelacyjny REGIONAL // sąd okręgowy DISTRICT // sąd rejonowy |
Typ sądu powszechnego |
Lista wydziałów sądu powszechnego
Adres
https://www.saos.org.pl/cc/courts/CC_COURT_ID/courtDivisions/list
CC_COURT_ID - wewnętrzny identyfikator sądu powszechnego w SAOS
Opis
Pozwala na pobranie listy wydziałów sądu powszechnego z podstawowymi danymi (id, nazwa). Przykład zastosowania: lista rozwijana wyboru wydziału dla danego sądu powszechnego.
Odpowiedź
ścieżka | typ | możliwe wartości | opis |
---|---|---|---|
id | Liczba całkowita | >0 | Identyfikator wydziału w systemie SAOS |
name | Tekst | Nazwa wydziału |
Lista izb Sądu Najwyższego
Adres
https://www.saos.org.pl/sc/chambers/list
Opis
Pozwala na pobranie listy izb Sądu Najwyższego z podstawowymi danymi (id, nazwa). Przykład zastosowania: lista rozwijana wyboru izby Sądu Najwyższego.
Odpowiedź
ścieżka | typ | możliwe wartości | opis |
---|---|---|---|
id | Liczba całkowita | >0 | Identyfikator izby w systemie SAOS |
name | Tekst | Nazwa izby |
Lista wydziałów izby Sądu Najwyższego
Adres
https://www.saos.org.pl/sc/chambers/SC_CHAMBER_ID/chamberDivisions/list
SC_CHAMBER_ID - wewnętrzny identyfikator izby Sądu Najwyższego w SAOS
Opis
Pozwala na pobranie listy wydziałów izby Sądu Najwyższego z podstawowymi danymi (id, nazwa). Przykład zastosowania: lista rozwijana wyboru wydziału izby Sądu Najwyższego.
Odpowiedź
ścieżka | typ | możliwe wartości | opis |
---|---|---|---|
id | Liczba całkowita | >0 | Identyfikator wydziału w systemie SAOS |
name | Tekst | Nazwa wydziału |
Lista dostępnych form orzeczeń Sądu Najwyższego
Adres
https://www.saos.org.pl/sc/judgmentForms/list
Opis
Pozwala na pobranie listy możliwych form orzeczeń Sądu Najwyższego (id, nazwa). Przykład zastosowania: lista rozwijana/ lista checkboxów wyboru formy orzeczenia lub pobranie słownika form orzeczeń do własnej bazy.
Odpowiedź
ścieżka | typ | możliwe wartości | opis |
---|---|---|---|
id | Liczba całkowita | >0 | Identyfikator formy orzeczenia w systemie SAOS |
name | Tekst | Nazwa formy orzeczenia |
Wyszukiwanie pozycji dziennika ustaw
Adres
https://www.saos.org.pl/search/lawJournalEntries
Opis
Pozwala na wyszukiwanie pozycji dziennika ustaw spośród tych, które dostępne są w SAOS. W SAOS dostępne są jedynie te pozycje dziennika ustaw, do których odwołuje się jakieś orzeczenie.
Przykład zastosowania: pole autocompletion wybory dziennika ustaw.
Parametry
nazwa | typ | wartość domyślna | wartości dozwolone | opis |
---|---|---|---|---|
pageSize | Liczba całkowita | 20 | >=10 i =<100 | Maksymalna liczba elementów na stronie (pobieranych przez jedno żądanie) |
pageNumber | Liczba całkowita | 0 | >=0 | Numer żądanej strony |
year | Liczba całkowita | pusta [dowolny] | Liczba całkowita [zgodna z typem Integer javy] | Rok dziennika ustaw |
journalNo | Liczba całkowita | pusta [dowolny] | Liczba całkowita [zgodna z typem Integer javy] | Numer dziennika ustaw |
entry | Liczba całkowita | pusta [dowolna] | Liczba całkowita [zgodna z typem Integer javy] | Numer pozycji w dzienniku ustaw |
text | Tekst | pusta [dowolny] | Dowolny tekst | Tytuł pozycji w dzienniku ustaw, będą wyszukane tylko te pozycje, których tytuł zawiera podaną frazę. |
Przykład wywołania
Odpowiedź
ścieżka | typ | możliwe wartości | opis |
---|---|---|---|
id | Liczba całkowita | >0 | Identyfikator pozycji dziennika ustaw w systemie SAOS. |
code | Tekst | Numer dziennika ustaw w formacie: rok/nr pozycji | |
year | Liczba całkowita | >0 | Rok dziennika ustaw. |
journalNo | Liczba całkowita | >=0 | Numer dziennika ustaw. |
entry | Liczba całkowita | >0 | Numer pozycji w dzienniku ustaw. |
title | Tekst | Nazwa formy orzeczenia. |
Wyszukiwanie słów kluczowych orzeczeń sądów powszechnych
Adres
https://www.saos.org.pl/keywords/COMMON/KEYWORD_START
KEYWORD_START- początek słowa kluczowego; będą wyszukane tylko słowa kluczowe rozpoczynające się na podaną frazę
Opis
Pozwala na przeszukiwanie bazy słów kluczowych orzeczeń sądów powszechnych. Przykład zastosowania: pole autocompletion wyboru słowa kluczowego.
Przykład wywołania
https://www.saos.org.pl/keywords/COMMON/prawo
Odpowiedź
ścieżka | typ | możliwe wartości | opis |
---|---|---|---|
id | Liczba całkowita | >0 | Identyfikator słowa kluczowego w systemie SAOS. |
name | Tekst | Słowo kluczowe. |
Generowanie wykresów
Adres
https://www.saos.org.pl/analysis/generate
Opis
Pozwala na wygenerowanie wykresów liczby/procentu orzeczeń (spełniających zadane kryteria) w funkcji czasu oraz w podziale na sądy powszechne.
Przykład wywołania
Parametry
nazwa | typ | wartość domyślna | wartości dozwolone | opis |
---|---|---|---|---|
seriesFilters[seriesIndex].phrase | Tekst | pusta [wszystkie] |
Tekst szukanej frazy zgodny z językiem zapytań seriesIndex - indeks serii wykresu numerowany od 0. Jeśli interesuje cię tylko jedna seria wpisz 0. Jeśli interesują cię dwie serie, dodaj dwa parametry: jeden z seriesIndex = 0 a drugi z seriesIndex = 1 itd. |
Fraza poszukiwana we wszystkich polach orzeczenia (metadane i treść). Tylko orzeczenia, które w jakimkolwiek polu zawierają frazę przypisaną do tego parametru będą brane pod uwagę przy generowaniu danej serii oznaczonej przez seriesIndex |
ysettings.valueType | Słownik | Wartość wymagana |
NUMBER [liczba całkowita orzeczeń] PERCENT [procent] NUMBER_PER_1000 [promil] |
Jednostka osi y. |
globalFilter.judgmentDateRange.startYear | Liczba całkowita | Wartość wymagana | Liczba całkowita > 0 | Rok dolnego ograniczenia daty orzeczenia. Dolne ograniczenie musi być wcześniejsze niż ograniczenie górne (rok-miesiąc). |
globalFilter.judgmentDateRange.startMonth | Liczba całkowita | Wartość wymagana | Liczba całkowita w przedziale <1, 12> | Miesiąc dolnego ograniczenia daty orzeczenia. Dolne ograniczenie musi być wcześniejsze niż ograniczenie górne (rok-miesiąc). |
globalFilter.judgmentDateRange.endYear | Liczba całkowita | Wartość wymagana | Liczba całkowita > 0 | Rok górnego ograniczenia daty orzeczenia. Dolne ograniczenie musi być wcześniejsze niż ograniczenie górne (rok-miesiąc). |
globalFilter.judgmentDateRange.endMonth | Liczba całkowita | Wartość wymagana | Liczba całkowita w przedziale <1, 12> | Miesiąc górnego ograniczenia daty orzeczenia. Dolne ograniczenie musi być wcześniejsze niż ograniczenie górne (rok-miesiąc). |
globalFilter.courtCriteria.courtType | Słownik | pusta [dowolny] |
APPEAL [apelacyjny] REGIONAL [okręgowy] DISTRICT [rejonowy] |
Typ sądu powszechnego. |
globalFilter.courtCriteria.ccCourtId | Liczba całkowita | pusta [dowolny] | Dowolna liczba całkowita [odpowiednik typu long w javie] | Identyfikator wewnętrzny sądu powszechnego w SAOS. |
globalFilter.courtCriteria.ccDivisionId | Liczba całkowita | pusta [dowolny] | Dowolna liczba całkowita [odpowiednik typu long w javie] | Identyfikator wewnętrzny wydziału sądu powszechnego w SAOS [unikalny w ramach wszystkich wydziałów wszystkich sądów] |
globalFilter.courtCriteria. ccIncludeDependentCourtJudgments |
Boolean | false | true/ false |
Czy uwzględnić orzeczenia sądów podrzędnych dla określonego sądu powszechnego? Flaga ma sens w przypadku określenia sądu powszechnego przez ccDivisionId. Przykład: ccCourtId = identyfikator sądu Apelacyjnego w Białymstoku. Jeśli ccIncludeDependentCourtJudgments ustawiona na false, wtedy będą brane pod uwagę jedynie orzeczenia wydane przez Sąd Apelacyjny w Białymstoku. W przypadku wartości true pod uwagę będą brane również orzeczenia z wszystkich sądów okręgowych i rejonowych z apelacji białostockiej. |
globalFilter.courtCriteria.scChamberId | Liczba całkowita | pusta [dowolny] |
Dowolna liczba całkowita [odpowiednik typu long w javie] |
Identyfikator wewnętrzny izby Sądu Najwyższego w SAOS. |
globalFilter.courtCriteria.scDivisionId | Liczba całkowita | pusta [dowolny] |
Dowolna liczba całkowita [odpowiednik typu long w javie] |
Identyfikator wewnętrzny wydziału izby SN w SAOS, unikalny w ramach wszystkich wydziałów wszystkich izb. |
Odpowiedź
Obiekt analysisForm
Obiekt zawiera wartości parametrów wywołania serwisu. Dla przykładowego wywołania obiekt przyjmie następującą formę:
"analysisForm": { "seriesFilters": [ { "phrase": null } ], "globalFilter": { "judgmentDateRange": { "startMonth": 1, "startYear": 1995, "endMonth": 6, "endYear": 2015 }, "courtCriteria": { "courtType": "COMMON", "ccCourtId": null, "ccIncludeDependentCourtJudgments": false, "ccCourtDivisionId": null, "scCourtChamberId": null, "scCourtChamberDivisionId": null } }, "ysettings": { "valueType": "NUMBER" } }
Obiekt charts.MAIN_CHART
Zawiera dane dla głównego wykresu (liczba orzeczeń z podziałem na przedziały czasowe)
ścieżka | typ | możliwe wartości | opis |
---|---|---|---|
seriesList[seriesIndex].points | Lista | Punkty wykresu dla serii o indeksie seriesIndex. | |
seriesList[seriesIndex].points[j][0] | Liczba całkowita | >0 | Numer punktu na osi x. |
seriesList[seriesIndex].points[j][1] | Liczba całkowita | >0 | Wartość punktu na osi y. |
xticks | Lista | Informacje służące do wygenerowania szczegółowych wartości osi x. | |
xticks[j][0] | Liczba całkowita | >0 | Numer xtick'a (zgodny z numerem punku na osi x). |
xticks[j][1] | Obiekt | Obiekt z szczegółową informacją na temat wartości x punktu. Dla wykresu głównego jest to informacja o przedziale czasowym. W zależności od wybranego dolnego oraz górnego ograniczenia daty orzeczenia oś x zostaje podzielona na różne typy przedziałów czasowych (przedział będący wielokrotnością dnia, wielokrotnością miesiąca lub wielokrotnością roku). | |
xticks[j][1].period | Słownik |
DAY // dzień MONTH // miesiąc YEAR // rok |
Typ przedziału czasowego. |
xticks[j][1] // wielokrotność roku | Obiekt |
Przedział będący wielokrotnością roku. Przykładowa postać obiektu: { "startYear": 2010, "endYear": 2010, "period": "YEAR" } |
|
xticks[j][1] // wielokrotność miesiąca | Obiekt |
Przedział będący wielokrotnością miesiąca. Przykładowa postać obiektu: { "startYear": 2010, "startMonthOfYear": 7, "endYear": 2010, "endMonthOfYear": 12, "period": "MONTH" } |
|
xticks[j][1] // wielokrotność dnia | Obiekt |
Przedział będący wielokrotnością dnia. Przykładowa postać obiektu: { startDay: { "dayOfMonth": 26, "monthOfYear": 2, "year": 2010, }, endDay: { "dayOfMonth": 4, "monthOfYear": 3, "year": 2010, }, "period": "DAY" } |
Obiekt charts.AGGREGATED_MAIN_CHART
Zawiera dane wykresu podsumowującego wykres główny. Oś x określa serię wykresu głównego. Oś y jest sumą wartości wszystkich punktów danej serii wykresu głównego.
ścieżka | typ | możliwe wartości | opis |
---|---|---|---|
seriesList[seriesIndex].points | Lista | Punkty wykresu dla serii o indeksie seriesIndex. | |
seriesList[seriesIndex].points[j][0] | Liczba całkowita | >0 | Numer punktu na osi x. |
seriesList[seriesIndex].points[j][1] | Liczba całkowita | >0 | Wartość punktu na osi y. |
Obiekt charts.CC_COURT_CHART
Zawiera dane wykresu z podziałem na sądy powszechne.
ścieżka | typ | możliwe wartości | opis |
---|---|---|---|
seriesList[seriesIndex].points | Lista | Punkty wykresu dla serii o indeksie seriesIndex. | |
seriesList[seriesIndex].points[j][0] | Liczba całkowita | >0 | Numer punktu na osi x. |
seriesList[seriesIndex].points[j][1] | Liczba całkowita | >0 | Wartość punktu na osi y. |
xticks | Lista | Informacje służące do wygenerowania szczegółowych wartości osi x. | |
xticks[j][0] | Liczba całkowita | >0 | Numer xtick'a (zgodny z numerem punku na osi x). |
xticks[j][1] | Obiekt |
Obiekt z szczegółową informacją na temat wartości x punktu. Dla wykresu z podziałem na sądy powszechne jest to informacja o sądzie. Przykładowa postać obiektu: { "courtId": 34, "name": "Sąd Apelacyjny w Białymstoku" } |