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
Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

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": [
      {
      "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
Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

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": [
      {
      "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
Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

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": [
      {
      "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
Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

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": [
    {
      "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
Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

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": [
    {
      "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
Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

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": [
        {
          "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
Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

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": [
        {
            "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
wymagane

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
wymagane

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
Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

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": [
        {
            "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
opcjonalne

odległość [metry]

number (double)

Query

x
opcjonalne

x (lon)

number (double)

Query

y
opcjonalne

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/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
opcjonalne

x (lon)

number (double)

Query

y
opcjonalne

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?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
opcjonalne

x (lon)

number (double)

Query

y
opcjonalne

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
opcjonalne

x (lon)

number (double)

Query

y
opcjonalne

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
opcjonalne

x (lon)

number (double)

Query

y
opcjonalne

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
opcjonalne

odległość [metry]

number (double)

Query

x
opcjonalne

x (lon)

number (double)

Query

y
opcjonalne

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
opcjonalne

odległość [metry]

number (double)

Query

x
opcjonalne

x (lon)

number (double)

Query

y
opcjonalne

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ł

Parametry
Typ Nazwa Opis Schemat

Body

req
wymagane

req

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
opcjonalne

tekst po kursorze, pełne słowa

string

Query

b
opcjonalne

tekst przed kursorem, może zawierać częściowe słowo

string

Query

bbox
opcjonalne

ekstent w postaci: x1,y1,x2,y2 lub pusty string

string

Query

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

"soft"

Query

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

20

Query

idx
opcjonalne

Identyfikatory zasobów oddzielone przecinkami.

string

Query

tag
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array(multi)

Query

top
opcjonalne

operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or

< string > array(multi)

"or"

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

Produkuje
  • application/json

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
wymagane

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

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
opcjonalne

ekstent w postaci: x1,y1,x2,y2 lub pusty string

string

Query

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

"soft"

Query

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

20

Query

idx
opcjonalne

Identyfikatory zasobów oddzielone przecinkami.

string

"all"

Query

offs
opcjonalne

ofset

integer (int32)

0

Query

q
opcjonalne

tekst zapytania

string

Query

r
opcjonalne

dane referencyjne zwracane w ramach zapytania: all | pkt,ulc,… | none | (empty)

string

Query

tag
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array(multi)

Query

top
opcjonalne

operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or

< string > array(multi)

"or"

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
  • application/json

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
opcjonalne

tekst po kursorze, pełne słowa

string

Query

b
opcjonalne

tekst przed kursorem, może zawierać częściowe słowo

string

Query

bbox
opcjonalne

ekstent w postaci: x1,y1,x2,y2 lub pusty string

string

Query

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

"soft"

Query

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

20

Query

idx
opcjonalne

Identyfikatory zasobów referencyjnych oddzielone przecinkami: all | pkt,ulc,… | none | (pusty)

string

"all"

Query

tag
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array(multi)

Query

top
opcjonalne

operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or

< string > array(multi)

"or"

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

Produkuje
  • application/json

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
wymagane

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

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
opcjonalne

ekstent w postaci: x1,y1,x2,y2 lub pusty string

string

Query

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

"soft"

Query

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

20

Query

idx
opcjonalne

Identyfikatory zasobów referencyjnych oddzielone przecinkami: all | pkt,ulc,… | none | (pusty)

string

"all"

Query

offs
opcjonalne

ofset

integer (int32)

0

Query

q
opcjonalne

tekst zapytania

string

Query

tag
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array(multi)

Query

top
opcjonalne

operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or

< string > array(multi)

"or"

Query

useExtSvc
opcjonalne

true - użycie także zewnętrznej usługi (adresy,działki)

boolean

"false"

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
  • application/json

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
opcjonalne

ekstent w postaci: x1,y1,x2,y2 lub pusty string

string

Query

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

"soft"

Query

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

20

Query

idx
opcjonalne

Identyfikatory zasobów referencyjnych oddzielone przecinkami: all | pkt,ulc,… | none | (pusty)

string

"all"

Query

offs
opcjonalne

ofset

integer (int32)

0

Query

q
opcjonalne

tekst zapytania

string

Query

tag
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array(multi)

Query

top
opcjonalne

operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or

< string > array(multi)

"or"

Query

useExtOnly
opcjonalne

true - użycie tylko zewnętrznej usługi (działki)

boolean

"false"

Query

useExtSvc
opcjonalne

true - użycie także zewnętrznej usługi (adresy,działki)

boolean

"false"

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
  • application/json

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

Produkuje
  • application/json

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
opcjonalne

ekstent w postaci: x1,y1,x2,y2 lub pusty string

string

Query

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

"soft"

Query

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

20

Query

offs
opcjonalne

ofset

integer (int32)

0

Query

q
opcjonalne

tekst zapytania

string

Query

tag
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array(multi)

Query

top
opcjonalne

operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or

< string > array(multi)

"or"

Body

req
wymagane

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

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
wymagane

hId - identyfikator hierarchii

string

Path

level
wymagane

level - poziom hierarchii

string

Query

cnt
opcjonalne

cnt

integer (int32)

100

Query

o
opcjonalne

offset

integer (int32)

0

Body

req
wymagane

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

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
opcjonalne

ekstent w postaci: x1,y1,x2,y2 lub pusty string

string

Query

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

"soft"

Query

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

20

Query

offs
opcjonalne

ofset

integer (int32)

0

Query

q
opcjonalne

tekst zapytania

string

Query

tag
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array(multi)

Query

top
opcjonalne

operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or

< string > array(multi)

"or"

Body

req
wymagane

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

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
opcjonalne

ekstent w postaci: x1,y1,x2,y2 lub pusty string

string

Query

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

"soft"

Query

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

20

Query

offs
opcjonalne

ofset

integer (int32)

0

Query

q
opcjonalne

tekst zapytania

string

Query

tag
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array(multi)

Query

top
opcjonalne

operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or

< string > array(multi)

"or"

Body

req
wymagane

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

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
opcjonalne

ekstent w postaci: x1,y1,x2,y2 lub pusty string

string

Query

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

"soft"

Query

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

20

Query

offs
opcjonalne

ofset

integer (int32)

0

Query

q
opcjonalne

tekst zapytania

string

Query

tag
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array(multi)

Query

top
opcjonalne

operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or

< string > array(multi)

"or"

Body

req
wymagane

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

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
opcjonalne

ekstent w postaci: x1,y1,x2,y2 lub pusty string

string

Query

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

"soft"

Query

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

20

Query

offs
opcjonalne

ofset

integer (int32)

0

Query

q
opcjonalne

tekst zapytania

string

Query

tag
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array(multi)

Query

top
opcjonalne

operatory dla tagów: and | or. Dla wybranego zasobu w postaci: res || or,res || or

< string > array(multi)

"or"

Body

req
wymagane

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

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
opcjonalne

odwzorowanie

integer (int32)

reqs
opcjonalne

lista działek do zgeokodowania

< GcSingleDze > array

useExtServiceIfNotFound
opcjonalne

czy użyć zewnętrznych usug w przypadku nie znalezienia w CAPAP
Przykład : false

boolean

4.2. GcReqJpa

Struktura zapytania o geokodowanie jednostek podziału administracyjnego / gminy.

Nazwa Opis Schemat

epsg
opcjonalne

odwzorowanie

integer (int32)

reqs
opcjonalne

lista obiektów do zgeokodowania

< GcSingleJpa > array

4.3. GcReqPkt

Struktura zapytania o geokodowanie punktów adresowych.

Nazwa Opis Schemat

epsg
opcjonalne

odwzorowanie

integer (int32)

reqs
opcjonalne

lista punktów adresowych do zgeokodowania

< GcSinglePkt > array

useExtServiceIfNotFound
opcjonalne

czy użyć zewnętrznych usug w przypadku nie znalezienia w CAPAP
Przykład : false

boolean

4.4. GcReqPow

Struktura zapytania o geokodowanie powiatu.

Nazwa Opis Schemat

epsg
opcjonalne

odwzorowanie

integer (int32)

reqs
opcjonalne

lista obiektów do zgeokodowania

< GcSinglePow > array

4.5. GcReqPrngJo

Struktura zapytania o geokodowanie jednostki osadniczej.

Nazwa Opis Schemat

epsg
opcjonalne

odwzorowanie

integer (int32)

reqs
opcjonalne

lista obiektów do zgeokodowania

< GcSinglePrngJo > array

4.6. GcReqPrngOf

Struktura zapytania o geokodowanie obiektu fizjograficznego.

Nazwa Opis Schemat

epsg
opcjonalne

odwzorowanie

integer (int32)

reqs
opcjonalne

lista obiektów do zgeokodowania

< GcSinglePrngOf > array

4.7. GcReqWoj

Struktura zapytania o geokodowanie województwa.

Nazwa Opis Schemat

epsg
opcjonalne

odwzorowanie

integer (int32)

reqs
opcjonalne

lista obiektów do zgeokodowania

< GcSingleWoj > array

4.8. GcResult

Struktura zwracania wyniku operacji geokodowania.

Nazwa Opis Schemat

distance
opcjonalne

dla odwrotnego geokodowania - odległość

number (double)

extTimeMs
opcjonalne

czas wywołania usług zewnętrznych w ms

integer (int64)

id
opcjonalne

wartość atrybutu id przekazana w wywołaniu zapytania

object

others
opcjonalne

pozostałe, mniej trafne wyniki - jeśli są

< object > array

relevance
opcjonalne

trafność wyniku, liczona dla najlepszego trafienia

number (double)

score
opcjonalne

dla geokodowania - punktacja wyszukiwania

number (double)

single
opcjonalne

najlepsze trafienie będące wynikiem zapytania

object

source
opcjonalne

pochodzenie wyniku wyszukiwania

string

src
opcjonalne

wartość atrybutu src przekazana w wywołaniu zapytania

object

xmessage
opcjonalne

string

4.9. GcSingleDze

Parametry geokodowania działki

Nazwa Opis Schemat

ftsid
opcjonalne

wyszukiwanie po konkretnym identyfikatorze

string

gm_nazwa
opcjonalne

gmina

string

id
opcjonalne

wartość atrybutu id do zwrócenia w wynikach

object

idswde
opcjonalne

pełny identyfikator SWDE

string

miejsc_nazwa
opcjonalne

miejscowość

string

nr_dz
opcjonalne

numer działki

string

pow_nazwa
opcjonalne

powiat

string

q
opcjonalne

wyszukiwanie po pełym tekście

string

src
opcjonalne

wartość atrybutu src do zwrócenia w wynikach

object

teryt
opcjonalne

teryt

string

woj_nazwa
opcjonalne

województwo

string

4.10. GcSingleJpa

Parametry geokodowania JPA / gminy

Nazwa Opis Schemat

ftsid
opcjonalne

wyszukiwanie po konkretnym identyfikatorze

string

gm_nazwa
opcjonalne

gmina

string

id
opcjonalne

wartość atrybutu id do zwrócenia w wynikach

object

pow_nazwa
opcjonalne

powiat

string

q
opcjonalne

wyszukiwanie po pełym tekście

string

src
opcjonalne

wartość atrybutu src do zwrócenia w wynikach

object

teryt
opcjonalne

teryt

string

woj_nazwa
opcjonalne

województwo

string

4.11. GcSinglePkt

Parametry geokodowania punktu adresowego

Nazwa Opis Schemat

ftsid
opcjonalne

wyszukiwanie po konkretnym identyfikatorze

string

gm_nazwa
opcjonalne

gmina

string

id
opcjonalne

wartość atrybutu id do zwrócenia w wynikach

object

miejsc_n_nazwa
opcjonalne

nazwa miejscowości nadrzędnej

string

miejsc_nazwa
opcjonalne

nazwa miejscowości

string

pkt_kodPocztowy
opcjonalne

kod pocztowy

string

pkt_numer
opcjonalne

numer domu

string

pow_nazwa
opcjonalne

powiat

string

q
opcjonalne

wyszukiwanie po pełym tekście adresu, gdy nie są wydzielone jego części

string

src
opcjonalne

wartość atrybutu src do zwrócenia w wynikach

object

ul_nazwa_czesc
opcjonalne

część opcjonalna nazwy ulicy

string

ul_nazwa_glowna
opcjonalne

część główna nazwy ulicy

string

ul_nazwa_przed1
opcjonalne

przedrostek 1 nazwy ulicy

string

ul_nazwa_przed2
opcjonalne

przedrostek 2 nazwy ulicy

string

ul_pelna
opcjonalne

pełny tekst nazwy ulicy (nie rozbity na części)

string

ul_typ
opcjonalne

typ ulicy

string

woj_nazwa
opcjonalne

województwo

string

4.12. GcSinglePow

Parametry geokodowania powiatu

Nazwa Opis Schemat

ftsid
opcjonalne

wyszukiwanie po konkretnym identyfikatorze

string

id
opcjonalne

wartość atrybutu id do zwrócenia w wynikach

object

pow_nazwa
opcjonalne

powiat

string

q
opcjonalne

wyszukiwanie po pełym tekście

string

src
opcjonalne

wartość atrybutu src do zwrócenia w wynikach

object

teryt
opcjonalne

teryt

string

woj_nazwa
opcjonalne

województwo

string

4.13. GcSinglePrngJo

Parametry geokodowania jednostki osadniczej

Nazwa Opis Schemat

ftsid
opcjonalne

wyszukiwanie po konkretnym identyfikatorze

string

gm_nazwa
opcjonalne

gmina

string

id
opcjonalne

wartość atrybutu id do zwrócenia w wynikach

object

pow_nazwa
opcjonalne

powiat

string

q
opcjonalne

wyszukiwanie po pełym tekście

string

src
opcjonalne

wartość atrybutu src do zwrócenia w wynikach

object

woj_nazwa
opcjonalne

województwo

string

4.14. GcSinglePrngOf

Parametry geokodowania obiektu fizjograficznego

Nazwa Opis Schemat

ftsid
opcjonalne

wyszukiwanie po konkretnym identyfikatorze

string

gm_nazwa
opcjonalne

gmina

string

id
opcjonalne

wartość atrybutu id do zwrócenia w wynikach

object

pow_nazwa
opcjonalne

powiat

string

q
opcjonalne

wyszukiwanie po pełym tekście

string

src
opcjonalne

wartość atrybutu src do zwrócenia w wynikach

object

woj_nazwa
opcjonalne

województwo

string

4.15. GcSingleWoj

Parametry geokodowania województwa

Nazwa Opis Schemat

ftsid
opcjonalne

wyszukiwanie po konkretnym identyfikatorze

string

id
opcjonalne

wartość atrybutu id do zwrócenia w wynikach

object

q
opcjonalne

wyszukiwanie po pełym tekście

string

src
opcjonalne

wartość atrybutu src do zwrócenia w wynikach

object

teryt
opcjonalne

teryt

string

woj_nazwa
opcjonalne

województwo

string

4.16. HierarchDesc

Opis struktury filtrów hierarchicznych.

Nazwa Opis Schemat

filters
opcjonalne

filtry dostępne dla hierarchii

< HierarchLevelDesc > array

hierarchyName
opcjonalne

nazwa hierarchii

string

4.17. HierarchFilter

Parametry filtru wyszukiwań hierarchicznych.

Nazwa Opis Schemat

level
wymagane

poziom

string

q
opcjonalne

ciąg zapytania

string

v
opcjonalne

dokładna wartość (wybrana pozycja)

string

4.18. HierarchLevelDesc

Metadane dla danego poziomu filtrów hierarchicznych.

Nazwa Opis Schemat

l
opcjonalne

lp

integer (int32)

level
opcjonalne

poziom

string

name
opcjonalne

nazwa

string

qonly
wymagane

boolean

4.19. HierarchListEntry

Element odpowiedzi o wartości słownikowe dla wyszukiwania hierarchicznego.

Nazwa Opis Schemat

data
opcjonalne

dane znalezionego obiektu

object

filters
wymagane

filtry po wybraniu tego elementu

< HierarchFilter > array

value
wymagane

wartość

string

4.20. QueryNearestRefRequest

Parametry wyszukiwania najbliższych danych referencyjnch dla wywołania POST.

Nazwa Opis Schemat

bbox
opcjonalne

ekstent w postaci: x1,y1,x2,y2. Nie może być pusty!

string

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

offs
opcjonalne

ofset

integer (int32)

q
opcjonalne

tekst zapytania

string

r
opcjonalne

dane referencyjne zwracane w ramach zapytania: all | pkt,ulc,… | none | (empty)

string

tags
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array

top
opcjonalne

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
opcjonalne

ekstent w postaci: x1,y1,x2,y2. Nie może być pusty!

string

bboxm
opcjonalne

tryb ekstentu: soft|hard, domniemany: soft

string

cnt
opcjonalne

ilość zwracanych wyników

integer (int32)

idx
opcjonalne

Identyfikatory zasobów oddzielone przecinkami.

string

offs
opcjonalne

ofset

integer (int32)

q
opcjonalne

tekst zapytania

string

r
opcjonalne

dane referencyjne zwracane w ramach zapytania: all | pkt,ulc,… | none | (empty)

string

tags
opcjonalne

tag(i) filtrowania. Może być kilka. Tag dla wybranego zasobu w postaci: res || tag

< string > array

top
opcjonalne

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
opcjonalne

konfiguracja użytych warstw

< RevgcReqCfg > array

reqs
opcjonalne

lista poszczególnych zapytań / współrzędnych

< RevgcReqSingle > array

4.23. RevgcReqCfg

Konfiguracja zapytań odwrotnego geokodowania dla poszczególnych warstw.

Nazwa Opis Schemat

layer
opcjonalne

kod warstwy

string

maxDistance
opcjonalne

opcjonalna maksymalna odległość dla warstw punktowych

number (double)

4.24. RevgcReqSingle

Parametry operacji odwrotnego geokodowania.

Nazwa Opis Schemat

id
opcjonalne

wartość atrybutu id do zwrócenia w wynikach

object

src
opcjonalne

wartość atrybutu src do zwrócenia w wynikach

object

x
wymagane

pierwsza współrzędna

number (double)

y
wymagane

druga współrzędna współrzędna

number (double)

4.25. RevgcResSingle

Struktura zwracania wyniku operacji odwrotnego geokodowania.

Nazwa Opis Schemat

found
wymagane

znalezione obiekty z poszczególnych warstw

< string, GcResult > map

id
opcjonalne

wartość atrybutu id przekazana w wywołaniu zapytania

object

src
opcjonalne

wartość atrybutu src przekazana w wywołaniu zapytania

object

x
wymagane

pierwsza współrzędna

number (double)

y
wymagane

druga współrzędna współrzędna

number (double)