API Nedladdning Geotorget v1.0

Sammanfattning

Syftet med dessa API:er är att hantera ordrar och leveranser av Lantmäteriets geodata från Geotorget. Objektidentiteten som används för samtliga anrop är OrderID som visas på respektive orderrad i Geotorget under Mitt konto - Ärenden

Två olika API:er används, Geotorget-Order och Nedladdning.

Geotorget-Order

Få information om en befintlig order samt skapa och läs leveranser.

API:et är publicerat i Lantmäteriets API-Portal och det krävs ett systemkonto med behörighet till API-Portalens produktionsmiljö för att där skapa den behörighetsnyckel som används för autentisering vid användning av API:et

Åtkomstpunkt	Operation	Beskrivning
api.lantmateriet.se	GET /geotorget/orderhanterare/v2/{OrderID}	Läs order
	GET /geotorget/orderhanterare/v2/{OrderID}/leverans/latest	Läs senaste leverans
	POST /geotorget/orderhanterare/v2/{OrderID}/leverans?typ=BAS/FORANDRING	Skapa ny leverans

Nedladdning

Ladda hem levererade filer.

Detta API är inte publicerat i API-Portalen.

Åtkomstpunkt	Operation	Beskrivning
download-geotorget.lantmateriet.se	GET /download/{OrderID}/files	Ladda hem leverans

Geotorget Order

API:et Geotorget-Order är publicerat i API-portalens produktionsmiljö. Logga in i API-Portalen för att skapa den behörighetsnyckel som används för API:et.

Det är möjligt att använda API:et med autentiseringen Oauth2 eller Bearer token.

Order

Svarsfält för order

Sökväg	Typ	Beskrivning
objektidentitet	Sträng	Ett unikt id för ordern
ordermarkning	Sträng	Fritext som kund kan fylla i vid beställning för att märka ordern
arendenummer	Sträng	Ärendenummer till det relaterade ärendet
kundnummer	Sträng	Kundnummer för den kund som skapat ordern
leveransepost	Sträng	E-postadress dit ärendebekräftelse skickades
skapad	Sträng	Tidpunkt då ordern skapades
abonnemang	Sträng	Om ordern är av abonnemangskaraktär eller inte
produktnamn	Sträng	Produktnamn
produktnummer	Sträng	Produktnummer
produktTyp	Sträng	Vilken typ av produkt som ordern avser
produktinformation	Objekt	Information om vad ordern innehåller
produktinformation.stodjerForandring	Boolean	Om produkten stödjer förändring eller inte
senasteHandelse	Objekt	Senaste händelse [AKTIV, AVSLUTAD]

Läs order med OrderID

För att få information om en order används följande anrop.

HTTP anrop

GET /geotorget/orderhanterare/v2/{OrderID} HTTP/1.1
Content-Type: application/json
Host: api.lantmateriet.se

HTTP svar exempel

HTTP/1.1 200 OK
Content-Type: application/json
{
"objektidentitet": "{OrderID}",
"ordermarkning": "Kundens egna märkning",
"arendenummer": "LM0000/000000",
"kundnummer": "00000000",
"leveransepost": "epost@example.se",
"produktnamn": "Byggnad Nedladdning, vektor",
"produktnr": "50700202",
"abonnemang": false,
"skapad": "0000-00-00T00:00:00.000000Z",
"produktinformation": {
"_typ": "ginfo",
"stodjerForandring": false,
"tema": "vektor-topografi-10",
"format": "geopackage+zip",
"srs": "3011",
"uttagsparametrar": {
"informationsslag": [
"byggnadsverk",
"anlaggningsomrade"
]
},
"urvalsparametrar": {
"kommunkod": [
"0000"
]
}
},
"senasteHandelse": {
"tidstampel": "0000-00-00T00:00:00.000000Z",
"status": "AVSLUTAD"
},
"produktTyp": "NEDLADDNING"
}

Leverans

Svarsfält för leverans

Sökväg	Typ	Beskrivning
objektidentitet	Sträng	Ett unikt id för leveransen
skapad	Sträng	Tidpunkt då leveransen skapades
status	Sträng	Status för leverans [PÅGÅENDE, LYCKAD, MISSLYCKAD, MAKULERAD]
typ	Sträng	Typ av leverans [BAS, FORANDRING]
uppdaterad	Sträng	Tidpunkt för när leveransen senast ändrades
metadata	Objekt	Metadata om leveransen

Läs leverans för order

För att veta om en leverans är redo att laddas ner används följande anrop. Endast den senaste leveransen kan läsas.

HTTP anrop

GET /geotorget/orderhanterare/v2/{OrderID}/leverans/latest HTTP/1.1
Content-Type: application/json
Host: api.lantmateriet.se

HTTP svar exempel

HTTP/1.1 200 OK
Content-Type: application/json
{
"objektidentitet": "{LeveransID}",
"skapad": "0000-00-00T00:00:00.000000Z",
"status": "LYCKAD",
"typ" : "BAS",
"uppdaterad": "0000-00-00T00:00:00.000000Z",
"metadata": {
    "_typ": "temakatalog",
    "lagringstid": 14,
    "size": 751998717,
    "humanReadableSize": "717,2 MB"
}

Skapa ny leverans

Om ordern är av abonnemangskaraktär används följande anrop för att skapa en ny leverans. Nya leveranser kan skapas när ordern har status AKTIV och det inte redan pågår en leverans.

Observera att endast den senaste leveransen är tillgänglig för nedladdning. Kontrollera att den senaste leveransen är nedladdad innan en ny leverans startas.

För produkter som stödjer förändring kan du välja mellan att starta en leverans av typen Bas eller Förändring. Om ingen typ anges levereras Bas.

Förändring
Leverans av data för ordern som har förändrats sedan tidpunkten för den senast LYCKADE leveransen
Bas
Leverans av allt data för ordern

Ange typ av leverans
Utan typ	POST /geotorget/orderhanterare/v2/{OrderID}/leverans
Typ Bas	POST /geotorget/orderhanterare/v2/{OrderID}/leverans?typ=BAS
Typ Förändring	POST /geotorget/orderhanterare/v2/{OrderID}/leverans?typ=FORANDRING

HTTP anrop

POST /geotorget/orderhanterare/v2/{OrderID}/leverans HTTP/1.1
Content-Type: application/json
Host: api.lantmateriet.se

HTTP svar exempel

HTTP/1.1 201 OK
Content-Type: application/json
{
"objektidentitet": "{LeveransID}",
"skapad": "0000-00-00T00:00:00.000000Z",
"status": "PÅGÅENDE",
"typ" : "BAS",
}

Nedladdning

Svarsfält för nedladdning

Sökväg	Typ	Beskrivning
href	Sträng	URL för att fråga vidare
title	Sträng	Titel på resursen
type	Sträng	Typ av resurs. [application/json, application/octet-stream] application/octet-stream är en fil som kan laddas ner. application/json är för att fråga vidare (underkatalog)
length	Nummer	Filens storlek i byte
displaySize	Sträng	Filens storlek i klartext
updated	Sträng	Datum för när filen producerades

Ladda hem leverans

När status på den senaste leveransen är LYCKAD kan leveransen laddas ner. Detta görs med samma OrderID via en annan åtkomstpunkt: download-geotorget.lantmateriet.se

HTTP anrop

GET /download/{OrderID}/files HTTP/1.1
Content-Type: application/json
Host: download-geotorget.lantmateriet.se

HTTP svar exempel

HTTP/1.1 200 OK
Content-Type: application/json
[
{
"href": "https://download-geotorget.lantmateriet.se/download/{OrderID}/files/root/byggnadsverk_kn0000.zip",
"title": "byggnadsverk_kn0000.zip",
"type": "application/octet-stream"
"length": 81484886,
"displaySize": "77,7 MB",
"updated": "0000-00-00T00:00:00.000000Z"
},
{
"href": "https://download-geotorget.lantmateriet.se/download/{OrderID}/files/root/anlaggningsomrade_kn0000.zip",
"title": "anlaggningsomrade_kn0000.zip",
"type": "application/octet-stream"
"length": 81484886,
"displaySize": "77,7 MB",
"updated": "0000-00-00T00:00:00.000000Z"
},
{
"href": "https://download-geotorget.lantmateriet.se/download/{OrderID}/files/root/uttag.json",
"title": "uttag.json",
"type": "application/octet-stream"
"length": 81484886,
"displaySize": "77,7 MB",
"updated": "0000-00-00T00:00:00.000000Z"
}
]