Gå till innehållet

Fastighet och Samfällighet Direkt

FastighetOchSamfallighetDirektClient

Client for the Fastighet och Samfällighet Direkt API.

Source code in lantmateriet_qgis/core/clients/fastighetochsamfallighetdirekt.py
 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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
class FastighetOchSamfallighetDirektClient(BaseClient):
    """Client for the Fastighet och Samfällighet Direkt API."""

    base_path = "/distribution/produkter/fastighetsamfallighet/v3.1"

    MAX_GET_MANY = 250

    @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:
        """Download a single property."""
        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]:
        """Download many single properties."""
        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_aktbeteckning(
        self, text: str
    ) -> list[RegisterenhetsReference]:
        query = QUrlQuery()
        query.addQueryItem("aktbeteckning", text)

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

    def get_references_from_geometry(
        self, geometry: QgsGeometry | QgsReferencedGeometry, buffer: int = 0
    ) -> list[RegisterenhetsReference]:
        """Download property references based on a geometri."""
        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 [RegisterenhetsReference(**item) for item in result]

get_one

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

Download a single property.

Source code in lantmateriet_qgis/core/clients/fastighetochsamfallighetdirekt.py
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def get_one(
    self,
    id: str | UUID | QUuid,
    include: IncludableData | Iterable[IncludableData] | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> dict:
    """Download a single property."""
    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]

Download many single properties.

Source code in lantmateriet_qgis/core/clients/fastighetochsamfallighetdirekt.py
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
def get_many(
    self,
    ids: list[str | UUID | QUuid],
    include: IncludableData | Iterable[IncludableData] | None = None,
    srid: QgsCoordinateReferenceSystem | None = None,
) -> list[dict]:
    """Download many single properties."""
    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_geometry

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

Download property references based on a geometri.

Source code in lantmateriet_qgis/core/clients/fastighetochsamfallighetdirekt.py
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
def get_references_from_geometry(
    self, geometry: QgsGeometry | QgsReferencedGeometry, buffer: int = 0
) -> list[RegisterenhetsReference]:
    """Download property references based on a geometri."""
    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 [RegisterenhetsReference(**item) for item in result]

Data Types

IncludableData = Literal['basinformation', 'registerbeteckning', 'atgard', 'beteckningForeReformen', 'andel', 'omrade', 'historik', 'total'] module-attribute

RegisterenhetsReference

Source code in lantmateriet_qgis/core/clients/fastighetochsamfallighetdirekt.py
20
21
22
23
class RegisterenhetsReference(TypedDict):
    objektidentitet: str
    beteckning: str
    typ: Literal["fastighet", "samfällighet"]