Dokumentation af REST web service API
REST web servicen der leverer information til dette website er beskrevet i nedenstående tabel. Der er ikke xsd skemaer for den XML servicen returnerer.
Parameteren {pid} går igen i mange af URI'erne. {pid} er et ID der angiver én virksomhed, et bestemt år. Dvs. det er en sammensat af andre nøgler. En virksomhed er kun placeret på en geografisk position indenfor et år. Man kan derfor betragte {pid} som "stedet som nøgle".
Baseadresse: http://MiljoeoplysningerService.mst.dk/v1
| Resource | URI | Metode | Repræsentation | Status | Beskrivelse |
|---|---|---|---|---|---|
| Virksomhed | /virksomhed/{pid} | GET | XML | 200, 405, 500 | Returnerer data om en enkelt virksomhed: CvrNr, CvrPNr, Navn, Adresse, EmailHovedpostkasse, Webadresse, Moderselskab, Tilsynsmyndighed, Regnskabsaar og Geografiskekoordinater. |
| Virksomheder | /virksomheder?navn={navn}&kommunekode={kommunekode}&cvrnr={cvrnr}&medtaglistepunkt={medtaglistepunkt}&listepunktKategoriId={listepunktKategoriId}&listepunktId={listepunktId}&pnr={pnr}&vejnavn={vejnavn}&by={by}&postnr={postnr}®nskabsaar={regnskabsaar}&medtagstof={medtagstof}&stofid={stofid}&udledningtilluft={udledningtilluft}&udledningtilvandviakloak={udledningtilvandviakloak}&vandtilreceipient={vandtilreceipient}&medtagaffald={medtagaffald}&ikkefarligtaffald={ikkefarligtaffald}&farligtaffald={farligtaffald}&farligtaffaldeksporteret={farligtaffaldeksporteret}&nyttegoerelseeskporteret={nyttegoerelseeskporteret}&bortskaffteteskporteret={bortskaffteteskporteret}&nyttegoerelsefarligt={nyttegoerelsefarligt}&bortskafftetfarligt={bortskafftetfarligt}&nyttegoerelseikkefarligt={nyttegoerelseikkefarligt}&bortskafftetikkefarligt={bortskafftetikkefarligt} |
GET | XML | 200, 405, 500 | Søger efter virksomheder der opfylder søgekriterierne. Returnerer virksomheds ID og Geografiskekoordinater |
| Virksomheder, kun id'er | /virksomhedsId?navn={navn}&kommunekode={kommunekode}&cvrnr={cvrnr}&medtaglistepunkt={medtaglistepunkt}&listepunktKategoriId={listepunktKategoriId}&listepunktId={listepunktId}&pnr={pnr}&vejnavn={vejnavn}&by={by}&postnr={postnr}®nskabsaar={regnskabsaar}&medtagstof={medtagstof}&stofid={stofid}&udledningtilluft={udledningtilluft}&udledningtilvandviakloak={udledningtilvandviakloak}&vandtilreceipient={vandtilreceipient}&medtagaffald={medtagaffald}&ikkefarligtaffald={ikkefarligtaffald}&farligtaffald={farligtaffald}&farligtaffaldeksporteret={farligtaffaldeksporteret}&nyttegoerelseeskporteret={nyttegoerelseeskporteret}&bortskaffteteskporteret={bortskaffteteskporteret}&nyttegoerelsefarligt={nyttegoerelsefarligt}&bortskafftetfarligt={bortskafftetfarligt}&nyttegoerelseikkefarligt={nyttegoerelseikkefarligt}&bortskafftetikkefarligt={bortskafftetikkefarligt} |
GET | XML | 200, 405, 500 | Søger efter virksomheder der opfylder søgekriterierne. Returnerer en liste af virksomheds ID'er |
| Virksomhedens hovedaktivitet | /virksomhed/{pid}/hovedaktivitet |
GET | XML | 200, 405, 500 | Returnerer et listepunkt |
| Virksomhedens biaktiviteter | /virksomhed/{pid}/biaktiviteter |
GET | XML | 200, 405, 500 | Returnerer en liste af listepunkter |
| Listepunkt kategorier | /listepunktkategorier |
GET | XML | 200, 405, 500 | Returnerer en liste af listepunkts kategorier |
| Listepunkt | /listePunkt |
GET | XML | 200, 405, 500 | Returnerer en liste af listepunkter |
| Stof liste | /stof |
GET | XML | 200, 405, 500 | Returnerer en liste af stoffer, herunder {stofid} for hvert stof (angivet som Kode). |
| Stof udledning | /stof/udledning?regnskabsaar={regnskabsaar}&stofid={stofid}&udledningtilluft={udledningtilluft}&udledningtilvandviakloak={udledningtilvandviakloak}&vandtilreceipient={vandtilreceipient} |
GET | XML | 200, 405, 500 | Returnerer en stofudledtafvirksomhedoversigt struktur der viser mængden af udledningen af et stof samt hvilke virksomheder der udleder stoffet |
| Stof udvikling | /virksomhed/{pid}/stofudvikling/{stofid} |
GET | XML | 200, 405, 500 | Returnerer en stofudvikling struktur der viser udviklingen af et stof over tid for en virksomhed |
| Stof branche udvikling | /listePunkt/{id}/stofbrancheudvikling/{stofid} |
GET | XML | 200, 405, 500 | Returnerer en stofbrancheudvikling struktur der viser udviklingen af et stof over tid for en virksomheds samlede branche |
| Affald udvikling | /virksomhed/{pid}/affaldudvikling/affaldstype/{affaldstype}/behandlingsform/{behandlingsform} |
GET | XML | 200, 405, 500 | Returnerer en affaldudvikling struktur der viser udviklingen for affald over tid for en virksomhed. {affaldstype} kan antage 'farligtaffald' - 'ikkefarligtaffald' - 'farligtaffaldeksporteret'. {behandlingsform} kan antage 'nyttegoerelse' 'bortskaffelse' |
| Kommune | /kommuner |
GET | XML | 200, 405, 500 | Returnerer en liste af kommuner i Danmark |
| Regnskabsår | /indberettetaar |
GET | XML | 200, 405, 500 | Returnerer en liste af regnskabsår |
| Groentregnskab | /virksomhed/{pid}/{regnskabsaar}/groentregnskab |
GET | XML | 200, 405, 500 | Returnerer et grøntregnskab |
| Stamdata og miljødata | /virksomhed/{pid}/stamdataogmiljoedata |
GET | XML | 200, 405, 500 | Returnerer en StamdataogMiljoedata struktur |
| Stamdata og miljødata fil | /virksomhed/{pid}/stamdataogmiljoedata/{guid} |
GET | XML | 200, 405, 500 | Returnerer en stream af bytes der udgør en fil. {guid} findes ved kaldet til /virksomhed/{pid}/stamdataogmiljoedata |
| Miljøberetninger | /virksomhed/{pid}/miljoeberetning |
GET | XML | 200, 405, 500 | Returnerer en MiljoeBeretningSamling struktur |
| Miljøberetning | /virksomhed/{pid}/miljoeberetning/{guid} |
GET | XML | 200, 405, 500 | Returnerer en stream af bytes der udgør en fil.{guid} findes ved kaldet til /virksomhed/{pid}/miljoeberetning |