|
Główny Urząd Geodezji i KartografiiSpecyfikacja usługi ULDK |
|
Usługa ULDK umożliwia wyszukiwanie obiektów oraz współrzędnych na podstawie identyfikatora szukanego obiektu lub poprzez wskazanie współrzędnych XY punktu, który znajduje się wewnątrz obiektu.
Metody wywołania usługi (Endpoints)
API obsługuje zapytania typu GET. Poniżej znajdują się dostępne metody strukturyzacji zapytań:
1. Przez identyfikator szukanego obiektu
2. Przez pełen identyfikator działki lub nazwę obrębu i numer działki
3. Wyszukanie obiektu we wskazanym punkcie (Przez współrzędne)
4. Snapowanie (Przyciąganie do najbliższego punktu załamania działki)
5. Łączenie geometrii działek o podanych identyfikatorach
Konsola testowa API
Wybierz metodę, uzupełnij parametry i przetestuj działanie usługi ULDK na żywo.
Parametry zapytania (Query Parameters)
| Parametr | Typ | Opis | Wartości / Format / Przykłady |
|---|---|---|---|
request |
string wymagany | Określa rodzaj operacji oraz poszukiwanego obiektu. |
Dla identyfikatora / współrzędnych:GetParcelById / GetParcelByXY - działkaGetBuildingById / GetBuildingByXY - budynekGetRegionById / GetRegionByXY- obręb (PRG)GetRegionByNameOrId - obręb po ID lub nazwie TERYT (PRG)GetCommuneById / GetCommuneByXY gmina (PRG)GetCountyById / GetCountyByXY - powiat (PRG)GetVoivodeshipById / GetVoivodeshipByXY - województwo (PRG)Inne metody: GetParcelByIdOrNr - działka po indentyfikatorze (np. 141201_1.0001.6509) lub nazwie obrębu i numerze działki (np. Krzewina 134),SnapToPoint,GetAggregateArea
|
id |
string | Identyfikator obiektu lub obiektów (rozdzielone przecinkami dla GetAggregateArea). |
• Działka: WWPPGG_R.OOOO.[AR_NR.].NR_DZ (np. 141201_1.0001.6509)• Budynek: WWPPGG_R.OOOO.NR_DZ.Nr_BUD (np. 141301_1.0010.713/2.5_BUD)• Obręb: WWPPGG_R.OOOO• Gmina: WWPPGG_R | Powiat: WWPP | Województwo: WW• Dla GetParcelByIdOrNr dopuszczalne również: Nazwa numer (np. Krzewina 134)
|
xy |
string | Współrzędne punktu wyszukiwania. Kolejność zgodna z reprezentacją WKT dla wybranego układu. |
• X,Y - domyślny układ PUWG 1992• X,Y,SRID - specyficzny układ (np. 460166.4,313380.5,2180)
|
radius |
double | Promień wyszukiwania w metrach stosowany wyłącznie przy funkcji SnapToPoint. |
Domyślnie: 1 (np. radius=15) |
srid |
integer | Kod EPSG układu współrzędnych, w którym ma zostać zwrócona geometria. | Domyślnie: 2180 (PUWG 1992). Przykład: srid=4326 |
result |
string | Opcjonalny parametr określający zwracane atrybuty (wartości oddzielone przecinkami). |
geom_wkb - geometria w formacie wbk (domyślny),geom_wkt - geometria w formacie wbk,geom_extent - zasięg geometryczny obiektu (bbox),teryt - identyfikator TERYT obiektu (np. 141201_1.0001.6509),id - identyfikator TERYT obiektu (np. 141201_1.0001.6509),function - funkcja (dla budynków),voivodeship - nazwa województwa,county - nazwa powiatu,commune - nazwa gminy ,region - nazwa obrębu lub numer,parcel - numer działki,datasource - informacja o pochodzeniu danych zwróconych przez usługę
|
- Geometria zwracana jest domyślnie w układzie PUWG 1992 (EPSG:2180).
voivodeship,county,commune,regionjeśli informacja dot. działki z powiatu nie zawiera takich pól, to są one uzupełniane z PRG
GetParcelByIdOrNr
Dla metody GetParcelByIdOrNr w pierwszym wierszu odpowiedzi zwracana jest liczba znalezionych działek.
Wyniki dla wyszukiwania na podstawie nazwy obrębu i numeru działki, nie zawsze są jednoznaczne i w wyniku wyszukiwania można otrzymać więcej działek ze względu na powtarzające się nazwy obrębów, np. zapytanie o działkę 756 w obrębie Stara Wieś:
W przypadku zapytań z nazwą obrębu oprócz wyniku, który może zawierać większą liczbę odpowiedzi trzeba także liczyć się z tym, że czas odpowiedzi może być wydłużony, ponieważ zapytanie musi być obsłużone przez wszystkie powiaty, w których występuje obręb o podanej nazwie. Dla przykładu przy wyszukiwaniu działki „Dąbrowa 12” uzyskujemy w wyniku aż 57 działek spełniających warunki wyszukiwania.
SnapToPointa
Funkcja SnapToPoint oprócz geometrii punktu zwraca również odległość wskazanego punktu od punktu znalezionego.
W wyniku zapytania otrzymujemy plik zawierający 3 linie. W pierwszej linii jest status odpowiedzi, w drugiej współrzędne punktu w formacie WKB, a w trzeciej rzeczywista odległość zwróconego punktu od punktu, którego współrzędne podano w wywołaniu usługi.
GetAggregateArea
Funkcja GetAggregateArea zwraca pojedynczą geometrię typu POLYGON dla działek sąsiadujących, a w przypadku działek niegraniczących ze sobą - MULTIPOLYGON.
