Geotorget Nedladdning

Detta API ersätter API Nedladdning Geotorget v1.0

Sammanfattning

Syftet med detta API är att hantera ordrar och leveranser för beställningar i Geotorget för produkter som inte har ett eget API.

Läs order och den senaste leveransen, skapa nya leveranser samt ladda ner levererade data. Objektidentiteten som används för samtliga anrop är OrderID som visas på respektive orderrad i Mitt konto Ärenden.

Behörighet till API:et beställs i Geotorget, se produkten Geotorget Nedladdning.

Åtkomstpunkt	Operation	Beskrivning
api.lantmateriet.se	GET /geotorget/nedladdning/v1/{OrderID}	Läs order
	POST /geotorget/nedladdning/v1/{OrderID}/leverans?typ=BAS/FORANDRING	Starta ny leverans
	GET /geotorget/nedladdning/v1/{OrderID}/leverans/latest	Läs senaste leverans
	GET /geotorget/nedladdning/v1/{OrderID}/leverans/latest/files	Ladda ner leverans

Autentisering

Autentisering används för att verifiera och säkerställa att en användare eller ett system har rätt behörighet att få åtkomst till en tjänst eller resurs.

Det finns två metoder för autentisering, för privatpersoner är endast Basic Autentisering tillgängligt.

Basic Autentisering
En enkel autentiseringsmetod där användaren anger användarnamn och lösenord för att verifiera sin identitet och få åtkomst till en tjänst.
OAuth2
En nyckelbaserad autentisering där användaren med hjälp av API-portalen administrerar behörighetsgrupper och behörighetsnycklar för att tilldela åtkomst till tjänster. Läs mer om och gå till API-portalen på lantmateriet.se.

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
produktnamn	Sträng	Produktnamn
produktnr	Sträng	Produktnummer
abonnemang	Sträng	Om ordern är av abonnemangskaraktär eller inte
skapad	Sträng	Tidpunkt då ordern skapades
uppdaterad	Sträng	Tidpunkt då order har fått ny status
produktinformation	Objekt	Information om vad ordern innehåller
produktinformation.stodjerForandring	Boolean	Om produkten stödjer förändring eller inte
status	Sträng	Status på order [AKTIV, AVSLUTAD]
produktTyp	Sträng	Vilken typ av produkt som ordern avser [NEDLADDNING, BEHORIGHET]

Läs order med OrderID

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

HTTP-anrop

GET /geotorget/nedladdning/v1/{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": "Märkning",
  "arendenummer": "LM0000/000000",
  "kundnummer": "12345678",
  "leveransepost": "mail@example.com",
  "produktnamn": "Geodataprodukt",
  "produktnr": "123456",
  "abonnemang": true,
  "skapad": "0000-00-00T00:00:00.000000Z",
  "uppdaterad": "0000-00-00T00:00:00.000000Z",
  "produktinformation": {
    "tema": "produkt-tema",
    "srs": "3006",
    "stodjerForandring": true,
    "format": "produktformat",
    "uttagsparametrar": {
      "indelning": "Index 2,5 km",
      "excludeFiles": {
        "border": false
      },
      "namnsattning": "indexruta"
    }
  },
  "status": "AKTIV",
  "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

Starta ny leverans

Nya leveranser kan startas när ordern:

Är av typen NEDLADDNING
Är ett abonnemang
Orderstatus är AKTIV
Leveransstatus är LYCKAD, MISSLYCKAD eller MAKULERAD

Kontrollera att den senaste leveransen är nedladdad innan en ny leverans startas, endast den senaste leveransen kan laddas ner.

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/nedladdning/v1/{OrderID}/leverans
Typ Bas	POST /geotorget/nedladdning/v1/{OrderID}/leverans?typ=BAS
Typ Förändring	POST /geotorget/nedladdning/v1/{OrderID}/leverans?typ=FORANDRING

HTTP-anrop

POST /geotorget/nedladdning/v1/{OrderID}/leverans 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": "PÅGÅENDE",
  "typ": "BAS",
  "uppdaterad": "0000-00-00T00:00:00.000000Z"
}

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/nedladdning/v1/{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": {
    "lagringstid": 14,
    "size": 751998717,
    "humanReadableSize": "717,2 MB"
  }
}

Nedladdning

Svarsfält för nedladdning.

Sökväg	Typ	Beskrivning
path	Sträng	Sökväg 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 ner leverans

När status på den senaste leveransen är LYCKAD kan leveransen laddas ner.

HTTP-anrop

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

HTTP-svar exempel

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "path": "/leverans/latest/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"
  },
  {
    "path": "/leverans/latest/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"
  },
  {
    "path": "/leverans/latest/files/root/uttag.json",
    "title": "uttag.json",
    "type": "application/octet-stream",
    "length": 81484886,
    "displaySize": "77,7 MB",
    "updated": "0000-00-00T00:00:00.000000Z"
  }
]