Generella parametrar

Detta är de generella parametrar i Sveriges Radios öppna API som är tillgängliga i varje API metod, samt deras standardvärden om parametern saknas i anropet.

Användandet av dessa parametrar beskrivs nedan utifrån funktionalitet.

Dataformat - format, callback

Detta är de olika dataformat som för närvarande stöds av APIet.

format = xml

Resultatet returneras som XML.

format = json

Resultatet returneras som JSON.

format = json, callback = funktionsnamn

Om resultatet ska returneras som JSONP måste även parameter callback anges. Om inget funktionsnamn anges när JSONP efterfrågas returneras resultatet som JSON.

Paginering - pagination, page, size

pagination = false

Resultatet returneras utan att pagineras.

pagination = true

Resultatet returneras med paginering aktiverat. Standardvärden används för page och size och endast de första 10 elementen returneras.

pagination = true, page = x, size = y

Resultatet returneras med paginering aktiverat. Parametern size anger det maximala antalet element som ska returneras. Parametern page anger önskad sida av pagineringen.

Exempelvis: Om x = 3 och y = 5 och listan har över 15 element returneras element 11 t.o.m 15.

Ljud - audioquality, liveaudiotemplateid, ondemandaudiotemplateid

Ljudkvalité - audioquality

audioquality anger önskad ljudkvalitet. För mer info se ljudkvalitet.

Ljudlänksmall - liveaudiotemplateid, ondemandaudiotemplateid

liveaudiotemplateid och ondemandaudiotemplateid anger önskad format på url:en. För mer info se ljudlänksmallar.

Filtrering - filter, filtervalue

Resultatet filtreras innan det returneras utifrån angivna filteringsparametrar. Se dokumentationen av varje specifik API-metod för parametervärden som stöds att filtrera på.

Man kan inte kombinera olika filtreringar.

filter = elementnamn, filtervalue = elementvärde

Om filter och filtervalue är angivet filtreras resultatet innan det returneras utifrån dessa värden. Parametern filter anger vilket element resultatet ska filtreras utifrån. Parametern filtervalue anger vilket värde filtreringen ska använda sig av. Filtreringen av text inkluderar samtliga element där filtervalue ingår i. Exempelvis är ditt filtervalue = "radio", kommer resultatet även ta med element som innehåller ordet "sveriges radio".

Filtrering av numeriska värden kräver en exakt träff.

Sortering - sort

Resultatet sorteras innan det returneras utifrån angivna sort-parametrar. Se dokumentationen av varje specifik API-metod för värden som stöds att sortera på.

sort = värde[ desc][,värde[ desc],...]

Om sort är angivet, sorteras resultatet innan det returneras utifrån de värden, som angetts.

Det går att sortera på flera värden, och sortering sker i den ordning de anges. Exempelvis kommer sort=värde1,värde2 sortera på först värde1 och sedan värde2.

Det går även att sortera i fallande ordning med hjälp av instruktionen +desc (descending). Exempelvis kommer sort=värde1+desc,värde2d sortera på värde1 i fallande ordning och därefter värde2 i stigande ordning.

Indentering - indent

Denna inställning kan vara bra att känna till om man manuellt besöker APIet och vill undersöka resultatet. Dataformat som JSON kan vara svårläst utan indentering. Standardinställningen i APIet är satt till false, eftersom datamängden för varje anrop bör minimeras.

indent = false

Resultatet returneras utan indentering.

Exempelsvar (förkortat): Ej indenterat JSON

{"copyright":"Copyright Sveriges Radio 2012. All rights reserved.","programs": [{"programid":2485,"title":"ad lib med Lex","description":"ad lib är ett direktsänt underhållningsprogram med örat på det aktuella, ett slags fånga dagen med musik. Du som lyssnare blir bjuden på allsköns jubileer, jubilarer, premiärer, sekundärer och sköna konster av alla (o)upptänkliga slag.","podunits":[],"payoff":"Carpe diem med LEX","broadcastinfo":"tisdag-torsdag kl 18.04","email":"adlib@sverigesradio.se", ... ,"pagination":{"page":1,"size":10,"totalhits":438,"totalpages":44,"nextpage":"http://api.sr.se/api/v2/programs?format=json&indent=false&page=2"}}

indent = true

Resultatet indenteras.

Exempelsvar (förkortat): indenterat JSON
{
  "copyright": "Copyright Sveriges Radio 2012. All rights reserved.",
  "programs": [
    {
      "programid": 2485,
      "title": "ad lib med Lex",
      "description": "ad lib är ett direktsänt underhållningsprogram med örat på det aktuella...,
      "podunits": [],
      "payoff": "Carpe diem med LEX",
      "broadcastinfo": "tisdag-torsdag kl 18.04",
      "email": "adlib@sverigesradio.se",
      ...
    },
    ...
  ],
  "pagination": {
    "page": 1,
    "size": 10,
    "totalhits": 438,
    "totalpages": 44,
    "nextpage": "http://api.sr.se/api/v2/programs?format=json&indent=true&page=2"
  }
}