Gå till innehållet

Belägenhetsadress Direkt

BelagenhetsadressDirektClient

Client for the Belägenhetsadress Direkt API.

Source code in lantmateriet_qgis/core/clients/belagenhetsadressdirekt.py 
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
class BelagenhetsadressDirektClient(BaseClient):
    """Client for the Belägenhetsadress Direkt API."""

    base_path = "/distribution/produkter/belagenhetsadress/v4.2"

    MAX_GET_MANY = 250

    @classmethod
    def _handle_results(
        cls,
        include: Literal["basinformation", "berorkrets", "total"] | None,
        srid: QgsCoordinateReferenceSystem | None,
        results: list[dict],
    ) -> list[
        BelagenhetsadressNoInfo
        | BelagenhetsadressBasinformation
        | BelagenhetsadressBerorkrets
        | BelagenhetsadressTotal
    ]:
        if include is None:
            return [
                BelagenhetsadressNoInfo(id=result["id"], geometry=None)
                for result in results["features"]
            ]
        elif include == "basinformation":
            return [
                from_feature(
                    result, srid or QgsCoordinateReferenceSystem.fromEpsgId(3006)
                )
                for result in results["features"]
            ]
        elif include == "berorkrets":
            return [
                BelagenhetsadressBerorkrets(
                    id=result["id"],
                    geometry=None,
                    registerenhetsreferens=RegisterenhetsReference(
                        **result["properties"]["registerenhetsreferens"]
                    ),
                )
                for result in results["features"]
            ]
        elif include == "total":
            return [
                from_feature(
                    result, srid or QgsCoordinateReferenceSystem.fromEpsgId(3006)
                )
                for result in results["features"]
            ]
        else:
            raise ValueError(
                "Invalid include parameter. Must be one of: 'basinformation', 'berorkrets', 'total'."
            )

    @overload
    def get_one(
        self,
        id: str | UUID | QUuid,
        include: None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> BelagenhetsadressNoInfo: ...
    @overload
    def get_one(
        self,
        id: str | UUID | QUuid,
        include: Literal["basinformation"] | None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> BelagenhetsadressBasinformation: ...
    @overload
    def get_one(
        self,
        id: str | UUID | QUuid,
        include: Literal["berorkrets"] | None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> BelagenhetsadressBasinformation: ...
    @overload
    def get_one(
        self,
        id: str | UUID | QUuid,
        include: Literal["total"] | None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> BelagenhetsadressBasinformation: ...
    def get_one(
        self,
        id: str | UUID | QUuid,
        include: Literal["basinformation", "berorkrets", "total"] | None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> (
        BelagenhetsadressNoInfo
        | BelagenhetsadressBasinformation
        | BelagenhetsadressBerorkrets
        | BelagenhetsadressTotal
    ):
        """Download a single address."""
        query = QUrlQuery()
        query.addQueryItem("includeData", include or "basinformation")
        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(include, srid, result)[0]

    @overload
    def get_many(
        self,
        ids: list[str | UUID | QUuid],
        include: None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> list[BelagenhetsadressNoInfo]: ...
    @overload
    def get_many(
        self,
        ids: list[str | UUID | QUuid],
        include: Literal["basinformation"] | None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> list[BelagenhetsadressBasinformation]: ...
    @overload
    def get_many(
        self,
        ids: list[str | UUID | QUuid],
        include: Literal["berorkrets"] | None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> list[BelagenhetsadressBerorkrets]: ...
    @overload
    def get_many(
        self,
        ids: list[str | UUID | QUuid],
        include: Literal["total"] | None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> list[BelagenhetsadressTotal]: ...
    def get_many(
        self,
        ids: list[str | UUID | QUuid],
        include: Literal["basinformation", "berorkrets", "total"] | None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> list[
        BelagenhetsadressNoInfo
        | BelagenhetsadressBasinformation
        | BelagenhetsadressBerorkrets
        | BelagenhetsadressTotal
    ]:
        """Download many single addresses."""
        if len(ids) > self.MAX_GET_MANY:
            raise ValueError(
                f"Too many IDs. Maximum is {self.MAX_GET_MANY}, got {len(ids)}."
            )

        query = QUrlQuery()
        query.addQueryItem("includeData", include or "basinformation")
        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(include, srid, results)

    @overload
    def get_by_registerenhet(
        self,
        registerenhet_id: str | UUID | QUuid | list[str | UUID | QUuid],
        include: None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> list[BelagenhetsadressNoInfo]: ...
    @overload
    def get_by_registerenhet(
        self,
        registerenhet_id: str | UUID | QUuid | list[str | UUID | QUuid],
        include: Literal["basinformation"] = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> list[BelagenhetsadressBasinformation]: ...
    @overload
    def get_by_registerenhet(
        self,
        registerenhet_id: str | UUID | QUuid | list[str | UUID | QUuid],
        include: Literal["berorkrets"] = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> list[BelagenhetsadressBerorkrets]: ...
    @overload
    def get_by_registerenhet(
        self,
        registerenhet_id: str | UUID | QUuid | list[str | UUID | QUuid],
        include: Literal["total"] = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> list[BelagenhetsadressTotal]: ...
    def get_by_registerenhet(
        self,
        registerenhet_id: str | UUID | QUuid | list[str | UUID | QUuid],
        include: Literal["basinformation", "berorkrets", "total"] | None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> list[
        BelagenhetsadressNoInfo
        | BelagenhetsadressBasinformation
        | BelagenhetsadressBerorkrets
        | BelagenhetsadressTotal
    ]:
        """Get addresses belonging to a specific property."""
        query = QUrlQuery()
        query.addQueryItem("includeData", include or "basinformation")
        if srid is not None:
            query.addQueryItem("srid", str(coerce_crs(srid)))

        if isinstance(registerenhet_id, list):
            registerenhet_id = [coerce_uuid_to_str(id) for id in registerenhet_id]
            results = self._post("/registerenhet", query, registerenhet_id)
        else:
            results = self._get(
                f"/registerenhet/{coerce_uuid_to_str(registerenhet_id)}", query
            )
        return self._handle_results(include, srid, results)

    @overload
    def get_by_point(
        self,
        point: QgsGeometry | QgsReferencedGeometry,
        include: None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> BelagenhetsadressNoInfo: ...
    @overload
    def get_by_point(
        self,
        point: QgsGeometry | QgsReferencedGeometry,
        include: Literal["basinformation"] = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> BelagenhetsadressBasinformation: ...
    @overload
    def get_by_point(
        self,
        point: QgsGeometry | QgsReferencedGeometry,
        include: Literal["berorkrets"] = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> BelagenhetsadressBerorkrets: ...
    @overload
    def get_by_point(
        self,
        point: QgsGeometry | QgsReferencedGeometry,
        include: Literal["total"] = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> BelagenhetsadressTotal: ...
    def get_by_point(
        self,
        point: QgsGeometry | QgsReferencedGeometry,
        include: Literal["basinformation", "berorkrets", "total"] | None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> (
        BelagenhetsadressNoInfo
        | BelagenhetsadressBasinformation
        | BelagenhetsadressBerorkrets
        | BelagenhetsadressTotal
    ):
        """Get the adress closest to a given point."""
        query = QUrlQuery()
        query.addQueryItem("includeData", include or "basinformation")
        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(include, srid, result)[0]

    @overload
    def get_references_from_text(
        self,
        text: str,
        municipality: str | None = None,
        status: Literal["Gällande", "Reserverad"] | None = None,
        max_hits: int = 100,
        split_address: Literal[False] = False,
    ) -> list[BelagenhetsadressReference]: ...
    @overload
    def get_references_from_text(
        self,
        text: str,
        municipality: str | None = None,
        status: Literal["Gällande", "Reserverad"] | None = None,
        max_hits: int = 100,
        split_address: Literal[True] = False,
    ) -> list[BelagenhetsadressReferenceWithComponents]: ...
    def get_references_from_text(
        self,
        text: str,
        municipality: str | None = None,
        status: Literal["Gällande", "Reserverad"] | None = None,
        max_hits: int = 100,
        split_address: Literal[True, False] = False,
    ) -> list[BelagenhetsadressReference | BelagenhetsadressReferenceWithComponents]:
        """Get references to addresses matching a given text."""
        query = QUrlQuery()
        query.addQueryItem("adress", text)
        if municipality is not None:
            query.addQueryItem("kommunkod", municipality)
        if status is not None:
            query.addQueryItem("status", status)
        query.addQueryItem("maxHits", str(max_hits))
        query.addQueryItem("splitAdress", str(split_address).lower())

        result = self._get("/referens/fritext", query)
        if split_address:
            return [
                BelagenhetsadressReferenceWithComponents(
                    objektidentitet=item["objektidentitet"],
                    adress=item["adress"],
                    **item["adressComponents"],
                )
                for item in result
            ]
        else:
            return [BelagenhetsadressReference(**item) for item in result]

    @overload
    def get_references_from_geometry(
        self,
        geometry: QgsGeometry | QgsReferencedGeometry,
        buffer: int = 0,
        status: Literal["Gällande", "Reserverad"] | None = None,
        split_address: Literal[False] = False,
    ) -> list[BelagenhetsadressReference]: ...
    @overload
    def get_references_from_geometry(
        self,
        geometry: QgsGeometry | QgsReferencedGeometry,
        buffer: int = 0,
        status: Literal["Gällande", "Reserverad"] | None = None,
        split_address: Literal[True] = False,
    ) -> list[BelagenhetsadressReferenceWithComponents]: ...
    def get_references_from_geometry(
        self,
        geometry: QgsGeometry | QgsReferencedGeometry,
        buffer: int = 0,
        status: Literal["Gällande", "Reserverad"] | None = None,
        split_address: Literal[True, False] = False,
    ) -> list[BelagenhetsadressReference | BelagenhetsadressReferenceWithComponents]:
        """Get references to addresses matching a given geometry."""

        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)
        query.addQueryItem("splitAdress", str(split_address).lower())

        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")
        if split_address:
            return [
                BelagenhetsadressReferenceWithComponents(
                    objektidentitet=item["objektidentitet"],
                    adress=item["adress"],
                    **item["adressComponents"],
                )
                for item in result
            ]
        else:
            return [BelagenhetsadressReference(**item) for item in result]

    def autocomplete(
        self,
        search: str,
        status: Literal["Gällande", "Reserverad"] | None = None,
        max_hits: int = 100,
    ) -> list[str]:
        query = QUrlQuery()
        query.addQueryItem("adress", search)
        if status is not None:
            query.addQueryItem("status", status)
        query.addQueryItem("maxHits", str(max_hits))

        return self._get("/autocomplete/adress", query)

    def autocomplete_references(self, *args, **kwargs):
        raise NotImplementedError()

get_one 

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

get_one(
    id: str | UUID | QUuid,
    include: Literal["basinformation"] | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> BelagenhetsadressBasinformation

get_one(
    id: str | UUID | QUuid,
    include: Literal["berorkrets"] | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> BelagenhetsadressBasinformation

get_one(
    id: str | UUID | QUuid,
    include: Literal["total"] | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> BelagenhetsadressBasinformation

get_one(
    id: str | UUID | QUuid,
    include: Literal[
        "basinformation", "berorkrets", "total"
    ]
    | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> (
    BelagenhetsadressNoInfo
    | BelagenhetsadressBasinformation
    | BelagenhetsadressBerorkrets
    | BelagenhetsadressTotal
)

Download a single address.

Source code in lantmateriet_qgis/core/clients/belagenhetsadressdirekt.py 
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
def get_one(
    self,
    id: str | UUID | QUuid,
    include: Literal["basinformation", "berorkrets", "total"] | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> (
    BelagenhetsadressNoInfo
    | BelagenhetsadressBasinformation
    | BelagenhetsadressBerorkrets
    | BelagenhetsadressTotal
):
    """Download a single address."""
    query = QUrlQuery()
    query.addQueryItem("includeData", include or "basinformation")
    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(include, srid, result)[0]

get_many 

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

get_many(
    ids: list[str | UUID | QUuid],
    include: Literal["basinformation"] | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[BelagenhetsadressBasinformation]

get_many(
    ids: list[str | UUID | QUuid],
    include: Literal["berorkrets"] | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[BelagenhetsadressBerorkrets]

get_many(
    ids: list[str | UUID | QUuid],
    include: Literal["total"] | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[BelagenhetsadressTotal]

get_many(
    ids: list[str | UUID | QUuid],
    include: Literal[
        "basinformation", "berorkrets", "total"
    ]
    | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[
    BelagenhetsadressNoInfo
    | BelagenhetsadressBasinformation
    | BelagenhetsadressBerorkrets
    | BelagenhetsadressTotal
]

Download many single addresses.

Source code in lantmateriet_qgis/core/clients/belagenhetsadressdirekt.py 
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
def get_many(
    self,
    ids: list[str | UUID | QUuid],
    include: Literal["basinformation", "berorkrets", "total"] | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[
    BelagenhetsadressNoInfo
    | BelagenhetsadressBasinformation
    | BelagenhetsadressBerorkrets
    | BelagenhetsadressTotal
]:
    """Download many single addresses."""
    if len(ids) > self.MAX_GET_MANY:
        raise ValueError(
            f"Too many IDs. Maximum is {self.MAX_GET_MANY}, got {len(ids)}."
        )

    query = QUrlQuery()
    query.addQueryItem("includeData", include or "basinformation")
    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(include, srid, results)

get_by_registerenhet 

get_by_registerenhet(
    registerenhet_id: str
    | UUID
    | QUuid
    | list[str | UUID | QUuid],
    include: None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[BelagenhetsadressNoInfo]

get_by_registerenhet(
    registerenhet_id: str
    | UUID
    | QUuid
    | list[str | UUID | QUuid],
    include: Literal["basinformation"] = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[BelagenhetsadressBasinformation]

get_by_registerenhet(
    registerenhet_id: str
    | UUID
    | QUuid
    | list[str | UUID | QUuid],
    include: Literal["berorkrets"] = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[BelagenhetsadressBerorkrets]

get_by_registerenhet(
    registerenhet_id: str
    | UUID
    | QUuid
    | list[str | UUID | QUuid],
    include: Literal["total"] = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[BelagenhetsadressTotal]

get_by_registerenhet(
    registerenhet_id: str
    | UUID
    | QUuid
    | list[str | UUID | QUuid],
    include: Literal[
        "basinformation", "berorkrets", "total"
    ]
    | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[
    BelagenhetsadressNoInfo
    | BelagenhetsadressBasinformation
    | BelagenhetsadressBerorkrets
    | BelagenhetsadressTotal
]

Get addresses belonging to a specific property.

Source code in lantmateriet_qgis/core/clients/belagenhetsadressdirekt.py 
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
def get_by_registerenhet(
    self,
    registerenhet_id: str | UUID | QUuid | list[str | UUID | QUuid],
    include: Literal["basinformation", "berorkrets", "total"] | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[
    BelagenhetsadressNoInfo
    | BelagenhetsadressBasinformation
    | BelagenhetsadressBerorkrets
    | BelagenhetsadressTotal
]:
    """Get addresses belonging to a specific property."""
    query = QUrlQuery()
    query.addQueryItem("includeData", include or "basinformation")
    if srid is not None:
        query.addQueryItem("srid", str(coerce_crs(srid)))

    if isinstance(registerenhet_id, list):
        registerenhet_id = [coerce_uuid_to_str(id) for id in registerenhet_id]
        results = self._post("/registerenhet", query, registerenhet_id)
    else:
        results = self._get(
            f"/registerenhet/{coerce_uuid_to_str(registerenhet_id)}", query
        )
    return self._handle_results(include, srid, results)

get_by_point 

get_by_point(
    point: QgsGeometry | QgsReferencedGeometry,
    include: None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> BelagenhetsadressNoInfo

get_by_point(
    point: QgsGeometry | QgsReferencedGeometry,
    include: Literal["basinformation"] = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> BelagenhetsadressBasinformation

get_by_point(
    point: QgsGeometry | QgsReferencedGeometry,
    include: Literal["berorkrets"] = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> BelagenhetsadressBerorkrets

get_by_point(
    point: QgsGeometry | QgsReferencedGeometry,
    include: Literal["total"] = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> BelagenhetsadressTotal

get_by_point(
    point: QgsGeometry | QgsReferencedGeometry,
    include: Literal[
        "basinformation", "berorkrets", "total"
    ]
    | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> (
    BelagenhetsadressNoInfo
    | BelagenhetsadressBasinformation
    | BelagenhetsadressBerorkrets
    | BelagenhetsadressTotal
)

Get the adress closest to a given point.

Source code in lantmateriet_qgis/core/clients/belagenhetsadressdirekt.py 
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
def get_by_point(
    self,
    point: QgsGeometry | QgsReferencedGeometry,
    include: Literal["basinformation", "berorkrets", "total"] | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> (
    BelagenhetsadressNoInfo
    | BelagenhetsadressBasinformation
    | BelagenhetsadressBerorkrets
    | BelagenhetsadressTotal
):
    """Get the adress closest to a given point."""
    query = QUrlQuery()
    query.addQueryItem("includeData", include or "basinformation")
    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(include, srid, result)[0]

get_references_from_text 

get_references_from_text(
    text: str,
    municipality: str | None = None,
    status: Literal["Gällande", "Reserverad"] | None = None,
    max_hits: int = 100,
    split_address: Literal[False] = False,
) -> list[BelagenhetsadressReference]

get_references_from_text(
    text: str,
    municipality: str | None = None,
    status: Literal["Gällande", "Reserverad"] | None = None,
    max_hits: int = 100,
    split_address: Literal[True] = False,
) -> list[BelagenhetsadressReferenceWithComponents]

get_references_from_text(
    text: str,
    municipality: str | None = None,
    status: Literal["Gällande", "Reserverad"] | None = None,
    max_hits: int = 100,
    split_address: Literal[True, False] = False,
) -> list[
    BelagenhetsadressReference
    | BelagenhetsadressReferenceWithComponents
]

Get references to addresses matching a given text.

Source code in lantmateriet_qgis/core/clients/belagenhetsadressdirekt.py 
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
def get_references_from_text(
    self,
    text: str,
    municipality: str | None = None,
    status: Literal["Gällande", "Reserverad"] | None = None,
    max_hits: int = 100,
    split_address: Literal[True, False] = False,
) -> list[BelagenhetsadressReference | BelagenhetsadressReferenceWithComponents]:
    """Get references to addresses matching a given text."""
    query = QUrlQuery()
    query.addQueryItem("adress", text)
    if municipality is not None:
        query.addQueryItem("kommunkod", municipality)
    if status is not None:
        query.addQueryItem("status", status)
    query.addQueryItem("maxHits", str(max_hits))
    query.addQueryItem("splitAdress", str(split_address).lower())

    result = self._get("/referens/fritext", query)
    if split_address:
        return [
            BelagenhetsadressReferenceWithComponents(
                objektidentitet=item["objektidentitet"],
                adress=item["adress"],
                **item["adressComponents"],
            )
            for item in result
        ]
    else:
        return [BelagenhetsadressReference(**item) for item in result]

get_references_from_geometry 

get_references_from_geometry(
    geometry: QgsGeometry | QgsReferencedGeometry,
    buffer: int = 0,
    status: Literal["Gällande", "Reserverad"] | None = None,
    split_address: Literal[False] = False,
) -> list[BelagenhetsadressReference]

get_references_from_geometry(
    geometry: QgsGeometry | QgsReferencedGeometry,
    buffer: int = 0,
    status: Literal["Gällande", "Reserverad"] | None = None,
    split_address: Literal[True] = False,
) -> list[BelagenhetsadressReferenceWithComponents]

get_references_from_geometry(
    geometry: QgsGeometry | QgsReferencedGeometry,
    buffer: int = 0,
    status: Literal["Gällande", "Reserverad"] | None = None,
    split_address: Literal[True, False] = False,
) -> list[
    BelagenhetsadressReference
    | BelagenhetsadressReferenceWithComponents
]

Get references to addresses matching a given geometry.

Source code in lantmateriet_qgis/core/clients/belagenhetsadressdirekt.py 
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
def get_references_from_geometry(
    self,
    geometry: QgsGeometry | QgsReferencedGeometry,
    buffer: int = 0,
    status: Literal["Gällande", "Reserverad"] | None = None,
    split_address: Literal[True, False] = False,
) -> list[BelagenhetsadressReference | BelagenhetsadressReferenceWithComponents]:
    """Get references to addresses matching a given geometry."""

    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)
    query.addQueryItem("splitAdress", str(split_address).lower())

    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")
    if split_address:
        return [
            BelagenhetsadressReferenceWithComponents(
                objektidentitet=item["objektidentitet"],
                adress=item["adress"],
                **item["adressComponents"],
            )
            for item in result
        ]
    else:
        return [BelagenhetsadressReference(**item) for item in result]

Data Types

BelagenhetsadressReference

A reference to an address.

Source code in lantmateriet_qgis/core/clients/belagenhetsadressdirekt.py 
20
21
22
23
24
class BelagenhetsadressReference(TypedDict):
    """A reference to an address."""

    objektidentitet: str
    adress: str

BelagenhetsadressReferenceWithComponents

A reference to an address, with separate components.

Source code in lantmateriet_qgis/core/clients/belagenhetsadressdirekt.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class BelagenhetsadressReferenceWithComponents(BelagenhetsadressReference):
    """A reference to an address, with separate components."""

    kommun: str
    kommundel: str
    adressomrade: str
    gardsadressomrade: str | None
    adressplatsnummer: str | None
    bokstavstillagg: str | None
    lagestillagg: str | None
    lagestillagsnummer: str | None
    avvikandeAdressplatsBeteckning: str | None
    postnummer: str | None
    postort: str | None