Gå till innehållet

Registerbeteckning Direkt

RegisterbeteckningDirektClient

Client for the Registerbeteckning Direkt API.

Source code in lantmateriet_qgis/core/clients/registerbeteckningdirekt.py
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
class RegisterbeteckningDirektClient(BaseClient):
    """Client for the Registerbeteckning Direkt API."""

    base_path = "/distribution/produkter/registerbeteckning/v5"

    @classmethod
    def _handle_results(
        cls, srid: QgsCoordinateReferenceSystem | None, results: list[dict]
    ) -> list[dict]:
        return [
            from_feature(result, srid or QgsCoordinateReferenceSystem.fromEpsgId(3006))
            for result in results["features"]
        ]

    def get_one(
        self, id: str | UUID | QUuid, srid: QgsCoordinateReferenceSystem | None = None
    ) -> Beteckning:
        """Resolve a single designation."""
        query = QUrlQuery()
        if srid is not None:
            query.addQueryItem("srid", str(coerce_crs(srid)))

        result = self._get(f"/{coerce_uuid_to_str(id)}", query)
        return self._handle_results(srid, result)[0]

    def get_many(
        self,
        ids: list[str | UUID | QUuid],
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> list[Beteckning]:
        """Resolve multiple designations."""
        query = QUrlQuery()
        if srid is not None:
            query.addQueryItem("srid", str(coerce_crs(srid)))

        ids = [coerce_uuid_to_str(id) for id in ids]
        results = self._post("/", query, ids)
        return self._handle_results(srid, results)

    def get_by_name(
        self, name: str | list[str], srid: QgsCoordinateReferenceSystem | None = None
    ) -> list[Beteckning]:
        """Find designations matching a given name."""
        query = QUrlQuery()
        if srid is not None:
            query.addQueryItem("srid", str(coerce_crs(srid)))

        if isinstance(name, str):
            query.addQueryItem("namn", name)
            result = self._get("/namn", query)
        else:
            result = self._post("/namn", query, name)
        return self._handle_results(srid, result)

    def get_by_belongs_to(
        self,
        belongs_to: str | UUID | QUuid,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> list[Beteckning]:
        """Find designations belonging to a given object."""
        query = QUrlQuery()
        if srid is not None:
            query.addQueryItem("srid", str(coerce_crs(srid)))

        result = self._get(f"/tillhor/{coerce_uuid_to_str(belongs_to)}", query)
        return self._handle_results(srid, result)

    def get_by_point(
        self,
        point: QgsGeometry | QgsReferencedGeometry,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> list[Beteckning]:
        """Find designations overlapping a given point."""

        query = QUrlQuery()
        if srid is not None:
            query.addQueryItem("srid", str(coerce_crs(srid)))

        if isinstance(point, QgsReferencedGeometry):
            if is_supported_crs(point.crs()):
                query.addQueryItem("punktSrid", str(coerce_crs(point.crs())))
            else:
                transformer = QgsCoordinateTransform(
                    point.crs(),
                    QgsCoordinateReferenceSystem.fromEpsgId(3006),
                    QgsProject.instance().transformContext(),
                )
                point.transform(transformer)
        try:
            point: QgsPointXY = point.asPoint()
        except TypeError:
            raise ValueError("Invalid geometry type. Expected a point.")
        query.addQueryItem("koordinater", f"{point.y()},{point.x()}")

        result = self._get("/punkt", query)
        return self._handle_results(srid, result)

    def get_references_from_text(
        self,
        text: str,
        municipality_or_lan: str | None = None,
        status: Literal["gällande", "ledig", "omregistrerad", "reserverad", "spärrad"]
        | None = None,
        objektstatus: Literal["levande", "avregistrerad"] | None = None,
        max_hits: int = 100,
    ) -> list[RegisterbeteckningsReference]:
        """Find references to designations based on a text search."""

        query = QUrlQuery()
        query.addQueryItem("beteckning", text)
        if municipality_or_lan is not None:
            if len(municipality_or_lan) != 2:
                query.addQueryItem("kommunkod", municipality_or_lan)
            else:
                query.addQueryItem("lankod", municipality_or_lan)

        if status is not None:
            query.addQueryItem("status", status)
        if objektstatus is not None:
            query.addQueryItem("objektstatus", objektstatus)
        query.addQueryItem("maxHits", str(max_hits))

        result = self._get("/referens/fritext", query)
        return [RegisterbeteckningsReference(**item) for item in result]

    def get_references_from_geometry(
        self,
        geometry: QgsGeometry | QgsReferencedGeometry,
        buffer: int = 0,
        status: Literal["gällande", "ledig", "omregistrerad", "reserverad", "spärrad"]
        | None = None,
    ) -> list[RegisterbeteckningsReference]:
        """Find references to designations within a given geometry, or within a buffer distance thereof."""

        query = QUrlQuery()
        if isinstance(geometry, QgsReferencedGeometry):
            if not is_supported_crs(geometry.crs()):
                transformer = QgsCoordinateTransform(
                    geometry.crs(),
                    QgsCoordinateReferenceSystem.fromEpsgId(3006),
                    QgsProject.instance().transformContext(),
                )
                geometry.transform(transformer)
                geometry = QgsReferencedGeometry(
                    geometry.geometry(), QgsCoordinateReferenceSystem.fromEpsgId(3006)
                )
        else:
            geometry = QgsReferencedGeometry(
                geometry, QgsCoordinateReferenceSystem.fromEpsgId(3006)
            )
        if status is not None:
            query.addQueryItem("status", status)

        data = json.loads(geometry.asJson())
        data["crs"] = {
            "type": "name",
            "properties": {"name": geometry.crs().toOgcUrn()},
        }
        data = {"geometri": data, "buffer": buffer}

        result = self._post("/referens/geometri", query, data)
        if result is None:
            raise ValueError("Error retrieving references")
        return [RegisterbeteckningsReference(**item) for item in result]

get_one

get_one(
    id: str | UUID | QUuid,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> Beteckning

Resolve a single designation.

Source code in lantmateriet_qgis/core/clients/registerbeteckningdirekt.py
 95
 96
 97
 98
 99
100
101
102
103
104
def get_one(
    self, id: str | UUID | QUuid, srid: QgsCoordinateReferenceSystem | None = None
) -> Beteckning:
    """Resolve a single designation."""
    query = QUrlQuery()
    if srid is not None:
        query.addQueryItem("srid", str(coerce_crs(srid)))

    result = self._get(f"/{coerce_uuid_to_str(id)}", query)
    return self._handle_results(srid, result)[0]

get_many

get_many(
    ids: list[str | UUID | QUuid],
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[Beteckning]

Resolve multiple designations.

Source code in lantmateriet_qgis/core/clients/registerbeteckningdirekt.py
106
107
108
109
110
111
112
113
114
115
116
117
118
def get_many(
    self,
    ids: list[str | UUID | QUuid],
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[Beteckning]:
    """Resolve multiple designations."""
    query = QUrlQuery()
    if srid is not None:
        query.addQueryItem("srid", str(coerce_crs(srid)))

    ids = [coerce_uuid_to_str(id) for id in ids]
    results = self._post("/", query, ids)
    return self._handle_results(srid, results)

get_by_name

get_by_name(
    name: str | list[str],
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[Beteckning]

Find designations matching a given name.

Source code in lantmateriet_qgis/core/clients/registerbeteckningdirekt.py
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def get_by_name(
    self, name: str | list[str], srid: QgsCoordinateReferenceSystem | None = None
) -> list[Beteckning]:
    """Find designations matching a given name."""
    query = QUrlQuery()
    if srid is not None:
        query.addQueryItem("srid", str(coerce_crs(srid)))

    if isinstance(name, str):
        query.addQueryItem("namn", name)
        result = self._get("/namn", query)
    else:
        result = self._post("/namn", query, name)
    return self._handle_results(srid, result)

get_by_belongs_to

get_by_belongs_to(
    belongs_to: str | UUID | QUuid,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[Beteckning]

Find designations belonging to a given object.

Source code in lantmateriet_qgis/core/clients/registerbeteckningdirekt.py
135
136
137
138
139
140
141
142
143
144
145
146
def get_by_belongs_to(
    self,
    belongs_to: str | UUID | QUuid,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[Beteckning]:
    """Find designations belonging to a given object."""
    query = QUrlQuery()
    if srid is not None:
        query.addQueryItem("srid", str(coerce_crs(srid)))

    result = self._get(f"/tillhor/{coerce_uuid_to_str(belongs_to)}", query)
    return self._handle_results(srid, result)

get_by_point

get_by_point(
    point: QgsGeometry | QgsReferencedGeometry,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[Beteckning]

Find designations overlapping a given point.

Source code in lantmateriet_qgis/core/clients/registerbeteckningdirekt.py
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
def get_by_point(
    self,
    point: QgsGeometry | QgsReferencedGeometry,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[Beteckning]:
    """Find designations overlapping a given point."""

    query = QUrlQuery()
    if srid is not None:
        query.addQueryItem("srid", str(coerce_crs(srid)))

    if isinstance(point, QgsReferencedGeometry):
        if is_supported_crs(point.crs()):
            query.addQueryItem("punktSrid", str(coerce_crs(point.crs())))
        else:
            transformer = QgsCoordinateTransform(
                point.crs(),
                QgsCoordinateReferenceSystem.fromEpsgId(3006),
                QgsProject.instance().transformContext(),
            )
            point.transform(transformer)
    try:
        point: QgsPointXY = point.asPoint()
    except TypeError:
        raise ValueError("Invalid geometry type. Expected a point.")
    query.addQueryItem("koordinater", f"{point.y()},{point.x()}")

    result = self._get("/punkt", query)
    return self._handle_results(srid, result)

get_references_from_text

get_references_from_text(
    text: str,
    municipality_or_lan: str | None = None,
    status: Literal[
        "gällande",
        "ledig",
        "omregistrerad",
        "reserverad",
        "spärrad",
    ]
    | None = None,
    objektstatus: Literal["levande", "avregistrerad"]
    | None = None,
    max_hits: int = 100,
) -> list[RegisterbeteckningsReference]

Find references to designations based on a text search.

Source code in lantmateriet_qgis/core/clients/registerbeteckningdirekt.py
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
def get_references_from_text(
    self,
    text: str,
    municipality_or_lan: str | None = None,
    status: Literal["gällande", "ledig", "omregistrerad", "reserverad", "spärrad"]
    | None = None,
    objektstatus: Literal["levande", "avregistrerad"] | None = None,
    max_hits: int = 100,
) -> list[RegisterbeteckningsReference]:
    """Find references to designations based on a text search."""

    query = QUrlQuery()
    query.addQueryItem("beteckning", text)
    if municipality_or_lan is not None:
        if len(municipality_or_lan) != 2:
            query.addQueryItem("kommunkod", municipality_or_lan)
        else:
            query.addQueryItem("lankod", municipality_or_lan)

    if status is not None:
        query.addQueryItem("status", status)
    if objektstatus is not None:
        query.addQueryItem("objektstatus", objektstatus)
    query.addQueryItem("maxHits", str(max_hits))

    result = self._get("/referens/fritext", query)
    return [RegisterbeteckningsReference(**item) for item in result]

get_references_from_geometry

get_references_from_geometry(
    geometry: QgsGeometry | QgsReferencedGeometry,
    buffer: int = 0,
    status: Literal[
        "gällande",
        "ledig",
        "omregistrerad",
        "reserverad",
        "spärrad",
    ]
    | None = None,
) -> list[RegisterbeteckningsReference]

Find references to designations within a given geometry, or within a buffer distance thereof.

Source code in lantmateriet_qgis/core/clients/registerbeteckningdirekt.py
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
def get_references_from_geometry(
    self,
    geometry: QgsGeometry | QgsReferencedGeometry,
    buffer: int = 0,
    status: Literal["gällande", "ledig", "omregistrerad", "reserverad", "spärrad"]
    | None = None,
) -> list[RegisterbeteckningsReference]:
    """Find references to designations within a given geometry, or within a buffer distance thereof."""

    query = QUrlQuery()
    if isinstance(geometry, QgsReferencedGeometry):
        if not is_supported_crs(geometry.crs()):
            transformer = QgsCoordinateTransform(
                geometry.crs(),
                QgsCoordinateReferenceSystem.fromEpsgId(3006),
                QgsProject.instance().transformContext(),
            )
            geometry.transform(transformer)
            geometry = QgsReferencedGeometry(
                geometry.geometry(), QgsCoordinateReferenceSystem.fromEpsgId(3006)
            )
    else:
        geometry = QgsReferencedGeometry(
            geometry, QgsCoordinateReferenceSystem.fromEpsgId(3006)
        )
    if status is not None:
        query.addQueryItem("status", status)

    data = json.loads(geometry.asJson())
    data["crs"] = {
        "type": "name",
        "properties": {"name": geometry.crs().toOgcUrn()},
    }
    data = {"geometri": data, "buffer": buffer}

    result = self._post("/referens/geometri", query, data)
    if result is None:
        raise ValueError("Error retrieving references")
    return [RegisterbeteckningsReference(**item) for item in result]

Data Types

Beteckning

Source code in lantmateriet_qgis/core/clients/registerbeteckningdirekt.py
56
57
58
59
60
61
class Beteckning(TypedDict):
    registerenhetsreferens: RegisterenhetsReference
    gemensamhetsanlaggningsreferens: GemensamhetsanlaggningsReference
    registerbeteckning: list[Registerbeteckning]
    aldreRegisterbeteckning: list[dict]
    aldreTidigareRegisterbeteckning: list[dict]

RegisterenhetsReference

Source code in lantmateriet_qgis/core/clients/registerbeteckningdirekt.py
49
50
51
52
53
class RegisterenhetsReference(TypedDict):
    objektidentitet: str
    objektstatus: Literal["avregistrerad", "levande"]
    typ: Literal["Fastighet", "Samfällighet"]
    registerenhetsomrade: list[Registerenhetsomrade] | None

GemensamhetsanlaggningsReference

Source code in lantmateriet_qgis/core/clients/registerbeteckningdirekt.py
43
44
45
46
class GemensamhetsanlaggningsReference(TypedDict):
    objektidentitet: str
    objektstatus: Literal["avregistrerad", "levande"]
    registerenhetsomrade: list[Registerenhetsomrade] | None

Registerbeteckning

Source code in lantmateriet_qgis/core/clients/registerbeteckningdirekt.py
29
30
31
32
33
34
35
36
37
38
39
40
class Registerbeteckning(Utbytesobjekt):
    markering: bool | None
    registeromrade: str
    trakt: str
    block: str | None
    enhet: int
    beteckningsstatus: Literal[
        "gällande", "ledig", "omregistrerad", "reserverad", "spärrad"
    ]
    omregistreringsdatum: str | None
    omregistreringsaktbeteckning: str | None
    omregistreradTill: str | None

Registerenhetsomrade

Source code in lantmateriet_qgis/core/clients/registerbeteckningdirekt.py
23
24
25
26
class Registerenhetsomrade(TypedDict):
    omradesnummer: int
    markering: bool | None
    centralpunktskoordinat: dict | None

RegisterbeteckningsReference

Source code in lantmateriet_qgis/core/clients/registerbeteckningdirekt.py
64
65
66
67
68
69
class RegisterbeteckningsReference(TypedDict):
    objektidentitet: str
    registerenhet: str | None
    registerenhetstyp: Literal["Fastighet", "Samfällighet"] | None
    gemensamhetsanlaggning: str | None
    beteckning: str