SERVICE MANUAL

Miljödata MVM

Introduktion

Miljödata MVM tillhandahåller öppna API:er och andra tjänster som gör det möjligt för applikationer att få tillgång till data och funktionalitet som återfinns i systemet. Tjänsterna erbjuds främst som REST och SOAP tjänster och data kan hämtas i JSON eller XML formaten.

API:erna är i beta version och arbetet fortskrider med att utöka dess funktionalitet.

För mer information, klicka på nedan länk eller navigera till sidan ”Öppet API” i webbapplikationen. xxxxx://xxxxxxxxx.xxx.xx/xxx/XxxxXXX

Översikt

Systemet erbjuder följande web services

• ObservationsService.svc : stationsinformation, observationer och mätvärden

• DomainDefinitionsService.svc : systemvärden såsom enheter och parametrar

• SecureTokenService.svc : hanterar autentisering och utlämning av säkerhetstokens Web servicarna stödjer SOAP 1.1, REST JSON och POST JSON anrop.

Instruktioner

Behörigheter och säkerhet

Alla webmetoder kräver en säkerhetstoken. Det finns två typer av säkerhetstokens som är beskrivna i nedan tabell.

De allra flesta webbmetoder accepterar en så kallad ”publik ticket” varför de flesta klienter inte behöver anropa SecureTokenService.

Typ av token

Beskrivning

Hur får jag denna token?

Publik ticket

En statisk access token som kan tilldelas flera användare och sällan ändras.

Skapa ett konto i Artdatabankens UserAdmin (* länk nedan). Logga in i Miljödata MVM. Navigera till sidan ”Mina sidor” och anmäl dig som web service användare. Då får du denna säkerhetstoken. Inget

godkännande krävs.

Dynamisk, privat token

En privat token som tilldelas inloggade användare.

Skapa ett konto i Artdatabankens UserAdmin (* länk nedan). Beställ rollen Tjänstekonsument. Rollen måste godkännas. Logga in i Miljödata MVM. Anropa web service SecurityTokenService med

inloggningsuppgifter.

* Artdatabankens UserAdmin: xxxxx://xxxxxxxxx.xxxxxxxxxxxxx.xx

ObservationsService stödjer både HTTPS (SSL) och HTTP.

Felhantering

Vid fel kastar webbmetoderna en FaulExeption med ett meddelande som beskriver felet.

Metoden SecureTokenService.Login() returnerar alltid än sträng, även vid felaktiga uppgifter och behörigheter. I de fall användarkontot har fel kontouppgifter eller behörigheter returneras "401 Unauthorized"

Web service specifikation

Alla web services inkluderar två standardmetoder som inte kräver någon token eller https. Dessa är

AreYouThere och GetServiceVersion.

ObservationsService

Service WSDL

xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxxxxxxxXxxxxxx.xxx?xxxx

XSD scheman

xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxxxxxxxXxxxxxx.xxx?xxxxxxx0

Med mera. Se WSDL för fler XSD resurser.

DomainDefinitionsService

Service WSDL

xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxXxxxxxxxxxxXxxxxxx.xxx?xxxx

XSD scheman

xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxXxxxxxxxxxxXxxxxxx.xxx?xxxxxxx0

Med mera. Se WSDL för fler XSD resurser.

Metoder

SecureTokenService

Exempel

Byt ut texten [token] i nedan exempel med en publik ticket eller dynamisk säkerhetstoken.

REST anrop

DomainDefinitionsService GetServiceVersion xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxXxxxxxxxxxxXxxxxxx.xxx/xxxx/XxxXxxxxxxXxxxxxx

DomainDefinitionsService GetParameter xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxXxxxxxxxxxxXxxxxxx.xxx/xxxx/XxxXxxxxxxxx?xxxxxx[xxxxx]&xxx ameterCode=Ca

DomainDefinitionsService GetParameterList xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxXxxxxxxxxxxXxxxxxx.xxx/xxxx/XxxXxxxxxxxxXxxx?xxxxxx[xxxxx]& parameterCategory=Kemi

DomainDefinitionsService GetUnitByName xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxXxxxxxxxxxxXxxxxxx.xxx/xxxx/XxxXxxxXxXxxx?xxxxxx[xxxxx]&x ame=m

DomainDefinitionsService GetUnits xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxXxxxxxxxxxxXxxxxxx.xxx/xxxx/XxxXxxxx?xxxxxx[xxxxx]

ObservationsService GetServiceVersion xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxxxxxxxXxxxxxx.xxx/xxxx/XxxXxxxxxxXxxxxxx

ObservationsService GetSitesByName xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxxxxxxxXxxxxxx.xxx/xxxx/XxxXxxxxXxXxxx?xxxxxx[xxxxx] &name=Havgårdssjön

ObservationsService GetSitesByEUId xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxxxxxxxXxxxxxx.xxx/xxxx/XxxXxxxxXxXXXx?xxxxxx[xxxxx]&xxxxxXX 615365-134524

ObservationsService GetSite xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxxxxxxxXxxxxxx.xxx/xxxx/XxxXxxx?xxxxxx[xxxxx] &siteid=145

ObservationsService GetSamplesBySite xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxxxxxxxXxxxxxx.xxx/xxxx/XxxXxxxxxxXxXxxx?xxxxxx[xxxxx]&xxxxxx

=145&fromYear=2011&toYear=2014

ObservationsService GetFullSample xxxxx://xxxxxxxxx.xxx.xx/xxx/xx/XxxxxxxxxxxxXxxxxxx.xxx/xxxx/XxxXxxxXxxxxx?xxxxxx[xxxxx]&xxx0000 6

SOAP klientkod

Här är exempelkod i c#.net som anropar webbmetoden DomainDefinitionsService.GetServiceVersion över SOAP. MDMvmDomainDefinitionsService_QA i detta exempel är en service reference till web service DomainDefinitionsService.

/// <summary>

/// Retrieves the web service version.

/// Calls the GetServiceVersion method of the DomainDefinitionsService.

/// </summary>

/// <returns>A string representation of the service version.</returns> public string GetServiceVersion()

{

MDMvmDomainDefinitionsService_QA.DomainDefinitionsServiceClient serviceRef = new MDMvmDomainDefinitionsService_QA.DomainDefinitionsServiceClient();

try

{

}

string result = serviceRef.GetServiceVersion(); serviceRef.Close();

return result;

catch (Exception ee)

{

serviceRef.Abort(); throw;

}

Service reference exempel till SecureTokenService (Notera “soap11” på slutet i web service adressen).

<?xml version="1.0" encoding="utf-8" ?>

<system.serviceModel>

</binding>

</basicHttpBinding>

</bindings>

</client>

</system.serviceModel>

</configuration>

FAQ

Vilka tekniska protokoll och standarder stöds?

Web servicarna stödjer SOAP 1.1, REST JSON och POST JSON anrop.

Vad kan jag göra med web servicarna?

Du kan söka observationer och mätvärden av intresse, hämta stationsinformation och slå upp referensinformation om t.ex. parametrar och enheter.

Krävs autentisering för att använda web servicarna?

En säkerhetstoken krävs. Det finns två typer av säkerhetstoken: den ena kräver autentisering genom web servicen SecureTokenService, den andra aktiverar du genom att logga in i Miljödata MVM applikationen. Se vidare avsnittet Behörigheter och säkerhet i denna manual.

Hur gör jag för att skapa ett konto i Artdatabankens UserAdmin? Får jag ett konto direkt eller måste någon godkänna mig först?

Navigera till nedan länk i en webbläsare och följ instruktioner för att skapa ett personligt användarkonto. Användarkonton behöver inte godkännas men utökade behörighetsroller måste först godkännas och tilldelas av en administratör.

xxxxx://xxxxxxxxx.xxxxxxxxxxxxx.xx

Vilket koordinatsystem används för geografisk information?

Sweref 99 TM.

Finns det en lista över vilken typ av data som finns i systemet?

Ja. Mängden data presenteras på olika vis på sidan Innehåll. //xxxxxxxxx.xxx.xx/xxx/XxxxXxxxxxxx

En lista över undersökningar (projekt) och övervakningsprogram i systemet finns på sidan Innehåll – Undersökningar. xxxxx://xxxxxxxxx.xxx.xx/xxx/XxxxXxxxxxxx/Xxxxxxx

Vad är en Site? Vad är en SiteFeature?

En site är en station. Det kan beskrivas som en övervakningsstation, en lokal eller annan yta man är intresserad av att övervaka.

Finns det en lista över stationerna i systemet?

Ja, på sidan Innehåll – Stationer. xxxxx://xxxxxxxxx.xxx.xx/xxx/XxxxXxxxxxxx/XxxxxxxxXxxxx

Vad är en ObservationCollection? Vad är en Sample?

En ObservationCollection är en samling relaterade observationer och mätvärden. Det är resultatet av en provtagning.

Finns det en lista över proverna eller provtagningarna i systemet? Nej. Använd det grafiska sökverktyget för att hitta prover av intresse. Vad är en Parameter? Vad är en Property?

En parameter / property är en egenskap som har observerats eller analyserats. Exempel är pH och temperatur.

Finns det en lista över parametrarna i systemet?

Ja, på sidan Innehåll – Parametrar. xxxxx://xxxxxxxxx.xxx.xx/xxx/XxxxXxxxxxxx/Xxxxxxxxxx

Vad är en UnitOfMeasureType?

UnitOfMeasureType är en enhet. Exempel är meter och mg/l.

Finns det en lista över enheterna i systemet?

Ja, på sidan Innehåll – Enheter. xxxxx://xxxxxxxxx.xxx.xx/xxx/XxxxXxxxxxxx/Xxxxx

Finns det en manual eller dokumentation över informationen i systemet?

Nej. Ovan beskrivs de viktigaste objekttyperna. Mer information om informationen från Datavärdskapet för sjöar och vattendrag återfinns på

xxxxx://xxx.xxx.xx/xx/xxxxxxxxxxxxx/xxxxxx-xxxxx/xxxxxxxxxxxx/

För mer hjälp angående responseobjekten eller informationsmodellen, vänligen kontakta en systemförvaltare.

Vad är en indexberäkning?

En indexberäkning är ett beräknat värde uträknat från mätvärden i ett prov som ytterligare beskriver ett prov.

Se sidan Innehåll – Indexberäkningar för en komplett lista med beskrivningar. xxxxx://xxxxxxxxx.xxx.xx/xxx/XxxxXxxxxxxx/XxxxxxxxxxXxxxxxx

Document Metadata

Table of Contents

SERVICE MANUAL

Document Metadata