API för hushållsavfall

Allt data som är av kategorin öppna data inom e-tjänsten för avfallshantering finns tillgänglig via ett REST API för återanvändning. Datat kan hämtas både i JSON- och CSV-format från samma API. API:et finns med två varianter, ett där du får ut datat i JSON-format och ett där du får ut datat i CSV-format. Via JSON API:et kan du hämta och visa data direkt utefter valda parametrar, via CSV API:et genererar du en fil utefter dina parametrar som därefter kan laddas hem och bearbetas vidare.

JSON

Parameter Beskrivning
URL http://mitt.sundsvall.se/api/waste/v2/waste.json
HTTP metod GET
Innehåll application/json
 

Exempel på ett lyckat svar

					
{
  "status": "success",
  "data": [
    {
      "nyko": 11,
      "date": "2014-01-01",
      "building": "Verksamhetsavfall",
      "weight": 48.5,
      "type": "Brännbart"
    },
    {
      "nyko": 11,
      "date": "2014-01-01",
      "building": "Verksamhetsavfall",
      "weight": 45.0,
      "type": "Brännbart"
    }
  ]
}
					
 

Exempel på ett misslyckat svar där från datum ej gick att parsa.

					
{
  "status": "error",
  "message": "Kunde inte parsa från datum."
}
					

CSV

Parameter Beskrivning
URL http://mitt.sundsvall.se/api/waste/v1/waste.csv
HTTP metod GET
Innehåll application/csv

Parametrar i API

Följande parametrar finns tillgängliga. Alla parametrar är valfria.

Parameter Beskrivning
dateFrom Datum att hämta ifrån. Exempel: 2011-01-01
dateTo Datum att hämta till. Exempel: 2014-01-01
weightFrom Minska vikten >=. Exempel: 2.2
weightTo Tyngsta vikten <=. Exempel: 20.6
type Matavfall, Brannbart.
building Hyresfastighet, Verksamhetsavfall, Villor, Fritidshus,Special
nyko Nykonivå. Siffra 1-9 för nivå 1, 10-99 för nivå 2. exempel: nyko=1.
pretty true, För pretty print. Endast JSON.

Beskrivning av parametern building

Värde Beskrivning
Villor Hushållsavfall från villor
Hyresfastighet Hushållsavfall från flerfamiljshus (bostadsrätter, hyreshus)
Verksamhetsavfall Hushållsavfall insamlat från olika typer av verksamheter/föreningar/företag
Fritidshus Hushållsavfall från fritidshus
Special Special anläggningar, ej hushållssopor

Nyko nivå 1

Nyko Område
1 Sundsvalls täto
2 Alnö kdel
3 Kovland kdel
4 Njurunda täto
5 Njurunda glesb
6 Matfors kdel
7 Stöde kdel
8 IndalLiden kdel
9 Hushållsavfall från fritidshus
11 Restpost

Nyko nivå 2

Nyko Område
11 GranloBergså
12 BirstaLjustad
13 HagaBosvSkönsb
14 Skönsmon
15 NackstaSöderm
16 City
21 ViUsland
22 Ankarsvik
23 Alnötäts omland
31 Kovland
32 Kovlands omland
41 Bredsand
42 Svartvik
43 Kvissleby
44 Klockarberget
45 NjubomMjösund
46 SkottsNyland
47 Essvik
51 JuniBergaVNolby
52 ÄngomArmsjön
61 Matfors
62 Lucksta
63 Lucksta omland
64 Matfors omland
71 Stöde
72 S Stöde omland
73 N Stöde omland
74 Nedansjö
81 Indal
82 Liden
83 Indal omland
84 Holm omland
85 Liden omland
99 Restpost

Exempel

Några exempel

http://mitt.sundsvall.se/api/waste/v2/waste.json/?dateFrom=2012-01-03&dateTo=2012-01-04
&nyko=1&building=Verksamhetsavfall&building=Hyresfastighet
&type=Matavfall&weightFrom=3&weightTo=13&pretty=true
						
{
  "status": "success",
  "data": [
    {
      "nyko": 11,
      "date": "2012-01-03",
      "building": "Hyresfastighet",
      "weight": 12.0,
      "type": "Matavfall"
    },
    {
      "nyko": 11,
      "date": "2012-01-03",
      "building": "Hyresfastighet",
      "weight": 7.0,
      "type": "Matavfall"
    },
    {
      "nyko": 11,
      "date": "2012-01-03",
      "building": "Hyresfastighet",
      "weight": 9.0,
      "type": "Matavfall"
    },
    {
      "nyko": 11,
      "date": "2012-01-03",
      "building": "Hyresfastighet",
      "weight": 6.0,
      "type": "Matavfall"
    }
  ]
}						
						

Licens för användning

Informationen om avfallsmängder kan återanvändas fritt. Det gäller all information som ges tillgång via API, både gällande avfallsmängder och nyckelkodsområden. Informationen lyder under en Creative commons CC-0-licens http://creativecommons.org/about/cc0.

Uppdateringar och ändringar i API

Alla uppdateringar och ändringar av detta API kommer att publiceras på Sundsvalls kommuns utvecklingsblogg (utveckling.sundsvall.se). Uppdateringar på utvecklingsbloggen kan följas via RSS.

Kända brister i datamängd

De tömningar som har nyckelkodsområde "0" innebär att tömningen är gjord på en fastighet som inte går att matcha till ett nyckelkodsområde. Detta beror på hur ett avfallskärl är knytet till fastighet och fel rättas löpande i källdatat.

Den andra bristen gäller att vissa tömningar har 0 kg eller t om ett negativt värde. Detta beror på att mätutrustningen varit felande vid tömningstillfället.