Pasta poligonu serviss

Pasta poligonu tīmekļa serviss (API) nodrošina Latvijas, Igaunijas un lielākās daļas Lietuvas pasta poligonu robežu koordinātu (ģeometrijas) saņemšanu. Pasta poligonu API rezultātu meklēšana notiek, veicot HTTP GET pieprasījumu uz klientam piešķirtu URL saiti, kas ir pieejams kā REST veida tīmekļa serviss. Klients var padot API teksta vaicājumu ar pasta poligona indeksa vērtību (vai vairākām), kā arī pasta indeksu grupas, un kā atbildes rezultātu saņemt konkrēto poligonu virsotņu koordinātas.

Servisa URL

Servisa saitei jāatbilst šādai formai:

https://api.kartes.lv/v3//postal_codes?

Atgriezto datu formāts ir JSON.

HTTP metode ir GET.

Pieprasījuma parametri

Iespējams padot šādus GET parametrus:

Parametrs	Skaidrojums	Vērtības
search	Pasta indekss (vairākus atdalīt ar komatu, maksimālais indeksu skaits 800)	Parametrs obligāts, ja netiek padots groups LV, EE vai LT valstu abreviatūra un poligona numurs
groups	Pasta indeksa grupa (vairākas atdalīt ar komatu)	Parametrs obligāts, ja netiek padots search Piemērs "LV-10"
wgs84	Ja padots, ģeometrija tiek atgriezta WGS84 (EPSG:4326) koordinātās, pretējā gadījumā TM Baltic93 (EPSG:25884)	Bez parametra
wkt	Ja padots, ģeometrija tiek atgriezta WKT formātā, pretējā gadījumā GeoJSON masīvā	Bez parametra
union_mode	Apvienošanas algoritms	Pieejami 3 režīmi: isolate (noklusējuma vērtība) – vienmēr katrs poligons atgriezts ka atsevišķs objekts; collect – poligoni apvienoti vienā objektā, bet starp viņiem ir robeža; union – poligoni apvienoti pilnībā, robežas nav.

Atbildes parametri

Atbildē tiek atgriezts masīvs ar objektiem, objektu parametri ir šādi:

Parametrs	Skaidrojums
postal_code	Masīvs ar pasta poligonu indeksiem, kurus tika atrasti pēc search parametra.
geometry	Atrasto pasta poligonu ģeometrija WKT vai GeoJSON formātā, kas ir atkarīgs no definētā wkt parametra.

Kļūdu kodi

Kods	Skaidrojums
200	Wrong union mode. Nepareizs apvienošanas algoritms.
200	Postal code index is missing. Nav pasta indeksa.
200	Too many postal indexes were passed. Pārāk liels pasta indeksu skaits.
404	No location found. Tiek atgriezts, ja nekas nav ticis atrasts.
5xx	Servera kļūda.

Paraugi

1. paraugs

Pieprasījums:

https://api.kartes.lv/v3//postal_codes?search=LV-1021,LV-1082&wgs84&wkt&union_mode=union

Atbilde:

[
    {
        "postal_code": [
            "LV-1021",
            "LV-1082"
        ],
        "geometry": "POLYGON((24.2123111802785 56.953430682896,24.2153246434572 56.952974283183,...))"
    }
]

2. paraugs

Pieprasījums:

https://api.kartes.lv/v3//postal_codes?search=LV-1021,LV-1082&wgs84&wkt&union_mode=isolate

Atbilde:

[
    {
        "postal_code": [
            "LV-1021"
        ],
        "geometry": "POLYGON((24.2287944060861 56.9599540264562,24.2287074011031 56.9599767747401,24.2270271112969 56.9604160973327,24.2246066418339 56.9583737401,...))"
    },
    {
        "postal_code": [
            "LV-1082"
        ],
        "geometry": "MULTIPOLYGON(((24.2145900344104 56.9517267143314,24.2145994285211 56.9518323289897,24.2144417916266 56.9519238258176,...)))"
    }
]

3. paraugs

Pieprasījums:

https://api.kartes.lv/v3//postal_codes?search=LV-1021,LV-1082&wgs84&wkt&union_mode=collect

Atbilde:

[
    {
        "postal_code": [
            "LV-1021",
            "LV-1082"
        ],
        "geometry": "GEOMETRYCOLLECTION(POLYGON((24.2287944060861 56.9599540264562,24.2287074011031 56.9599767747401,24.2270271112969 56.9604160973327,24.2246066418339 56.9583737401,...)))"
    }
]

4. paraugs

Pieprasījums:

https://api.kartes.lv/v3//postal_codes?search=LV-2167&groups=LV-10&wgs84&wkt&union_mode=union

Atbilde:

[
    {
        "postal_code": [
            "LV-1050",
            "LV-2167",
            ...
            "LV-1024"
        ],
        "geometry": "POLYGON((24.0702378727879 56.8792032859641,24.0693149401602 56.8792182722479,24.0674807921115 56.8792676685704,24.0654289714374 56.8747037327839,...))"
    }
]