Sortere.no - API

Formål

Autocomplete-tjenestene kan brukes til å slå opp steder (postnr, adresse, kommune, fylke) eller kjernedata (produkttyper og avfallstyper). Det er en JSON-RPC-tjeneste som brukes ved et HTTP-kall.

Tjenester

Steder

Url: http://data.sortere.no/api/sted/{søkeord}

Dette søket returnerer alle steder som matcher {søkeord}. Det blir gjort søk både mot steder som begynner med søkeordet og steder som inneholder søkeordet. F.eks vil et søk på 'be' gi både treff på Bergen og Lebesby. Treff som matcher begynnelsen av stedet kommer først i resultatsettet.

Søket matches opp mot postnummer (hvis søkeordet er numerisk) eller stedsnavn (kommunenavn, poststed, gatenavn eller fylkesnavn). Resultat-objektet inneholder en tabell for hver av de fire stedstypene. Se under for eksempelresultat ved søk på 'grod':

{
    "jsonrpc": "2.0",
    "id": null,
    "result": {
        "query": "grod",
        "kommune": [],
        "postnr": [],
        "adresse": [{
            "navn": "Grodals\u00e5sen",
            "postnr": "1389",
            "poststed": "",
            "kommune": "Asker",
            "kommunenr": "0220"
        }],
        "fylke": []
    }
}
                    

Parameter: type

Verdier: 'poststed', 'adresse', 'kommune' eller 'fylke'

Ved å spesifisere type-parameteret kan en begrense hvilke stedstyper som blir tatt med i resultatet. Hvis en f.eks. ønsker å bare få ut kommunene som matcher 'os' kan en bruke dette parameteret:

http://data.sortere.no/api/sted/os?type=kommune

Det er mulig å spesifisere flere typer separert med komma (eks. "?type=fylke,kommune")

Forslag

Url: http://data.sortere.no/api/forslag/{søketerm}

Denne tjenesten returnerer søkeord, produkt- og avfallstyper som har matchende navn for en gitt søketerm. Både navn som begynner på søketermen og navn som inneholder søketermen blir returnert, med de som begynner på ordet først i resultatet. Eksempel på søk på 'batterier':

{
    "jsonrpc": "2.0",
    "id": null,
    "result": {
        "sokeord": [],
        "avfallstyper": [{
            "id": 9,
            "navnNb": "Batterier",
            "navnNy": "Batteri",
            "bildeUrl": "\/bilde\/6\/batterier.png"
        }, {
            "id": 91,
            "navnNb": "Oppladbare batterier",
            "navnNy": "Oppladingsbatteri",
            "bildeUrl": "\/bilde\/6\/batterier.png"
        }],
        "produkttyper": []
    }
}
                    

Tjenesten tar ingen ekstra parametere.

Formål

Denne tjenesten omfatter data om alle mottakene hvor en bedrift kan levere næringsavfall.

Tjenester

Næringspunkter

Url: http://data.sortere.no/api/punkter/naring

Grunnsøket returnerer alle næringsmottak i Norge. Under er et eksempel på strukturen i resultatsettet.

{
    "jsonrpc": "2.0",
    "id": null,
    "result": {
        "antall": 1,
        "data": [{
            "id": 4,
            "overskrift": "Egil R\u00f8dsrud AS",
            "lat": "59.394080",
            "lng": "10.744740",
            "ekstra": {
                "gateadresse": "Vestre Huggenesvei 57",
                "postadresse": "Ryggeraet 55",
                "postnr": "1580",
                "poststed": "RYGGE",
                "telefon": "69 23 46 00",
                "avfallstyper": [{
                    "id": 36,
                    "navnNb": "EPS",
                    "navnNy": "EPS",
                    "bildeUrl": "\/bilde\/29\/eps.png"
                },
                "returselskaper": [{
                    "id": 1,
                    "navn": "Gr\u00f8nt Punkt Norge AS",
                    "kortnavn": "gpn"
                }]
            }
        }]
    }
}
                    

Tjenesten aksepterer en rekke parametere for å begrense søket:

Parameter: avfallstyper

Verdier: En kommaseparert liste med avfallstype-ider

Resultatsettet inneholder alle mottak hvor en kan levere en eller flere av de aktuelle avfallstypene:

http://data.sortere.no/api/punkter/naring?avfallstyper=52

Parameter: ider

Verdier: En kommaseparert liste med punkt-ider

Resultatsettet inneholder informasjonen om mottakene som har disse nøklene:

http://data.sortere.no/api/punkter/naring?ider=212,213

Parameter: returselskaper

Verdier: En kommaseparert liste med kortnavn på returselskaper (eks: gpn=Grønt Punkt Norge, renas=Renas)

Resultatsettet inneholder alle mottakene som har avtale med de aktuelle returselskapene (nyttig om man skal lage kart som kun gjelder Grønt Punkt Norge f.eks):

http://data.sortere.no/api/punkter/naring?returselskaper=gpn

Parameter: kolonner

Verdier: En kommaseparert liste over kolonnenavn

Id- og type-kolonnene er alltid med. Kolonnene i "ekstra"-objektet spesifiseres ved å bruke "ekstra" som et prefiks til kolonnenavnet (f.eks. "ekstra.postnr" eller "ekstra.avfallstyper"):

http://data.sortere.no/api/punkter/naring?kolonner=lat,lng,overskrift

Parameter: lat, lng og radius

Verdier: WGS84-koordinater og radius i meter

Hvis et av parameterene utelates blir det ikke foretatt en geofiltrering av resultatet. Punktene returneres sortert etter distanse fra senterpunktet i søket. Denne distansen er inkludert som en egenskap i svaret. Både utvelgelse og avstandberegning er basert på en sfærisk geoide for å forenkle matteoperasjonene og dermed er ikke resultatet meternøyaktig:

http://data.sortere.no/api/punkter/naring?lat=60.3925&lng=5.323333&radius=10000

Parameter: antall

Verdier: Et tall

Et tall som sier hvor mange rader som skal returneres av hele resultatsettet:

http://data.sortere.no/api/punkter/naring?antall=3

Parameter: start

Verdier: Et tall

Et tall som sier på hvilken indeks (0-indeksert) resultatsettet skal starte på i forhold til hovedsvaret:

http://data.sortere.no/api/punkter/naring?start=3

Formål

Denne tjenesten omfatter data om alle returpunkter og gjenvinningsstasjoner der en privatperson kan levere avfall.

Tjenester

Husholdningspunkter

Url: http://data.sortere.no/api/punkter/husholdning Alternativt: http://data.sortere.no/api/punkter

Grunnsøket returnerer alle returpunkter og gjenvinningsstasjoner i Norge. Under er et eksempel på strukturen i resultatsettet.

{
    jsonrpc: "2.0",
    id: null,
    result: {
        antall: {
            returpunkter: 1,
            gjenvinningsstasjoner: 1
        },
        data: [{
            id: 16437,
            overskrift: "Farlig Avfall",
            beskrivelse: "Gjenvinningsstasjon - Møllendalsveien",
            lat: "60.379300",
            lng: "5.345600",
            type: "farlig",
            ekstra: {
                gateadresse: "",
                postnr: "5009",
                poststed: "BERGEN",
                kommune: "Bergen",
                kommunenr: "1201",
                avfallstyper: [{
                    id: 9,
                    navnNb: "Batterier",
                    navnNy: "Batteri",
                    bildeUrl: "/bilde/6/batterier.png"
                }]
            }
        }, {
            id: 1304,
            overskrift: "Møllendalsveien gjenvinningsstasjon",
            beskrivelse: null,
            lat: "60.379181",
            lng: "5.344537",
            type: "gjenvinningsstasjon",
            ekstra: {
                gateadresse: "Møllendalsv.31",
                postnr: "5009",
                poststed: "Bergen",
                telefon: null,
                apningstider: "Mandag og torsdag: 10.00 - 20.00 Tirsdag, onsdag og fredag: 10.00 - 17.00",
                kommune: "Bergen",
                kommunenr: "1201",
                avfallstyper: [{
                    id: 9,
                    navnNb: "Batterier",
                    navnNy: "Batteri",
                    bildeUrl: "/bilde/6/batterier.png"
                }]
            }
        }]
    }
}
                

Merk at gjenvinningsstasjoner og returpunkt har forskjellig struktur. 'type'-parameteret kan være 'gjenvinningsstasjon', 'farlig', 'returpunkt', 'pantepunkt', 'batpunkt' eller 'hyttepunkt'. Alle de fem siste blir talt sammen i 'returpunkter'-egenskapet til svaret.

Merk også at gjenviningstasjonser og returpunkt kan ha overlappende id-er. Bruk 'type' + 'id' som nøkkel for å identifisere et punkt unikt.

Tjenesten aksepterer en rekke parametere for å begrense søket:

Parameter: avfallstyper

Verdier: En kommaseparert liste med avfallstype-ider

Resultatsettet inneholder punkter hvor en kan levere en eller flere av de aktuelle avfallstypene:

http://data.sortere.no/api/punkter/husholdning?avfallstyper=9

Parameter: ider

Verdier: En kommaseparert liste med punkt-ider

Resultatsettet inneholder informasjonen om punktene som har disse nøklene:

http://data.sortere.no/api/punkter/husholdning?ider=16122,16437

Parameter: kolonner

Verdier: En kommaseparert liste over kolonnenavn

Id-kolonnen er alltid med. Kolonnene i "ekstra"-objektet spesifiseres ved å bruke "ekstra" som et prefiks til kolonnenavnet (f.eks. "ekstra.postnr" eller "ekstra.avfallstyper"):

http://data.sortere.no/api/punkter/husholdning?kolonner=lat,lng,overskrift (OBS: Relativt tregt søk som returnerer alle returpunkter i norge)

Parameter: lat, lng og radius

Verdier: WGS84-koordinater og radius i meter

Hvis et av parameterene utelates blir det ikke foretatt en geofiltrering av resultatet. Punktene returneres sortert etter distanse fra senterpunktet i søket. Denne distansen er inkludert som en egenskap i svaret. Både utvelgelse og avstandberegning er basert på en sfærisk geoide for å forenkle matteoperasjonene og dermed er ikke resultatet meternøyaktig:

http://data.sortere.no/api/punkter/husholdning?lat=60.3925&lng=5.323333&radius=1000

Parameter: distanseberegning

Verdier: 'ja' eller 'nei'

Parameter for å slå av distanseberegning og avstandssortering i geo-søk der det ikke er nødvendig. Dette spare inn noen tideler på de tyngre søkene. Dette paremeteret har ingen effekt om det blir brukt utenfor geo-søk.

http://data.sortere.no/api/punkter/naring?lat=60.3925&lng=5.323333&radius=10000&distanseberegning=nei

Parameter: kommuner

Verdier: en kommaseparert liste over kommunenavn/nummer

Resultatsettet inneholder alle punkter som tilhører de aktuelle kommunene:

http://data.sortere.no/api/punkter/husholdning?kommuner=1201,Oslo

Parameter: renovasjonsselskap

Verdier: en renovasjonsselskaps-id (IKS)

Resultatsettet inneholder alle punkter som tilhører det aktuelle renovasjonsselskapet:

http://data.sortere.no/api/punkter/husholdning?renovasjonsselskap=3

Parameter: type

Verdier: En streng ('gjenvinningsstasjon', 'farlig', 'returpunkt', 'pantepunkt', 'batpunkt' eller 'hyttepunkt')

Returnerer alle punkter som er av den oppgitte typen:

http://data.sortere.no/api/punkter/husholdning?type=hyttepunkt

Parameter: med_nasjonale

Verdier: 'ja' eller 'nei'

Inkluderer punkter fra nasjonale ordningshavere i et renovasjonsselskaps-søk

http://data.sortere.no/api/punkter/husholdning?renovasjonsselskap=3&med_nasjonale=ja

Formål

Søk mot sortere-databasen gjøres for å få ut komplett informasjon om avfallstyper, produkttyper og miljogifter (kjerneentiteter) samt kommuner som er registrert i databasen. Tjenestene kan levere ut både lokal (kommunal) og nasjonalt tilpasset informasjon

Tjenester

Fritekstsøk

Url: http://data.sortere.no/api/sok/fritekst/{søkestreng}

Dette søket returnerer alle kjerneentiteter med navn som matcher {søkestreng}. Det blir gjort søk både mot navn som begynner med søkestrengen og navn som inneholder søkeordet. F.eks vil et søk på 'papp' gi både treff på Papp, papir og kartong og Bølgepappsby. Treff som matcher begynnelsen av navnet kommer først i resultatsettet. Produkttyper har tilknyttede søkeord som det også vil matches på på samme måten. Hvis resultatet er funnet gjennom et søkeord vil 'sokeord'-egenskapen inneholdet ordet det ble gjort treff på. Eksempelstruktur:

{
    jsonrpc: "2.0",
    id: null,
    result: {
        resultattype: "resultatliste",
        soketekst: "ars",
        antallTreff: 3,
        avfallstyper: [{
            id: 91,
            navn: "Oppladbare batterier",
            beskrivelse: "...",
            farlig: false,
            bildeUrl: "/bilde/6/batterier.png",
            sokeord: "brannvarslerbatteri",
            treff: "brannvarslerbatteri"
        }],
        produkttyper: [{
            id: 364,
            navn: "Røykvarsler",
            beskrivelse: "",
            bildeUrl: "/bilde/225/røykvarsler.jpg",
            sokeord: null,
            treff: "Røykvarsler",
            sorteringer: [{
                id: 29,
                navn: "Elektrisk og elektronisk avfall",
                beskrivelse: ...",
                farlig: false,
                bildeUrl: "/bilde/22/elektrisk og elektronisk avfall.png",
                veiledning: "",
                nasjonal: true
            }]
        }],
        miljogifter: [{
            id: 5,
            navn: "Arsen",
            beskrivelse: "...

", bildeUrl: null, treff: "Arsen" }], kommune: {} } }

Resultatsettet er fordelt på opp til tre lister for hver av de tre kjerneentitetene. Merk at produkttyper kan bli sortert som flere avfallstyper og at egenskapen 'sorteringer' derfor er en liste. Disse sorteringene kan overstyres og da vil 'nasjonal'-egensken være false. En sortering er i dette tilfellet et alias for avfallstype med litt ekstra informasjon.

Parameter: kommune

Verdier: Et kommunenavn eller kommunenummer

Lokaliserer søket til én kommune. Man vil få kommunens egne sorteringer, tips og ordninger opp i resultatet.

http://data.sortere.no/api/sok/fritekst/papp?kommune=1201

Kommunesøk

Url: http://data.sortere.no/api/sok/fritekst/?kommune={navn eller nr}

{
    jsonrpc: "2.0",
    id: null,
    result: {
        resultattype: "kommune",
        kommune: {
            navn: "Bergen",
            oppslagsnavn: "Bergen",
            nummer: "1201",
            malform: "nb",
            gateadresse: null,
            postadresse: null,
            postnummer: "5006",
            poststed: null,
            lat: "60.388070",
            lng: "5.331850",
            kontaktinfoOverskrift: "Bergen",
            kontakttelefon: "815 33 030",
            kontaktepost: "bir@bir.no",
            hjemmesideUrl: null,
            tips: {
                obs: [],
                visste: [],
                hva: [],
                lenke: [],
                handtering: [],
                special: []
            },
            ordninger: {
                henteordninger: [{
                    type: "henteordning",
                    navn: "Restavfall",
                    beskrivelse: "",
                    handtering: null,
                    hjemmesideUrl: "www.bir.no",
                    gateadresse: null,
                    postnummer: null,
                    poststed: null,
                    lat: null,
                    lng: null,
                    avfallstyper: [75,110],
                    telefonnr: null
                }],
                kompostordninger: [],
                punktordninger: [],
                hyttepunktordninger: [],
                batpunktordninger: [],
                gjenvinningsstasjoner: [{
                    type: "gjenvinningsstasjon",
                    navn: "Møllendalsveien gjenvinningsstasjon",
                    beskrivelse: null,
                    hjemmesideUrl: null,
                    gateadresse: "Møllendalsv.31",
                    postnummer: "5009",
                    poststed: "Bergen",
                    lat: "60.379181",
                    lng: "5.344537",
                    avfallstyper: [9,124,17],
                    telefonnr: null,
                    apningstider: "..."
                }]
            }
        }
    }
}
                    

Alle ordningene er like, bortsett fra gjenvinningsstasjoner som ikke har 'handtering' men istedet har 'apningstider'

Parameter: kommune

Verdier: Et kommunenavn eller kommunenummer

Obligatorisk parameter som gir kommunedata som resultat såfremt det ikke søkes etter noe annet (ref: fritekstsøk)

http://data.sortere.no/api/sok/fritekst/?kommune=1201

Entitetssøk/liste

Url: http://data.sortere.no/api/sok/entitet/{type}/{id}

Leverer ut all informasjon om entitetstypen oppgitt i {type}. Det er tre ulike entitetstyper: 'avfallstype', 'produkttype' og 'miljogift'. Hvis ikke {id} oppgis vil systemet returnere en liste over alle entiteter av den aktuelle typen, er det oppgitt vil informasjonen om den enkeltentiteten bli returnert.

For øyeblikket returnerer utlistingen av alle avfallstyper kun husholdnings-avfallstyper.

Parameter: kommune

Verdier: Et kommunenavn eller kommunenummer

Dette parameteret lokaliserer dataene i resultatet til en gitt kommune. Hvis ikke parameteret er oppgitt vil tjenesten returnere nasjonal informasjon.

http://data.sortere.no/api/sok/entitet/avfallstype/2?kommune=1201

Populære-søk

Url: http://data.sortere.no/api/sok/populaere

Returnerer alle produkttyper som er markert som populære i databasen. Senere vil denne listen reflektere hva som faktisk blir søkt på mest.

Formål

Denne tjenesten leverer ut ekstrainformasjon om gitte avfallstyper (default: alle). Denne informasjonen inngår i "Verktøykassen", en samlebetegnelse for en informasjonspakke angående hvordan ulike avfallstyper (og udnerkategorier av dem) gjenvinnes.

Tjenester

Url: http://data.sortere.no/api/avfallstypeinformasjon

Dette søket returnerer alle avfallstypeinformasjonsentiteter med alle tilgjengelige kolonner.

{
    "jsonrpc": "2.0",
    "id": null,
    "result": {
        antall: 1,
        data: [{
            id: 5,
            underkategori: "Low-density polyethylene (PE-LD)",
            destinasjon: null,
            gjenvinning: null,
            miljogevinst: null,
            transport: null,
            spartEnergi: null,
            spartCo2: null,
            spartRastoff: null,
            avfallstype: {
                id: 104,
                navnNb: "Plastemballasje",
                navnNy: "Plastemballasje",
                beskrivelseNb: "...",
                beskrivelseNy: null,
                bildeUrl: "/bilde/87/pp-sekk.png",
                tidsserier: [{
                    id: 1,
                    arstall: 2010,
                    totaltTonn: 135066,
                    totaltBeskrivelse: null,
                    innsamletTonn: null,
                    innsamletProsent: null,
                    innsamletBeskrivelse: null,
                    materialgjenvunnetTonn: 52905,
                    materialgjenvunnetProsent: "39.2",
                    materialgjenvunnetBeskrivelse: null,
                    energiutnyttetTonn: 68470,
                    energiutnyttetProsent: "50.7",
                    energiutnyttetBeskrivelse: null
                }]
            },
            eksempler: [ ],
            hvaBlirDetTil: [ ]
        }]
    }
}
                    

Parameter: avfallstyper

Verdier: En kommaseparert liste med avfallstype-ider

Resultatsettet inneholder alle avfallstypeinformasjoner som er knyttet til avfallstypene i listen:

http://data.sortere.no/api/avfallstypeinformasjon?avfallstyper=104

Parameter: kolonner

Verdier: En kommaseparert liste over kolonnenavn

Id- og underkategori-kolonnene er alltid med. Eksempel med bare tidsserier:

http://data.sortere.no/api/avfallstypeinformasjon?kolonner=tidsserier

Formål

Disse tjenestene gjør det mulig å søke i sortere.nos bildearkiv på tagger, fritekst og spesifikke bilde-ider. Bilde-apiet inneholder også en tjeneste for å hente ut bildefiler i arbitrære størrelser fra arkivet basert på id.

Alle tjenestene utenom bildefil-tjenesten leverer ut JSON-data på følgende format:

{
    "jsonrpc": "2.0",
    "id": null,
    "result": {
        "treff": 1,
        "data": [{
            "id": 1,
            "tittel": "amalgam",
            "ext": "png",
            "mime": "image\/png",
            "width": 66,
            "height": 66,
            "beskrivelse": null,
            "fotobyline": null,
            "kilde": null,
            "tags": "avfallstype",
            "url": "http:\/\/sortere.datamagi.no\/bilde\/1"
        }]
    }
}
                    

Tjenester

Søk etter alle

Url: http://data.sortere.no/service/bildesok/alle/

Dette søker returnerer en liste over alle bilder i databasen.

Tjenesten tar ingen ekstra parametere.

Fritekstsøk

Url: http://data.sortere.no/service/bildesok/fritekst/{søkestreng}

Dette søket returnerer alle bilder hvor enten 'navn', 'beskrivelse', 'fotobyline' eller 'kilde' matcher hele eller deler av søkestrengen, samt at det gjøres en matching mot taggene til bildet

Tjenesten tar ingen ekstra parametere.

Idsøk

Url: http://data.sortere.no/service/bildesok/id/{id-liste}

Søket returnerer en liste over alle bilder som har matchende id-er med elementene i den kommaseparerte id-listen.

Tjenesten tar ingen ekstra parametere.

Taggsøk

Url: http://data.sortere.no/service/bildesok/tags/{tag-liste}

Søket returnerer en liste over bilder som er tagget med tagger som matcher de oppgitt i den kommaseparerte listen

Tjenesten tar ingen ekstra parametere.

Tomtaggsøk

Url: http://data.sortere.no/service/bildesok/utentags/

Søket returnerer alle bilder som ikke er tagget.

Tjenesten tar ingen ekstra parametere.

Bildefil

Url: http://data.sortere.no/bilde/{id}/{filnavn}

Denne tjenesten returnerer bildefilen med den oppgitte id-en. Filanvn er valgfritt å oppgi for å kunne spesifisere url-er ser ut som "vanlige" bilde-urler.

Parameter: w og h

'w' og 'h' brukes til å sepsifisere hvilken høyde(h) og bredde(w) det returnerte bildet skal ha. Det vil da bli resamplet på serveren. Det resamplete bildet blir cachet slik at operasjonen ikke må gjentas ved senere kall til samme bilde-fil i en gitt størrelse.

http://data.sortere.no/bilde/2/asbest.png?w=16&h=16

Formål

Denne tjenesten leverer ut informasjon om Renovasjonsselskap registrert i Sortere-databasen.

Tjenester

Url: http://data.sortere.no/api/renovasjonsselskap

Dette søket returnerer alle renovasjonsselskapene med alle tilgjengelige kommuner.

{
    jsonrpc: "2.0",
    id: null,
    result: {
        antall: 1,
        data: [
            {
                id: 8,
                navn: "Finnmark Ressursselskap AS",
                kortnavn: "Finnmark Ressursselskap",
                gateadresse: null,
                postadresse: "Postboks 543",
                postnummer: "9615",
                poststed: null,
                kontaktinfoOverskrift: null,
                kontaktperson: "Vektoperatør",
                kontakttelefon: "48 09 66 00",
                kontaktepost: "postmottak@finnress.no",
                kommuner: [
                    {
                        id: 414,
                        nummer: "2004",
                        navn: "Hammerfest",
                        oppslagsnavn: "Hammerfest",
                        gateadresse: null,
                        postadresse: "Postboks 543",
                        postnummer: "9616",
                        poststed: null,
                        lat: "70.662320",
                        lng: "23.682750"
                    },
                    {
                        id: 419,
                        nummer: "2017",
                        navn: "Kvalsund",
                        oppslagsnavn: "Kvalsund",
                        gateadresse: null,
                        postadresse: "Postboks 543",
                        postnummer: "9616",
                        poststed: null,
                        lat: "70.504550",
                        lng: "23.977950"
                    }
                ]
            }
        ]
    }
}
                    

Parameter: ider

Verdier: En kommaseparert liste med renovasjonsselskaps-ider

Resultatsettet inneholder renovasjonsselskapene med de gitte id-ene

http://data.sortere.no/api/renovasjonsselskap?ider=3,4