1. Przegląd
Usługi REST/JSON dostarczające powyższych funkcjonalności opierając się o dane GUGiK na potrzeby systemów Geoportal oraz CAPAP.
1.1. Informacja o wersji
Wersja : 1.0.2
1.2. Informacja o licencji
Licencja : Komercyjna
Warunki użycia : Wykorzystanie usługi wyszukiwania, identyfikacji, geokodowania i odwrotnego geokodowania w celach komercyjnych lub niekomercyjnych dozwolone jest bezpłatnie, pod warunkiem podania źródła.
1.3. Schemat URI
Host : https://capap.gugik.gov.pl/
Ścieżka bazowa : /
1.4. Tagi
-
Usługa geokodowania : Usługa dostarcza funkcjonalności geokodowania w oparciu o dane referencyjne Geoportal / CAPAP, tj. zwraca geometrię (oraz atrybuty powiązane z tą geometrią) w oparciu o alfanumeryczne dane określające lokalizacje. Podstawą geokodowania mogą być zarówno dane ustrukturalizowane (czyli dla adresu osobno miejscowość, ulica, numer), jak i dane zgromadzone w jedym polu (adres). Możliwa jest też kombinacja obu sposobów. Dane ustrukturalizowane zapewnią lepszą trafność usługi.
-
Usługa odwrotnego geokodowania : Usługa udostępnia mechanizmy geokodowania odwrotnego. Pozwala uzyskać atrybuty obiektów znalezionych w oparciu o podaną lokalizację (punkt). W zależności od wybranego (wybranych) zasobów referencyjnych będzie to obiekt najbliższy - dla danych referencyjnych punktowych (z ograniczeniem maksymalnej odległości) lub obiekt w którym leży podana lokalizacja - dla danych referencyjnych poligonowych.
-
Usługa wyszukiwania CAPAP : Wyszukiwanie pełnotekstowe i przestrzenne dla zasobów CAPAP. Wyszukiwanie dostępne jest jedynie dla zasobów publicznych.
-
Usługa wyszukiwania danych referencyjnych : Wyszukiwanie pełnotekstowe i przestrzenne dla danych referencyjnych. Przeszukiwane są wybrane (lub wszystkie) referencyjne zasoby systemów Geoportal / CAPAP. Dla punktów adresowych i działek, usługa jest zintegrowana z zasobami zewnętrznymi.
-
Usługa wyszukiwania hierarchicznego : Usługa udostępnia wyszukiwanie wybranych danych referencyjnych w sposób hierarchiczny. Wybór kolejnych poziomów hierarchii filtruje wyniki wyszukiwania oraz dostępne listy wartości kolejnych poziomów hierarchii.
2. Lokalizacja (URL) API
2.1. Środowisko produkcyjne
Adres usługi:
https://capap.gugik.gov.pl/api/fts/
Ścieżki w poniższej dokumentacji podane względem:
https://capap.gugik.gov.pl/
2.2. Środowisko testowe
Adres usługi:
https://testcapap.gugik.gov.pl/api/fts/
Ścieżki w poniższej dokumentacji podane względem:
https://testcapap.gugik.gov.pl/
3. Zasoby
3.1. Usługa Geokodowania
Usługa dostarcza funkcjonalności geokodowania w oparciu o dane referencyjne Geoportal / CAPAP, tj. zwraca geometrię (oraz atrybuty powiązane z tą geometrią) w oparciu o alfanumeryczne dane określające lokalizacje. Podstawą geokodowania mogą być zarówno dane ustrukturalizowane (czyli dla adresu osobno miejscowość, ulica, numer), jak i dane zgromadzone w jedym polu (adres). Możliwa jest też kombinacja obu sposobów. Dane ustrukturalizowane zapewnią lepszą trafność usługi.
3.1.1. Geokodowanie działek
POST /api/fts/gc/dze
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< GcResult > array |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
{ "reqs": [
{
"idswde": "020201_1.0001.107",
"woj_nazwa": "Dolnośląskie",
"miejsc_nazwa": "Bielawa"
}
],
"useExtServiceIfNotFound": true
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{ "reqs": [
{
"idswde": "020201_1.0001.107",
"woj_nazwa": "Dolnośląskie",
"miejsc_nazwa": "Bielawa"
}
],
"useExtServiceIfNotFound": true
}' \
https://capap.gugik.gov.pl/api/fts/gc/dze
Przykład: Odpowiedź
{
"single": {
"id": 9713972,
"name": "020201_1.0001.107 Bielawa Północ 107",
"desc": "0202011",
"shortDesc": "020201_1.0001.107 Bielawa Północ 107",
"longDesc": "0202011",
"filterKeys": [
"dzierżoniowski",
"Bielawa",
"dolnośląskie",
"0202011"
],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
16.62721899,
50.7012276
],
[
16.62731732,
50.70132551
],
...
]
]
},
"gm_nazwa": "Bielawa",
"pow_nazwa": "dzierżoniowski",
"woj_nazwa": "dolnośląskie",
"nr_dz": "107",
"idswde": "020201_1.0001.107",
"miejsc_nazwa": "Bielawa Północ",
"ftsid": null,
"center": "50.701, 16.628",
"record": {
"id": 9713972,
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
16.62721899,
50.7012276
],
[
16.62731732,
50.70132551
],
...
]
]
},
"type": "Feature",
"properties": {
"ZRD": "LPIS",
"MIEJSC": "Bielawa Północ",
"IDENTYFIKATOR": "020201_1.0001.107",
"NUMER": "107",
"POWIAT": "dzierżoniowski",
"POWIERZCHNIA": 31704,
"OBJECTID": 9713972,
"GMINA": "Bielawa",
"WOJEWODZTWO": "dolnośląskie",
"TERYT": "0202011",
"OBREB_EWIDENCYJNY": "PÓŁNOC"
}
},
"es_metadata_id": "9713972"
},
"relevance": 1.0,
"source": "CAPAP"
}]
3.1.2. Geokodowanie działek - lpis
POST /api/fts/gc/dze_lpis
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< GcResult > array |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
{ "reqs": [
{
"idswde": "020201_1.0001.107",
"woj_nazwa": "Dolnośląskie",
"miejsc_nazwa": "Bielawa"
}
]
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{ "reqs": [
{
"idswde": "020201_1.0001.107",
"woj_nazwa": "Dolnośląskie",
"miejsc_nazwa": "Bielawa"
}
]
}' \
https://capap.gugik.gov.pl/api/fts/gc/dze_lpis
Przykład: Odpowiedź
[
{
"single": {
"id": 9713972,
"name": "020201_1.0001.107 Bielawa Północ 107",
"desc": "0202011",
"shortDesc": "020201_1.0001.107 Bielawa Północ 107",
"longDesc": "0202011",
"filterKeys": [
"dzierżoniowski",
"Bielawa",
"dolnośląskie",
"0202011"
],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
16.62721899,
50.7012276
],
[
16.62731732,
50.70132551
],
...
]
]
},
"gm_nazwa": "Bielawa",
"pow_nazwa": "dzierżoniowski",
"woj_nazwa": "dolnośląskie",
"nr_dz": "107",
"idswde": "020201_1.0001.107",
"miejsc_nazwa": "Bielawa Północ",
"ftsid": null,
"center": "50.701, 16.628",
"record": {
"id": 9713972,
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
16.62721899,
50.7012276
],
[
16.62731732,
50.70132551
],
...
]
]
},
"type": "Feature",
"properties": {
"ZRD": "LPIS",
"MIEJSC": "Bielawa Północ",
"IDENTYFIKATOR": "020201_1.0001.107",
"NUMER": "107",
"POWIAT": "dzierżoniowski",
"POWIERZCHNIA": 31704,
"OBJECTID": 9713972,
"GMINA": "Bielawa",
"WOJEWODZTWO": "dolnośląskie",
"TERYT": "0202011",
"OBREB_EWIDENCYJNY": "PÓŁNOC"
}
},
"es_metadata_id": "9713972"
},
"relevance": 1.0,
"source": "CAPAP"
}
]
3.1.3. Geokodowanie działek - zsin
POST /api/fts/gc/dze_zsin
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< GcResult > array |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
{ "reqs": [
{
"idswde": "020201_1.0001.107",
"woj_nazwa": "Dolnośląskie",
"miejsc_nazwa": "Bielawa"
}
]
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{ "reqs": [
{
"idswde": "020201_1.0001.107",
"woj_nazwa": "Dolnośląskie",
"miejsc_nazwa": "Bielawa"
}
]
}' \
https://capap.gugik.gov.pl/api/fts/gc/dze_zsin
Przykład: Odpowiedź
[{"relevance":0.0,"source":"CAPAP"}]
3.1.4. Geokodowanie gmin
POST /api/fts/gc/gmi
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< GcResult > array |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
{ "reqs": [
{
"teryt": "0618112",
"gm_nazwa": "Tomaszów Lubelski"
}
]
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{ "reqs": [
{
"teryt": "0618112",
"gm_nazwa": "Tomaszów Lubelski"
}
]
}
' \
https://capap.gugik.gov.pl/api/fts/gc/gmi
Przykład: Odpowiedź
[
{
"single": {
"name": "Tomaszów Lubelski",
"desc": "0618112 tomaszowski lubelskie",
"shortDesc": "Tomaszów Lubelski 0618112 e1bac242-c5ae-4bed-b982-b3238dbceb50",
"longDesc": "tomaszowski lubelskie PL.PZGIK.200/e1bac242-c5ae-4bed-b982-b3238dbceb50",
"filterKeys": [
"gmina"
],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
23.46911639,
50.38545234
],
[
23.46322375,
50.38600554
],
...
]
]
},
"teryt": "0618112",
"sort1": "tomaszów lubelski",
"ftsid": "pl.pzgik.200/e1bac242-c5ae-4bed-b982-b3238dbceb50",
"id": 369958,
"woj_nazwa": "lubelskie",
"gm_nazwa": "Tomaszów Lubelski",
"pow_nazwa": "tomaszowski",
"center": "50.45482933703209, 23.43155877016154",
"record": {
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
23.46911639,
50.38545234
],
[
23.46322375,
50.38600554
],
...
]
]
},
"type": "Feature",
"id": 369958,
"properties": {
"id": 369958,
"woj_id_lokalnyid": "a1e8cdc7-d26d-4982-946f-ff3e5082eecd",
"gm_id_wersjaid": "2012-09-26T22:43:07+02:00",
"gm_idteryt": "0618112",
"woj_id_wersjaid": "2012-09-27T13:45:12+02:00",
"woj_id_przestrzenNazw": "PL.PZGIK.200",
"woj_nazwa": "lubelskie",
"pow_id_przestrzenNazw": "PL.PZGIK.200",
"gm_id_lokalnyid": "e1bac242-c5ae-4bed-b982-b3238dbceb50",
"gm_nazwa": "Tomaszów Lubelski",
"woj_idteryt": "06",
"pow_idteryt": "0618",
"pow_id_wersjaid": "2012-09-27T07:39:43+02:00",
"gm_id_przestrzenNazw": "PL.PZGIK.200",
"pow_nazwa": "tomaszowski",
"pow_id_lokalnyid": "0a318aee-35ab-4a38-ae71-c0757d318e42"
}
},
"es_metadata_id": "369958"
},
"relevance": 1.0,
"source": "CAPAP"
}
]
3.1.5. Geokodowanie jpa
POST /api/fts/gc/jpa
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< GcResult > array |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
{ "reqs": [
{
"teryt": "0618112",
"gm_nazwa": "Tomaszów Lubelski"
}
]}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{ "reqs": [
{
"teryt": "0618112",
"gm_nazwa": "Tomaszów Lubelski"
}
]}
' \
https://capap.gugik.gov.pl/api/fts/gc/jpa
Przykład: Odpowiedź
[
{
"single": {
"name": "Tomaszów Lubelski",
"desc": "0618112 tomaszowski lubelskie",
"shortDesc": "Tomaszów Lubelski 0618112 e1bac242-c5ae-4bed-b982-b3238dbceb50",
"longDesc": "tomaszowski lubelskie PL.PZGIK.200/e1bac242-c5ae-4bed-b982-b3238dbceb50",
"filterKeys": [
"gmina"
],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
23.46911639,
50.38545234
],
[
23.46322375,
50.38600554
],
...
]
]
},
"teryt": "0618112",
"sort1": "tomaszów lubelski",
"ftsid": "pl.pzgik.200/e1bac242-c5ae-4bed-b982-b3238dbceb50",
"id": 369958,
"woj_nazwa": "lubelskie",
"gm_nazwa": "Tomaszów Lubelski",
"pow_nazwa": "tomaszowski",
"center": "50.45482933703209, 23.43155877016154",
"record": {
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
23.46911639,
50.38545234
],
[
23.46322375,
50.38600554
],
...
]
]
},
"type": "Feature",
"id": 369958,
"properties": {
"id": 369958,
"woj_id_lokalnyid": "a1e8cdc7-d26d-4982-946f-ff3e5082eecd",
"gm_id_wersjaid": "2012-09-26T22:43:07+02:00",
"gm_idteryt": "0618112",
"woj_id_wersjaid": "2012-09-27T13:45:12+02:00",
"woj_id_przestrzenNazw": "PL.PZGIK.200",
"woj_nazwa": "lubelskie",
"pow_id_przestrzenNazw": "PL.PZGIK.200",
"gm_id_lokalnyid": "e1bac242-c5ae-4bed-b982-b3238dbceb50",
"gm_nazwa": "Tomaszów Lubelski",
"woj_idteryt": "06",
"pow_idteryt": "0618",
"pow_id_wersjaid": "2012-09-27T07:39:43+02:00",
"gm_id_przestrzenNazw": "PL.PZGIK.200",
"pow_nazwa": "tomaszowski",
"pow_id_lokalnyid": "0a318aee-35ab-4a38-ae71-c0757d318e42"
}
},
"es_metadata_id": "369958"
},
"relevance": 1.0,
"source": "CAPAP"
}
]
3.1.6. Geokodowanie punktów adresowych
POST /api/fts/gc/pkt
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< GcResult > array |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
{ "reqs": [
{
"pkt_numer": "60",
"pkt_kodPocztowy": "51-162",
"ul_pelna": "długosza",
"miejsc_nazwa": "wroclaw"
}
],
"useExtServiceIfNotFound": true
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{ "reqs": [
{
"pkt_numer": "60",
"pkt_kodPocztowy": "51-162",
"ul_pelna": "długosza",
"miejsc_nazwa": "wroclaw"
}
],
"useExtServiceIfNotFound": true
}
' \
https://capap.gugik.gov.pl/api/fts/gc/pkt
Przykład: Odpowiedź
[
{
"others": [
{
"name": "ul. Jana Długosza 60 - Wrocław",
"id": 138170845,
"desc": "51-162 ulica Wrocław Wrocław dolnośląskie",
"shortDesc": "Jana Długosza 60 Wrocław",
"longDesc": "ulica ul. 51-162 Wrocław Wrocław dolnośląskie",
"filterKeys": [
"Wrocław",
"dolnośląskie"
],
"geometry": {
"type": "Point",
"coordinates": [
17.06499396,
51.13534439
]
},
"ul_pelna": "ulica ul. Jana Długosza",
"miejsc_pelna": " Wrocław",
"sort1": "60",
"loduri": "https://pzgik.geoportal.gov.pl/prg/PunktAdresowy/PL.PZGIK.200.0f115d1c-f3cb-4327-82c5-dc6a1db55174",
"teryt": "0264011",
"ftsid": "pl.pzgik.200/0f115d1c-f3cb-4327-82c5-dc6a1db55174",
"miejsc_nazwa": "Wrocław",
"pkt_numer": "60",
"ul_nazwa_przed1": "ul.",
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": "Długosza",
"ul_nazwa_czesc": "Jana",
"ul_typ": "ulica",
"pkt_kodPocztowy": "51-162",
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Wrocław",
"pow_nazwa": "Wrocław",
"center": "51.13534438986596, 17.064993959806493",
"pkt_numer_n1": null,
"pkt_numer_n2": null,
"record": {
"id": 138170845,
"geometry": {
"type": "Point",
"coordinates": [
17.06499396,
51.13534439
]
},
"type": "Feature",
"properties": {
"id": 138170845,
"loduri": "https://pzgik.geoportal.gov.pl/prg/PunktAdresowy/PL.PZGIK.200.0f115d1c-f3cb-4327-82c5-dc6a1db55174",
"pkt_id_przestrzenNazw": "PL.PZGIK.200",
"miejsc_nazwa": "Wrocław",
"gm_idteryt": "0264011",
"miejsc_n_nazwa": null,
"pkt_numer": "60",
"ul_nazwa_przed1": "ul.",
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": "Długosza",
"pkt_status": "istniejacy",
"pkt_id_lokalnyid": "0f115d1c-f3cb-4327-82c5-dc6a1db55174",
"ul_nazwa_czesc": "Jana",
"woj_idteryt": "02",
"ul_typ": "ulica",
"ul_idTERYT": "03851",
"pkt_id_wersjaid": "2018-06-28T00:07:55+02:00",
"pow_idteryt": "0264",
"pkt_kodPocztowy": "51-162",
"miejsc_n_idTERYT": null,
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Wrocław",
"pow_nazwa": "Wrocław",
"miejsc_idTERYT": "0986283"
}
},
"es_metadata_id": "138170845"
},
{
"name": "ul. Jana Długosza 59-75 - Wrocław",
"id": 138170856,
"desc": "51-162 ulica Wrocław Wrocław dolnośląskie",
"shortDesc": "Jana Długosza 59-75 Wrocław",
"longDesc": "ulica ul. 51-162 Wrocław Wrocław dolnośląskie",
"filterKeys": [
"Wrocław",
"dolnośląskie"
],
"geometry": {
"type": "Point",
"coordinates": [
17.06673173,
51.13553514
]
},
"ul_pelna": "ulica ul. Jana Długosza",
"miejsc_pelna": " Wrocław",
"sort1": "59-75",
"loduri": "https://pzgik.geoportal.gov.pl/prg/PunktAdresowy/PL.PZGIK.200.b9349488-0fcf-4231-b753-a2dbc21fc6b1",
"teryt": "0264011",
"ftsid": "pl.pzgik.200/b9349488-0fcf-4231-b753-a2dbc21fc6b1",
"miejsc_nazwa": "Wrocław",
"pkt_numer": "59-75",
"ul_nazwa_przed1": "ul.",
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": "Długosza",
"ul_nazwa_czesc": "Jana",
"ul_typ": "ulica",
"pkt_kodPocztowy": "51-162",
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Wrocław",
"pow_nazwa": "Wrocław",
"center": "51.13553514456226, 17.066731733159955",
"pkt_numer_n1": [
"59",
"75",
"59/75"
],
"pkt_numer_n2": [
"60",
"61",
"62",
"63",
"64",
"65",
"66",
"67",
"68",
"69",
"70",
"71",
"72",
"73",
"74"
],
"record": {
"id": 138170856,
"geometry": {
"type": "Point",
"coordinates": [
17.06673173,
51.13553514
]
},
"type": "Feature",
"properties": {
"id": 138170856,
"loduri": "https://pzgik.geoportal.gov.pl/prg/PunktAdresowy/PL.PZGIK.200.b9349488-0fcf-4231-b753-a2dbc21fc6b1",
"pkt_id_przestrzenNazw": "PL.PZGIK.200",
"miejsc_nazwa": "Wrocław",
"gm_idteryt": "0264011",
"miejsc_n_nazwa": null,
"pkt_numer": "59-75",
"ul_nazwa_przed1": "ul.",
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": "Długosza",
"pkt_status": "istniejacy",
"pkt_id_lokalnyid": "b9349488-0fcf-4231-b753-a2dbc21fc6b1",
"ul_nazwa_czesc": "Jana",
"woj_idteryt": "02",
"ul_typ": "ulica",
"ul_idTERYT": "03851",
"pkt_id_wersjaid": "2018-06-28T00:07:56+02:00",
"pow_idteryt": "0264",
"pkt_kodPocztowy": "51-162",
"miejsc_n_idTERYT": null,
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Wrocław",
"pow_nazwa": "Wrocław",
"miejsc_idTERYT": "0986283"
}
},
"es_metadata_id": "138170856"
}
],
"relevance": 0.975,
"source": "CAPAP"
}
]
Przykład: Treść zapytania POST - pojedyncza linia
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
{ "reqs": [
{
"q": "Wrocław Długosza 60"
}
],
"useExtServiceIfNotFound": true
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{ "reqs": [
{
"q": "Wrocław Długosza 60"
}
],
"useExtServiceIfNotFound": true
}
' \
https://capap.gugik.gov.pl/api/fts/gc/pkt
Przykład: Odpowiedź
[
{
"single": {
"name": "ul. Jana Długosza 60 - Wrocław",
"id": 138170845,
"desc": "51-162 ulica Wrocław Wrocław dolnośląskie",
"shortDesc": "Jana Długosza 60 Wrocław",
"longDesc": "ulica ul. 51-162 Wrocław Wrocław dolnośląskie",
"filterKeys": [
"Wrocław",
"dolnośląskie"
],
"geometry": {
"type": "Point",
"coordinates": [
17.06499396,
51.13534439
]
},
"ul_pelna": "ulica ul. Jana Długosza",
"miejsc_pelna": " Wrocław",
"sort1": "60",
"loduri": "https://pzgik.geoportal.gov.pl/prg/PunktAdresowy/PL.PZGIK.200.0f115d1c-f3cb-4327-82c5-dc6a1db55174",
"teryt": "0264011",
"ftsid": "pl.pzgik.200/0f115d1c-f3cb-4327-82c5-dc6a1db55174",
"miejsc_nazwa": "Wrocław",
"pkt_numer": "60",
"ul_nazwa_przed1": "ul.",
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": "Długosza",
"ul_nazwa_czesc": "Jana",
"ul_typ": "ulica",
"pkt_kodPocztowy": "51-162",
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Wrocław",
"pow_nazwa": "Wrocław",
"center": "51.13534438986596, 17.064993959806493",
"pkt_numer_n1": null,
"pkt_numer_n2": null,
"record": {
"id": 138170845,
"geometry": {
"type": "Point",
"coordinates": [
17.06499396,
51.13534439
]
},
"type": "Feature",
"properties": {
"id": 138170845,
"loduri": "https://pzgik.geoportal.gov.pl/prg/PunktAdresowy/PL.PZGIK.200.0f115d1c-f3cb-4327-82c5-dc6a1db55174",
"pkt_id_przestrzenNazw": "PL.PZGIK.200",
"miejsc_nazwa": "Wrocław",
"gm_idteryt": "0264011",
"miejsc_n_nazwa": null,
"pkt_numer": "60",
"ul_nazwa_przed1": "ul.",
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": "Długosza",
"pkt_status": "istniejacy",
"pkt_id_lokalnyid": "0f115d1c-f3cb-4327-82c5-dc6a1db55174",
"ul_nazwa_czesc": "Jana",
"woj_idteryt": "02",
"ul_typ": "ulica",
"ul_idTERYT": "03851",
"pkt_id_wersjaid": "2018-06-28T00:07:55+02:00",
"pow_idteryt": "0264",
"pkt_kodPocztowy": "51-162",
"miejsc_n_idTERYT": null,
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Wrocław",
"pow_nazwa": "Wrocław",
"miejsc_idTERYT": "0986283"
}
},
"es_metadata_id": "138170845"
},
"relevance": 1.0,
"source": "CAPAP"
}
]
3.1.7. Geokodowanie powiatu
POST /api/fts/gc/pow
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< GcResult > array |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
{ "reqs": [
{
"teryt": "0618",
"pow_nazwa": "tomaszowski"
}
]
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{ "reqs": [
{
"teryt": "0618",
"pow_nazwa": "tomaszowski"
}
]
}
' \
https://capap.gugik.gov.pl/api/fts/gc/pow
Przykład: Odpowiedź
[
{
"single": {
"name": "tomaszowski",
"desc": "0618 lubelskie",
"shortDesc": "tomaszowski 0618 0a318aee-35ab-4a38-ae71-c0757d318e42",
"longDesc": "lubelskie PL.PZGIK.200/0a318aee-35ab-4a38-ae71-c0757d318e42",
"filterKeys": [
"powiat"
],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
23.5841632,
50.58412406
],
[
23.58870791,
50.59004896
],
...
]
]
},
"teryt": "0618",
"sort1": "tomaszowski",
"ftsid": "pl.pzgik.200/0a318aee-35ab-4a38-ae71-c0757d318e42",
"id": 366425,
"woj_nazwa": "lubelskie",
"pow_nazwa": "tomaszowski",
"center": "50.47370688348184, 23.553793319339206",
"record": {
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
23.5841632,
50.58412406
],
[
23.58870791,
50.59004896
],
...
]
]
},
"type": "Feature",
"id": 366425,
"properties": {
"id": 366425,
"woj_id_lokalnyid": "a1e8cdc7-d26d-4982-946f-ff3e5082eecd",
"gm_id_wersjaid": null,
"gm_idteryt": null,
"woj_id_wersjaid": "2012-09-27T13:45:12+02:00",
"woj_id_przestrzenNazw": "PL.PZGIK.200",
"woj_nazwa": "lubelskie",
"pow_id_przestrzenNazw": "PL.PZGIK.200",
"gm_id_lokalnyid": null,
"gm_nazwa": null,
"woj_idteryt": "06",
"pow_idteryt": "0618",
"pow_id_wersjaid": "2012-09-27T07:39:43+02:00",
"gm_id_przestrzenNazw": null,
"pow_nazwa": "tomaszowski",
"pow_id_lokalnyid": "0a318aee-35ab-4a38-ae71-c0757d318e42"
}
},
"es_metadata_id": "366425"
},
"relevance": 1.0,
"source": "CAPAP"
}
]
3.1.8. Geokodowanie PRNG - jednostki osadnicze
POST /api/fts/gc/prngjo
Parametry
Typ | Nazwa | Opis | Schemat |
---|---|---|---|
Body |
req |
req |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< GcResult > array |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
{ "reqs": [
{
"q": "Nowa wieś"
}
]
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{ "reqs": [
{
"q": "Nowa wieś"
}
]
}
' \
https://capap.gugik.gov.pl/api/fts/gc/prngjo
Przykład: Odpowiedź
[
{
"others": [
{
"id": 1618030,
"name": "Nowa Wieś",
"desc": " - miejscowość, wieś",
"shortDesc": "Nowa Wieś",
"longDesc": " wieś",
"filterKeys": [
"miejscowość",
"urzędowa",
"wieś",
"Punkt centralny"
],
"geometry": {
"type": "Point",
"coordinates": [
15.40950474,
51.26373192
]
},
"sort1": "Nowa Wieś",
"ftsid": "pl.pzgik.204.prng/00000000-0000-0000-0000-000000088194",
"gm_nazwa": null,
"pow_nazwa": null,
"woj_nazwa": null,
"teryt": null,
"center": "51.2637319227272, 15.4095047425547",
"record": {
"id": 1618030,
"geometry": {
"type": "Point",
"coordinates": [
15.40950474,
51.26373192
]
},
"type": "Feature",
"properties": {
"LODURI": "https://pzgik.geoportal.gov.pl/prng/Miejscowosc/PL.PZGiK.204.PRNG.00000000-0000-0000-0000-000000088194-",
"ID_W_SYS_ZEWNETRZNYM": "0191550 ",
"NAZWA_SKROCONA": null,
"KLASA": "miejscowość",
"ID_PRNG": 88194,
"OBJECTID": 1618030,
"SYSTEM_ZEWNETRZNY": "TERYT",
"STATUS": "urzędowa",
"NADRZEDNY": null,
"NAZWA_URZEDOWA": null,
"RODZAJ": "wieś",
"ID_JEDN_OSAD": 616940,
"NAZWA_PRZYMIOTNIK": "nowowiejski",
"ID_IIP": "00000000-0000-0000-0000-000000088194",
"NAZWA_MN_NAR": null,
"NAZWA_DOPELNIACZ": "-wej Wsi",
"NAZWA_MIANOWNIK": "Nowa Wieś",
"FUNKCJA_ADM": null
}
},
"es_metadata_id": "1618030"
},
{
"id": 1671125,
"name": "Nowa Wieś",
"desc": " - miejscowość, wieś",
"shortDesc": "Nowa Wieś",
"longDesc": " wieś",
"filterKeys": [
"miejscowość",
"urzędowa",
"wieś",
"Punkt centralny"
],
"geometry": {
"type": "Point",
"coordinates": [
19.26125563,
52.97164079
]
},
"sort1": "Nowa Wieś",
"ftsid": "pl.pzgik.204.prng/00000000-0000-0000-0000-000000088245",
"gm_nazwa": null,
"pow_nazwa": null,
"woj_nazwa": null,
"teryt": null,
"center": "52.9716407884769, 19.2612556297618",
"record": {
"id": 1671125,
"geometry": {
"type": "Point",
"coordinates": [
19.26125563,
52.97164079
]
},
"type": "Feature",
"properties": {
"LODURI": "https://pzgik.geoportal.gov.pl/prng/Miejscowosc/PL.PZGiK.204.PRNG.00000000-0000-0000-0000-000000088245-",
"ID_W_SYS_ZEWNETRZNYM": "0861452 ",
"NAZWA_SKROCONA": null,
"KLASA": "miejscowość",
"ID_PRNG": 88245,
"OBJECTID": 1671125,
"SYSTEM_ZEWNETRZNY": "TERYT",
"STATUS": "urzędowa",
"NADRZEDNY": null,
"NAZWA_URZEDOWA": null,
"RODZAJ": "wieś",
"ID_JEDN_OSAD": 629623,
"NAZWA_PRZYMIOTNIK": "nowowiejski",
"ID_IIP": "00000000-0000-0000-0000-000000088245",
"NAZWA_MN_NAR": null,
"NAZWA_DOPELNIACZ": "-wej Wsi",
"NAZWA_MIANOWNIK": "Nowa Wieś",
"FUNKCJA_ADM": null
}
},
"es_metadata_id": "1671125"
},
{
"id": 1189468,
"name": "Nowa Wieś",
"desc": "Jaworze Górne - miejscowość, część wsi",
"shortDesc": "Nowa Wieś",
"longDesc": "Jaworze Górne część wsi",
"filterKeys": [
"miejscowość",
"urzędowa",
"część wsi",
"Punkt centralny"
],
"geometry": {
"type": "Point",
"coordinates": [
21.34075055,
49.92256194
]
},
"sort1": "Nowa Wieś",
"ftsid": "pl.pzgik.204.prng/00000000-0000-0000-0000-000000179518",
"gm_nazwa": null,
"pow_nazwa": null,
"woj_nazwa": null,
"teryt": null,
"center": "49.92256194, 21.34075055",
"record": {
"id": 1189468,
"geometry": {
"type": "Point",
"coordinates": [
21.34075055,
49.92256194
]
},
"type": "Feature",
"properties": {
"LODURI": "https://pzgik.geoportal.gov.pl/prng/Miejscowosc/PL.PZGiK.204.PRNG.00000000-0000-0000-0000-000000179518-",
"ID_W_SYS_ZEWNETRZNYM": "0825960 ",
"NAZWA_SKROCONA": null,
"KLASA": "miejscowość",
"ID_PRNG": 179518,
"OBJECTID": 1189468,
"SYSTEM_ZEWNETRZNY": "TERYT",
"STATUS": "urzędowa",
"NADRZEDNY": "Jaworze Górne",
"NAZWA_URZEDOWA": "Nowa Wieś",
"RODZAJ": "część wsi",
"ID_JEDN_OSAD": 529365,
"NAZWA_PRZYMIOTNIK": null,
"ID_IIP": "00000000-0000-0000-0000-000000179518",
"NAZWA_MN_NAR": null,
"NAZWA_DOPELNIACZ": "-wej Wsi",
"NAZWA_MIANOWNIK": "Nowa Wieś",
"FUNKCJA_ADM": null
}
},
"es_metadata_id": "1189468"
},
...
],
"relevance": 1.0,
"source": "CAPAP"
}
]
3.1.9. Geokodowanie PRNG - obiekty fizjograficzne
POST /api/fts/gc/prngof
Parametry
Typ | Nazwa | Opis | Schemat |
---|---|---|---|
Body |
req |
req |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< GcResult > array |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
{ "reqs": [
{
"q": "wilkołak"
}
]
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{ "reqs": [
{
"q": "wilkołak"
}
]
}
' \
https://capap.gugik.gov.pl/api/fts/gc/prngof
Przykład: Odpowiedź
[
{
"others": [
{
"id": 1575760,
"name": "Wilkołak",
"desc": " - obiekt ukształtowania terenu, góra, szczyt",
"shortDesc": "Wilkołak",
"longDesc": " obiekt ukształtowania terenu góra, szczyt",
"filterKeys": [
"obiekt ukształtowania terenu",
"urzędowa",
"góra, szczyt",
"Punkt centralny"
],
"geometry": {
"type": "Point",
"coordinates": [
15.91198881,
51.10481469
]
},
"sort1": "Wilkołak",
"prng_klasa": "obiekt ukształtowania terenu",
"prng_rodzaj": "góra, szczyt",
"ftsid": "pl.pzgik.204.prng/00000000-0000-0000-0000-000000148062",
"gm_nazwa": null,
"pow_nazwa": null,
"woj_nazwa": null,
"teryt": null,
"center": "51.1048146919122, 15.9119888135401",
"record": {
"id": 1575760,
"geometry": {
"type": "Point",
"coordinates": [
15.91198881,
51.10481469
]
},
"type": "Feature",
"properties": {
"LODURI": "https://pzgik.geoportal.gov.pl/prng/Miejscowosc/PL.PZGiK.204.PRNG.00000000-0000-0000-0000-000000148062-",
"ID_W_SYS_ZEWNETRZNYM": null,
"NAZWA_SKROCONA": null,
"KLASA": "obiekt ukształtowania terenu",
"ID_PRNG": 148062,
"OBJECTID": 1575760,
"SYSTEM_ZEWNETRZNY": null,
"STATUS": "urzędowa",
"NADRZEDNY": null,
"NAZWA_URZEDOWA": null,
"RODZAJ": "góra, szczyt",
"NAZWA_PRZYMIOTNIK": null,
"ID_IIP": "00000000-0000-0000-0000-000000148062",
"NAZWA_MN_NAR": null,
"NAZWA_DOPELNIACZ": "-ka",
"NAZWA_MIANOWNIK": "Wilkołak"
}
},
"es_metadata_id": "1575760"
},
{
"id": 1811557,
"name": "Wilkołak",
"desc": " - Inny obiekt fizjograficzny, pole",
"shortDesc": "Wilkołak",
"longDesc": " Inny obiekt fizjograficzny pole",
"filterKeys": [
"Inny obiekt fizjograficzny",
"niestandaryzowana",
"pole",
"Punkt centralny"
],
"geometry": {
"type": "Point",
"coordinates": [
18.7641527,
49.86241632
]
},
"sort1": "Wilkołak",
"prng_klasa": "inny obiekt fizjograficzny",
"prng_rodzaj": "pole",
"ftsid": "pl.pzgik.204.prng/00000000-0000-0000-0000-000000148061",
"gm_nazwa": null,
"pow_nazwa": null,
"woj_nazwa": null,
"teryt": null,
"center": "49.8624163220119, 18.7641526957837",
"record": {
"id": 1811557,
"geometry": {
"type": "Point",
"coordinates": [
18.7641527,
49.86241632
]
},
"type": "Feature",
"properties": {
"LODURI": "https://pzgik.geoportal.gov.pl/prng/Miejscowosc/PL.PZGiK.204.PRNG.00000000-0000-0000-0000-000000148061-",
"ID_W_SYS_ZEWNETRZNYM": null,
"NAZWA_SKROCONA": null,
"KLASA": "Inny obiekt fizjograficzny",
"ID_PRNG": 148061,
"OBJECTID": 1811557,
"SYSTEM_ZEWNETRZNY": null,
"STATUS": "niestandaryzowana",
"NADRZEDNY": null,
"NAZWA_URZEDOWA": null,
"RODZAJ": "pole",
"NAZWA_PRZYMIOTNIK": null,
"ID_IIP": "00000000-0000-0000-0000-000000148061",
"NAZWA_MN_NAR": null,
"NAZWA_DOPELNIACZ": "-ka",
"NAZWA_MIANOWNIK": "Wilkołak"
}
},
"es_metadata_id": "1811557"
}
],
"relevance": 1.0,
"source": "CAPAP"
}
]
3.1.10. Geokodowanie województwa
POST /api/fts/gc/woj
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< GcResult > array |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
{ "reqs": [
{
"woj_nazwa": "lubelskie"
}
]
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{ "reqs": [
{
"woj_nazwa": "lubelskie"
}
]
}
' \
https://capap.gugik.gov.pl/api/fts/gc/woj
Przykład: Odpowiedź
[
{
"single": {
"name": "lubelskie",
"desc": "06",
"shortDesc": "lubelskie 06 a1e8cdc7-d26d-4982-946f-ff3e5082eecd",
"longDesc": "PL.PZGIK.200/a1e8cdc7-d26d-4982-946f-ff3e5082eecd",
"filterKeys": [
"województwo"
],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
21.61554253,
51.61756198
],
[
21.64009108,
51.6258957
],
...
]
]
},
"teryt": "06",
"sort1": "lubelskie",
"ftsid": "pl.pzgik.200/a1e8cdc7-d26d-4982-946f-ff3e5082eecd",
"id": 366264,
"woj_nazwa": "lubelskie",
"center": "51.21654457397616, 22.903089541282053",
"record": {
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
21.61554253,
51.61756198
],
[
21.64009108,
51.6258957
],
...
]
]
},
"type": "Feature",
"id": 366264,
"properties": {
"id": 366264,
"woj_id_lokalnyid": "a1e8cdc7-d26d-4982-946f-ff3e5082eecd",
"gm_id_wersjaid": null,
"gm_idteryt": null,
"woj_id_wersjaid": "2012-09-27T13:45:12+02:00",
"woj_id_przestrzenNazw": "PL.PZGIK.200",
"woj_nazwa": "lubelskie",
"pow_id_przestrzenNazw": null,
"gm_id_lokalnyid": null,
"gm_nazwa": null,
"woj_idteryt": "06",
"pow_idteryt": null,
"pow_id_wersjaid": null,
"gm_id_przestrzenNazw": null,
"pow_nazwa": null,
"pow_id_lokalnyid": null
}
},
"es_metadata_id": "366264"
},
"relevance": 1.0,
"source": "CAPAP"
}
]
3.2. Usługa Odwrotnego Geokodowania
Usługa udostępnia mechanizmy geokodowania odwrotnego. Pozwala uzyskać atrybuty obiektów znalezionych w oparciu o podaną lokalizację (punkt). W zależności od wybranego (wybranych) zasobów referencyjnych będzie to obiekt najbliższy - dla danych referencyjnych punktowych (z ograniczeniem maksymalnej odległości) lub obiekt w którym leży podana lokalizacja - dla danych referencyjnych poligonowych.
3.2.1. Odwrotne geokodowanie - punkty adresowe
GET /api/fts/rgc/adr
Opis
wg. odległości, zwraca najbliższy
Parametry
Typ | Nazwa | Opis | Schemat |
---|---|---|---|
Query |
d |
odległość [metry] |
number (double) |
Query |
x |
x (lon) |
number (double) |
Query |
y |
y (lat) |
number (double) |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Przykład: Treść (URL) zapytania GET
-
Metoda HTTP: GET
-
URL:
https://capap.gugik.gov.pl/api/fts/rgc/adr?x=16.925&y=51.089&d=500
Przykład: cURL
curl -X GET 'https://capap.gugik.gov.pl/api/fts/rgc/adr?x=16.925&y=51.089&d=500'
Przykład: Odpowiedź
{
"single": {
"name": "Chłopska 60 - Smolec",
"id": 137040022,
"desc": "55-080 ulica Kąty Wrocławskie wrocławski dolnośląskie",
"shortDesc": "Chłopska 60 Smolec",
"longDesc": "ulica 55-080 Kąty Wrocławskie wrocławski dolnośląskie",
"filterKeys": [
"Smolec",
"dolnośląskie"
],
"geometry": {
"type": "Point",
"coordinates": [
16.92229107,
51.09164773
]
},
"ul_pelna": "ulica Chłopska",
"miejsc_pelna": " Smolec",
"sort1": "60",
"loduri": "https://pzgik.geoportal.gov.pl/prg/PunktAdresowy/PL.PZGIK.200.4d0dd699-0d53-4fee-b8f8-dd27570261fe",
"teryt": "0223043",
"ftsid": "pl.pzgik.200/4d0dd699-0d53-4fee-b8f8-dd27570261fe",
"miejsc_nazwa": "Smolec",
"pkt_numer": "60",
"ul_nazwa_przed1": null,
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": "Chłopska",
"ul_nazwa_czesc": null,
"ul_typ": "ulica",
"pkt_kodPocztowy": "55-080",
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Kąty Wrocławskie",
"pow_nazwa": "wrocławski",
"center": "51.09164772823128, 16.922291067245677",
"pkt_numer_n1": null,
"pkt_numer_n2": null,
"record": {
"id": 137040022,
"geometry": {
"type": "Point",
"coordinates": [
16.92229107,
51.09164773
]
},
"type": "Feature",
"properties": {
"id": 137040022,
"loduri": "https://pzgik.geoportal.gov.pl/prg/PunktAdresowy/PL.PZGIK.200.4d0dd699-0d53-4fee-b8f8-dd27570261fe",
"pkt_id_przestrzenNazw": "PL.PZGIK.200",
"miejsc_nazwa": "Smolec",
"gm_idteryt": "0223043",
"miejsc_n_nazwa": null,
"pkt_numer": "60",
"ul_nazwa_przed1": null,
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": "Chłopska",
"pkt_status": "istniejacy",
"pkt_id_lokalnyid": "4d0dd699-0d53-4fee-b8f8-dd27570261fe",
"ul_nazwa_czesc": null,
"woj_idteryt": "02",
"ul_typ": "ulica",
"ul_idTERYT": "02750",
"pkt_id_wersjaid": "2017-11-17T14:41:47+02:00",
"pow_idteryt": "0223",
"pkt_kodPocztowy": "55-080",
"miejsc_n_idTERYT": null,
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Kąty Wrocławskie",
"pow_nazwa": "wrocławski",
"miejsc_idTERYT": "0875187"
}
},
"es_metadata_id": "137040022"
},
"distance": 349.96274659489956,
"relevance": 0.0,
"source": "CAPAP"
}
3.2.2. Odwrotne geokodowanie - dzeiałki
GET /api/fts/rgc/dze
Parametry
Typ | Nazwa | Opis | Schemat |
---|---|---|---|
Query |
x |
x (lon) |
number (double) |
Query |
y |
y (lat) |
number (double) |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Przykład: Treść (URL) zapytania GET
-
Metoda HTTP: GET
-
URL:
https://capap.gugik.gov.pl/api/fts/rgc/dze?x=16.925&y=51.089&d=500
Przykład: cURL
curl -X GET 'https://capap.gugik.gov.pl/api/fts/rgc/dze?x=16.925&y=51.089&d=500'
Przykład: Odpowiedź
{
"single": {
"id": 10815535,
"name": "026401_1.0038.AR_28.18/1 Wrocław Muchobór Wielki 18/1",
"desc": "0264011",
"shortDesc": "026401_1.0038.AR_28.18/1 Wrocław Muchobór Wielki 18/1",
"longDesc": "0264011",
"filterKeys": [
"Wrocław",
"Wrocław",
"dolnośląskie",
"0264011"
],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
16.9218654,
51.08972848
],
[
16.92664815,
51.08899423
],
[
16.92641821,
51.08881445
],
[
16.92624425,
51.08869252
],
[
16.92181388,
51.08938013
],
[
16.9218654,
51.08972848
]
]
]
},
"gm_nazwa": "Wrocław",
"pow_nazwa": "Wrocław",
"woj_nazwa": "dolnośląskie",
"nr_dz": "18/1",
"idswde": "026401_1.0038.AR_28.18/1",
"miejsc_nazwa": "Wrocław Muchobór Wielki",
"ftsid": null,
"center": "51.089, 16.924",
"record": {
"id": 10815535,
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
16.9218654,
51.08972848
],
[
16.92664815,
51.08899423
],
[
16.92641821,
51.08881445
],
[
16.92624425,
51.08869252
],
[
16.92181388,
51.08938013
],
[
16.9218654,
51.08972848
]
]
]
},
"type": "Feature",
"properties": {
"ZRD": "LPIS",
"MIEJSC": "Wrocław Muchobór Wielki",
"IDENTYFIKATOR": "026401_1.0038.AR_28.18/1",
"NUMER": "18/1",
"POWIAT": "Wrocław",
"POWIERZCHNIA": 12934,
"OBJECTID": 10815535,
"GMINA": "Wrocław",
"WOJEWODZTWO": "dolnośląskie",
"TERYT": "0264011",
"OBREB_EWIDENCYJNY": "Muchobór Wielki"
}
},
"es_metadata_id": "10815535"
},
"distance": 0.0,
"relevance": 0.0,
"source": "CAPAP"
}
3.2.3. Odwrotne geokodowanie - dze LPIS
GET /api/fts/rgc/dze_lpis
Opis
tylko lpis
Parametry
Typ | Nazwa | Opis | Schemat |
---|---|---|---|
Query |
x |
x (lon) |
number (double) |
Query |
y |
y (lat) |
number (double) |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść (URL) zapytania GET
-
Metoda HTTP: GET
-
URL:
https://capap.gugik.gov.pl/api/fts/rgc/dze_lpis?x=16.925&y=51.089&d=500
Przykład: cURL
curl -X GET 'https://capap.gugik.gov.pl/api/fts/rgc/dze_lpis?x=16.925&y=51.089&d=500'
Przykład: Odpowiedź
{
"single": {
"id": 10815535,
"name": "026401_1.0038.AR_28.18/1 Wrocław Muchobór Wielki 18/1",
"desc": "0264011",
"shortDesc": "026401_1.0038.AR_28.18/1 Wrocław Muchobór Wielki 18/1",
"longDesc": "0264011",
"filterKeys": [
"Wrocław",
"Wrocław",
"dolnośląskie",
"0264011"
],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
16.9218654,
51.08972848
],
[
16.92664815,
51.08899423
],
[
16.92641821,
51.08881445
],
[
16.92624425,
51.08869252
],
[
16.92181388,
51.08938013
],
[
16.9218654,
51.08972848
]
]
]
},
"gm_nazwa": "Wrocław",
"pow_nazwa": "Wrocław",
"woj_nazwa": "dolnośląskie",
"nr_dz": "18/1",
"idswde": "026401_1.0038.AR_28.18/1",
"miejsc_nazwa": "Wrocław Muchobór Wielki",
"ftsid": null,
"center": "51.089, 16.924",
"record": {
"id": 10815535,
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
16.9218654,
51.08972848
],
[
16.92664815,
51.08899423
],
[
16.92641821,
51.08881445
],
[
16.92624425,
51.08869252
],
[
16.92181388,
51.08938013
],
[
16.9218654,
51.08972848
]
]
]
},
"type": "Feature",
"properties": {
"ZRD": "LPIS",
"MIEJSC": "Wrocław Muchobór Wielki",
"IDENTYFIKATOR": "026401_1.0038.AR_28.18/1",
"NUMER": "18/1",
"POWIAT": "Wrocław",
"POWIERZCHNIA": 12934,
"OBJECTID": 10815535,
"GMINA": "Wrocław",
"WOJEWODZTWO": "dolnośląskie",
"TERYT": "0264011",
"OBREB_EWIDENCYJNY": "Muchobór Wielki"
}
},
"es_metadata_id": "10815535"
},
"distance": 0.0,
"relevance": 0.0,
"source": "CAPAP"
}
3.2.4. Odwrotne geokodowanie - dze ZSIN
GET /api/fts/rgc/dze_zsin
Opis
tylko ZSIN
Parametry
Typ | Nazwa | Opis | Schemat |
---|---|---|---|
Query |
x |
x (lon) |
number (double) |
Query |
y |
y (lat) |
number (double) |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść (URL) zapytania GET
-
Metoda HTTP: GET
-
URL:
https://capap.gugik.gov.pl/api/fts/rgc/dze_zsin?x=16.925&y=51.089&d=500
Przykład: cURL
curl -X GET 'https://capap.gugik.gov.pl/api/fts/rgc/dze_zsin?x=16.925&y=51.089&d=500'
Przykład: Odpowiedź
{"relevance":0.0,"source":"CAPAP"}
3.2.5. Odwrotne geokodowanie - AU (gminy)
GET /api/fts/rgc/gmi
Parametry
Typ | Nazwa | Opis | Schemat |
---|---|---|---|
Query |
x |
x (lon) |
number (double) |
Query |
y |
y (lat) |
number (double) |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść (URL) zapytania GET
-
Metoda HTTP: GET
-
URL:
https://capap.gugik.gov.pl/api/fts/rgc/gmi?x=16.925&y=51.089&d=500
Przykład: cURL
curl -X GET 'https://capap.gugik.gov.pl/api/fts/rgc/gmi?x=16.925&y=51.089&d=500'
Przykład: Odpowiedź
{
"single": {
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
16.92790759,
51.08893336
],
[
16.92157437,
51.0888209
],
...
]
]
},
"sort1": "Wrocław",
"name": "Wrocław 0264011",
"desc": "Wrocław dolnośląskie",
"shortDesc": "Wrocław 0264011 1d3d85c1-023a-4694-8b9f-e76e73b49b0f",
"longDesc": "Wrocław dolnośląskie PL.PZGIK.200/1d3d85c1-023a-4694-8b9f-e76e73b49b0f",
"filterKeys": [
"dolnośląskie",
"Wrocław"
],
"teryt": "0264011",
"ftsid": "pl.pzgik.200/1d3d85c1-023a-4694-8b9f-e76e73b49b0f",
"id": "367326-15",
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Wrocław",
"center": "51.127695503264064, 16.996109471371156",
"pow_nazwa": "Wrocław",
"record": {
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
17.02806005,
51.0426686
],
[
17.02041637,
51.04493935
],
...
]
]
},
"type": "Feature",
"id": "367326-15",
"properties": {
"woj_id_lokalnyid": "f1ef3856-09ba-4e3d-af9d-a876794d570f",
"gm_id_wersjaid": "2012-09-26T22:18:07+02:00",
"gm_idteryt": "0264011",
"woj_id_wersjaid": "2017-10-10T00:00:00+02:00",
"woj_id_przestrzenNazw": "PL.PZGIK.200",
"id": "367326-15",
"woj_nazwa": "dolnośląskie",
"pow_id_przestrzenNazw": "PL.PZGIK.200",
"gm_id_lokalnyid": "1d3d85c1-023a-4694-8b9f-e76e73b49b0f",
"gm_nazwa": "Wrocław",
"woj_idteryt": "02",
"pow_idteryt": "0264",
"pow_id_wersjaid": "2012-09-27T07:36:28+02:00",
"gm_id_przestrzenNazw": "PL.PZGIK.200",
"pow_nazwa": "Wrocław",
"pow_id_lokalnyid": "3fa081d3-e6b9-4653-9cd3-c7dd6f53ea81"
}
},
"es_metadata_id": "367326-15"
},
"distance": 0.0,
"relevance": 0.0,
"source": "CAPAP"
}
3.2.6. Odwrotne geokodowanie - prngjo
GET /api/fts/rgc/prngjo
Opis
wg. odległości, zwraca najbliższy
Parametry
Typ | Nazwa | Opis | Schemat |
---|---|---|---|
Query |
d |
odległość [metry] |
number (double) |
Query |
x |
x (lon) |
number (double) |
Query |
y |
y (lat) |
number (double) |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść (URL) zapytania GET
-
Metoda HTTP: GET
-
URL:
https://capap.gugik.gov.pl/api/fts/rgc/prngjo?x=16.925&y=51.089&d=5000
Przykład: cURL
curl -X GET 'https://capap.gugik.gov.pl/api/fts/rgc/prngjo?x=16.925&y=51.089&d=5000'
Przykład: Odpowiedź
{
"single": {
"id": 1652715,
"name": "Rupalowo",
"desc": "Krzeptów - miejscowość, część wsi",
"shortDesc": "Rupalowo",
"longDesc": "Krzeptów część wsi",
"filterKeys": [
"miejscowość",
"niestandaryzowana",
"część wsi",
"Punkt centralny"
],
"geometry": {
"type": "Point",
"coordinates": [
16.92097672,
51.09711835
]
},
"sort1": "Rupalowo",
"ftsid": "pl.pzgik.204.prng/00000000-0000-0000-0000-000000118455",
"gm_nazwa": null,
"pow_nazwa": null,
"woj_nazwa": null,
"teryt": null,
"center": "51.0971183532608, 16.9209767182813",
"record": {
"id": 1652715,
"geometry": {
"type": "Point",
"coordinates": [
16.92097672,
51.09711835
]
},
"type": "Feature",
"properties": {
"LODURI": "https://pzgik.geoportal.gov.pl/prng/Miejscowosc/PL.PZGiK.204.PRNG.00000000-0000-0000-0000-000000118455-",
"ID_W_SYS_ZEWNETRZNYM": null,
"NAZWA_SKROCONA": null,
"KLASA": "miejscowość",
"ID_PRNG": 118455,
"OBJECTID": 1652715,
"SYSTEM_ZEWNETRZNY": null,
"STATUS": "niestandaryzowana",
"NADRZEDNY": "Krzeptów",
"NAZWA_URZEDOWA": null,
"RODZAJ": "część wsi",
"ID_JEDN_OSAD": 620868,
"NAZWA_PRZYMIOTNIK": null,
"ID_IIP": "00000000-0000-0000-0000-000000118455",
"NAZWA_MN_NAR": null,
"NAZWA_DOPELNIACZ": "-wa",
"NAZWA_MIANOWNIK": "Rupalowo",
"FUNKCJA_ADM": null
}
},
"es_metadata_id": "1652715"
},
"distance": 945.4349603491526,
"relevance": 0.0,
"source": "CAPAP"
}
3.2.7. Odwrotne geokodowanie - prngof
GET /api/fts/rgc/prngof
Opis
wg. odległości, zwraca najbliższy
Parametry
Typ | Nazwa | Opis | Schemat |
---|---|---|---|
Query |
d |
odległość [metry] |
number (double) |
Query |
x |
x (lon) |
number (double) |
Query |
y |
y (lat) |
number (double) |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść (URL) zapytania GET
-
Metoda HTTP: GET
-
URL:
https://capap.gugik.gov.pl/api/fts/rgc/prngof?x=16.925&y=51.089&d=5000
Przykład: cURL
curl -X GET 'https://capap.gugik.gov.pl/api/fts/rgc/prngof?x=16.925&y=51.089&d=5000'
Przykład: Odpowiedź
{
"single": {
"id": 1512177,
"name": "Kacza Góra",
"desc": " - obiekt ukształtowania terenu, wzgórze, wzniesienie",
"shortDesc": "Kacza Góra",
"longDesc": " obiekt ukształtowania terenu wzgórze, wzniesienie",
"filterKeys": [
"obiekt ukształtowania terenu",
"niestandaryzowana",
"wzgórze, wzniesienie",
"Punkt centralny"
],
"geometry": {
"type": "Point",
"coordinates": [
16.92107095,
51.09228929
]
},
"sort1": "Kacza Góra",
"prng_klasa": "obiekt ukształtowania terenu",
"prng_rodzaj": "wzgórze, wzniesienie",
"ftsid": "pl.pzgik.204.prng/00000000-0000-0000-0000-000000235708",
"gm_nazwa": null,
"pow_nazwa": null,
"woj_nazwa": null,
"teryt": null,
"center": "51.0922892946415, 16.9210709538218",
"record": {
"id": 1512177,
"geometry": {
"type": "Point",
"coordinates": [
16.92107095,
51.09228929
]
},
"type": "Feature",
"properties": {
"LODURI": "https://pzgik.geoportal.gov.pl/prng/Miejscowosc/PL.PZGiK.204.PRNG.00000000-0000-0000-0000-000000235708-",
"ID_W_SYS_ZEWNETRZNYM": null,
"NAZWA_SKROCONA": null,
"KLASA": "obiekt ukształtowania terenu",
"ID_PRNG": 235708,
"OBJECTID": 1512177,
"SYSTEM_ZEWNETRZNY": null,
"STATUS": "niestandaryzowana",
"NADRZEDNY": null,
"NAZWA_URZEDOWA": null,
"RODZAJ": "wzgórze, wzniesienie",
"NAZWA_PRZYMIOTNIK": null,
"ID_IIP": "00000000-0000-0000-0000-000000235708",
"NAZWA_MN_NAR": null,
"NAZWA_DOPELNIACZ": "-czej -ry",
"NAZWA_MIANOWNIK": "Kacza Góra"
}
},
"es_metadata_id": "1512177"
},
"distance": 457.24655836050357,
"relevance": 0.0,
"source": "CAPAP"
}
3.2.8. Odwrotne geokodowanie - wiele
POST /api/fts/rgc/rgcm
Opis
Odwrotne geokodowanie dla wielu punktów, przy użyciu wielu źródeł
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< RevgcResSingle > array |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
{
"cfg": [
{
"layer": "adr",
"maxDistance": 500
},
{
"layer": "dze"
},
{
"layer": "gmi"
},
{
"layer": "prngof",
"maxDistance": 5000
},
{
"layer": "prngjo",
"maxDistance": 5000
}
],
"reqs": [
{
"src": "abc",
"id": "myId01",
"x": 16.925,
"y": 51.089
},
{
"src": "abc",
"id": "myId01",
"x": 15.925,
"y": 51.089
}
]
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"cfg": [
{
"layer": "adr",
"maxDistance": 500
},
{
"layer": "dze"
},
{
"layer": "gmi"
},
{
"layer": "prngof",
"maxDistance": 5000
},
{
"layer": "prngjo",
"maxDistance": 5000
}
],
"reqs": [
{
"src": "abc",
"id": "myId01",
"x": 16.925,
"y": 51.089
},
{
"src": "abc",
"id": "myId01",
"x": 15.925,
"y": 51.089
}
]
}
' \
https://capap.gugik.gov.pl/api/fts/rgc/rgcm
Przykład: Odpowiedź
[
{
"id": "myId01",
"src": "abc",
"x": 16.925,
"y": 51.089,
"found": {
"adr": {
"single": {
"name": "Chłopska 60 - Smolec",
"id": 137040022,
"desc": "55-080 ulica Kąty Wrocławskie wrocławski dolnośląskie",
"shortDesc": "Chłopska 60 Smolec",
"longDesc": "ulica 55-080 Kąty Wrocławskie wrocławski dolnośląskie",
"filterKeys": [
"Smolec",
"dolnośląskie"
],
"geometry": {
"type": "Point",
"coordinates": [
16.92229107,
51.09164773
]
},
"ul_pelna": "ulica Chłopska",
"miejsc_pelna": " Smolec",
"sort1": "60",
"loduri": "https://pzgik.geoportal.gov.pl/prg/PunktAdresowy/PL.PZGIK.200.4d0dd699-0d53-4fee-b8f8-dd27570261fe",
"teryt": "0223043",
"ftsid": "pl.pzgik.200/4d0dd699-0d53-4fee-b8f8-dd27570261fe",
"miejsc_nazwa": "Smolec",
"pkt_numer": "60",
"ul_nazwa_przed1": null,
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": "Chłopska",
"ul_nazwa_czesc": null,
"ul_typ": "ulica",
"pkt_kodPocztowy": "55-080",
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Kąty Wrocławskie",
"pow_nazwa": "wrocławski",
"center": "51.09164772823128, 16.922291067245677",
"pkt_numer_n1": null,
"pkt_numer_n2": null,
"record": {
"id": 137040022,
"geometry": {
"type": "Point",
"coordinates": [
16.92229107,
51.09164773
]
},
"type": "Feature",
"properties": {
"id": 137040022,
"loduri": "https://pzgik.geoportal.gov.pl/prg/PunktAdresowy/PL.PZGIK.200.4d0dd699-0d53-4fee-b8f8-dd27570261fe",
"pkt_id_przestrzenNazw": "PL.PZGIK.200",
"miejsc_nazwa": "Smolec",
"gm_idteryt": "0223043",
"miejsc_n_nazwa": null,
"pkt_numer": "60",
"ul_nazwa_przed1": null,
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": "Chłopska",
"pkt_status": "istniejacy",
"pkt_id_lokalnyid": "4d0dd699-0d53-4fee-b8f8-dd27570261fe",
"ul_nazwa_czesc": null,
"woj_idteryt": "02",
"ul_typ": "ulica",
"ul_idTERYT": "02750",
"pkt_id_wersjaid": "2017-11-17T14:41:47+02:00",
"pow_idteryt": "0223",
"pkt_kodPocztowy": "55-080",
"miejsc_n_idTERYT": null,
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Kąty Wrocławskie",
"pow_nazwa": "wrocławski",
"miejsc_idTERYT": "0875187"
}
},
"es_metadata_id": "137040022"
},
"distance": 349.96274659489956,
"relevance": 0.0,
"source": "CAPAP"
},
"dze": {
"single": {
"id": 10815535,
"name": "026401_1.0038.AR_28.18/1 Wrocław Muchobór Wielki 18/1",
"desc": "0264011",
"shortDesc": "026401_1.0038.AR_28.18/1 Wrocław Muchobór Wielki 18/1",
"longDesc": "0264011",
"filterKeys": [
"Wrocław",
"Wrocław",
"dolnośląskie",
"0264011"
],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
16.9218654,
51.08972848
],
[
16.92664815,
51.08899423
],
[
16.92641821,
51.08881445
],
[
16.92624425,
51.08869252
],
[
16.92181388,
51.08938013
],
[
16.9218654,
51.08972848
]
]
]
},
"gm_nazwa": "Wrocław",
"pow_nazwa": "Wrocław",
"woj_nazwa": "dolnośląskie",
"nr_dz": "18/1",
"idswde": "026401_1.0038.AR_28.18/1",
"miejsc_nazwa": "Wrocław Muchobór Wielki",
"ftsid": null,
"center": "51.089, 16.924",
"record": {
"id": 10815535,
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
16.9218654,
51.08972848
],
[
16.92664815,
51.08899423
],
[
16.92641821,
51.08881445
],
[
16.92624425,
51.08869252
],
[
16.92181388,
51.08938013
],
[
16.9218654,
51.08972848
]
]
]
},
"type": "Feature",
"properties": {
"ZRD": "LPIS",
"MIEJSC": "Wrocław Muchobór Wielki",
"IDENTYFIKATOR": "026401_1.0038.AR_28.18/1",
"NUMER": "18/1",
"POWIAT": "Wrocław",
"POWIERZCHNIA": 12934,
"OBJECTID": 10815535,
"GMINA": "Wrocław",
"WOJEWODZTWO": "dolnośląskie",
"TERYT": "0264011",
"OBREB_EWIDENCYJNY": "Muchobór Wielki"
}
},
"es_metadata_id": "10815535"
},
"distance": 0.0,
"relevance": 0.0,
"source": "CAPAP"
},
"gmi": {
"single": {
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
16.92790759,
51.08893336
],
[
16.92157437,
51.0888209
],
...
]
]
},
"sort1": "Wrocław",
"name": "Wrocław 0264011",
"desc": "Wrocław dolnośląskie",
"shortDesc": "Wrocław 0264011 1d3d85c1-023a-4694-8b9f-e76e73b49b0f",
"longDesc": "Wrocław dolnośląskie PL.PZGIK.200/1d3d85c1-023a-4694-8b9f-e76e73b49b0f",
"filterKeys": [
"dolnośląskie",
"Wrocław"
],
"teryt": "0264011",
"ftsid": "pl.pzgik.200/1d3d85c1-023a-4694-8b9f-e76e73b49b0f",
"id": "367326-15",
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Wrocław",
"center": "51.127695503264064, 16.996109471371156",
"pow_nazwa": "Wrocław",
"record": {
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
17.02806005,
51.0426686
],
[
17.02041637,
51.04493935
],
...
]
]
},
"type": "Feature",
"id": "367326-15",
"properties": {
"woj_id_lokalnyid": "f1ef3856-09ba-4e3d-af9d-a876794d570f",
"gm_id_wersjaid": "2012-09-26T22:18:07+02:00",
"gm_idteryt": "0264011",
"woj_id_wersjaid": "2017-10-10T00:00:00+02:00",
"woj_id_przestrzenNazw": "PL.PZGIK.200",
"id": "367326-15",
"woj_nazwa": "dolnośląskie",
"pow_id_przestrzenNazw": "PL.PZGIK.200",
"gm_id_lokalnyid": "1d3d85c1-023a-4694-8b9f-e76e73b49b0f",
"gm_nazwa": "Wrocław",
"woj_idteryt": "02",
"pow_idteryt": "0264",
"pow_id_wersjaid": "2012-09-27T07:36:28+02:00",
"gm_id_przestrzenNazw": "PL.PZGIK.200",
"pow_nazwa": "Wrocław",
"pow_id_lokalnyid": "3fa081d3-e6b9-4653-9cd3-c7dd6f53ea81"
}
},
"es_metadata_id": "367326-15"
},
"distance": 0.0,
"relevance": 0.0,
"source": "CAPAP"
},
"prngof": {
"single": {
"id": 1512177,
"name": "Kacza Góra",
"desc": " - obiekt ukształtowania terenu, wzgórze, wzniesienie",
"shortDesc": "Kacza Góra",
"longDesc": " obiekt ukształtowania terenu wzgórze, wzniesienie",
"filterKeys": [
"obiekt ukształtowania terenu",
"niestandaryzowana",
"wzgórze, wzniesienie",
"Punkt centralny"
],
"geometry": {
"type": "Point",
"coordinates": [
16.92107095,
51.09228929
]
},
"sort1": "Kacza Góra",
"prng_klasa": "obiekt ukształtowania terenu",
"prng_rodzaj": "wzgórze, wzniesienie",
"ftsid": "pl.pzgik.204.prng/00000000-0000-0000-0000-000000235708",
"gm_nazwa": null,
"pow_nazwa": null,
"woj_nazwa": null,
"teryt": null,
"center": "51.0922892946415, 16.9210709538218",
"record": {
"id": 1512177,
"geometry": {
"type": "Point",
"coordinates": [
16.92107095,
51.09228929
]
},
"type": "Feature",
"properties": {
"LODURI": "https://pzgik.geoportal.gov.pl/prng/Miejscowosc/PL.PZGiK.204.PRNG.00000000-0000-0000-0000-000000235708-",
"ID_W_SYS_ZEWNETRZNYM": null,
"NAZWA_SKROCONA": null,
"KLASA": "obiekt ukształtowania terenu",
"ID_PRNG": 235708,
"OBJECTID": 1512177,
"SYSTEM_ZEWNETRZNY": null,
"STATUS": "niestandaryzowana",
"NADRZEDNY": null,
"NAZWA_URZEDOWA": null,
"RODZAJ": "wzgórze, wzniesienie",
"NAZWA_PRZYMIOTNIK": null,
"ID_IIP": "00000000-0000-0000-0000-000000235708",
"NAZWA_MN_NAR": null,
"NAZWA_DOPELNIACZ": "-czej -ry",
"NAZWA_MIANOWNIK": "Kacza Góra"
}
},
"es_metadata_id": "1512177"
},
"distance": 457.24655836050357,
"relevance": 0.0,
"source": "CAPAP"
},
"prngjo": {
"single": {
"id": 1652715,
"name": "Rupalowo",
"desc": "Krzeptów - miejscowość, część wsi",
"shortDesc": "Rupalowo",
"longDesc": "Krzeptów część wsi",
"filterKeys": [
"miejscowość",
"niestandaryzowana",
"część wsi",
"Punkt centralny"
],
"geometry": {
"type": "Point",
"coordinates": [
16.92097672,
51.09711835
]
},
"sort1": "Rupalowo",
"ftsid": "pl.pzgik.204.prng/00000000-0000-0000-0000-000000118455",
"gm_nazwa": null,
"pow_nazwa": null,
"woj_nazwa": null,
"teryt": null,
"center": "51.0971183532608, 16.9209767182813",
"record": {
"id": 1652715,
"geometry": {
"type": "Point",
"coordinates": [
16.92097672,
51.09711835
]
},
"type": "Feature",
"properties": {
"LODURI": "https://pzgik.geoportal.gov.pl/prng/Miejscowosc/PL.PZGiK.204.PRNG.00000000-0000-0000-0000-000000118455-",
"ID_W_SYS_ZEWNETRZNYM": null,
"NAZWA_SKROCONA": null,
"KLASA": "miejscowość",
"ID_PRNG": 118455,
"OBJECTID": 1652715,
"SYSTEM_ZEWNETRZNY": null,
"STATUS": "niestandaryzowana",
"NADRZEDNY": "Krzeptów",
"NAZWA_URZEDOWA": null,
"RODZAJ": "część wsi",
"ID_JEDN_OSAD": 620868,
"NAZWA_PRZYMIOTNIK": null,
"ID_IIP": "00000000-0000-0000-0000-000000118455",
"NAZWA_MN_NAR": null,
"NAZWA_DOPELNIACZ": "-wa",
"NAZWA_MIANOWNIK": "Rupalowo",
"FUNKCJA_ADM": null
}
},
"es_metadata_id": "1652715"
},
"distance": 945.4349603491526,
"relevance": 0.0,
"source": "CAPAP"
}
}
},
{
"id": "myId01",
"src": "abc",
"x": 15.925,
"y": 51.089,
"found": {
"adr": {
"single": {
"name": "Wilków 51",
"id": 129481401,
"desc": "59-500 Złotoryja złotoryjski dolnośląskie",
"shortDesc": "51 Wilków",
"longDesc": "59-500 Złotoryja złotoryjski dolnośląskie",
"filterKeys": [
"Wilków",
"dolnośląskie"
],
"geometry": {
"type": "Point",
"coordinates": [
15.92665517,
51.09081381
]
},
"ul_pelna": "",
"miejsc_pelna": " Wilków",
"sort1": "51",
"loduri": "https://pzgik.geoportal.gov.pl/prg/PunktAdresowy/PL.PZGIK.200.290d3f3f-a647-4671-a586-af4589247863",
"teryt": "0226062",
"ftsid": "pl.pzgik.200/290d3f3f-a647-4671-a586-af4589247863",
"miejsc_nazwa": "Wilków",
"pkt_numer": "51",
"ul_nazwa_przed1": null,
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": null,
"ul_nazwa_czesc": null,
"ul_typ": null,
"pkt_kodPocztowy": "59-500",
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Złotoryja",
"pow_nazwa": "złotoryjski",
"center": "51.09081380964888, 15.926655174695636",
"pkt_numer_n1": null,
"pkt_numer_n2": null,
"record": {
"id": 129481401,
"geometry": {
"type": "Point",
"coordinates": [
15.92665517,
51.09081381
]
},
"type": "Feature",
"properties": {
"id": 129481401,
"loduri": "https://pzgik.geoportal.gov.pl/prg/PunktAdresowy/PL.PZGIK.200.290d3f3f-a647-4671-a586-af4589247863",
"pkt_id_przestrzenNazw": "PL.PZGIK.200",
"miejsc_nazwa": "Wilków",
"gm_idteryt": "0226062",
"miejsc_n_nazwa": null,
"pkt_numer": "51",
"ul_nazwa_przed1": null,
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": null,
"pkt_status": "istniejacy",
"pkt_id_lokalnyid": "290d3f3f-a647-4671-a586-af4589247863",
"ul_nazwa_czesc": null,
"woj_idteryt": "02",
"ul_typ": null,
"ul_idTERYT": null,
"pkt_id_wersjaid": "2016-11-25T15:15:31+02:00",
"pow_idteryt": "0226",
"pkt_kodPocztowy": "59-500",
"miejsc_n_idTERYT": null,
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Złotoryja",
"pow_nazwa": "złotoryjski",
"miejsc_idTERYT": "0368728"
}
},
"es_metadata_id": "129481401"
},
"distance": 232.4637286375988,
"relevance": 0.0,
"source": "CAPAP"
},
"dze": {
"single": {
"id": 10958369,
"name": "022606_2.0015.404 Wilków 404",
"desc": "0226062",
"shortDesc": "022606_2.0015.404 Wilków 404",
"longDesc": "0226062",
"filterKeys": [
"złotoryjski",
"Złotoryja",
"dolnośląskie",
"0226062"
],
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
15.91398563,
51.08135778
],
[
15.91408547,
51.08147811
],
...
]
]
},
"gm_nazwa": "Złotoryja",
"pow_nazwa": "złotoryjski",
"woj_nazwa": "dolnośląskie",
"nr_dz": "404",
"idswde": "022606_2.0015.404",
"miejsc_nazwa": "Wilków",
"ftsid": null,
"center": "51.085, 15.92",
"record": {
"id": 10958369,
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
15.91398563,
51.08135778
],
[
15.91408547,
51.08147811
],
...
]
]
},
"type": "Feature",
"properties": {
"ZRD": "LPIS",
"MIEJSC": "Wilków",
"IDENTYFIKATOR": "022606_2.0015.404",
"NUMER": "404",
"POWIAT": "złotoryjski",
"POWIERZCHNIA": 584180,
"OBJECTID": 10958369,
"GMINA": "Złotoryja",
"WOJEWODZTWO": "dolnośląskie",
"TERYT": "0226062",
"OBREB_EWIDENCYJNY": "WILKÓW"
}
},
"es_metadata_id": "10958369"
},
"distance": 0.0,
"relevance": 0.0,
"source": "CAPAP"
},
"gmi": {
"single": {
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
15.91573187,
51.10464553
],
[
15.9227815,
51.10483144
],
...
]
]
},
"sort1": "Złotoryja",
"name": "Złotoryja 0226062",
"desc": "złotoryjski dolnośląskie",
"shortDesc": "Złotoryja 0226062 ee903b58-86ef-4341-9a66-d923c400ef13",
"longDesc": "złotoryjski dolnośląskie PL.PZGIK.200/ee903b58-86ef-4341-9a66-d923c400ef13",
"filterKeys": [
"dolnośląskie",
"złotoryjski"
],
"teryt": "0226062",
"ftsid": "pl.pzgik.200/ee903b58-86ef-4341-9a66-d923c400ef13",
"id": "367323-6",
"woj_nazwa": "dolnośląskie",
"gm_nazwa": "Złotoryja",
"center": "51.14087712644706, 15.965339075044",
"pow_nazwa": "złotoryjski",
"record": {
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
15.9405129,
51.06549715
],
[
15.93675998,
51.06584597
],
...
]
]
},
"type": "Feature",
"id": "367323-6",
"properties": {
"woj_id_lokalnyid": "f1ef3856-09ba-4e3d-af9d-a876794d570f",
"gm_id_wersjaid": "2012-09-26T22:18:01+02:00",
"gm_idteryt": "0226062",
"woj_id_wersjaid": "2017-10-10T00:00:00+02:00",
"woj_id_przestrzenNazw": "PL.PZGIK.200",
"id": "367323-6",
"woj_nazwa": "dolnośląskie",
"pow_id_przestrzenNazw": "PL.PZGIK.200",
"gm_id_lokalnyid": "ee903b58-86ef-4341-9a66-d923c400ef13",
"gm_nazwa": "Złotoryja",
"woj_idteryt": "02",
"pow_idteryt": "0226",
"pow_id_wersjaid": "2012-09-27T07:36:28+02:00",
"gm_id_przestrzenNazw": "PL.PZGIK.200",
"pow_nazwa": "złotoryjski",
"pow_id_lokalnyid": "07f182b1-9146-43e5-a62d-836c211f9ff1"
}
},
"es_metadata_id": "367323-6"
},
"distance": 0.0,
"relevance": 0.0,
"source": "CAPAP"
},
"prngof": {
"single": {
"id": 1522929,
"name": "Kozia",
"desc": " - obiekt ukształtowania terenu, góra, szczyt",
"shortDesc": "Kozia",
"longDesc": " obiekt ukształtowania terenu góra, szczyt",
"filterKeys": [
"obiekt ukształtowania terenu",
"urzędowa",
"góra, szczyt",
"Punkt centralny"
],
"geometry": {
"type": "Point",
"coordinates": [
15.9374693,
51.09385779
]
},
"sort1": "Kozia",
"prng_klasa": "obiekt ukształtowania terenu",
"prng_rodzaj": "góra, szczyt",
"ftsid": "pl.pzgik.204.prng/00000000-0000-0000-0000-000000165905",
"gm_nazwa": null,
"pow_nazwa": null,
"woj_nazwa": null,
"teryt": null,
"center": "51.093857794512, 15.9374693040306",
"record": {
"id": 1522929,
"geometry": {
"type": "Point",
"coordinates": [
15.9374693,
51.09385779
]
},
"type": "Feature",
"properties": {
"LODURI": "https://pzgik.geoportal.gov.pl/prng/Miejscowosc/PL.PZGiK.204.PRNG.00000000-0000-0000-0000-000000165905-",
"ID_W_SYS_ZEWNETRZNYM": null,
"NAZWA_SKROCONA": null,
"KLASA": "obiekt ukształtowania terenu",
"ID_PRNG": 165905,
"OBJECTID": 1522929,
"SYSTEM_ZEWNETRZNY": null,
"STATUS": "urzędowa",
"NADRZEDNY": null,
"NAZWA_URZEDOWA": null,
"RODZAJ": "góra, szczyt",
"NAZWA_PRZYMIOTNIK": null,
"ID_IIP": "00000000-0000-0000-0000-000000165905",
"NAZWA_MN_NAR": null,
"NAZWA_DOPELNIACZ": "-ziej",
"NAZWA_MIANOWNIK": "Kozia"
}
},
"es_metadata_id": "1522929"
},
"distance": 1024.7669462173076,
"relevance": 0.0,
"source": "CAPAP"
},
"prngjo": {
"single": {
"id": 1669569,
"name": "Wilków",
"desc": " - miejscowość, wieś",
"shortDesc": "Wilków",
"longDesc": " wieś",
"filterKeys": [
"miejscowość",
"urzędowa",
"wieś",
"Punkt centralny"
],
"geometry": {
"type": "Point",
"coordinates": [
15.92787404,
51.09175685
]
},
"sort1": "Wilków",
"ftsid": "pl.pzgik.204.prng/00000000-0000-0000-0000-000000148162",
"gm_nazwa": null,
"pow_nazwa": null,
"woj_nazwa": null,
"teryt": null,
"center": "51.0917568499933, 15.927874041549",
"record": {
"id": 1669569,
"geometry": {
"type": "Point",
"coordinates": [
15.92787404,
51.09175685
]
},
"type": "Feature",
"properties": {
"LODURI": "https://pzgik.geoportal.gov.pl/prng/Miejscowosc/PL.PZGiK.204.PRNG.00000000-0000-0000-0000-000000148162-",
"ID_W_SYS_ZEWNETRZNYM": "0368728 ",
"NAZWA_SKROCONA": null,
"KLASA": "miejscowość",
"ID_PRNG": 148162,
"OBJECTID": 1669569,
"SYSTEM_ZEWNETRZNY": "TERYT",
"STATUS": "urzędowa",
"NADRZEDNY": null,
"NAZWA_URZEDOWA": null,
"RODZAJ": "wieś",
"ID_JEDN_OSAD": 628102,
"NAZWA_PRZYMIOTNIK": "wilkowski",
"ID_IIP": "00000000-0000-0000-0000-000000148162",
"NAZWA_MN_NAR": null,
"NAZWA_DOPELNIACZ": "-kowa",
"NAZWA_MIANOWNIK": "Wilków",
"FUNKCJA_ADM": null
}
},
"es_metadata_id": "1669569"
},
"distance": 366.41705165589775,
"relevance": 0.0,
"source": "CAPAP"
}
}
}
]
3.3. Usługa Wyszukiwania CAPAP
Wyszukiwanie pełnotekstowe i przestrzenne dla zasobów CAPAP. Wyszukiwanie dostępne jest jedynie dla zasobów publicznych.
3.3.1. Auto-uzupełnianie
GET /api/fts/ac
Opis
Bazując na tekście przed kursorem i po nim, zwraca listę tekstów auto-uzupełnienia. Teksty te mogą zastąpić tekst przed kursorem.Zwracane teksty uwzględniają możliwe do otrzymania wyniki zapytania.
Parametry
Typ | Nazwa | Opis | Schemat | Domyślnie |
---|---|---|---|---|
Query |
a |
tekst po kursorze, pełne słowa |
string |
|
Query |
b |
tekst przed kursorem, może zawierać częściowe słowo |
string |
|
Query |
bbox |
ekstent w postaci: x1,y1,x2,y2 lub pusty string |
string |
|
Query |
bboxm |
tryb ekstentu: soft|hard, domniemany: soft |
string |
|
Query |
cnt |
ilość zwracanych wyników |
integer (int32) |
|
Query |
idx |
Identyfikatory zasobów oddzielone przecinkami. |
string |
|
Query |
tag |
tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag |
< string > array(multi) |
|
Query |
ter |
ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty) |
string |
|
Query |
top |
operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or |
< string > array(multi) |
|
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< string > array |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Przykład: Treść (URL) zapytania GET
-
Metoda HTTP: GET
-
URL:
https://capap.gugik.gov.pl/api/fts/ac?b=Str&a=&cnt=10&idx=2148,2149&bbox=17.435,49.802,21.478,53.994&bboxm=soft&tag=&r=none
Przykład: cURL
curl -X GET 'https://capap.gugik.gov.pl/api/fts/ac?b=Str&a=&cnt=10&idx=2148,2149&bbox=17.435,49.802,21.478,53.994&bboxm=soft&tag=&r=none'
Przykład: Odpowiedź
["strzyżew"]
3.3.2. Wyszukiwanie najbliższych , wywoływane przez POST
POST /api/fts/qn
Opis
Zwraca listę wyników posortowaną wg. trafności i odległości od podanego zasięgu. Wyszukiwanie odbywa się na podstawie podanego tekstu oraz listy identyfikatorów zasobów podlegających wyszukiwaniu.Podany tekst może być pusty - wówczas wyszukiwanie obejmuje wszystkie rekordy. Dodatkowo można uszczegółowić wyszukiwanie za pomocą geometrii (bounding box) i/lub tagów.Wynikiem jest lista znalezionych rekordów (stronicowana), zakodowana w postaci geojson.
Parametry
Typ | Nazwa | Opis | Schemat |
---|---|---|---|
Body |
req |
req |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
string |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
{
"bbox": "17.435,49.802,21.478,53.994",
"bboxm": "hard",
"cnt": 2,
"idx": "2148,2149",
"offs": 0,
"q": "Dą",
"r": "none",
"tags": [
""
],
"top": [
"or"
]
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"bbox": "17.435,49.802,21.478,53.994",
"bboxm": "hard",
"cnt": 2,
"idx": "2148,2149",
"offs": 0,
"q": "Dą",
"r": "none",
"tags": [
""
],
"top": [
"or"
]
}' \
https://capap.gugik.gov.pl/api/fts/qn
Przykład: Odpowiedź
{
"type": "FeatureCollection",
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
},
"_search": {
"cntPerRes": {
"2149": 23312,
"2148": 3790
},
"tags": [
{
"tag": "MAZOWIECKIE",
"cnt": 5994
},
{
"tag": "ŁÓDZKIE",
"cnt": 4925
},
...
],
"tagsPerRes": {
"2149": [
{
"tag": "MAZOWIECKIE",
"cnt": 5994
},
{
"tag": "ŁÓDZKIE",
"cnt": 4925
},
...
],
"2148": []
},
"time": 78,
"total": 27102,
"extraTotal": 0,
"max_score": 23.911245
},
"features": [
{
"type": "Feature",
"id": "2149#375557",
"geometry": {
"type": "Point",
"coordinates": [
19.44611311,
51.89566464
]
},
"properties": {
"id": 375557,
"numer_proj": "POPC.01.01.00-10-0049/17",
"nazwa_proj": "Budowa sieci NGA w powiatach: brzezińskim, pabianickim, zgierskim, łódzkim wschodnim i mieście Łódź.",
"beneficjen": "\"TOYA\"-SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ",
"ident_budy": "1000000002928234",
"wojewodztw": "ŁÓDZKIE",
"powiat": "zgierski",
"gmina": "Zgierz",
"kod_terc": "1020092",
"miejscowos": "DĄBRÓWKA STRUMIANY",
"kod_simc": "0416634",
"ulica": "CEGIELNIANA",
"kod_ulic": "02580",
"numer_porz": "9C",
"sz_geogr": "51.895697",
"dl_geogr": "19.446175",
"rodzaj_ob": "punkt adresowy podstawowy",
"rejon": "0416634",
"status": "w realizacji"
},
"_id": 375557,
"_search": {
"score": 23.911245,
"res": "2149",
"type": "res2149",
"id": "375557",
"name": "DĄBRÓWKA STRUMIANY CEGIELNIANA 9C",
"desc": "Status: w realizacji",
"source": "CAPAP"
}
},
{
"type": "Feature",
"id": "2149#375553",
"geometry": {
"type": "Point",
"coordinates": [
19.44393134,
51.89694651
]
},
"properties": {
"id": 375553,
"numer_proj": "POPC.01.01.00-10-0049/17",
"nazwa_proj": "Budowa sieci NGA w powiatach: brzezińskim, pabianickim, zgierskim, łódzkim wschodnim i mieście Łódź.",
"beneficjen": "\"TOYA\"-SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ",
"ident_budy": "1000000002928221",
"wojewodztw": "ŁÓDZKIE",
"powiat": "zgierski",
"gmina": "Zgierz",
"kod_terc": "1020092",
"miejscowos": "DĄBRÓWKA STRUMIANY",
"kod_simc": "0416634",
"ulica": "CEGIELNIANA",
"kod_ulic": "02580",
"numer_porz": "5",
"sz_geogr": "51.897379",
"dl_geogr": "19.443778",
"rodzaj_ob": "punkt adresowy podstawowy",
"rejon": "0416634",
"status": "w realizacji"
},
"_id": 375553,
"_search": {
"score": 23.853958,
"res": "2149",
"type": "res2149",
"id": "375553",
"name": "DĄBRÓWKA STRUMIANY CEGIELNIANA 5",
"desc": "Status: w realizacji",
"source": "CAPAP"
}
}
]
}
3.3.3. Wyszukiwanie najbliższych
GET /api/fts/qn
Opis
Zwraca listę wyników posortowaną wg. trafności i odległości od podanego zasięgu. Wyszukiwanie odbywa się na podstawie podanego tekstu oraz listy identyfikatorów zasobów podlegających wyszukiwaniu.Podany tekst może być pusty - wówczas wyszukiwanie obejmuje wszystkie rekordy. Dodatkowo można uszczegółowić wyszukiwanie za pomocą geometrii (bounding box) i/lub tagów.Wynikiem jest lista znalezionych rekordów (stronicowana), zakodowana w postaci geojson.
Parametry
Typ | Nazwa | Opis | Schemat | Domyślnie |
---|---|---|---|---|
Query |
bbox |
ekstent w postaci: x1,y1,x2,y2 lub pusty string |
string |
|
Query |
bboxm |
tryb ekstentu: soft|hard, domniemany: soft |
string |
|
Query |
cnt |
ilość zwracanych wyników |
integer (int32) |
|
Query |
idx |
Identyfikatory zasobów oddzielone przecinkami. |
string |
|
Query |
offs |
ofset |
integer (int32) |
|
Query |
q |
tekst zapytania |
string |
|
Query |
r |
dane referencyjne zwracane w ramach zapytania: all | pkt,ulc,… | none | (empty) |
string |
|
Query |
tag |
tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag |
< string > array(multi) |
|
Query |
ter |
ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty) |
string |
|
Query |
top |
operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or |
< string > array(multi) |
|
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Przykład: Treść (URL) zapytania GET
-
Metoda HTTP: GET
-
URL:
https://capap.gugik.gov.pl/api/fts/qn?f=geojson&q=Dą&offs=0&cnt=2&idx=2148,2149&bbox=17.435,49.802,21.478,53.994&bboxm=hard&tag=&top=or&r=none
Przykład: cURL
curl -X GET 'https://capap.gugik.gov.pl/api/fts/qn?f=geojson&q=Dą&offs=0&cnt=2&idx=2148,2149&bbox=17.435,49.802,21.478,53.994&bboxm=hard&tag=&top=or&r=none'
Przykład: Odpowiedź
{
"type": "FeatureCollection",
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
},
"_search": {
"cntPerRes": {
"2149": 23312,
"2148": 3790
},
"tags": [
{
"tag": "MAZOWIECKIE",
"cnt": 5993
},
{
"tag": "ŁÓDZKIE",
"cnt": 4925
},
{
"tag": "WIELKOPOLSKIE",
"cnt": 2204
},
{
"tag": "MAŁOPOLSKIE",
"cnt": 2173
},
{
"tag": "ŚLĄSKIE",
"cnt": 2147
},
{
"tag": "KUJAWSKO-POMORSKIE",
"cnt": 1932
},
{
"tag": "ŚWIĘTOKRZYSKIE",
"cnt": 1910
},
{
"tag": "WARMIŃSKO-MAZURSKIE",
"cnt": 826
},
{
"tag": "POMORSKIE",
"cnt": 660
},
{
"tag": "OPOLSKIE",
"cnt": 247
},
{
"tag": "PODKARPACKIE",
"cnt": 117
},
{
"tag": "DOLNOŚLĄSKIE",
"cnt": 81
}
],
"tagsPerRes": {
"2149": [
{
"tag": "MAZOWIECKIE",
"cnt": 5993
},
{
"tag": "ŁÓDZKIE",
"cnt": 4925
},
{
"tag": "WIELKOPOLSKIE",
"cnt": 2204
},
{
"tag": "MAŁOPOLSKIE",
"cnt": 2173
},
{
"tag": "ŚLĄSKIE",
"cnt": 2147
},
{
"tag": "KUJAWSKO-POMORSKIE",
"cnt": 1932
},
{
"tag": "ŚWIĘTOKRZYSKIE",
"cnt": 1910
},
{
"tag": "WARMIŃSKO-MAZURSKIE",
"cnt": 826
},
{
"tag": "POMORSKIE",
"cnt": 660
},
{
"tag": "OPOLSKIE",
"cnt": 247
},
{
"tag": "PODKARPACKIE",
"cnt": 117
},
{
"tag": "DOLNOŚLĄSKIE",
"cnt": 81
}
],
"2148": []
},
"time": 33,
"total": 27102,
"extraTotal": 0,
"max_score": 23.911245
},
"features": [
{
"type": "Feature",
"id": "2149#375557",
"geometry": {
"type": "Point",
"coordinates": [
19.44611311,
51.89566464
]
},
"properties": {
"id": 375557,
"numer_proj": "POPC.01.01.00-10-0049/17",
"nazwa_proj": "Budowa sieci NGA w powiatach: brzezińskim, pabianickim, zgierskim, łódzkim wschodnim i mieście Łódź.",
"beneficjen": "\"TOYA\"-SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ",
"ident_budy": "1000000002928234",
"wojewodztw": "ŁÓDZKIE",
"powiat": "zgierski",
"gmina": "Zgierz",
"kod_terc": "1020092",
"miejscowos": "DĄBRÓWKA STRUMIANY",
"kod_simc": "0416634",
"ulica": "CEGIELNIANA",
"kod_ulic": "02580",
"numer_porz": "9C",
"sz_geogr": "51.895697",
"dl_geogr": "19.446175",
"rodzaj_ob": "punkt adresowy podstawowy",
"rejon": "0416634",
"status": "w realizacji"
},
"_id": 375557,
"_search": {
"score": 23.911245,
"res": "2149",
"type": "res2149",
"id": "375557",
"name": "DĄBRÓWKA STRUMIANY CEGIELNIANA 9C",
"desc": "Status: w realizacji",
"source": "CAPAP"
}
},
{
"type": "Feature",
"id": "2149#375553",
"geometry": {
"type": "Point",
"coordinates": [
19.44393134,
51.89694651
]
},
"properties": {
"id": 375553,
"numer_proj": "POPC.01.01.00-10-0049/17",
"nazwa_proj": "Budowa sieci NGA w powiatach: brzezińskim, pabianickim, zgierskim, łódzkim wschodnim i mieście Łódź.",
"beneficjen": "\"TOYA\"-SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ",
"ident_budy": "1000000002928221",
"wojewodztw": "ŁÓDZKIE",
"powiat": "zgierski",
"gmina": "Zgierz",
"kod_terc": "1020092",
"miejscowos": "DĄBRÓWKA STRUMIANY",
"kod_simc": "0416634",
"ulica": "CEGIELNIANA",
"kod_ulic": "02580",
"numer_porz": "5",
"sz_geogr": "51.897379",
"dl_geogr": "19.443778",
"rodzaj_ob": "punkt adresowy podstawowy",
"rejon": "0416634",
"status": "w realizacji"
},
"_id": 375553,
"_search": {
"score": 23.853958,
"res": "2149",
"type": "res2149",
"id": "375553",
"name": "DĄBRÓWKA STRUMIANY CEGIELNIANA 5",
"desc": "Status: w realizacji",
"source": "CAPAP"
}
}
]
}
3.4. Usługa Wyszukiwania Danych Referencyjnych
Wyszukiwanie pełnotekstowe i przestrzenne dla danych referencyjnych. Przeszukiwane są wybrane (lub wszystkie) referencyjne zasoby systemów Geoportal / CAPAP. Dla punktów adresowych i działek, usługa jest zintegrowana z zasobami zewnętrznymi.
3.4.1. Autocomplete
GET /api/fts/ref/ac
Opis
returns list of autocomplete words, based on before cursor (partial text) and after cursor text.Returned strings contains completed before text, without after part
Parametry
Typ | Nazwa | Opis | Schemat | Domyślnie |
---|---|---|---|---|
Query |
a |
tekst po kursorze, pełne słowa |
string |
|
Query |
b |
tekst przed kursorem, może zawierać częściowe słowo |
string |
|
Query |
bbox |
ekstent w postaci: x1,y1,x2,y2 lub pusty string |
string |
|
Query |
bboxm |
tryb ekstentu: soft|hard, domniemany: soft |
string |
|
Query |
cnt |
ilość zwracanych wyników |
integer (int32) |
|
Query |
idx |
Identyfikatory zasobów referencyjnych oddzielone przecinkami: all | pkt,ulc,… | none | (pusty) |
string |
|
Query |
tag |
tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag |
< string > array(multi) |
|
Query |
ter |
ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty) |
string |
|
Query |
top |
operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or |
< string > array(multi) |
|
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< string > array |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Przykład: Treść (URL) zapytania GET
-
Metoda HTTP: GET
-
URL:
https://capap.gugik.gov.pl/api/fts/ref/ac?b=mierzej&a=&cnt=10&idx=pkt,ulc,dze,jpa,prngof,prngjo&bbox=18.681,54.586,18.828,54.660&bboxm=soft
Przykład: cURL
curl -X GET 'https://capap.gugik.gov.pl/api/fts/ref/ac?b=mierzej&a=&cnt=10&idx=pkt,ulc,dze,jpa,prngof,prngjo&bbox=18.681,54.586,18.828,54.660&bboxm=soft'
Przykład: Odpowiedź
["mierzejewskiego", "mierzejewskich", "mierzejowa", "mierzeja"]
3.4.2. Wyszukiwanie najbliższych , wywoływane przez POST
POST /api/fts/ref/qn
Opis
Zwraca listę wyników posortowaną wg. trafności i odległości od podanego zasięgu. Wyszukiwanie odbywa się na podstawie podanego tekstu oraz listy identyfikatorów zasobów podlegających wyszukiwaniu.Podany tekst może być pusty - wówczas wyszukiwanie obejmuje wszystkie rekordy. Dodatkowo można uszczegółowić wyszukiwanie za pomocą geometrii (bounding box) i/lub tagów.Wynikiem jest lista znalezionych rekordów (stronicowana), zakodowana w postaci geojson.
Parametry
Typ | Nazwa | Opis | Schemat |
---|---|---|---|
Body |
req |
req |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
string |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
{
"bbox": "13.810,48.933,24.9155,54.797",
"bboxm": "soft",
"r": "pkt,ulc,dze,jpa,prngof,prngjo",
"cnt": 2,
"offs": 0,
"q": "Herde",
"tags": [
""
],
"top": [
"or"
]
}
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"bbox": "13.810,48.933,24.9155,54.797",
"bboxm": "soft",
"r": "pkt,ulc,dze,jpa,prngof,prngjo",
"cnt": 2,
"offs": 0,
"q": "Herde",
"tags": [
""
],
"top": [
"or"
]
}' \
https://capap.gugik.gov.pl/api/fts/ref/qn
Przykład: Odpowiedź
{
"type": "FeatureCollection",
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
},
"_search": {
"cntPerRes": {
"ulc": 1
},
"tags": [
{
"tag": "Bytom",
"cnt": 1
},
{
"tag": "śląskie",
"cnt": 1
}
],
"tagsPerRes": {
"ulc": [
{
"tag": "Bytom",
"cnt": 1
},
{
"tag": "śląskie",
"cnt": 1
}
]
},
"time": 70,
"total": 1,
"extraTotal": 0,
"max_score": 24.429346
},
"features": [
{
"id": "ulc#5065532",
"geometry": {
"type": "LineString",
"coordinates": [
[
18.88051686,
50.40149523
],
[
18.87927031,
50.40182088
],
[
18.87838485,
50.40207977
],
[
18.87747652,
50.40235322
],
[
18.87649519,
50.40264412
],
[
18.87568727,
50.40288555
],
[
18.87563705,
50.40290009
],
[
18.87515491,
50.40224442
]
]
},
"type": "Feature",
"properties": {
"id": 5065532,
"miejsc_nazwa": "Bytom",
"gm_idteryt": "2462011",
"miejsc_n_nazwa": null,
"ul_nazwa_przed1": null,
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": "Herdy",
"ul_nazwa_czesc": "Edmunda",
"woj_idteryt": "24",
"ul_typ": "ulica",
"ul_idTERYT": "06622",
"pow_idteryt": "2462",
"miejsc_n_idTERYT": null,
"miejsc_idTERYT": "0938670"
},
"_id": 5065532,
"_search": {
"score": 24.429346,
"res": "ulc",
"type": "spec_ulc",
"id": "5065532",
"name": "Edmunda Herdy - Bytom",
"desc": "ulica Bytom Bytom śląskie",
"source": "PRGAD"
}
}
]
}
3.4.3. Wyszukiwanie najbliższych
GET /api/fts/ref/qn
Opis
Zwraca listę wyników posortowaną wg. trafności i odległości od podanego zasięgu. Wyszukiwanie odbywa się na podstawie podanego tekstu oraz listy identyfikatorów zasobów podlegających wyszukiwaniu.Podany tekst może być pusty - wówczas wyszukiwanie obejmuje wszystkie rekordy. Dodatkowo można uszczegółowić wyszukiwanie za pomocą geometrii (bounding box) i/lub tagów.Wynikiem jest lista znalezionych rekordów (stronicowana), zakodowana w postaci geojson.
Parametry
Typ | Nazwa | Opis | Schemat | Domyślnie |
---|---|---|---|---|
Query |
bbox |
ekstent w postaci: x1,y1,x2,y2 lub pusty string |
string |
|
Query |
bboxm |
tryb ekstentu: soft|hard, domniemany: soft |
string |
|
Query |
cnt |
ilość zwracanych wyników |
integer (int32) |
|
Query |
idx |
Identyfikatory zasobów referencyjnych oddzielone przecinkami: all | pkt,ulc,… | none | (pusty) |
string |
|
Query |
offs |
ofset |
integer (int32) |
|
Query |
q |
tekst zapytania |
string |
|
Query |
tag |
tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag |
< string > array(multi) |
|
Query |
ter |
ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty). NA RAZIE nie filtruje usług zewnętrznych. |
string |
|
Query |
top |
operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or |
< string > array(multi) |
|
Query |
useExtSvc |
true - użycie także zewnętrznej usługi (adresy,działki) |
boolean |
|
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Przykład: Treść (URL) zapytania GET
-
Metoda HTTP: GET
-
URL:
https://capap.gugik.gov.pl/api/fts/ref/qn?f=geojson&q=Herde&offs=0&cnt=50&idx=pkt,ulc,dze,jpa,prngof,prngjo&bbox=13.810,48.933,24.915,54.797&bboxm=soft&tag=&top=or&useExtSvc=true
Przykład: cURL
curl -X GET 'https://capap.gugik.gov.pl/api/fts/ref/qn?f=geojson&q=Herde&offs=0&cnt=50&idx=pkt,ulc,dze,jpa,prngof,prngjo&bbox=13.810,48.933,24.9155,54.797&bboxm=soft&tag=&top=or&useExtSvc=true'
Przykład: Odpowiedź
{
"type": "FeatureCollection",
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
},
"_search": {
"cntPerRes": {
"ulc": 1
},
"tags": [
{
"tag": "Bytom",
"cnt": 1
},
{
"tag": "śląskie",
"cnt": 1
}
],
"tagsPerRes": {
"ulc": [
{
"tag": "Bytom",
"cnt": 1
},
{
"tag": "śląskie",
"cnt": 1
}
]
},
"time": 76,
"total": 1,
"extraTotal": 0,
"max_score": 24.429346
},
"features": [
{
"id": "ulc#5065532",
"geometry": {
"type": "LineString",
"coordinates": [
[
18.88051686,
50.40149523
],
[
18.87927031,
50.40182088
],
[
18.87838485,
50.40207977
],
[
18.87747652,
50.40235322
],
[
18.87649519,
50.40264412
],
[
18.87568727,
50.40288555
],
[
18.87563705,
50.40290009
],
[
18.87515491,
50.40224442
]
]
},
"type": "Feature",
"properties": {
"id": 5065532,
"miejsc_nazwa": "Bytom",
"gm_idteryt": "2462011",
"miejsc_n_nazwa": null,
"ul_nazwa_przed1": null,
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": "Herdy",
"ul_nazwa_czesc": "Edmunda",
"woj_idteryt": "24",
"ul_typ": "ulica",
"ul_idTERYT": "06622",
"pow_idteryt": "2462",
"miejsc_n_idTERYT": null,
"miejsc_idTERYT": "0938670"
},
"_id": 5065532,
"_search": {
"score": 24.429346,
"res": "ulc",
"type": "spec_ulc",
"id": "5065532",
"name": "Edmunda Herdy - Bytom",
"desc": "ulica Bytom Bytom śląskie",
"source": "PRGAD"
}
}
]
}
3.4.4. Wyszukiwanie pełnotekstowe
GET /api/fts/ref/qq
Opis
Wyszukiwanie na podstawie podanego tekstu wśród danych referencyjnych (wszystkich lub wybranych). Dodatkowo można uszczegółowić wyszukiwanie za pomocą geometrii (bounding box) i/lub tagów. Wynikiem jest lista znalezionych rekordów (stronicowana), zakodowana w postaci geojson.
Parametry
Typ | Nazwa | Opis | Schemat | Domyślnie |
---|---|---|---|---|
Query |
bbox |
ekstent w postaci: x1,y1,x2,y2 lub pusty string |
string |
|
Query |
bboxm |
tryb ekstentu: soft|hard, domniemany: soft |
string |
|
Query |
cnt |
ilość zwracanych wyników |
integer (int32) |
|
Query |
idx |
Identyfikatory zasobów referencyjnych oddzielone przecinkami: all | pkt,ulc,… | none | (pusty) |
string |
|
Query |
offs |
ofset |
integer (int32) |
|
Query |
q |
tekst zapytania |
string |
|
Query |
tag |
tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag |
< string > array(multi) |
|
Query |
ter |
ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty). NA RAZIE nie filtruje usług zewnętrznych. |
string |
|
Query |
top |
operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or |
< string > array(multi) |
|
Query |
useExtOnly |
true - użycie tylko zewnętrznej usługi (działki) |
boolean |
|
Query |
useExtSvc |
true - użycie także zewnętrznej usługi (adresy,działki) |
boolean |
|
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Przykład: Treść (URL) zapytania GET
-
Metoda HTTP: GET
-
URL:
https://capap.gugik.gov.pl/api/fts/ref/qq?f=geojson&q=Herde&offs=0&cnt=50&idx=pkt,ulc,dze,jpa,prngof,prngjo&bbox=13.810,48.933,24.915,54.797&bboxm=soft&tag=&top=or&useExtSvc=false
Przykład: cURL
curl -X GET 'https://capap.gugik.gov.pl/api/fts/ref/qq?f=geojson&q=Herde&offs=0&cnt=50&idx=pkt,ulc,dze,jpa,prngof,prngjo&bbox=13.810,48.933,24.915,54.797&bboxm=soft&tag=&top=or&useExtSvc=false'
Przykład: Odpowiedź
{
"type": "FeatureCollection",
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
},
"_search": {
"cntPerRes": {},
"tags": [
{
"tag": "Bytom",
"cnt": 1
},
{
"tag": "śląskie",
"cnt": 1
}
],
"tagsPerRes": {
"ulc": [
{
"tag": "Bytom",
"cnt": 1
},
{
"tag": "śląskie",
"cnt": 1
}
]
},
"time": 98,
"total": 1,
"extraTotal": 0,
"max_score": 114.31155
},
"features": [
{
"id": "ulc#5065532",
"geometry": {
"type": "LineString",
"coordinates": [
[
18.88051686,
50.40149523
],
[
18.87927031,
50.40182088
],
[
18.87838485,
50.40207977
],
[
18.87747652,
50.40235322
],
[
18.87649519,
50.40264412
],
[
18.87568727,
50.40288555
],
[
18.87563705,
50.40290009
],
[
18.87515491,
50.40224442
]
]
},
"type": "Feature",
"properties": {
"id": 5065532,
"miejsc_nazwa": "Bytom",
"gm_idteryt": "2462011",
"miejsc_n_nazwa": null,
"ul_nazwa_przed1": null,
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": "Herdy",
"ul_nazwa_czesc": "Edmunda",
"woj_idteryt": "24",
"ul_typ": "ulica",
"ul_idTERYT": "06622",
"pow_idteryt": "2462",
"miejsc_n_idTERYT": null,
"miejsc_idTERYT": "0938670"
},
"_id": 5065532,
"_search": {
"score": 114.31155,
"res": "ulc",
"type": "spec_ulc",
"id": "5065532",
"name": "Edmunda Herdy - Bytom",
"desc": "ulica Bytom Bytom śląskie",
"source": "PRGAD"
}
}
]
}
3.4.5. test
GET /api/fts/ref/test
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
string |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
*/*
3.5. Usługa Wyszukiwania Hierarchicznego
Usługa udostępnia wyszukiwanie wybranych danych referencyjnych w sposób hierarchiczny. Wybór kolejnych poziomów hierarchii filtruje wyniki wyszukiwania oraz dostępne listy wartości kolejnych poziomów hierarchii.
3.5.1. pobranie konfiguracji hierarchii
GET /api/fts/hier/_cfg
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< string, HierarchDesc > map |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Przykład: Treść (URL) zapytania GET
-
Metoda HTTP: GET
-
URL:
https://capap.gugik.gov.pl/api/fts/hier/_cfg
Przykład: cURL
curl -X GET 'https://capap.gugik.gov.pl/api/fts/hier/_cfg'
Przykład: Odpowiedź
{
"dze": {
"hierarchyName": "dze",
"filters": [
{
"l": 0,
"level": "woj",
"name": "województwo",
"qonly": false
},
{
"l": 1,
"level": "pow",
"name": "powiat",
"qonly": false
},
{
"l": 2,
"level": "gmi",
"name": "gmina",
"qonly": false
}
]
},
"jpa": {
"hierarchyName": "jpa",
"filters": [
{
"l": 0,
"level": "woj",
"name": "województwo",
"qonly": false
},
{
"l": 1,
"level": "pow",
"name": "powiat",
"qonly": false
},
{
"l": 2,
"level": "gmi",
"name": "gmina",
"qonly": false
}
]
},
"pkt": {
"hierarchyName": "pkt",
"filters": [
{
"l": 0,
"level": "woj",
"name": "województwo",
"qonly": false
},
{
"l": 1,
"level": "pow",
"name": "powiat",
"qonly": false
},
{
"l": 2,
"level": "gmi",
"name": "gmina",
"qonly": false
},
{
"l": 3,
"level": "msc",
"name": "miejscowość",
"qonly": false
},
{
"l": 4,
"level": "ulc",
"name": "ulica",
"qonly": false
},
{
"l": 5,
"level": "kod",
"name": "kod pocztowy",
"qonly": true
},
{
"l": 5,
"level": "nr",
"name": "numer domu",
"qonly": false
}
]
},
"prngof": {
"hierarchyName": "prngof",
"filters": [
{
"l": 0,
"level": "kl",
"name": "klasa",
"qonly": false
},
{
"l": 1,
"level": "r",
"name": "rodzaj",
"qonly": false
},
{
"l": 2,
"level": "naz",
"name": "nazwa",
"qonly": false
}
]
},
"prngjo": {
"hierarchyName": "prngjo",
"filters": [
{
"l": 0,
"level": "woj",
"name": "województwo",
"qonly": false
},
{
"l": 1,
"level": "pow",
"name": "powiat",
"qonly": false
},
{
"l": 2,
"level": "gmi",
"name": "gmina",
"qonly": false
},
{
"l": 3,
"level": "msc",
"name": "miejscowość",
"qonly": false
}
]
}
}
3.5.2. Zapytanie o działki, przy użyciu filtrowania hierarchiznego.
POST /api/fts/hier/dze/qq
Opis
Zwraca wyniki w postaci geojson z dodatkowymi informacjami ( atrybuty _search).
Parametry
Typ | Nazwa | Opis | Schemat | Domyślnie |
---|---|---|---|---|
Query |
bbox |
ekstent w postaci: x1,y1,x2,y2 lub pusty string |
string |
|
Query |
bboxm |
tryb ekstentu: soft|hard, domniemany: soft |
string |
|
Query |
cnt |
ilość zwracanych wyników |
integer (int32) |
|
Query |
offs |
ofset |
integer (int32) |
|
Query |
q |
tekst zapytania |
string |
|
Query |
tag |
tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag |
< string > array(multi) |
|
Query |
ter |
ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty) |
string |
|
Query |
top |
operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or |
< string > array(multi) |
|
Body |
req |
req |
< HierarchFilter > array |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
string |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
[
{
"level": "woj",
"v": "lubelskie"
},
{
"level": "pow",
"v": "lubartowski"
},
{
"level": "gmi",
"v": "Abramów"
}
]
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '[
{
"level": "woj",
"v": "lubelskie"
},
{
"level": "pow",
"v": "lubartowski"
},
{
"level": "gmi",
"v": "Abramów"
}
]' \
https://capap.gugik.gov.pl/api/fts/hier/dze/qq?q=a&offs=0&cnt=50&bbox=15.910,52.448,17.278,53.213&bboxm=soft&tag=&top=or
Przykład: Odpowiedź
"score": 17.439493,
"res": "dze",
"type": "spec_dze",
"id": "13896875",
"name": "060802_2.0008.AR_1.1147 - Sosnówka 1147",
"desc": "gm. Abramów pow. lubartowski woj. lubelskie",
"source": "LPIS"
}
},
{
"id": "dze#13900075",
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
22.29082916,
51.48261265
],
[
22.2907453,
51.48222478
],
[
22.28938904,
51.48293401
],
[
22.2898218,
51.48324416
],
[
22.28942177,
51.48344848
],
[
22.29038727,
51.48410196
],
[
22.29122156,
51.48374039
],
[
22.29109653,
51.4833812
],
[
22.29082916,
51.48261265
]
]
]
},
"type": "Feature",
"properties": {
"ZRD": "LPIS",
"MIEJSC": "Wielkolas",
"IDENTYFIKATOR": "060802_2.0009.AR_2.1487/1",
"NUMER": "1487/1",
"POWIAT": "lubartowski",
"POWIERZCHNIA": 15200,
"OBJECTID": 13900075,
"GMINA": "Abramów",
"WOJEWODZTWO": "lubelskie",
"TERYT": "0608022",
"OBREB_EWIDENCYJNY": "WIELKOLAS"
},
"_id": 13900075,
"_search": {
"score": 17.439493,
"res": "dze",
"type": "spec_dze",
"id": "13900075",
"name": "060802_2.0009.AR_2.1487/1 - Wielkolas 1487/1",
"desc": "gm. Abramów pow. lubartowski woj. lubelskie",
"source": "LPIS"
}
},
...
]
}
3.5.3. pobieranie słowników
POST /api/fts/hier/fdict/{hId}/{level}
Opis
zwraca słowniki dla odpowiedniego poziomu hierarchii
Parametry
Typ | Nazwa | Opis | Schemat | Domyślnie |
---|---|---|---|---|
Path |
hId |
hId - identyfikator hierarchii |
string |
|
Path |
level |
level - poziom hierarchii |
string |
|
Query |
cnt |
cnt |
integer (int32) |
|
Query |
o |
offset |
integer (int32) |
|
Body |
req |
req |
< HierarchFilter > array |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
< HierarchListEntry > array |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '[
]' \
https://capap.gugik.gov.pl/api/fts/hier/fdict/dze/gmi?o=0&cnt=2
Przykład: Odpowiedź
[
{
"value": "Abramów",
"filters": [
{
"level": "woj",
"v": "lubelskie"
},
{
"level": "pow",
"v": "lubartowski"
},
{
"level": "gmi",
"v": "Abramów"
}
]
},
{
"value": "Adamów",
"filters": [
{
"level": "woj",
"v": "lubelskie"
},
{
"level": "pow",
"v": "łukowski"
},
{
"level": "gmi",
"v": "Adamów"
}
]
}
]
3.5.4. Zapytanie o jpa, przy użyciu filtrowania hierarchiznego.
POST /api/fts/hier/jpa/qq
Opis
Zwraca wyniki w postaci geojson z dodatkowymi informacjami ( atrybuty _search).
Parametry
Typ | Nazwa | Opis | Schemat | Domyślnie |
---|---|---|---|---|
Query |
bbox |
ekstent w postaci: x1,y1,x2,y2 lub pusty string |
string |
|
Query |
bboxm |
tryb ekstentu: soft|hard, domniemany: soft |
string |
|
Query |
cnt |
ilość zwracanych wyników |
integer (int32) |
|
Query |
offs |
ofset |
integer (int32) |
|
Query |
q |
tekst zapytania |
string |
|
Query |
tag |
tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag |
< string > array(multi) |
|
Query |
ter |
ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty) |
string |
|
Query |
top |
operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or |
< string > array(multi) |
|
Body |
req |
req |
< HierarchFilter > array |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
string |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '[
]' \
https://capap.gugik.gov.pl/api/fts/hier/jpa/qq?q=Dzi&cnt=1&offs=0&top=or&bbox=17.435%2C49.802%2C21.478%2C53.994&bboxm=soft
Przykład: Odpowiedź
{
"type": "FeatureCollection",
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
},
"_search": {
"cntPerRes": {},
"tags": [
{
"tag": "gmina",
"cnt": 27
},
{
"tag": "powiat",
"cnt": 2
}
],
"tagsPerRes": {
"jpa": [
{
"tag": "gmina",
"cnt": 27
},
{
"tag": "powiat",
"cnt": 2
}
]
},
"time": 25,
"total": 29,
"extraTotal": 0,
"max_score": 10
},
"features": [
{
"geometry": {
"type": "Polygon",
"coordinates": [
[
[
17.66926988,
51.16081526
],
[
17.66541946,
51.16261954
],
...
]
]
},
"type": "Feature",
"id": "jpa#367182",
"properties": {
"id": 367182,
"woj_id_lokalnyid": "f1ef3856-09ba-4e3d-af9d-a876794d570f",
"gm_id_wersjaid": "2012-09-26T22:30:34+02:00",
"gm_idteryt": "0214042",
"woj_id_wersjaid": "2017-10-10T00:00:00+02:00",
"woj_id_przestrzenNazw": "PL.PZGIK.200",
"woj_nazwa": "dolnośląskie",
"pow_id_przestrzenNazw": "PL.PZGIK.200",
"gm_id_lokalnyid": "1dd31283-e8db-48c9-ae5d-c3f66bf24d10",
"gm_nazwa": "Dziadowa Kłoda",
"woj_idteryt": "02",
"pow_idteryt": "0214",
"pow_id_wersjaid": "2012-09-27T07:36:28+02:00",
"gm_id_przestrzenNazw": "PL.PZGIK.200",
"pow_nazwa": "oleśnicki",
"pow_id_lokalnyid": "258b68f9-31cb-4f37-bbdf-f1824805a0e4"
},
"_id": 367182,
"_search": {
"score": 10,
"res": "jpa",
"type": "ref_jpa",
"id": "367182",
"name": "Dziadowa Kłoda",
"desc": "0214042 oleśnicki dolnośląskie",
"source": "PRGAD"
}
}
]
}
3.5.5. Zapytanie o adresy, przy użyciu filtrowania hierarchiznego.
POST /api/fts/hier/pkt/qq
Opis
Zwraca wyniki w postaci geojson z dodatkowymi informacjami ( atrybuty _search).
Parametry
Typ | Nazwa | Opis | Schemat | Domyślnie |
---|---|---|---|---|
Query |
bbox |
ekstent w postaci: x1,y1,x2,y2 lub pusty string |
string |
|
Query |
bboxm |
tryb ekstentu: soft|hard, domniemany: soft |
string |
|
Query |
cnt |
ilość zwracanych wyników |
integer (int32) |
|
Query |
offs |
ofset |
integer (int32) |
|
Query |
q |
tekst zapytania |
string |
|
Query |
tag |
tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag |
< string > array(multi) |
|
Query |
ter |
ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty) |
string |
|
Query |
top |
operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or |
< string > array(multi) |
|
Body |
req |
req |
< HierarchFilter > array |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
string |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
[
{
"level": "woj",
"v": ""
},
{
"level": "pow",
"v": ""
},
{
"level": "gmi",
"v": ""
},
{
"level": "msc",
"v": ""
},
{
"level": "ulc",
"v": ""
},
{
"level": "kod",
"v": ""
},
{
"level": "nr",
"v": "3"
}
]
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '[
{
"level": "woj",
"v": ""
},
{
"level": "pow",
"v": ""
},
{
"level": "gmi",
"v": ""
},
{
"level": "msc",
"v": ""
},
{
"level": "ulc",
"v": ""
},
{
"level": "kod",
"v": ""
},
{
"level": "nr",
"v": "3"
}
]' \
https://capap.gugik.gov.pl/api/fts/hier/pkt/qq?q=a&offs=0&cnt=50&bbox=15.910,52.447,17.278,53.212&bboxm=soft&tag=&top=or
Przykład: Odpowiedź
{
"type": "FeatureCollection",
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
},
"_search": {
"cntPerRes": {},
"tags": [
{
"tag": "mazowieckie",
"cnt": 28719
},
{
"tag": "wielkopolskie",
"cnt": 22525
},
...
],
"tagsPerRes": {
"pkt": [
{
"tag": "mazowieckie",
"cnt": 28719
},
{
"tag": "wielkopolskie",
"cnt": 22525
},
...
]
},
"time": 23,
"total": 193831,
"extraTotal": 0,
"max_score": 36.87255
},
"features": [
{
"id": "pkt#134283023",
"geometry": {
"type": "Point",
"coordinates": [
15.94801444,
53.00822146
]
},
"type": "Feature",
"properties": {
"id": 134283023,
"loduri": "https://pzgik.geoportal.gov.pl/prg/PunktAdresowy/PL.PZGIK.200.ac687658-0546-43e0-84ed-b091205d4c56",
"pkt_id_przestrzenNazw": "PL.PZGIK.200",
"miejsc_nazwa": "Stare Osieczno",
"gm_idteryt": "0806013",
"miejsc_n_nazwa": null,
"pkt_numer": "3",
"ul_nazwa_przed1": null,
"ul_nazwa_przed2": null,
"ul_nazwa_glowna": null,
"pkt_status": "istniejacy",
"pkt_id_lokalnyid": "ac687658-0546-43e0-84ed-b091205d4c56",
"ul_nazwa_czesc": null,
"woj_idteryt": "08",
"ul_typ": null,
"ul_idTERYT": null,
"pkt_id_wersjaid": "2017-04-26T09:44:45+02:00",
"pow_idteryt": "0806",
"pkt_kodPocztowy": "66-520",
"miejsc_n_idTERYT": null,
"woj_nazwa": "lubuskie",
"gm_nazwa": "Dobiegniew",
"pow_nazwa": "strzelecko-drezdenecki",
"miejsc_idTERYT": "0180634"
},
"_id": 134283023,
"_search": {
"score": 36.87255,
"res": "pkt",
"type": "spec_pkt",
"id": "134283023",
"name": "Stare Osieczno 3",
"desc": "66-520, gm. Dobiegniew, pow. strzelecko-drezdenecki, woj. lubuskie",
"source": "PRGAD"
}
},
...
]
}
3.5.6. Zapytanie o prngjo, przy użyciu filtrowania hierarchiznego.
POST /api/fts/hier/prngjo/qq
Opis
Zwraca wyniki w postaci geojson z dodatkowymi informacjami ( atrybuty _search).
Parametry
Typ | Nazwa | Opis | Schemat | Domyślnie |
---|---|---|---|---|
Query |
bbox |
ekstent w postaci: x1,y1,x2,y2 lub pusty string |
string |
|
Query |
bboxm |
tryb ekstentu: soft|hard, domniemany: soft |
string |
|
Query |
cnt |
ilość zwracanych wyników |
integer (int32) |
|
Query |
offs |
ofset |
integer (int32) |
|
Query |
q |
tekst zapytania |
string |
|
Query |
tag |
tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag |
< string > array(multi) |
|
Query |
ter |
ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty) |
string |
|
Query |
top |
operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or |
< string > array(multi) |
|
Body |
req |
req |
< HierarchFilter > array |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
string |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
[
{
"level": "woj",
"v": ""
},
{
"level": "pow",
"v": "suski"
},
{
"level": "gmi",
"v": ""
},
{
"level": "msc",
"v": ""
}
]
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '[
{
"level": "woj",
"v": ""
},
{
"level": "pow",
"v": "suski"
},
{
"level": "gmi",
"v": ""
},
{
"level": "msc",
"v": ""
}
]' \
https://capap.gugik.gov.pl/api/fts/hier/prngjo/qq?q=a&offs=0&cnt=50&bbox=15.910,52.448,17.278,53.213&bboxm=soft&tag=&top=or
Przykład: Odpowiedź
{
"type": "FeatureCollection",
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
},
"_search": {
"cntPerRes": {},
"tags": [
{
"tag": "Punkt centralny",
"cnt": 149
},
...
],
"tagsPerRes": {
"prngjo": [
{
"tag": "Punkt centralny",
"cnt": 149
},
...
]
},
"time": 15,
"total": 149,
"extraTotal": 0,
"max_score": 6.1573644
},
"features": [
{
"id": "prngjo#1801931",
"geometry": {
"type": "Point",
"coordinates": [
19.63416667,
49.67916667
]
},
"type": "Feature",
"properties": {
"LODURI": "https://pzgik.geoportal.gov.pl/prng/Miejscowosc/PL.PZGiK.204.PRNG.00000000-0000-0000-0000-000000002557-",
"ID_W_SYS_ZEWNETRZNYM": "0077020 ",
"NAZWA_SKROCONA": null,
"KLASA": "miejscowość",
"ID_PRNG": 2557,
"OBJECTID": 1801931,
"SYSTEM_ZEWNETRZNY": "TERYT",
"STATUS": "urzędowa",
"NADRZEDNY": "Skawica",
"NAZWA_URZEDOWA": null,
"RODZAJ": "część wsi",
"ID_JEDN_OSAD": 705127,
"NAZWA_PRZYMIOTNIK": null,
"ID_IIP": "00000000-0000-0000-0000-000000002557",
"NAZWA_MN_NAR": null,
"NAZWA_DOPELNIACZ": "U Barana",
"NAZWA_MIANOWNIK": "U Barana",
"FUNKCJA_ADM": null
},
"_id": 1801931,
"_search": {
"score": 6.1573644,
"res": "prngjo",
"type": "spec_prngjo",
"id": "1801931",
"name": "U Barana",
"desc": "Skawica - miejscowość, część wsi",
"source": "CAPAP"
}
},
...
]
}
3.5.7. Zapytanie o prngof, przy użyciu filtrowania hierarchiznego.
POST /api/fts/hier/prngof/qq
Opis
Zwraca wyniki w postaci geojson z dodatkowymi informacjami ( atrybuty _search).
Parametry
Typ | Nazwa | Opis | Schemat | Domyślnie |
---|---|---|---|---|
Query |
bbox |
ekstent w postaci: x1,y1,x2,y2 lub pusty string |
string |
|
Query |
bboxm |
tryb ekstentu: soft|hard, domniemany: soft |
string |
|
Query |
cnt |
ilość zwracanych wyników |
integer (int32) |
|
Query |
offs |
ofset |
integer (int32) |
|
Query |
q |
tekst zapytania |
string |
|
Query |
tag |
tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag |
< string > array(multi) |
|
Query |
ter |
ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty) |
string |
|
Query |
top |
operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or |
< string > array(multi) |
|
Body |
req |
req |
< HierarchFilter > array |
Odpowiedzi
Kod HTTP | Opis | Schemat |
---|---|---|
200 |
OK |
string |
201 |
Created |
Bez zawartości |
401 |
Unauthorized |
Bez zawartości |
403 |
Forbidden |
Bez zawartości |
404 |
Not Found |
Bez zawartości |
Konsumuje
-
application/json
Produkuje
-
application/json
Przykład: Treść zapytania POST
-
Metoda HTTP: POST
-
Content-Type: application/json
-
Body:
[
{
"level": "kl",
"v": "obiekt uksztaltowania terenu"
},
{
"level": "r",
"v": ""
},
{
"level": "naz",
"v": ""
}
]
Przykład: cURL
curl -X POST \
-H "Content-Type: application/json" \
-d '[
{
"level": "kl",
"v": "obiekt uksztaltowania terenu"
},
{
"level": "r",
"v": ""
},
{
"level": "naz",
"v": ""
}
]' \
https://capap.gugik.gov.pl/api/fts/hier/prngof/qq?q=a&offs=0&cnt=50&bbox=15.910,52.448,17.278,53.213&bboxm=soft&tag=&top=or
Przykład: Odpowiedź
{
"type": "FeatureCollection",
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
},
"_search": {
"cntPerRes": {},
"tags": [
{
"tag": "Punkt centralny",
"cnt": 7068
},
...
],
"tagsPerRes": {
"prngof": [
{
"tag": "Punkt centralny",
"cnt": 7068
},
...
]
},
"time": 17,
"total": 7156,
"extraTotal": 0,
"max_score": 10.0
},
"features": [
{
"id": "prngof#1373076",
"geometry": {
"type": "Point",
"coordinates": [
15.95398526,
52.98903809
]
},
"type": "Feature",
"properties": {
"LODURI": "https://pzgik.geoportal.gov.pl/prng/Miejscowosc/PL.PZGiK.204.PRNG.00000000-0000-0000-0000-000000235752-",
"ID_W_SYS_ZEWNETRZNYM": null,
"NAZWA_SKROCONA": null,
"KLASA": "Inny obiekt fizjograficzny",
"ID_PRNG": 235752,
"OBJECTID": 1373076,
"SYSTEM_ZEWNETRZNY": null,
"STATUS": "niestandaryzowana",
"NADRZEDNY": null,
"NAZWA_URZEDOWA": null,
"RODZAJ": "inny obiekt [3]",
"NAZWA_PRZYMIOTNIK": null,
"ID_IIP": "00000000-0000-0000-0000-000000235752",
"NAZWA_MN_NAR": null,
"NAZWA_DOPELNIACZ": "-ny",
"NAZWA_MIANOWNIK": "Kotlina"
},
"_id": 1373076,
"_search": {
"score": 10.0,
"res": "prngof",
"type": "spec_prngof",
"id": "1373076",
"name": "Kotlina",
"desc": " - Inny obiekt fizjograficzny, inny obiekt [3]",
"source": "CAPAP"
}
},
...
]
}
4. Definicje
Poniższy rozdział zawiera opisy struktur danych, które są używane jako parametry lub wynik zapytań z rozdziału 3.
Wszystkie poniższe definicje należy rozumieć jako doprecyzowanie struktury i zawartości JSONów używanych / produkowanych przez opisywane usługi.
4.1. GcReqDze
Struktura zapytania o geokodowanie działek.
Nazwa | Opis | Schemat |
---|---|---|
epsg |
odwzorowanie |
integer (int32) |
reqs |
lista działek do zgeokodowania |
< GcSingleDze > array |
useExtServiceIfNotFound |
czy użyć zewnętrznych usug w przypadku nie znalezienia w CAPAP |
boolean |
4.2. GcReqJpa
Struktura zapytania o geokodowanie jednostek podziału administracyjnego / gminy.
Nazwa | Opis | Schemat |
---|---|---|
epsg |
odwzorowanie |
integer (int32) |
reqs |
lista obiektów do zgeokodowania |
< GcSingleJpa > array |
4.3. GcReqPkt
Struktura zapytania o geokodowanie punktów adresowych.
Nazwa | Opis | Schemat |
---|---|---|
epsg |
odwzorowanie |
integer (int32) |
reqs |
lista punktów adresowych do zgeokodowania |
< GcSinglePkt > array |
useExtServiceIfNotFound |
czy użyć zewnętrznych usug w przypadku nie znalezienia w CAPAP |
boolean |
4.4. GcReqPow
Struktura zapytania o geokodowanie powiatu.
Nazwa | Opis | Schemat |
---|---|---|
epsg |
odwzorowanie |
integer (int32) |
reqs |
lista obiektów do zgeokodowania |
< GcSinglePow > array |
4.5. GcReqPrngJo
Struktura zapytania o geokodowanie jednostki osadniczej.
Nazwa | Opis | Schemat |
---|---|---|
epsg |
odwzorowanie |
integer (int32) |
reqs |
lista obiektów do zgeokodowania |
< GcSinglePrngJo > array |
4.6. GcReqPrngOf
Struktura zapytania o geokodowanie obiektu fizjograficznego.
Nazwa | Opis | Schemat |
---|---|---|
epsg |
odwzorowanie |
integer (int32) |
reqs |
lista obiektów do zgeokodowania |
< GcSinglePrngOf > array |
4.7. GcReqWoj
Struktura zapytania o geokodowanie województwa.
Nazwa | Opis | Schemat |
---|---|---|
epsg |
odwzorowanie |
integer (int32) |
reqs |
lista obiektów do zgeokodowania |
< GcSingleWoj > array |
4.8. GcResult
Struktura zwracania wyniku operacji geokodowania.
Nazwa | Opis | Schemat |
---|---|---|
distance |
dla odwrotnego geokodowania - odległość |
number (double) |
extTimeMs |
czas wywołania usług zewnętrznych w ms |
integer (int64) |
id |
wartość atrybutu id przekazana w wywołaniu zapytania |
object |
others |
pozostałe, mniej trafne wyniki - jeśli są |
< object > array |
relevance |
trafność wyniku, liczona dla najlepszego trafienia |
number (double) |
score |
dla geokodowania - punktacja wyszukiwania |
number (double) |
single |
najlepsze trafienie będące wynikiem zapytania |
object |
source |
pochodzenie wyniku wyszukiwania |
string |
src |
wartość atrybutu src przekazana w wywołaniu zapytania |
object |
xmessage |
string |
4.9. GcSingleDze
Parametry geokodowania działki
Nazwa | Opis | Schemat |
---|---|---|
ftsid |
wyszukiwanie po konkretnym identyfikatorze |
string |
gm_nazwa |
gmina |
string |
id |
wartość atrybutu id do zwrócenia w wynikach |
object |
idswde |
pełny identyfikator SWDE |
string |
miejsc_nazwa |
miejscowość |
string |
nr_dz |
numer działki |
string |
pow_nazwa |
powiat |
string |
q |
wyszukiwanie po pełym tekście |
string |
src |
wartość atrybutu src do zwrócenia w wynikach |
object |
teryt |
teryt |
string |
woj_nazwa |
województwo |
string |
4.10. GcSingleJpa
Parametry geokodowania JPA / gminy
Nazwa | Opis | Schemat |
---|---|---|
ftsid |
wyszukiwanie po konkretnym identyfikatorze |
string |
gm_nazwa |
gmina |
string |
id |
wartość atrybutu id do zwrócenia w wynikach |
object |
pow_nazwa |
powiat |
string |
q |
wyszukiwanie po pełym tekście |
string |
src |
wartość atrybutu src do zwrócenia w wynikach |
object |
teryt |
teryt |
string |
woj_nazwa |
województwo |
string |
4.11. GcSinglePkt
Parametry geokodowania punktu adresowego
Nazwa | Opis | Schemat |
---|---|---|
ftsid |
wyszukiwanie po konkretnym identyfikatorze |
string |
gm_nazwa |
gmina |
string |
id |
wartość atrybutu id do zwrócenia w wynikach |
object |
miejsc_n_nazwa |
nazwa miejscowości nadrzędnej |
string |
miejsc_nazwa |
nazwa miejscowości |
string |
pkt_kodPocztowy |
kod pocztowy |
string |
pkt_numer |
numer domu |
string |
pow_nazwa |
powiat |
string |
q |
wyszukiwanie po pełym tekście adresu, gdy nie są wydzielone jego części |
string |
src |
wartość atrybutu src do zwrócenia w wynikach |
object |
ul_nazwa_czesc |
część opcjonalna nazwy ulicy |
string |
ul_nazwa_glowna |
część główna nazwy ulicy |
string |
ul_nazwa_przed1 |
przedrostek 1 nazwy ulicy |
string |
ul_nazwa_przed2 |
przedrostek 2 nazwy ulicy |
string |
ul_pelna |
pełny tekst nazwy ulicy (nie rozbity na części) |
string |
ul_typ |
typ ulicy |
string |
woj_nazwa |
województwo |
string |
4.12. GcSinglePow
Parametry geokodowania powiatu
Nazwa | Opis | Schemat |
---|---|---|
ftsid |
wyszukiwanie po konkretnym identyfikatorze |
string |
id |
wartość atrybutu id do zwrócenia w wynikach |
object |
pow_nazwa |
powiat |
string |
q |
wyszukiwanie po pełym tekście |
string |
src |
wartość atrybutu src do zwrócenia w wynikach |
object |
teryt |
teryt |
string |
woj_nazwa |
województwo |
string |
4.13. GcSinglePrngJo
Parametry geokodowania jednostki osadniczej
Nazwa | Opis | Schemat |
---|---|---|
ftsid |
wyszukiwanie po konkretnym identyfikatorze |
string |
gm_nazwa |
gmina |
string |
id |
wartość atrybutu id do zwrócenia w wynikach |
object |
pow_nazwa |
powiat |
string |
q |
wyszukiwanie po pełym tekście |
string |
src |
wartość atrybutu src do zwrócenia w wynikach |
object |
woj_nazwa |
województwo |
string |
4.14. GcSinglePrngOf
Parametry geokodowania obiektu fizjograficznego
Nazwa | Opis | Schemat |
---|---|---|
ftsid |
wyszukiwanie po konkretnym identyfikatorze |
string |
gm_nazwa |
gmina |
string |
id |
wartość atrybutu id do zwrócenia w wynikach |
object |
pow_nazwa |
powiat |
string |
q |
wyszukiwanie po pełym tekście |
string |
src |
wartość atrybutu src do zwrócenia w wynikach |
object |
woj_nazwa |
województwo |
string |
4.15. GcSingleWoj
Parametry geokodowania województwa
Nazwa | Opis | Schemat |
---|---|---|
ftsid |
wyszukiwanie po konkretnym identyfikatorze |
string |
id |
wartość atrybutu id do zwrócenia w wynikach |
object |
q |
wyszukiwanie po pełym tekście |
string |
src |
wartość atrybutu src do zwrócenia w wynikach |
object |
teryt |
teryt |
string |
woj_nazwa |
województwo |
string |
4.16. HierarchDesc
Opis struktury filtrów hierarchicznych.
Nazwa | Opis | Schemat |
---|---|---|
filters |
filtry dostępne dla hierarchii |
< HierarchLevelDesc > array |
hierarchyName |
nazwa hierarchii |
string |
4.17. HierarchFilter
Parametry filtru wyszukiwań hierarchicznych.
Nazwa | Opis | Schemat |
---|---|---|
level |
identyfikator filtra |
string |
q |
ciąg znaków zapytania |
string |
v |
dokładna wartość (wybrana pozycja słownikowa) |
string |
4.18. HierarchLevelDesc
Metadane dla danego poziomu filtrów hierarchicznych.
Nazwa | Opis | Schemat |
---|---|---|
l |
poziom (faktyczny) |
integer (int32) |
level |
identyfikator filtra |
string |
name |
nazwa filtra |
string |
qonly |
boolean |
4.19. HierarchListEntry
Element odpowiedzi o wartości słownikowe dla wyszukiwania hierarchicznego.
Nazwa | Opis | Schemat |
---|---|---|
data |
dane znalezionego obiektu |
object |
filters |
filtry po wybraniu tego elementu |
< HierarchFilter > array |
value |
wartość |
string |
4.20. QueryNearestRefRequest
Parametry wyszukiwania najbliższych danych referencyjnch dla wywołania POST.
Nazwa | Opis | Schemat |
---|---|---|
bbox |
ekstent w postaci: x1,y1,x2,y2. Nie może być pusty! |
string |
bboxm |
tryb ekstentu: soft|hard, domniemany: soft |
string |
cnt |
ilość zwracanych wyników |
integer (int32) |
offs |
ofset |
integer (int32) |
q |
tekst zapytania |
string |
r |
dane referencyjne zwracane w ramach zapytania: all | pkt,ulc,… | none | (empty) |
string |
tags |
tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag |
< string > array |
ter |
ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty). NA RAZIE nie filtruje usług zewnętrznych. |
string |
top |
operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or |
< string > array |
4.21. QueryNearestRequest
Dane wyszukiwania najbliższych dla wywołania POST.
Nazwa | Opis | Schemat |
---|---|---|
bbox |
ekstent w postaci: x1,y1,x2,y2. Nie może być pusty! |
string |
bboxm |
tryb ekstentu: soft|hard, domniemany: soft |
string |
cnt |
ilość zwracanych wyników |
integer (int32) |
idx |
Identyfikatory zasobów oddzielone przecinkami. |
string |
offs |
ofset |
integer (int32) |
q |
tekst zapytania |
string |
r |
dane referencyjne zwracane w ramach zapytania: all | pkt,ulc,… | none | (empty) |
string |
tags |
tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag |
< string > array |
ter |
ograniczenie do terytu: województwa (2 cyfry), powiatu (4 cyfry), gminy (7 cyfr) | (empty) |
string |
top |
operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or |
< string > array |
4.22. RevgcReq
Struktura zapytań odwrotnego geokodowania dla poszczególnych warstw.
Nazwa | Opis | Schemat |
---|---|---|
cfg |
konfiguracja użytych warstw |
< RevgcReqCfg > array |
reqs |
lista poszczególnych zapytań / współrzędnych |
< RevgcReqSingle > array |
4.23. RevgcReqCfg
Konfiguracja zapytań odwrotnego geokodowania dla poszczególnych warstw.
Nazwa | Opis | Schemat |
---|---|---|
layer |
kod warstwy |
string |
maxDistance |
opcjonalna maksymalna odległość dla warstw punktowych |
number (double) |
4.24. RevgcReqSingle
Parametry operacji odwrotnego geokodowania.
Nazwa | Opis | Schemat |
---|---|---|
id |
wartość atrybutu id do zwrócenia w wynikach |
object |
src |
wartość atrybutu src do zwrócenia w wynikach |
object |
x |
pierwsza współrzędna (lon) |
number (double) |
y |
druga współrzędna (lat) |
number (double) |
4.25. RevgcResSingle
Struktura zwracania wyniku operacji odwrotnego geokodowania.
Nazwa | Opis | Schemat |
---|---|---|
found |
znalezione obiekty z poszczególnych warstw |
< string, GcResult > map |
id |
wartość atrybutu id przekazana w wywołaniu zapytania |
object |
src |
wartość atrybutu src przekazana w wywołaniu zapytania |
object |
x |
pierwsza współrzędna (lon) |
number (double) |
y |
druga współrzędna (lat) |
number (double) |