Ändringshistorik

2024-04-26	8.0.5	Förtydligade sorteringsparametrar	Peter Larsson, Advant
2021-12-03	8.0.4	Nytt fält: trail_time Filer finns nu i API:t	Magnus Johansson, Advant
2021-10-19	8.0.3	Slugs på andra språk tillagda på produkter och evenemang	Magnus Johansson, Advant
2021-10-01	8.0.2	Nya metadatafält på bild tillagda Ledfält tillagda	Magnus Johansson, Advant
2021-09-27	8.0.1	Dokumentation flyttad från PDF till webb	Magnus Johansson, Advant
2021-09-15	8.0.1	Plats har uppdaterats med fält för latitud och longitud Det går nu att söka på flera kommaseparerade ID:n i endpoints	Magnus Johansson, Advant
2021-08-19	8.0.0	RC-markeringen har plockats bort	Magnus Johansson, Advant
2021-07-08	8.0.0-rc1	Två nya endpoints för enskilda produkter och evenemang har lagts till Parametrar som ännu färdigställs i beta har nu färdigställs. API:t är i produktionsklart och har satts som RC (release candidate 1)	Magnus Johansson, Advant
2021-06-08	8.0.0-beta1	I samband med det helt nya Turid-API:t har också en ny dokumentation tags fram	Magnus Johansson, Advant

URL till API

Alla endpoints huserar under: https://turid.visitvarmland.com/api/v8

Endpoints

Produkter och evenemang

Produkter och evenemang hämtas via två separata endpoints: /products och /events

Två endpoints finns också för att hämta enskilda produkter och evenemang under /products/ID och /events/ID. Flera kommaseparerade ID:n kan skickas in med /products/ID,ID,ID

Följande parametrar kan skickas in, ingen är obligatorisk:

Parameter	Datatyp eller möjliga värden	Default	Beskrivning
`lang`	En av: `sv` `en` `de`	`sv`	Returnerar resultat på angivet språk
`municipalities`	En eller flera av (kommaseparerade): `-` `arjang` `arvika` `degerfors` `eda` `filipstad` `forshaga` `grums` `hagfors` `hammaro` `karlskoga` `karlstad` `kil` `kristinehamn` `munkfors` `saffle` `storfors` `sunne` `torsby`		Filtrerar efter angivna kommuner. Se kommun-dokumentation
`from`	`ÅÅÅÅ-MM-DD`	Dagens datum	Filtrerar evenemang som har ett tillfälle som startar tidigast angivet datum
`to`	`ÅÅÅÅ-MM-DD`		Filtrerar evenemang som har ett tillfälle som slutar senast angivet datum
`categories`	En eller flera av kategori-slugar (kommaseparerade)		Filtrerar efter angivna kategorier. Se kategori-dokumentation
`search`	Sträng		Filtrerar efter angivet fritextsökbegrepp
`updatedsince`	`ÅÅÅÅ-MM-DD` / `ÅÅÅÅ-MM-DD TT:MM:SS`		Filtrerar noder som uppdaterats sedan angiven tidpunkt
`translatedonly`	`0` / `1`	`0`	`0` = Returnerar alla noder, och använder svensk översättning om det angivna språket inte finns tillgängligt `1` = Returnerar enbart faktiskt översatta noder
`limit`	Integer (max `50`)	`10`	Antal noder att retunera per sida
`page`	Integer	`1`	Returnerar noder från angiven sida
`interest`	En eller flera av: `local` `regional` `travel`		Filtrerar efter angiven intressekategorisering
`publication`	En eller flera av (kommaseparerade): `ARK` `Årligt återkommande` `Dalslands Kanal` `Klarälvsbanan` `Lake Vänern` `Mariebergsskogen` `Naturkartan` `Unionsleden` `Vänerleden` `Värmlands Bergslag` `Visit Karlstad`		Filtrerar efter angiven publiceringskategorisering
`orderby`	Ett av: `updated` `created` `start_date` (enbart evenemang) `distance` (enbart produkt och när `latitude`/`longitude` är satt)	Se beskrivning	Sorterar resultatet efter angiven sortering Standard: Produkter `interest=local`+`DESC` `updated`+`DESC` Evenemang `start_date`+`ASC` `interest=travel`+`DESC` `interest=regional`+`DESC` `interest=local`+`DESC` `updated`: `DESC` `created`: `DESC` `start_date`: `ASC` `distance`: `ASC` Om `latitude`+`longitude`+`radius` är angivna vid produktlistning sorteras dessa efter `distance`+`ASC`, `orderby` har ingen effekt. Om `latlng` är angivet vid produktlistning sorteras dessa inte alls, `orderby` har ingen effekt. Om `orderby` inte är angivet vid produktlistning, och ingen av ovan fyra nämnda kriterier är satta, så sker sortering enligt följande: `municipalities` är angivet: Arrangörskategori+`DESC` `interest=travel`+`DESC` `interest=regional`+`DESC` `interest=local`+`DESC` `updated`+`DESC` `municipalities` är INTE angivet: `priority`+`DESC` `interest=local`+`DESC` `updated`+`DESC` = Fast sorteringsordning, `order` har ingen effekt.
`order`	Ett av: `asc`/`desc`
`latitude`	T.ex. `59.713997`		Filtrerar noder baserat på en angiven latitud och longitud, tillsammans med radius
`longitude`	T.ex. `14.169844`
`radius`	Anges med en siffra i antal kilometer	`100`
`latlng`	Format: `[[lat,lng],[lat,lng,rad],[lat,lng]]` T.ex. `[[59.713997,14.169844,2000],[59.834962,13.542754]]`		Filtrerar noder baserat på en lista av koordinater tillsammans med radius. Om inte radius anges för varje enskild koordinat används den globala `radius`-parametern

Svarssignatur

    {
        "id": integer,
        "created_at": datetime,
        "updated_at": datetime,
        "title": string,
        "description": string,
        "sales_text": string,
        "presentation": string,
        "open_hours": string,
        "ticket_information": string,
        "ticket_info": string,
        "open_times": string,
        "meta_title": string,
        "meta_keywords": string,
        "meta_description": string,
        "booking_link": string,
        "website_link": string,
        "organizers": [{
            "id": integer,
            "title": string,
            "street1": string,
            "street2": string,
            "zip_code": string,
            "city": string,
            "municipality_id": integer,
            "organization_id": integer,
            "booking_link": string,
            "website_link": string,
            "email": string,
            "phone_numbers": [
                string
            ]
        }],
        "websites": [],
        "prices": [{
            "price_type": string,
            "price": string,
            "seats_available": string,
            "description": string
        }],
        "phone_numbers": [],
        "images": [{
            "large": string,
            "medium": string,
            "small": string,
            "alt_text": string,
            "copyright": string,
            "description": string,
            "photographer": string,
            "year": integer
        }],
        "files": [{
            "link": string,
            "title": string,
            "size": string
        }],
        "categories": [{
            "id": integer,
            "title": string,
            "slug": string
        }],
        "places": [{
            "id": integer,
            "title": string,
            "presentation": string,
            "latitude": string,
            "longitude": string,
            "accessibility": [{
                "title": string,
                "more_information": string
            }]
        }],
        "distance": string,
        "slugs": {
            "sv": {
                "slug": "string",
                "full_slug": "string"
            },
            "en": {
                "slug": "string",
                "full_slug": "string"
            }
        },
        "is_trail": integer,
        "trail_code_snippet": string,
        "trail_total_length": integer,
        "number_of_trails": integer,
        "trail_level": string,
        "trail_terrain": string,
        "trail_time": string,
        "slug": string,
        "primary_image": {
            "large": string,
            "medium": string,
            "small": string
        },
        "occasions": [{
            "date_start": date,
            "date_end": date,
            "time_start": time,
            "time_end": time
        }],
        "past_occasions": [{
            "date_start": date,
            "date_end": date,
            "time_start": time,
            "time_end": time
        }],
        "related_products": [{
            "id": integer,
            "title": string
        }],
        "related_events": [{
            "id": integer,
            "title": string
        }]
    }

Kommuner

Kommuner hämtas via endpoint: /municipalities

Kategorier

Kategorier hämtas via endpoint: /categories