Avaliku API kirjeldus
Sellel lehel on ainult objektide avalikud lugemis- ja otsingu-API otsad.
Objektide lisamise, muutmise, piltide üleslaadimise ja muude kirjutavate tegevuste otsasid siin ei kirjeldata.
Üldinfo
Kõik allolevad näited kasutavad aktiivse keele baas-URL-i:
https://lipseesti.ee/est/GET full region tree
Tagastab maakondade, omavalitsuste ja asustusüksuste puu objektide otsingu piirkonnafiltrile.
Request
GET https://lipseesti.ee/est/units/getFullRegionTreeResponse
[
{
"id": "0039",
"text": "Harju maakond",
"children": [
{
"id": "0784",
"text": "Tallinn",
"children": [
{
"id": "0468",
"text": "Kesklinn"
}
]
}
]
}
]GET object by ID
Tagastab ühe avaldatud objekti detailandmed objekti ID järgi.
Request
GET https://lipseesti.ee/est/objects/getObjectDataById/174Response
{
"id": 9182,
"object_id": 174,
"name": "Tallinna Sotsiaal- ja Tervishoiuamet",
"address": "Paldiski mnt 48a",
"lat": "59.431333127797",
"lon": "24.711095884446",
"website": "https://www.tallinn.ee/",
"phone": "6457440",
"email": "sotsiaal@tallinnlv.ee",
"published_date": "2024-10-12 09:34:17",
"description": {
"value": "Objekti kirjeldus"
},
"components": [],
"image_files": [],
"video_links": [],
"accessibilities": [],
"object_categories": [],
"linked_objects": [],
"comments_allowed": true,
"suggestions_allowed": true
}GET object by GIS ID
Tagastab objekti põhiandmed GIS ID järgi. Seda kasutatakse kaardivaadetes.
Request
GET https://lipseesti.ee/est/objects/getObjectDataByGisId/6ecf0a56-6b5c-4b6c-8d8c-123456789abcResponse
{
"object_id": 174,
"name": "Tallinna Sotsiaal- ja Tervishoiuamet",
"address": "Paldiski mnt 48a",
"lat": "59.431333127797",
"lon": "24.711095884446",
"website": "https://www.tallinn.ee/",
"phone": "6457440",
"email": "sotsiaal@tallinnlv.ee"
}POST object search
Tagastab filtreeritud objektid. Seda otsa kasutatakse eelkõige kaardi- ja popup-vaadetes.
Request
POST https://lipseesti.ee/est/objects/getObjectsBySearch{
"search": "raamatukogu",
"filter": {
"categories": [163],
"subCategories": [175],
"groups": [48],
"accessibilities": [49],
"properties": [321],
"regions": ["0037", "0784"],
"addresses": [
{
"county": "0037"
}
],
"isElectionObject": false,
"limit": 50,
"useSession": false
}
}JSON response
[
{
"object_id": 174,
"name": "Tallinna Sotsiaal- ja Tervishoiuamet",
"address": "Paldiski mnt 48a",
"lat": "59.431333127797",
"lon": "24.711095884446",
"object_categories": [],
"accessibilities": []
}
]HTML popup response
Kui saata responseType: "HTML", tagastatakse ühe leitud objekti HTML-kaart.
{
"search": null,
"responseType": "HTML",
"filter": {
"gisId": "6ecf0a56-6b5c-4b6c-8d8c-123456789abc"
}
}POST map object search
Tagastab kaartide jaoks objektide GIS ID-d. Seda kasutavad objektide otsingu kaardivaade ja omavalitsuse kaart.
Request
POST https://lipseesti.ee/est/objects/getMapObjectsBySearch{
"search": "",
"filter": {
"categories": [],
"subCategories": [],
"groups": [],
"accessibilities": [],
"properties": [],
"addresses": [
{
"county": "0039"
}
],
"regions": ["0039"],
"isElectionObject": false
},
"page": 1,
"perPage": 24
}Response
[
{
"gis_id": "6ecf0a56-6b5c-4b6c-8d8c-123456789abc"
}
]POST paginated object search
Tagastab otsingutulemused koos paginatsiooniandmetega. See on põhiots veebilehe objektide nimekirja jaoks.
Request
POST https://lipseesti.ee/est/objects/getObjectsBySearchFull{
"search": "",
"filter": {
"categories": [],
"subCategories": [],
"groups": [],
"accessibilities": [],
"properties": [],
"addresses": [
{
"county": "0039"
}
],
"regions": ["0039"],
"isElectionObject": false,
"search": ""
},
"page": 1,
"perPage": 24,
"responseType": "html"
}JSON response
{
"items": [
{
"object_id": 174,
"name": "Tallinna Spordihoone",
"address": "Näide 1",
"image_files": [],
"has_video": false
}
],
"total": 138,
"page": 1,
"perPage": 24,
"totalPages": 6
}HTML response
Kui saata responseType: "html", tagastatakse HTML-fragmendid koos paginatsiooni metaandmetega.
{
".object-search__results": "<article>...</article>",
".object-search__pagination": "<nav>...</nav>",
"paginationData": {
"total": 138,
"page": 1,
"perPage": 24,
"totalPages": 6
}
}POST category counts
Tagastab kategooriate ja alamkategooriate tulemuste arvud aktiivsete filtrite põhjal.
Request
POST https://lipseesti.ee/est/objects/objectsAmountForCategories{
"search": "ujula",
"filter": {
"categories": [166],
"subCategories": [],
"groups": [],
"accessibilities": [],
"properties": [],
"regions": ["0037"],
"addresses": [],
"search": "ujula"
}
}Response
{
"categories": [
{ "id": 166, "count": 12 }
],
"subCategories": [
{ "id": 203, "count": 4 }
]
}GET object classifiers
Tagastab otsingus kasutatavad klassifikaatorid: kategooriad, alamkategooriad, sihtgrupid, omadused ja ligipääsetavuse grupid.
Request
GET https://lipseesti.ee/est/classifiers/getObjectCategoriesResponse
{
"objectCategories": [
{
"id": 163,
"name": "Ametiasutused",
"icon_path": "authorities",
"subCategories": [
{
"id": 175,
"name": "Sotsiaalasutused"
}
]
}
],
"groups": [],
"properties": [],
"accessibilityGroups": []
}