Gränssnittsdefinition
Detta gränssnitt exponerar en delmängd av ärendesystemets funktionalitet och schema för externt bruk. Gränssnittet tillåter frågor på ärenden och statistik, samt begränsad ajourhållning.
Åtkomstpunkt
Miljö | URL |
---|---|
Verifiering |
apimanager-ver.lantmateriet.se/geodata/issue/v1 |
Produktion |
apimanager.lantmateriet.se/geodata/issue/v1 |
Authentisering
För att kunna konsumera tjänsten krävs det att slutanvändaren (kommunen) har gett er tillgång till en "Consumer Key" och en "Consumer Secret" vilka skall användas för att authentisera med tjänsten, vilka de skapar genom att logga in i Lantmäteriets API-manager, skapa en applikation som de sedan kopplar till API:et. Beskrivning om hur kommunerna skall göra detta kommer att skickas ut i samband med att de får tillgång till tjänsten.
För test och verifieringssyften finns möjlighet att få tillgång till ett eget testkonto som liknar det slutanvändarna får vilket ger möjlighet att själv lägga upp en applikation i API-managern i Lantmäteriets verifieringsmiljö, prenumerera på API:et och själv plocka ut en Consumer Key och Consumer Secret. Ett sådant konto beställs via BAL-supporten <ajourhallning-bal@lm.se>.
API:et använder sig av oAuth2 med ett client credentials-flöde, information om hur man konsumerar API:er med denna säkerhetslösning på Lantmäteriet återfinns på:
Schema
Domän | Format | Schema |
---|---|---|
Frågor |
XML |
http://namespace.lantmateriet.se/geodata/issue/query/v2/queryIssues.xsd |
Uppdatering |
XML |
Scheman som refereras ovan gäller ärendedomänen för både externa och interna system, detta innebär att det återfinns element i dessa scheman vilka ej berörs i detta externa API. Exempelvis finns generella frågeobjekt som ej nämns i denna dokumentation. Dessa frågeobjekt likställs dock med de GET-operationer som erbjuds. Det finns även filtertyper som ej har översatts till query-parametrar för frågor, detta är med mening och en del av API-konstruktionen för externt bruk. |
Informationsutbytesmodell
Domän | Modell |
---|---|
Ärende |
Format
Data hämtas i XML-format, format för frågor anges i HTTP-headern Accept med värdet application/xml. För uppdateringar eller frågor som skickas med PUT anges motsvarande värde i headern Content-Type.
Felhantering
Vid klientfel returneras HTTP-statuskod från 4xx-familjen. Vid systemfel returneras HTTP-statuskod från 5xx-familjen. I båda fallen inkluderas detaljerad information i ett Result-objekt i bodyn.
Sammanfattning
Ärende
åtkomst | Beskrivning |
---|---|
Hämta ett specificerat ärende baserat på dess ID. |
|
Hämta ärenden för angivna kommuner, samtliga eller filtrerat baserat på ärendetyp. |
|
Stäng eller kommentera ärenden. |
Statistik
åtkomst | Beskrivning |
---|---|
Hämta statistik för antal ärenden för specifik kommun, samtliga eller filtrerat baserat på ärendetyp. |
Operationer
Möjliga värden för Requestparametrar vilka baseras på enumeration återfinns i respektive schema. |
GET /issue/{id}
Beskrivning
Hämta ett ärende baserat på dess ID.
Exempel
GET /geodata/issue/v1.0/issue/f37d4b4e-7cc9-49cc-8f80-b8c6afd6635c?municipalityFilter=2180 HTTP/1.1
Content-Type: application/xml
Host: exempel.lm.se
Parametrar
Path
Namn | Beskrivning | Datatyp | Standardvärde | Obligatorisk |
---|---|---|---|---|
id |
Objektidentitet för ärende som efterfrågas. |
UUID |
- |
true |
Query
Parameter | Description |
---|---|
|
Den kommunkod som frågan avser. |
Svar
Ett FindIssuesResponse med specificerat ärende vid lyckat anrop. Vid felaktigt anrop returneras fel enligt avsnittet Felhantering.
GET /issues
Beskrivning
Hämta samtliga ärenden eller ärenden specificerade av ärendetyp för en kommun. Samtliga frågor kräver att minst en kommunkod anges via municipalityFilter-parametern. Ärendetyper för filtrering kan anges via issueTypeFilter-parametern. Max ärendemängd per fråga är 200, för större frågor bör pagination med limit och offset användas. GET /statistics/{municipality} kan användas för att bedöma den totala mängden ärenden ägda av en kommun.
Exempel
GET /geodata/issue/v1.0/issues?municipalityFilter=2180&issueTypeFilter=Fastighetsbildnings%C3%A4rende&issueTitleFilter=0849-2351%2C0842-2351&orderBy=descending&offset=1&limit=200 HTTP/1.1
Content-Type: application/xml
Host: exempel.lm.se
Parametrar
Query
Parameter | Description |
---|---|
|
Den kommunkod som eller kommunkoder som frågan avser. |
|
Ärendetyper som efterfrågas. Se IssueTypeType för alternativ. |
|
Ärendetitel eller titlar som efterfrågas. |
|
Returnera resultat stigande eller fallande på datum. |
|
Första index i resultat av sökning. |
|
Max antal träffar i sökning. |
Svar
Ett FindIssuesResponse med ärenden utifrån angivna requestparametrar.
PUT /issues
Beskrivning
Stäng eller kommentera ett ärende.
Notera att ändpunkten endast tillåter förändringar med operationer av typen Modify och enbart förändringar av fälten objectVersion, IssueStatus samt nya instanser av comment i berörda objekt. När transaktionen skapas i konsumerande system måste ett unikt ID genereras för transaktionen samt de påverkade objektens version stegas.
Exempel
Request headers & body
PUT /geodata/issue/v1.0/issues HTTP/1.1
Content-Type: application/xml
Accept: application/xml
Content-Length: 1872
Host: exempel.lm.se
<?xml version="1.0" encoding="UTF-8"?>
<ns3:ChangeTransaction ns1:id="ID_d6dd1853-d771-4bdd-ae8b-f7577b465dfc" xmlns:ns6="http://namespace.lantmateriet.se/geodata/geometry/v1" xmlns:ns5="http://namespace.lantmateriet.se/geodata/quality/v1" xmlns:ns8="http://namespace.lantmateriet.se/geodata/coordinatesystem/v1" xmlns:ns7="http://namespace.lantmateriet.se/geodata/address/v1" xmlns:ns9="http://namespace.lantmateriet.se/geodata/issue/v2" xmlns:ns2="http://www.w3.org/1999/xlink" xmlns:ns1="http://www.opengis.net/gml/3.2" xmlns:ns4="http://namespace.lantmateriet.se/geodata/building/v1" xmlns:ns3="http://namespace.lantmateriet.se/geodata/exchange/v1">
<ns3:id>a38803ca-5b0c-4d97-a3b7-be656e417f34</ns3:id>
<ns3:description>Ärende exempel</ns3:description>
<ns3:extractedAtTime>2025-02-07T10:23:41.622Z</ns3:extractedAtTime>
<ns3:Modify>
<ns9:InvestigationIssue ns1:id="ID_8d94759b-86fd-4175-8ddf-099e4765526a">
<ns3:objectId>9afa87ef-6b52-4582-ad9a-733286a4c39e</ns3:objectId>
<ns3:objectVersion>2</ns3:objectVersion>
<ns9:createdDate>2013-10-30</ns9:createdDate>
<ns9:createdBy>SK_Folkbokföringen</ns9:createdBy>
<ns9:issueTitle>Adressplats saknas</ns9:issueTitle>
<ns9:issueDescription>NORRBACKA 2a</ns9:issueDescription>
<ns9:issueStatus>Stängt</ns9:issueStatus>
<ns9:municipalityKey>2180</ns9:municipalityKey>
<ns9:comment>
<ns9:createdTime>2016-02-03T13:00:27.833Z</ns9:createdTime>
<ns9:comment>Ändrar till Påbörjat.</ns9:comment>
</ns9:comment>
<ns9:priority>1</ns9:priority>
<ns9:issueType>Folkbokföringsärende</ns9:issueType>
<ns9:decision>Avslagen</ns9:decision>
</ns9:InvestigationIssue>
</ns3:Modify>
</ns3:ChangeTransaction>
Fält
Namn | Objekt | Beskrivning | Datatyp |
---|---|---|---|
id |
ChangeTransaction/id |
Förändringstransaktionens unika ID, skall genereras för varje transaktion. |
String |
objectVersion |
ChangeTransaction/Modify/InvestigationIssue/objectVersion |
objektets version, skall stegas vid varje förändring. |
Number |
issueStatus |
ChangeTransaction/Modify/InvestigationIssue/issueStatus |
Status för ärendet: Se IssueStatusType för alternativ. |
String |
comment |
ChangeTransaction/Modify/InvestigationIssue/comment |
Behållare för information berörande kommentar. |
String |
createdTime |
ChangeTransaction/Modify/InvestigationIssue/comment/createdTime |
Tidpunkt för kommentarens författande. |
String |
comment |
ChangeTransaction/Modify/InvestigationIssue/comment/comment |
Kommentar för ajourhållning. |
String |
Svar
Ett Result med olika information beroende på om transaktionen lyckades eller ej.
GET /statistics/{municipality}
Beskrivning
Hämta statistik berörande antal ärenden för en specifik kommun. Komplett statistik kan hämtas för samtliga ärendetyper eller en delmängd beroende på specificerat ärendefilter.
Exempel
GET /geodata/issue/v1.0/statistics/2180?issueTypeFilter=Fastighetsbildnings%C3%A4rende&groupBy=issueType HTTP/1.1
Content-Type: application/xml
Host: exempel.lm.se
Parametrar
Path
Namn | Beskrivning | Datatyp | Standardvärde | Obligatorisk |
---|---|---|---|---|
municipality |
Den kommunkod frågan avser. |
Integer |
- |
true |
Query
Parameter | Description |
---|---|
|
Ärendetyper, för vilka statistik efterfrågas. Se IssueTypeType för alternativ. |
|
Gruppering, för vilka statistik ordnas. Se CountIssueGroupingType för alternativ. |
Svar
Ett CountIssuesGroupedResponse med statistik för ärenden utifrån angivna requestparametrar.
Datatyper
Avsnittet beskriver de översta elementen i aktuella datatyper. Information om nästlade element, dess komposition samt multiplicitet beskrivs i aktuellt schema. |
CountIssuesGroupedResponse
CountIssuesGroupedResponse, behållare för statistiksökningens resultat - en eller flera entiteter av typen IssueCount beroende på angivet filter.
Exempel
HTTP/1.1 200 OK
Content-Type: application/xml;charset=UTF-8
Content-Length: 1026
<?xml version="1.0" encoding="UTF-8"?><isq:CountIssuesGroupedResponse xmlns:isq="http://namespace.lantmateriet.se/geodata/issue/query/v2" xmlns:address="http://namespace.lantmateriet.se/geodata/address/v1" xmlns:building="http://namespace.lantmateriet.se/geodata/building/v1" xmlns:ex="http://namespace.lantmateriet.se/geodata/exchange/v1" xmlns:fes="http://www.opengis.net/fes/2.0" xmlns:filter="http://namespace.lantmateriet.se/geodata/filter/v1" xmlns:gml="http://www.opengis.net/gml/3.2" xmlns:is="http://namespace.lantmateriet.se/geodata/issue/v2" xmlns:lg="http://namespace.lantmateriet.se/geodata/geometry/v1" xmlns:lq="http://namespace.lantmateriet.se/geodata/quality/v1" xmlns:messageevent="http://namespace.lantmateriet.se/geodata/issue/query/messageevent/v1" xmlns:result="http://namespace.lantmateriet.se/geodata/result/v1" xmlns:wfs="http://www.opengis.net/wfs/2.0"><isq:IssueCount><isq:count>3</isq:count><isq:IssueType>Fastighetsbildningsärende</isq:IssueType></isq:IssueCount></isq:CountIssuesGroupedResponse>
FindIssuesResponse
FindIssuesResponse, behållare för ärendesökningens resultat - ingen, en eller flera sökträffar av typen CadastralProcess och/eller InvestigationIssue.
Exempel
HTTP/1.1 200 OK
Content-Type: application/xml;charset=UTF-8
Content-Length: 2326
<?xml version="1.0" encoding="UTF-8"?><isq:FindIssuesResponse xmlns:isq="http://namespace.lantmateriet.se/geodata/issue/query/v2" xmlns:address="http://namespace.lantmateriet.se/geodata/address/v1" xmlns:building="http://namespace.lantmateriet.se/geodata/building/v1" xmlns:ex="http://namespace.lantmateriet.se/geodata/exchange/v1" xmlns:fes="http://www.opengis.net/fes/2.0" xmlns:filter="http://namespace.lantmateriet.se/geodata/filter/v1" xmlns:gml="http://www.opengis.net/gml/3.2" xmlns:is="http://namespace.lantmateriet.se/geodata/issue/v2" xmlns:lg="http://namespace.lantmateriet.se/geodata/geometry/v1" xmlns:lq="http://namespace.lantmateriet.se/geodata/quality/v1" xmlns:messageevent="http://namespace.lantmateriet.se/geodata/issue/query/messageevent/v1" xmlns:result="http://namespace.lantmateriet.se/geodata/result/v1" xmlns:wfs="http://www.opengis.net/wfs/2.0"><is:CadastralProcess gml:id="ID_640c12f9-5113-47ea-ae43-dbbbb4ce272c"><ex:objectId>f37d4b4e-7cc9-49cc-8f80-b8c6afd6635c</ex:objectId><ex:objectVersion>1</ex:objectVersion><is:createdDate>2018-05-17</is:createdDate><is:createdBy>Fastighetsbildningsmyndighet</is:createdBy><is:issueTitle>0842-2351</is:issueTitle><is:issueDescription>Fastighetsbildningsärende</is:issueDescription><is:issueStatus>Inkommet</is:issueStatus><is:municipalityKey>2180</is:municipalityKey><is:comment><is:createdTime>2019-10-22T13:02:09.781Z</is:createdTime><is:comment>Ändrar till Påbörjat, inväntar information.</is:comment></is:comment><is:comment><is:createdTime>2019-10-22T12:38:53.976Z</is:createdTime><is:comment>Byggnader behöver byta fastighet efter klyvning.</is:comment></is:comment><is:priority>1</is:priority><is:issueType>Fastighetsbildningsärende</is:issueType><is:dossier>0842-2351</is:dossier><is:cadastralDate>2018-05-17</is:cadastralDate><is:specification><is:realPropertyKey>198a353e-3af9-4530-bd08-901154355475</is:realPropertyKey><is:case>Berörd</is:case><is:propertyFormationMeasure>Klyvning</is:propertyFormationMeasure><is:propertyUnitDesignation>EXEMPEL NORR 20:8</is:propertyUnitDesignation><is:builtUp>true</is:builtUp><is:addressAssigned>true</is:addressAssigned><is:threeDimensionalSpaceProperty>false</is:threeDimensionalSpaceProperty><is:modifiedArea>true</is:modifiedArea></is:specification></is:CadastralProcess></isq:FindIssuesResponse>
HTTP/1.1 200 OK
Content-Type: application/xml;charset=UTF-8
Content-Length: 3583
<?xml version="1.0" encoding="UTF-8"?><isq:FindIssuesResponse xmlns:isq="http://namespace.lantmateriet.se/geodata/issue/query/v2" xmlns:address="http://namespace.lantmateriet.se/geodata/address/v1" xmlns:building="http://namespace.lantmateriet.se/geodata/building/v1" xmlns:ex="http://namespace.lantmateriet.se/geodata/exchange/v1" xmlns:fes="http://www.opengis.net/fes/2.0" xmlns:filter="http://namespace.lantmateriet.se/geodata/filter/v1" xmlns:gml="http://www.opengis.net/gml/3.2" xmlns:is="http://namespace.lantmateriet.se/geodata/issue/v2" xmlns:lg="http://namespace.lantmateriet.se/geodata/geometry/v1" xmlns:lq="http://namespace.lantmateriet.se/geodata/quality/v1" xmlns:messageevent="http://namespace.lantmateriet.se/geodata/issue/query/messageevent/v1" xmlns:result="http://namespace.lantmateriet.se/geodata/result/v1" xmlns:wfs="http://www.opengis.net/wfs/2.0"><is:CadastralProcess gml:id="ID_2a937097-9ffb-4fd4-8e9b-7d09f236a6ce"><ex:objectId>f37d4b4e-7cc9-49cc-8f80-b8c6afd6635c</ex:objectId><ex:objectVersion>1</ex:objectVersion><is:createdDate>2018-05-17</is:createdDate><is:createdBy>Fastighetsbildningsmyndighet</is:createdBy><is:issueTitle>0842-2351</is:issueTitle><is:issueDescription>Fastighetsbildningsärende</is:issueDescription><is:issueStatus>Inkommet</is:issueStatus><is:municipalityKey>2180</is:municipalityKey><is:comment><is:createdTime>2019-10-22T13:02:09.781Z</is:createdTime><is:comment>Ändrar till Påbörjat, inväntar information.</is:comment></is:comment><is:comment><is:createdTime>2019-10-22T12:38:53.976Z</is:createdTime><is:comment>Byggnader behöver byta fastighet efter klyvning.</is:comment></is:comment><is:priority>1</is:priority><is:issueType>Fastighetsbildningsärende</is:issueType><is:dossier>0842-2351</is:dossier><is:cadastralDate>2018-05-17</is:cadastralDate><is:specification><is:realPropertyKey>198a353e-3af9-4530-bd08-901154355475</is:realPropertyKey><is:case>Berörd</is:case><is:propertyFormationMeasure>Klyvning</is:propertyFormationMeasure><is:propertyUnitDesignation>EXEMPEL NORR 20:8</is:propertyUnitDesignation><is:builtUp>true</is:builtUp><is:addressAssigned>true</is:addressAssigned><is:threeDimensionalSpaceProperty>false</is:threeDimensionalSpaceProperty><is:modifiedArea>true</is:modifiedArea></is:specification></is:CadastralProcess><is:CadastralProcess gml:id="ID_ed889b7a-dadf-4fa9-9fc6-1ef219121de9"><ex:objectId>9eb2f4fa-6a34-4910-9a91-6ce68259ea9c</ex:objectId><ex:objectVersion>1</ex:objectVersion><is:createdDate>2018-05-17</is:createdDate><is:createdBy>Fastighetsbildningsmyndighet</is:createdBy><is:issueTitle>0849-2351</is:issueTitle><is:issueDescription>Fastighetsbildningsärende</is:issueDescription><is:issueStatus>Påbörjat</is:issueStatus><is:municipalityKey>2180</is:municipalityKey><is:comment><is:createdTime>2018-05-18T13:10:48.853Z</is:createdTime><is:comment>Inväntar vidare information.</is:comment></is:comment><is:priority>1</is:priority><is:issueType>Fastighetsbildningsärende</is:issueType><is:dossier>0849-2351</is:dossier><is:cadastralDate>2018-05-17</is:cadastralDate><is:specification><is:realPropertyKey>f26b4dae-4c3f-428d-a0e7-dc4c33a74ca3</is:realPropertyKey><is:case>Berörd</is:case><is:propertyFormationMeasure>Klyvning</is:propertyFormationMeasure><is:propertyUnitDesignation>EXEMPELBRO 11:1</is:propertyUnitDesignation><is:builtUp>true</is:builtUp><is:addressAssigned>false</is:addressAssigned><is:threeDimensionalSpaceProperty>false</is:threeDimensionalSpaceProperty><is:modifiedArea>true</is:modifiedArea></is:specification></is:CadastralProcess></isq:FindIssuesResponse>
Result
Result, behållare för en transaktions resultat, även behållare för samtliga fel inom gränssnittet - Tom successful tag vid lyckat resultat eller ett antal feltyper vid misslyckad transaktion, felaktig fråga eller internt fel.
<?xml version="1.0" encoding="UTF-8"?>
<result:Successful xmlns:result="http://namespace.lantmateriet.se/geodata/result/v1" xmlns:address="http://namespace.lantmateriet.se/geodata/address/v1" xmlns:building="http://namespace.lantmateriet.se/geodata/building/v1" xmlns:ex="http://namespace.lantmateriet.se/geodata/exchange/v1" xmlns:fes="http://www.opengis.net/fes/2.0" xmlns:filter="http://namespace.lantmateriet.se/geodata/filter/v1" xmlns:gml="http://www.opengis.net/gml/3.2" xmlns:is="http://namespace.lantmateriet.se/geodata/issue/v2" xmlns:isq="http://namespace.lantmateriet.se/geodata/issue/query/v2" xmlns:lg="http://namespace.lantmateriet.se/geodata/geometry/v1" xmlns:lq="http://namespace.lantmateriet.se/geodata/quality/v1" xmlns:messageevent="http://namespace.lantmateriet.se/geodata/issue/query/messageevent/v1" xmlns:wfs="http://www.opengis.net/wfs/2.0"/>
<?xml version="1.0" encoding="UTF-8"?><result:Result xmlns:result="http://namespace.lantmateriet.se/geodata/result/v1"><result:SchemaValidationError xmlns:address="http://namespace.lantmateriet.se/geodata/address/v1" xmlns:building="http://namespace.lantmateriet.se/geodata/building/v1" xmlns:ex="http://namespace.lantmateriet.se/geodata/exchange/v1" xmlns:fes="http://www.opengis.net/fes/2.0" xmlns:filter="http://namespace.lantmateriet.se/geodata/filter/v1" xmlns:gml="http://www.opengis.net/gml/3.2" xmlns:is="http://namespace.lantmateriet.se/geodata/issue/v2" xmlns:isq="http://namespace.lantmateriet.se/geodata/issue/query/v2" xmlns:lg="http://namespace.lantmateriet.se/geodata/geometry/v1" xmlns:lq="http://namespace.lantmateriet.se/geodata/quality/v1" xmlns:messageevent="http://namespace.lantmateriet.se/geodata/issue/query/messageevent/v1" xmlns:wfs="http://www.opengis.net/wfs/2.0"><result:timestamp>2025-02-07T10:23:38.169Z</result:timestamp><result:errorCode>Issue-4001</result:errorCode><result:errorMessage>SchemaValidationError Cause: cvc-pattern-valid: Value 'd5ee6e91-579b-aeef-faulty-uuid' is not facet-valid with respect to pattern '[a-fA-F0-9]{8}(-[a-fA-F0-9]{4})(-[a-fA-F0-9]{4})(-[a-fA-F0-9]{4})(-[a-fA-F0-9]{12})' for type 'UuidType'.</result:errorMessage><result:line>1</result:line><result:column>990</result:column></result:SchemaValidationError><result:SchemaValidationError xmlns:address="http://namespace.lantmateriet.se/geodata/address/v1" xmlns:building="http://namespace.lantmateriet.se/geodata/building/v1" xmlns:ex="http://namespace.lantmateriet.se/geodata/exchange/v1" xmlns:fes="http://www.opengis.net/fes/2.0" xmlns:filter="http://namespace.lantmateriet.se/geodata/filter/v1" xmlns:gml="http://www.opengis.net/gml/3.2" xmlns:is="http://namespace.lantmateriet.se/geodata/issue/v2" xmlns:isq="http://namespace.lantmateriet.se/geodata/issue/query/v2" xmlns:lg="http://namespace.lantmateriet.se/geodata/geometry/v1" xmlns:lq="http://namespace.lantmateriet.se/geodata/quality/v1" xmlns:messageevent="http://namespace.lantmateriet.se/geodata/issue/query/messageevent/v1" xmlns:wfs="http://www.opengis.net/wfs/2.0"><result:timestamp>2025-02-07T10:23:38.169Z</result:timestamp><result:errorCode>Issue-4001</result:errorCode><result:errorMessage>SchemaValidationError Cause: cvc-type.3.1.3: The value 'd5ee6e91-579b-aeef-faulty-uuid' of element 'objectId' is not valid.</result:errorMessage><result:line>1</result:line><result:column>990</result:column></result:SchemaValidationError></result:Result>