Brukerveiledning VN API

Transkript

1 Brukerveiledning VN API

2 Forord Denne brukerveiledningen omhandler bruk av tjenesten VN API, et åpent Web API. API-et er ment for å brukes av Visit Norway, både nettsted og mobilapplikasjoner, samt andre interessenter. Den beskriver de ulike kallene og strukturen på dataene man får tilbake. Bruk av API-et er myntet på utviklere og krever forkunnskaper om API-er generelt i tillegg til minimum grunnleggende programmeringskunnskaper. Innhold Forord... 2 Innhold Innledning Veiledning Generelt Struktur på resultatene Kontrollerne... 7 Products/Språk... 7 Products/Språk/Id... 7 ProductsByCategory/Språk/Category... 7 ProductsByCounty/Språk/Fylke... 7 ProductsByMunicipality/Språk/Kommune... 7 ProductsByPost/Språk/Poststed... 7 ProductsNearby/Språk/Latitude/Longitude... 7 ProductsByLocalOrganization/Språk/Id... 7 LocalOrganization Referanser Språkkoder Kategorier

3 1 Innledning Dette Web API-et tilbyr produkter som brukes på Visit Norway ( via httpprotokollen. API-et returner JSON-objekter, og er OData-kompatibelt. Siden dette API-et kun skal gi fra seg data til konsumentene, er det kun Get-metoder som tilbys. 2 Veiledning 2.1 Generelt For å kalle på API-et, brukes adressen/api etterfulgt av hvilken kontroller du vil bruke og eventuelle parametere. Som skilletegn mellom parametere og verdier brukes skråstek, «/». Alle kontrollerne, med unntak av LocalOrganization, krever spesifisering av språk som første parameter. Språket oppgis som en kode på to bokstaver. Liste av gjeldende språkkoder finnes under kapittelet Referanser bakerst i denne veiledningen. Parametere er i denne veiledningen angitt med krøllparenteser rundt, slik: Product/Språk. Hele dette elementet skal erstattes med en gyldig språkkode, for eksempel slik: Product/no Dersom ingen aktuelle resultater finnes, returner API-et null. 2.2 Struktur på resultatene Resultatene blir returnert som JSON-objekter. Følgende struktur beskriver resultatene fra de aller fleste kontrollerne: [ "$id": "1", "Id": 1, "StreetAddress": "sample string 2", "PostalCode": "sample string 3", "PostalArea": "sample string 4", "Municipality": "sample string 5", "County": "sample string 6", "Latitude": "sample string 7", "Longitude": "sample string 8", "Website": "sample string 9", "Phone": "sample string 10", " ": "sample string 11", "Name": "sample string 12", "Description": "sample string 13", "Transportation": "sample string 14", 3

4 "LocalOrgName": "sample string 15", "LocalOrgWebsite": "sample string 16", "OwnerName": "sample string 17", "Mediae": [ "$id": "2", "MediaType": "sample string 1", "Name": "sample string 2", "Description": "sample string 3", "Copyright": "sample string 4", "EmbeddedUri": "sample string 5", "Instances": [ "$id": "3", "Size": "sample string 1", "Width": 2, "Height": 3, "Uri": "sample string 4" "$ref": "3" "$ref": "3" ] "$ref": "2" "$ref": "2" "StandardOpeningTimes": [ "$id": "4", "Weekday": [ "sample string 1", "sample string 2", "sample string 3" "FromTime": "sample string 1", "ToTime": "sample string 2" "$ref": "4" "$ref": "4" "SpecialOpenings": [ 4

5 "$id": "5", "Weekday": [ "sample string 1", "sample string 2", "sample string 3" "FromDate": "sample string 1", "ToDate": "sample string 2", "FromTime": "sample string 3", "ToTime": "sample string 4" "$ref": "5" "$ref": "5" "Thirdparties": [ "$id": "6", "Uri": "sample string 1", "Name": "sample string 2" "$ref": "6" "$ref": "6" "Facilities": [ "$id": "7", "SubFacilities": [ "$id": "8", "Value": "sample string 1", "Name": "sample string 2" "$ref": "8" "$ref": "8" "Name": "sample string 1" "$ref": "7" 5

6 "$ref": "7" "Categories": [ "$id": "9", "CategoryName": "sample string 1", "ParentCategory": "$ref": "9" "$ref": "9" "$ref": "9" ] "$ref": "1" "$ref": "1" ] LocalOrganization-kontrolleren returnerer liste av lokale organisasjoner i følgende format: [ "$id": "1", "Id": 1, "Name": "sample string 1", "Website": "sample string 2" "$ref": "1" "$ref": "1" ] 6

7 2.3 Kontrollerne Products/Språk Returnerer en liste av alle produkter på det valgte språket. Products/Språk/Id Returnerer produktet med den aktuelle id-en på det valgte språket. ProductsByCategory/Språk/Category Returnerer en liste av alle produkter på det valgte språket i den valgte kategorien. Liste over gyldige kategorier finnes under kapittelet Referanser bakerst i denne veiledningen. ProductsByCounty/Språk/Fylke Returnerer en liste av alle produkter på det valgte språket i det spesifiserte fylket. ProductsByMunicipality/Språk/Kommune Returnerer en liste av alle produkter på et valgte språket i den spesifiserte kommunen. ProductsByPost/Språk/Poststed Returnerer en liste av alle produkter på det valgte språket i det spesifiserte poststedet. ProductsNearby/Språk/Latitude/Longitude Returnerer en liste av alle produkter på det valgte språket innenfor en sirkel med radius på én kilometer fra det aktuelle latitude-longitude-punktet. Gradene må oppgis med punktum, for eksempel slik: /API/ProductsNearby/no/ / / ProductsByLocalOrganization/Språk/Id Returnerer en liste av alle produkter på det valgte språket i den lokale organisasjonen med den oppgitte id-en. Liste over gyldige id-er kan hentes via kontrolleren LocalOrganization. LocalOrganization Returnerer en liste av alle lokale organisasjoner. 7

8 3 Referanser 3.1 Språkkoder Språk Språkkode Norsk Engelsk Spansk Tysk Fransk Italiensk no en es de fr it 3.2 Kategorier Aktiviteter Ambassader og konsulater Andre tjenester Annet Arrangement Arrangør Attraksjoner Bank Barer og puber Bensinstasjon Bil Bilutleie Buss Bussutleie Byggverk Båt Båt/Ferge Båtutleie Camping Campingutleie Dyr Fagmenn Fastfood Festivaler Festning og ruiner Fly For barn Foredrag og seminar Forestillinger Forretninger Foto Gatekjøkken og take away Guiding Havn/Marina Helikopter Helikopterutleie Helsetjenester Hotell Hytter Høytider og merkedager Håndverk Innredning Jakt og fiske Jernvare Kaféer og kaffebarer Kirke Kjøretøy Klesutleie Klær og sko Konditori og iskrembarer Konferanser Konserter Kulturhistorisk Kulturopplevelse 8

9 Kurs Shoppingsenter Litteratur Show Lokaler Sightseeing Mat Sightseeing Transport Mat og drikke Skjønnhet og helse Messer/Markeder Sport Museum Sport og friluft Musikk Sportsarrangementer Nattklubber Sykkelutleie Natur Taxi Naturaktiviteter Temaparker Naturattraksjon Tjenester og service Offentlig transport Tog Offentlige og kommunale tjenester Transport Overnatting Trikk/Bane Overnattingssteder Tur Parker Turer Parker og hager Turistforeningshytter Planter Turistinformasjon Post Ute Privat Utleie Reise Utleie av lokaler Reisepakke Utstilling Rekreasjon og behandlingssenter Utstillinger Religiøst Vandrerhjem og herberge Restauranter Vandring Servering Vask og rens Severdighet Ved sjøen Shopping Veikroer Verksted Vertshus og pensjonat Veterinær Vinmonopol Vinteraktiviteter Vinterutstyr 9