Gå till innehållet

Gemensamhetsanläggning Direkt

GemensamhetsanlaggningDirektClient

Client for the Gemensamhetsanläggning Direkt API.

Source code in lantmateriet_qgis/core/clients/gemensamhetsanlaggningdirekt.py
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 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
class GemensamhetsanlaggningDirektClient(BaseClient):
    """Client for the Gemensamhetsanläggning Direkt API."""

    base_path = "/distribution/produkter/gemensamhetsanlaggning/v2.1"

    @classmethod
    def _handle_results(
        cls,
        _include: IncludableData | Iterable[IncludableData] | None,
        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,
        include: IncludableData | Iterable[IncludableData] | None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> dict:
        """Get a single gemensamhetsanläggning."""
        query = QUrlQuery()
        if isinstance(include, str):
            query.addQueryItem("includeData", include)
        elif include is not None:
            query.addQueryItem("includeData", ",".join(include))
        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]

    def get_many(
        self,
        ids: list[str | UUID | QUuid],
        include: IncludableData | Iterable[IncludableData] | None = None,
        srid: QgsCoordinateReferenceSystem | None = None,
    ) -> list[dict]:
        """Get multiple gemensamhetsanläggningar."""

        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)

    def get_references_from_text(
        self, text: str
    ) -> list[GemensamhetsanlaggningsReference]:
        """Get references to gemensamhetsanläggningar from their aktbeteckning."""

        query = QUrlQuery()
        query.addQueryItem("aktbeteckning", text)

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

    def get_references_from_delagande(
        self, registerenhet: str | UUID | QUuid
    ) -> list[GemensamhetsanlaggningsReference]:
        """Get references to gemensamhetsanläggningar which the given property is a member of."""

        result = self._get(
            f"/referens/delagande/{coerce_uuid_to_str(registerenhet)}", QUrlQuery()
        )
        return [GemensamhetsanlaggningsReference(**item) for item in result]

    def get_references_from_geometry(
        self, geometry: QgsGeometry | QgsReferencedGeometry, buffer: int = 0
    ) -> list[GemensamhetsanlaggningsReference]:
        """Get references to gemensamhetsanläggningar within the given geometry, or within a buffer distance of it."""

        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)
            )

        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 [GemensamhetsanlaggningsReference(**item) for item in result]

get_one

get_one(
    id: str | UUID | QUuid,
    include: IncludableData
    | Iterable[IncludableData]
    | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> dict

Get a single gemensamhetsanläggning.

Source code in lantmateriet_qgis/core/clients/gemensamhetsanlaggningdirekt.py
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
def get_one(
    self,
    id: str | UUID | QUuid,
    include: IncludableData | Iterable[IncludableData] | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> dict:
    """Get a single gemensamhetsanläggning."""
    query = QUrlQuery()
    if isinstance(include, str):
        query.addQueryItem("includeData", include)
    elif include is not None:
        query.addQueryItem("includeData", ",".join(include))
    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: IncludableData
    | Iterable[IncludableData]
    | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[dict]

Get multiple gemensamhetsanläggningar.

Source code in lantmateriet_qgis/core/clients/gemensamhetsanlaggningdirekt.py
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def get_many(
    self,
    ids: list[str | UUID | QUuid],
    include: IncludableData | Iterable[IncludableData] | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[dict]:
    """Get multiple gemensamhetsanläggningar."""

    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_references_from_text

get_references_from_text(
    text: str,
) -> list[GemensamhetsanlaggningsReference]

Get references to gemensamhetsanläggningar from their aktbeteckning.

Source code in lantmateriet_qgis/core/clients/gemensamhetsanlaggningdirekt.py
90
91
92
93
94
95
96
97
98
99
def get_references_from_text(
    self, text: str
) -> list[GemensamhetsanlaggningsReference]:
    """Get references to gemensamhetsanläggningar from their aktbeteckning."""

    query = QUrlQuery()
    query.addQueryItem("aktbeteckning", text)

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

get_references_from_delagande

get_references_from_delagande(
    registerenhet: str | UUID | QUuid,
) -> list[GemensamhetsanlaggningsReference]

Get references to gemensamhetsanläggningar which the given property is a member of.

Source code in lantmateriet_qgis/core/clients/gemensamhetsanlaggningdirekt.py
101
102
103
104
105
106
107
108
109
def get_references_from_delagande(
    self, registerenhet: str | UUID | QUuid
) -> list[GemensamhetsanlaggningsReference]:
    """Get references to gemensamhetsanläggningar which the given property is a member of."""

    result = self._get(
        f"/referens/delagande/{coerce_uuid_to_str(registerenhet)}", QUrlQuery()
    )
    return [GemensamhetsanlaggningsReference(**item) for item in result]

get_references_from_geometry

get_references_from_geometry(
    geometry: QgsGeometry | QgsReferencedGeometry,
    buffer: int = 0,
) -> list[GemensamhetsanlaggningsReference]

Get references to gemensamhetsanläggningar within the given geometry, or within a buffer distance of it.

Source code in lantmateriet_qgis/core/clients/gemensamhetsanlaggningdirekt.py
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
def get_references_from_geometry(
    self, geometry: QgsGeometry | QgsReferencedGeometry, buffer: int = 0
) -> list[GemensamhetsanlaggningsReference]:
    """Get references to gemensamhetsanläggningar within the given geometry, or within a buffer distance of it."""

    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)
        )

    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 [GemensamhetsanlaggningsReference(**item) for item in result]

Data Types

IncludableData = Literal['basinformation', 'atgard', 'beteckningForeReformen', 'andel', 'geometri', 'total'] module-attribute

GemensamhetsanlaggningsReference

Source code in lantmateriet_qgis/core/clients/gemensamhetsanlaggningdirekt.py
19
20
21
class GemensamhetsanlaggningsReference(TypedDict):
    objektidentitet: str
    beteckning: str