API-RSPO

API-RSPO - ogólnodostępny interfejs bazy danych RSPO

Interfejs umożliwia przeglądanie informacji zawartych w bazie RSPO. Aby uzyskać dane o placówkach lub słownikach wykorzystywanych do ich opisu, należy połączyć się z wynienionymi poniżej endpoint'ami ustalając za pomocą nagłówka format komunikacji. Aktualnie dostępne są następujące formaty komunikacji:

JSON-LD - Header "accept: application/ld+json"
JSON - Header "accept: application/json"
YAML - Header "accept: application/x-yaml"
XML - Header "accept: application/xml"
CSV - Header "accept: text/csv"

Dane generowane są w porcjach po 100 pozycji, aby przejść do kolejnej strony z wynikami należy do URL dodać parametr page (zaczynając od 1).
Przykład: curl -X GET "https://api-rspo.mein.gov.pl/api/placowki/?page=1" -H "accept: application/json"

Przeglądarka API

GET /api/placowki/ umożliwia pobranie listy placówek.

Dostępne parametry przeszukiwania:

page - dane zwracane są po 100 pozycji - parametr page umożliwia określenie numeru strony
RSPO - pełny numer RSPO placówki
NIP -pełny numer NIP placówki
REGON - pełny numer REGON placówki
typ_podmiotu_id - ID typu podmiotu. Słownik typów podmiotów znajduje się pod endpointem: /api/typ/
status_publiczno_prawny_id - ID statusu publiczno-prawnego. Słownik znajduje się pod endpointem: /api/status_publiczno_prawny/
kategoria_ucznia_id - ID kategorii. Słownik znajduje się pod endpointem: /api/kategoria_ucznia/
etap_edukacji_id - ID etapu edukacji. Słownik znajduje się pod endpointem: /api/etap_edukacyjny/
wojewodztwo_nazwa - Pełna nazwa województwa. Słownik znajduje się pod endpointem: /api/wojewodztwa/
wojewodztwo_kod_teryt - Kod TERYT województwa. Słownik znajduje się pod endpointem: /api/wojewodztwa/
powiat_nazwa - Pełna nazwa powiatu. Słownik znajduje się pod endpointem: /api/powiaty/
powiat_kod_teryt - KOd TERYT powiatu. Słownik znajduje się pod endpointem: /api/powiaty/
gmina_nazwa - Pełna nazwa gminy. Słownik znajduje się pod endpointem: /api/gminy/
gmina_kod_teryt - Kod TERYT gminy. Słownik znajduje się pod endpointem: /api/gminy/
miejscowosc_nazwa - Pełna nazwa miejscowości. Słownik znajduje się pod endpointem: /api/miejscowosci/
miejscowosc_kod_teryt - Kod TERYT miejscowości. Słownik znajduje się pod endpointem: /api/miejscowosci/
zlikwidowana - Podanie wartości true powoduje uwzględnienie placówek zlikwidowanych

Przykład:

curl -X GET "https://api-rspo.mein.gov.pl/api/placowki/?miejscowosc_nazwa=Warszawa&etap_edukacji_id=2&page=1" -H "accept: application/json"

GET /api/placowki/{rspo} - umożliwia pobranie szczegółowych danych placówki

zwracany model danych:

                            [
                                {
                                "numerRspo": 0,
                                "dataZalozenia": "2019-07-03T09:14:47.618Z",
                                "dataRozpoczecia": "2019-07-03T09:14:47.618Z",
                                "dataZakonczenia": "2019-07-03T09:14:47.618Z",
                                "nip": "string",
                                "regon": "string",
                                "nazwaSkrocona": "string",
                                "nazwa": "string",
                                "typ": "string",
                                "dyrektorImie": "string",
                                "dyrektorNazwisko": "string",
                                    "statusPublicznoPrawny": {
                                        "id": 0,
                                        "nazwa": "string"
                                    },
                                "etapyEdukacji": [ ],
                                "dataWlaczeniaDoZespolu": "2019-07-03T09:14:47.618Z",
                                "dataWylaczeniaZZespolu": "2019-07-03T09:14:47.618Z",
                                "dataLikwidacji": "2019-07-03T09:14:47.618Z",
                                "kategoriaUczniow": {
                                        "id": 0,
                                        "nazwa": "string"
                                    },
                                "specyfikaSzkoly": "string",
                                "zwiazanieOrganizacyjne": {
                                        "id": 0,
                                        "nazwa": "string"
                                    },
                                "czyPosiadaObwod": true,
                                "czyPosiadaInternat": true,
                                "czyDotacjaWPrzyszlymRoku": true,
                                "opiekaDydaktycznoNaukowaUczelni": [ ],
                                "ksztalcenieZawodowe": [ ],
                                "ksztalcenieZawodoweProfilowane": [  ],
                                "ksztalcenieZawodoweArtystyczne": [  ],
                                "ksztalcenieNKJO": [ ],
                                "ksztalcenieWKolegiachNauczycielskich": [ ],
                                "ksztalcenieWkolegiachPracownikowSluzbSpolecznych": [  ],
                                "podmiotPrzekazujacyDaneDoRSPO": [ ],
                                "wojewodztwo": "string",
                                "wojewodztwoKodTERYT": "string",
                                "powiat": "string",
                                "powiatKodTERYT": "string",
                                "gmina": "string",
                                "gminaKodTERYT": "string",
                                "gminaRodzaj": "string",
                                "gminaRodzajKod": "string",
                                "miejscowosc": "string",
                                "miejscowoscKodTERYT": "string",
                                "ulica": "string",
                                "ulicaKodTERYT": "string",
                                "numerBudynku": "string",
                                "numerLokalu": "string",
                                "kodPocztowy": "string",
                                "geolokalizacja": [ ],
                                "telefon": "string",
                                "email": "string",
                                "stronaInternetowa": "string",
                                "adresDoKorespondecjiMiejscowosc": "string",
                                "adresDoKorespondecjiUlica": "string",
                                "adresDoKorespondecjiNumerBudynku": "string",
                                "adresDoKorespondecjiNumerLokalu": "string",
                                "adresDoKorespondecjiKodPocztowy": "string",
                                "placowkiPodrzedne": [ ]
                                }
                            ]

GET /api/etap_edukacyjny/ umożliwia pobranie listy etapów edukacyjnych.

Dostępne parametry przeszukiwania:

page - dane zwracane są po 100 pozycji - parametr page umożliwia określenie numeru strony
nazwa - pełna nazwa etapu

GET /api/etap_edukacyjny/{id} - umożliwia pobranie szczegółowych danych etapu edukacyjnego

zwracany model danych:

                            [
                                  {
                                    "id": 0,
                                    "nazwa": "string"
                                  }
                            ]