Koodistopalvelun REST-rajapinnat Yleiset tiedot Swagger Kuvaus Yhteiset kyselyparametrit (Query Parameters) Yhteiset otsikkoparametrit (HTTP Headers) Yhteiset vastauskoodit (HTTP Response Codes) Autentikointi Entiteetit XML JSON Resurssit GET / GET /{koodistouri} GET /{koodistouri}/koodi GET /{koodistouri}/koodi/{koodiuri} GET /relaatio/sisaltyy-ylakoodit/{koodiuri} GET /relaatio/sisaltyy-ylakoodit/{koodiuri} GET /relaatio/rinnasteinen/{koodiuri} GET /searchkoodis POST /codes PUT /codes GET /codes POST /codes/download/{codesuri}/{codesversion}
GET /codes/download/{codesuri}/{codesversion}/{format} POST /codes/addrelation/{codesuri}/{codesversion}/{relationtype} POST /codes/removerelation/{codesuri}/{codesversion}/{relationtype} GET /codes/{codesuri} GET /codes/all GET /codes/{codesuri}/{codesversion} POST /codes/upload/{codesuri} POST /codesgroup PUT /codesgroup POST /codesgroup/delete/{id} GET /codesgroup/{id} PUT /codeelement POST /codeelement/delete/{codeelementuri}/{codeelementversion} POST /codeelement
POST /codeelement/addrelation/{codeelementuri}/{codeelementuritoadd}/{relationtype} POST /codeelement/removerelation/{codeelementuri}/{codeelementuritoadd}/{relationtype} GET /codelement/codes/{codesuri}/{codesversion} GET /codelement/{codeelementuri} GET /rest/codelement/{codeelementuri}/{codeelementversion} GET /codelement/{codesuri}/{codesversion}/{codeelementuri} GET /codelement/latest/{codeelementuri} Yleiset tiedot Swagger Ajantasainen REST-rajapinnan Swagger-kuvaus löytyy osoitteista: https://itest-virkailija.oph.ware.fi/koodisto-service/swagger/index.html https://virkailija.oph.ware.fi/koodisto-service/swagger/index.html Kuvaus REST-rajapinnan kautta voi hakea koodistoja ja koodeja joko XML- tai JSON-formaatissa. URI HTTP Method URL parameterit Käyttötarkoitus KoodistoService - /koodisto-service/rest/ tai /koodisto-service/rest/json / GET - Palauttaa kaikki koodistoryhmät ja niiden s koodistot. /{koodistouri} GET koodistoversio Palautaa koodiston, jonka URI on {koodist Versionumeron voi antaa URL-parametrin
/{koodistouri}.xsd GET - Koodistojen lataus XSD-muodossa. Esime lija.opintopolku.fi/koodisto-service/rest/kun /{koodistouri}/koodi GET koodistoversio Palauttaa koodiston, jonka URI on {koodis Koodiston versionumeron voi antaa URL-p /{koodistouri}/koodi/{koodiuri} GET koodistoversio, koodiversio Palauttaa koodistosto, jonka URI on {kood jonka URI on {koodiuri}. Koodiston ja kood voi antaa URL-parametreina. /relaatio/sisaltyy-ylakoodit/{koodiuri} GET koodiversio Palauttaa koodille, jonka URI on {koodiuri} sisältyvyyssuhteessa yläpuolelle määritelly versionumeron voi antaa URL-parametrina /relaatio/sisaltyy-alakoodit/{koodiuri} GET koodiversio Palauttaa koodille, jonka URI on {koodiuri} sisältyvyyssuhteessa alapuolelle määritell versionumeron voi antaa URL-parametrina /relaatio/rinnasteinen/{koodiuri} GET koodiversio Palauttaa koodille, jonka URI on {koodiuri} rinnastuvuussuhteessa määritellyt koodit. versionumeron voi antaa URL-parametrina /searchkoodis GET - Palauttaa hakuehtoja vastaavat koodit. Ha annetaan URL-parametreina. /codes POST - Lisää koodiston /codes PUT - Päivittää koodistoa /codes GET - Palauttaa kaikki koodistoryhmät /codes/download/{codesuri}/{codesversion} POST koodistouri ja koodistoversio Ladataan koodisto XML, CSV tai Excel tie (Vanhentunut, tullaan poistamaan) /codes/download/{codesuri}/{codesversion}/{format} GET encoding Ladataan koodisto XML, CSV tai Excel tie /codes/addrelation/{codesuri}/{codesuritoadd}/{relationtype} POST koodistouri, koodistoversio, linkitettävän koodiston Uri ja relaatiotyyppi /codes/removerelation/{codesuri}/{codesuritoremove}/{relationtype} POST koodistouri, koodistoversio, irrotettavan koodiston Uri ja relaatiotyyppi Lisätään relaatio koodistojen välille Poistetaan relaatio koodistojen väliltä /codes/{codesuri} GET koodiston Uri Palauttaa koodiston /codes/all GET - Palauttaa kaikki koodistoryhmät ja niiden s koodistot. /codes/{codesuri}/{codesversion} GET koodistouri ja koodistoversio Palauttaa tietyn koodistoversion /codes/upload/{codesuri} POST koodistouri Tuo koodiston tiedostosta /codesgroup POST - Luo uuden koodistoryhmän /codesgroup PUT - Päivittää koodistoryhmää /codesgroup/delete/{id} POST Koodistoryhmän id /codesgroup/{id} GET Koodistoryhmän id Poistaa koodistoryhmän Palauttaa koodistoryhmän /codeelement PUT - Päivittää koodin /codeelement/delete/{codeelementuri}/{codeelementversion} POST Koodin Uri ja koodin versio /codeelement/{codesuri} POST Koodiston Uri mihin koodi lisätään /codeelement/addrelation/{codeelementuri}/{codeelementuritoadd}/{relationtype} POST Koodin Uri, linkitettävän koodin uri ja relaatiotyyppi Poistaa koodin Lisää uuden koodin Lisää relaation koodien välille
/codeelement/removerelation/{codeelementuri}/{codeelementuritoadd}/{relationtype} POST Koodin Uri, irrotettavan koodin uri ja relaatiotyyppi /codeelement/codes/{codesuri}/{codesversion} GET Koodin uri, koodin versio Poistaa koodien välisen relaation Palauttaa koodiston sisältämät koodit /codeelement/{codeelementuri} GET Koodin uri Palauttaa koodiversiot tietystä koodista /codeelement/{codeelementuri}/{codeelementversion} GET Koodin uri ja koodin versio /codeelement/{codesuri}/{codesversion}/{codeelementuri} GET Koodiston uri, koodiston versio ja koodin uri Palauttaa tietyn koodiversion Palauttaa koodin tietystä koodistoversiosta /codeelement/latest/{codeelementuri} GET Koodin uri Palauttaa uusimman koodiversion WADL URL: /koodisto-service/rest/application.wadl WADL Expand <?xml version="1.0" encoding="utf-8" standalone="yes"?> source <application xmlns="http://wadl.dev.java.net/2009/02"> <doc xmlns:jersey="http://jersey.java.net/" jersey:generatedby="jersey: 1.9.1 09/14/2011 02:05 PM"/> <grammars> <include href="application.wadl/xsd0.xsd"> <doc title="generated" xml:lang="en"/> </include> </grammars> <resources base="https://itest-virkailija.oph.ware.fi/koodisto-service/rest/"> <resource path="/api-docs"> <method id="resourcelisting" name="get"> <response> <representation mediatype="application/json"/> </response> </method> <resource path="/{route:.+}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="route" style="template" type="xs:string"/> <method id="apideclaration" name="get"> <response> <representation mediatype="application/json"/> </response> </method> </resource> </resource> <resource path="/codes"> <method id="insert" name="post"> <response> <representation mediatype="application/json"/> </response> </method> <method id="update" name="put"> <response> <representation mediatype="application/json"/> </response> </method> <method id="listallcodesgroups" name="get"> <response>
<representation mediatype="application/json"/> </response> </method> <resource path="/delete/{codesuri}/{codesversion}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesuri" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesversion" style="template" type="xs:int"/> <method id="delete" name="post"> <response> <representation mediatype="application/json"/> </response> </method> </resource> <resource path="/download/{codesuri}/{codesversion}/{fileformat}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesuri" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesversion" style="template" type="xs:int"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="fileformat" style="template" type="xs:string"/> <method id="download" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="encoding" style="query" type="xs:string" default="utf-8"/> </request> <response> <representation mediatype="application/octet-stream"/> </response> </method> </resource> <resource path="/download/{codesuri}/{codesversion}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesuri" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesversion" style="template" type="xs:int"/> <method id="download" name="post"> <request> <representation mediatype="application/json"/> </request> <response> <representation mediatype="application/json"/> </response> </method> </resource> <resource path="/addrelation/{codesuri}/{codesuritoadd}/{relationtype}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesuritoadd" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="relationtype" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesuri" style="template" type="xs:string"/> <method id="addrelation" name="post"/> </resource> <resource path="/removerelation/{codesuri}/{codesuritoremove}/{relationtype}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="relationtype" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesuri"
style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesuritoremove" style="template" type="xs:string"/> <method id="removerelation" name="post"/> </resource> <resource path="/all"> <method id="listallcodesinallcodegroups" name="get"> <response> <representation mediatype="application/json"/> </response> </method> </resource> <resource path="/{codesuri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesuri" style="template" type="xs:string"/> <method id="getcodesbycodesuri" name="get"> <response> <representation mediatype="application/json"/> </response> </method> </resource> <resource path="/{codesuri}/{codesversion}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesuri" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesversion" style="template" type="xs:int"/> <method id="getcodesbycodesuriandversion" name="get"> <response> <representation mediatype="application/json"/> </response> </method> </resource> <resource path="/upload/{codesuri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesuri" style="template" type="xs:string"/> <method id="uploadfile" name="post"> <request> <representation mediatype="multipart/form-data"/> </request> <response> <representation mediatype="*/*"/> </response> </method> </resource> </resource> <resource path="session"> <resource path="/maxinactiveinterval"> <method id="maxinactiveinterval" name="get"> <response> <representation mediatype="text/plain"/> </response> </method> </resource> </resource> <resource path="/"> <method id="listallkoodistoryhmas" name="get"> <response> <representation mediatype="application/xml"/> </response>
</method> <resource path="/{koodistouri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistouri" style="template" type="xs:string"/> <method id="getkoodistobyuri" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistoversio" style="query" type="xs:int"/> </request> <response> <representation mediatype="application/xml"/> </response> </method> </resource> <resource path="/{koodistouri}/koodi"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistouri" style="template" type="xs:string"/> <method id="getkoodisbykoodisto" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistoversio" style="query" type="xs:int"/> </request> <response> <representation mediatype="application/xml"/> </response> </method> </resource> <resource path="/{koodistouri}/koodi/arvo/{koodiarvo}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiarvo" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistouri" style="template" type="xs:string"/> <method id="getkoodisbyarvo" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistoversio" style="query" type="xs:int"/> </request> <response> <representation mediatype="application/xml"/> </response> </method> </resource> <resource path="/{koodistouri}/koodi/{koodiuri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiuri" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistouri" style="template" type="xs:string"/> <method id="getkoodibyuri" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistoversio" style="query" type="xs:int"/> </request> <response> <representation mediatype="application/xml"/> </response> </method> </resource> <resource path="/relaatio/sisaltyy-alakoodit/{koodiuri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiuri"
style="template" type="xs:string"/> <method id="getalakoodis" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiversio" style="query" type="xs:int"/> </request> <response> <representation mediatype="application/xml"/> </response> </method> </resource> <resource path="/relaatio/sisaltyy-ylakoodit/{koodiuri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiuri" style="template" type="xs:string"/> <method id="getylakoodis" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiversio" style="query" type="xs:int"/> </request> <response> <representation mediatype="application/xml"/> </response> </method> </resource> <resource path="/relaatio/rinnasteinen/{koodiuri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiuri" style="template" type="xs:string"/> <method id="getrinnasteinenkoodis" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiversio" style="query" type="xs:int"/> </request> <response> <representation mediatype="application/xml"/> </response> </method> </resource> <resource path="/{koodistouri}.xsd"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistouri" style="template" type="xs:string"/> <method id="getkoodistoxsdskeema" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistoversio" style="query" type="xs:int"/> </request> <response> <representation mediatype="application/xml"/> </response> </method> </resource> </resource> <resource path="/codeelement"> <method id="update" name="put"> <response> <representation mediatype="application/json"/> </response> </method> <resource path="/delete/{codeelementuri}/{codeelementversion}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema"
name="codeelementuri" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codeelementversion" style="template" type="xs:int"/> <method id="delete" name="post"> <response> <representation mediatype="application/json"/> </response> </method> </resource> <resource path="/{codesuri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesuri" style="template" type="xs:string"/> <method id="insert" name="post"> <response> <representation mediatype="application/json"/> </response> </method> </resource> <resource path="/{codeelementuri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codeelementuri" style="template" type="xs:string"/> <method id="getallcodeelementversionsbycodeelementuri" name="get"> <response> <representation mediatype="application/json"/> </response> </method> </resource> <resource path="/{codeelementuri}/{codeelementversion}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codeelementuri" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codeelementversion" style="template" type="xs:int"/> <method id="getcodeelementbyuriandversion" name="get"> <response> <representation mediatype="application/json"/> </response> </method> </resource> <resource path="/{codesuri}/{codesversion}/{codeelementuri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codeelementuri" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesuri" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesversion" style="template" type="xs:int"/> <method id="getcodeelementbycodeelementuri" name="get"> <response> <representation mediatype="application/json"/> </response> </method> </resource> <resource path="/codes/{codesuri}/{codesversion}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesuri" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codesversion" style="template" type="xs:int"/> <method id="getallcodeelementsbycodesuriandversion" name="get"> <response> <representation mediatype="application/json"/>
</response> </method> </resource> <resource path="/latest/{codeelementuri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codeelementuri" style="template" type="xs:string"/> <method id="getlatestcodeelementversionsbycodeelementuri" name="get"> <response> <representation mediatype="application/json"/> </response> </method> </resource> <resource path="/addrelation/{codeelementuri}/{codeelementuritoadd}/{relationtype}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="relationtype" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codeelementuri" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codeelementuritoadd" style="template" type="xs:string"/> <method id="addrelation" name="post"/> </resource> <resource path="/removerelation/{codeelementuri}/{codeelementuritoremove}/{relationtype}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="relationtype" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codeelementuri" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="codeelementuritoremove" style="template" type="xs:string"/> <method id="removerelation" name="post"/> </resource> </resource> <resource path="/codesgroup"> <method id="insert" name="post"> <response> <representation mediatype="application/json"/> </response> </method> <method id="update" name="put"> <response> <representation mediatype="application/json"/> </response> </method> <resource path="/delete/{id}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="id" style="template" type="xs:long"/> <method id="delete" name="post"> <response> <representation mediatype="application/json"/> </response> </method> </resource> <resource path="/{id}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="id" style="template" type="xs:long"/> <method id="getcodesbycodesuri" name="get"> <response> <representation mediatype="application/json"/>
</response> </method> </resource> </resource> <resource path="/json"> <method id="listallkoodistoryhmas" name="get"> <response> <representation mediatype="application/json;charset=utf-8"/> </response> </method> <resource path="/{koodistouri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistouri" style="template" type="xs:string"/> <method id="getkoodistobyuri" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistoversio" style="query" type="xs:int"/> </request> <response> <representation mediatype="application/json;charset=utf-8"/> </response> </method> </resource> <resource path="/{koodistouri}/koodi"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistouri" style="template" type="xs:string"/> <method id="getkoodisbykoodisto" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistoversio" style="query" type="xs:int"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="onlyvalidkoodis" style="query" type="xs:boolean" default="false"/> </request> <response> <representation mediatype="application/json;charset=utf-8"/> </response> </method> </resource> <resource path="/{koodistouri}/koodi/arvo/{koodiarvo}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiarvo" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistouri" style="template" type="xs:string"/> <method id="getkoodisbyarvo" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistoversio" style="query" type="xs:int"/> </request> <response> <representation mediatype="application/json;charset=utf-8"/> </response> </method> </resource> <resource path="/{koodistouri}/koodi/{koodiuri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiuri" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistouri" style="template" type="xs:string"/> <method id="getkoodibyuri" name="get">
<request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistoversio" style="query" type="xs:int"/> </request> <response> <representation mediatype="application/json;charset=utf-8"/> </response> </method> </resource> <resource path="/relaatio/sisaltyy-alakoodit/{koodiuri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiuri" style="template" type="xs:string"/> <method id="getalakoodis" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiversio" style="query" type="xs:int"/> </request> <response> <representation mediatype="application/json;charset=utf-8"/> </response> </method> </resource> <resource path="/relaatio/sisaltyy-ylakoodit/{koodiuri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiuri" style="template" type="xs:string"/> <method id="getylakoodis" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiversio" style="query" type="xs:int"/> </request> <response> <representation mediatype="application/json;charset=utf-8"/> </response> </method> </resource> <resource path="/relaatio/rinnasteinen/{koodiuri}"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiuri" style="template" type="xs:string"/> <method id="getrinnasteinenkoodis" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiversio" style="query" type="xs:int"/> </request> <response> <representation mediatype="application/json;charset=utf-8"/> </response> </method> </resource> <resource path="/searchkoodis"> <method id="searchkoodis" name="get"> <request> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiuris" style="query" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiarvo" style="query" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="kooditilas" style="query" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="validat" style="query" type="xs:string"/>
<param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiversio" style="query" type="xs:int"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiversioselection" style="query" type="xs:string"/> </request> <response> <representation mediatype="application/json;charset=utf-8"/> </response> </method> </resource> <resource path="/{koodistouri}.properties"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistouri" style="template" type="xs:string"/> <method id="getkoodistoaspropertiesdefaultlang" name="get"> <response> <representation mediatype="text/plain"/> </response> </method> </resource> <resource path="/{koodistouri}_{lang}.properties"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="lang" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistouri" style="template" type="xs:string"/> <method id="getkoodistoasproperties" name="get"> <response> <representation mediatype="text/plain"/> </response> </method> </resource> <resource path="/{koodistouri}/koodi/{koodiuri}/kieli/{lang}/metadata"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodiuri" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="lang" style="template" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="koodistouri" style="template" type="xs:string"/> <method id="updatekoodilangmetadata" name="post"> <request> <representation mediatype="application/x-www-form-urlencoded"> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="nimi" style="query" type="xs:string"/> <param xmlns:xs="http://www.w3.org/2001/xmlschema" name="kuvaus" style="query" type="xs:string"/> </representation> </request> <response> <representation mediatype="application/json;charset=utf-8"/> </response> </method> </resource>
</resource> </resources> </application> Yhteiset kyselyparametrit (Query Parameters) Nimi Kuvaus Esimerkki Ei yhteisiä kyselyparametreja Yhteiset otsikkoparametrit (HTTP Headers) Nimi Kuvaus Esimerkki Ei yhteisiä otsikkoparametreja Yhteiset vastauskoodit (HTTP Response Codes) Tilakoodi Kuvaus Ei yhteisiä vastauskoodeja. Autentikointi Kaikki koodistopalvelun GET rajapintakutsut ovat avoimia. Muut vaativat autentikoitumisen. Entiteetit XML Schema Expand <?xml version='1.0' encoding='utf-8'?> source <xs:schema version="1.0" elementformdefault="unqualified" targetnamespace="http://service.koodisto.sade.vm.fi/types/common" xmlns:tns="http://service.koodisto.sade.vm.fi/types/common" xmlns:xs="http://www.w3.org/2001/xmlschema"> <xs:complextype name="kooditype"> <xs:sequence> <xs:element name="koodiuri" type="xs:string" maxoccurs="1" minoccurs="1" /> <xs:element name="resourceuri" type="xs:string" maxoccurs="1" minoccurs="1" /> <xs:element minoccurs="0" maxoccurs="1" name="koodisto" type="tns:koodistoitemtype" /> <xs:element name="versio" type="xs:int" /> <xs:element name="koodiarvo" type="xs:string" /> <xs:element minoccurs="0" name="paivityspvm" type="xs:datetime" /> <xs:element minoccurs="0" name="voimassaalkupvm" type="xs:datetime" /> <xs:element minoccurs="0" name="voimassaloppupvm"
type="xs:datetime" /> <xs:element minoccurs="0" name="tila" type="tns:tilatype" /> <xs:element maxoccurs="unbounded" minoccurs="0" name="metadata" nillable="true" type="tns:koodimetadatatype" /> <xs:element name="lockingversion" type="xs:long" /> </xs:sequence> </xs:complextype> <xs:element name="koodi" type="tns:kooditype" /> <xs:complextype name="koodicollectiontype"> <xs:sequence> <xs:element name="koodi" type="tns:kooditype" maxoccurs="unbounded" minoccurs="0" /> </xs:sequence> </xs:complextype> <xs:element name="koodicollection" type="tns:koodicollectiontype" /> <xs:complextype name="koodiuriandversiotype"> <xs:sequence> <xs:element name="koodiuri" type="xs:string" maxoccurs="1" minoccurs="1" /> <xs:element name="versio" type="xs:int" maxoccurs="1" minoccurs="1" /> </xs:sequence> </xs:complextype> <xs:complextype name="koodimetadatatype"> <xs:sequence> <xs:element minoccurs="1" maxoccurs="1" name="kieli" type="tns:kielitype" /> <xs:element minoccurs="1" maxoccurs="1" name="nimi" type="xs:string" /> <xs:element minoccurs="1" maxoccurs="1" name="kuvaus" type="xs:string" /> <xs:element minoccurs="1" maxoccurs="1" name="lyhytnimi" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="kayttoohje" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="kasite" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="sisaltaamerkityksen" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="eisisallamerkitysta" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="huomioitavakoodi" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="sisaltaakoodiston" type="xs:string" /> </xs:sequence> </xs:complextype> <xs:simpletype name="suhteentyyppitype"> <xs:restriction base="xs:string"> <xs:enumeration value="sisaltyy" /> <xs:enumeration value="rinnasteinen" /> </xs:restriction> </xs:simpletype> <xs:simpletype name="kielitype"> <xs:restriction base="xs:string"> <xs:enumeration value="fi" /> <xs:enumeration value="sv" /> <xs:enumeration value="en" /> </xs:restriction>
</xs:simpletype> <xs:complextype name="koodistotype"> <xs:sequence> <xs:element name="koodistouri" type="xs:string" maxoccurs="1" minoccurs="1" /> <xs:element name="resourceuri" type="xs:string" maxoccurs="1" minoccurs="1" /> <xs:element name="versio" type="xs:int" /> <xs:element minoccurs="0" name="paivityspvm" type="xs:datetime" /> <xs:element minoccurs="0" name="voimassaalkupvm" type="xs:datetime" /> <xs:element minoccurs="0" name="voimassaloppupvm" type="xs:datetime" /> <xs:element minoccurs="0" name="tila" type="tns:tilatype" /> <xs:element minoccurs="0" name="omistaja" type="xs:string" /> <xs:element minoccurs="0" name="organisaatiooid" type="xs:string" /> <xs:element minoccurs="0" name="lukittu" type="xs:boolean" /> <xs:element maxoccurs="unbounded" minoccurs="0" name="metadatalist" nillable="true" type="tns:koodistometadatatype" /> <xs:element name="lockingversion" type="xs:long" /> </xs:sequence> </xs:complextype> <xs:complextype name="koodistometadatatype"> <xs:sequence> <xs:element minoccurs="1" maxoccurs="1" name="kieli" type="tns:kielitype" /> <xs:element minoccurs="1" maxoccurs="1" name="nimi" type="xs:string" /> <xs:element minoccurs="1" maxoccurs="1" name="kuvaus" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="kayttoohje" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="kasite" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="kohdealue" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="kohdealueenosaalue" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="sitovuustaso" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="toimintaymparisto" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="tarkentaakoodistoa" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="huomioitavakoodisto" type="xs:string" /> <xs:element minoccurs="0" maxoccurs="1" name="koodistonlahde" type="xs:string" /> </xs:sequence> </xs:complextype> <xs:element name="koodisto" type="tns:koodistotype" /> <xs:complextype name="koodistouriandversiotype"> <xs:sequence> <xs:element name="koodistouri" type="xs:string" maxoccurs="1" minoccurs="1" /> <xs:element name="versio" type="xs:int" maxoccurs="1" minoccurs="1" />
</xs:sequence> </xs:complextype> <xs:complextype name="koodistoryhmametadatatype"> <xs:sequence> <xs:element minoccurs="1" maxoccurs="1" name="nimi" type="xs:string" /> <xs:element minoccurs="1" maxoccurs="1" name="kieli" type="tns:kielitype" /> </xs:sequence> </xs:complextype> <xs:simpletype name="tilatype"> <xs:restriction base="xs:string"> <xs:enumeration value="passiivinen" /> <xs:enumeration value="luonnos" /> <xs:enumeration value="hyvaksytty" /> </xs:restriction> </xs:simpletype> <xs:complextype name="koodistoryhmacollectiontype"> <xs:sequence> <xs:element name="koodistoryhma" type="tns:koodistoryhmalisttype" minoccurs="0" maxoccurs="unbounded" /> </xs:sequence> </xs:complextype> <xs:element name="koodistoryhmacollection" type="tns:koodistoryhmacollectiontype" /> <xs:complextype name="koodistoryhmalisttype"> <xs:sequence> <xs:element minoccurs="0" name="koodistoryhmauri" maxoccurs="1" type="xs:string" /> <xs:element maxoccurs="unbounded" minoccurs="0" name="koodistoryhmametadatas" nillable="true" type="tns:koodistoryhmametadatatype" /> <xs:element maxoccurs="unbounded" minoccurs="0" name="koodistos" nillable="true" type="tns:koodistolisttype" /> </xs:sequence> </xs:complextype> <xs:complextype name="koodistolisttype"> <xs:sequence> <xs:element name="koodistouri" minoccurs="1" maxoccurs="1" type="xs:string" /> <xs:element name="omistaja" minoccurs="0" maxoccurs="1" type="xs:string" /> <xs:element name="organisaatiooid" minoccurs="1" maxoccurs="1" type="xs:string" /> <xs:element name="lukittu" minoccurs="0" maxoccurs="1" type="xs:boolean" /> <xs:element name="latestkoodistoversio" minoccurs="0" maxoccurs="1" type="tns:koodistoversiolisttype" /> <xs:element name="koodistoversios" minoccurs="0" maxoccurs="unbounded" type="tns:koodistoversiolisttype" /> </xs:sequence> </xs:complextype> <xs:complextype name="koodistoversiolisttype"> <xs:sequence> <xs:element name="koodistouri" minoccurs="1" maxoccurs="1" type="xs:string" /> <xs:element name="versio" type="xs:int" minoccurs="1" maxoccurs="1" /> <xs:element minoccurs="0" name="paivityspvm"
type="xs:datetime" /> <xs:element minoccurs="0" name="voimassaalkupvm" type="xs:datetime" /> <xs:element minoccurs="0" name="voimassaloppupvm" type="xs:datetime" /> <xs:element minoccurs="0" name="tila" type="tns:tilatype" /> <xs:element maxoccurs="unbounded" minoccurs="0" name="metadatalist" nillable="true" type="tns:koodistometadatatype" /> <xs:element name="koodisto" minoccurs="1" maxoccurs="1" type="tns:koodistolisttype" /> </xs:sequence> </xs:complextype> <xs:complextype name="koodistoitemtype"> <xs:sequence> <xs:element name="koodistouri" minoccurs="1" maxoccurs="1" type="xs:string" /> <xs:element name="organisaatiooid" minoccurs="1" maxoccurs="1" type="xs:string" /> <xs:element name="koodistoversio" minoccurs="1" maxoccurs="unbounded" type="xs:int" /> </xs:sequence> </xs:complextype> <xs:complextype name="genericfaultinfotype"> <xs:sequence> <xs:element name="errorcode" type="xs:string"></xs:element> <xs:element name="explanation" type="xs:string" maxoccurs="1" minoccurs="0"></xs:element> <xs:element name="fielderrors" minoccurs="0" maxoccurs="unbounded" type="tns:fielderrortype" /> </xs:sequence> </xs:complextype> <xs:complextype name="fielderrortype"> <xs:sequence> <xs:element name="field" type="xs:string" minoccurs="1" maxoccurs="1" /> <xs:element name="errormessage" type="xs:string" minoccurs="1" maxoccurs="1" /> </xs:sequence> </xs:complextype> <xs:simpletype name="exportimportformattype"> <xs:restriction base="xs:string"> <xs:enumeration value="jhs_xml" /> <xs:enumeration value="csv" /> <xs:enumeration value="xls" /> </xs:restriction>
</xs:simpletype> </xs:schema> JSON Resurssit GET / Palauttaa kaikki koodistoryhmät ja niiden sisältämät koodistot. Esitysmuodot application/json application/xml Nimi Arvojoukko/tyyppi Ei käytössä olevia otsikkoparametreja. Nimi Kuvaus Arvojoukko/tyyppi Esimerkki Oletusarvo Ei käytössä olevia kyselyparametreja. Koodi Kuvaus ja mahdollinen entiteetti Ei käytössä olevia vastauskoodeja. GET /koodisto-service/rest/json
Json-esitysmuoto [ { "koodistoryhmauri" : "http://kaikkikoodistot", "nimi" : "Kaikki koodistot", "kieli" : "FI", "koodistos" : [ { "koodistouri" : "eutukialue", "resourceuri" : "http://koodistopalvelu.opintopolku.fi/eutukialue", "omistaja" : "Opetushallitus", "organisaatiooid" : "1.2.246.562.10.00000000001", "lukittu" : null, "latestkoodistoversio" : { "paivityspvm" : 1377687284764, "voimassaalkupvm" : "2013-01-01", "voimassaloppupvm" : null, "tila" : "LUONNOS", "kieli" : "FI", "nimi" : "eutukialue", "kuvaus" : "eutukialue", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "SV", "nimi" : "eutukialue", "kuvaus" : "eutukialue", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "EN", "nimi" : "eutukialue", "kuvaus" : "eutukialue", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null Expand source
"kieli" : "FI", "nimi" : "eutukialue", "kuvaus" : "eutukialue", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "SV", "nimi" : "eutukialue", "kuvaus" : "eutukialue", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "EN", "nimi" : "eutukialue", "kuvaus" : "eutukialue", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null }, "koodistoversios" : [ { "paivityspvm" : 1377687284764, "voimassaalkupvm" : "2013-01-01", "voimassaloppupvm" : null, "tila" : "LUONNOS", "kieli" : "FI", "nimi" : "eutukialue", "kuvaus" : "eutukialue", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null,
"koodistonlahde" : null "kieli" : "SV", "nimi" : "eutukialue", "kuvaus" : "eutukialue", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "EN", "nimi" : "eutukialue", "kuvaus" : "eutukialue", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "FI", "nimi" : "eutukialue", "kuvaus" : "eutukialue", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "SV", "nimi" : "eutukialue", "kuvaus" : "eutukialue", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "EN", "nimi" : "eutukialue", "kuvaus" : "eutukialue",
"kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "koodistouri" : "paaaineet", "resourceuri" : "http://koodistopalvelu.opintopolku.fi/paaaineet", "omistaja" : "Opetushallitus", "organisaatiooid" : "1.2.246.562.10.00000000001", "lukittu" : null, "latestkoodistoversio" : { "paivityspvm" : 1377687996210, "voimassaalkupvm" : "2013-01-01", "voimassaloppupvm" : null, "tila" : "LUONNOS", "kieli" : "FI", "nimi" : "paaaineet", "kuvaus" : "paaaineet", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "SV", "nimi" : "paaaineet", "kuvaus" : "paaaineet", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "EN", "nimi" : "paaaineet", "kuvaus" : "paaaineet", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null,
"koodistonlahde" : null "kieli" : "FI", "nimi" : "paaaineet", "kuvaus" : "paaaineet", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "SV", "nimi" : "paaaineet", "kuvaus" : "paaaineet", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "EN", "nimi" : "paaaineet", "kuvaus" : "paaaineet", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null }, "koodistoversios" : [ { "paivityspvm" : 1377687996210, "voimassaalkupvm" : "2013-01-01", "voimassaloppupvm" : null, "tila" : "LUONNOS", "kieli" : "FI", "nimi" : "paaaineet", "kuvaus" : "paaaineet", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null,
"huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "SV", "nimi" : "paaaineet", "kuvaus" : "paaaineet", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "EN", "nimi" : "paaaineet", "kuvaus" : "paaaineet", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "FI", "nimi" : "paaaineet", "kuvaus" : "paaaineet", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "SV", "nimi" : "paaaineet", "kuvaus" : "paaaineet", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "EN", "nimi" : "paaaineet", "kuvaus" : "paaaineet",
"kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null
GET /koodisto-service/rest XML-esitysmuoto Expand <?xml version="1.0" encoding="utf-8" standalone="yes"?> source <ns2:koodistoryhmacollection xmlns:ns2="http://service.koodisto.sade.vm.fi/types/common"> <koodistoryhma> <koodistoryhmauri>http://kaikkikoodistot</koodistoryhmauri> <koodistoryhmametadatas> <nimi>kaikki koodistot</nimi> <kieli>fi</kieli> </koodistoryhmametadatas> <koodistos> <koodistouri>eutukialue</koodistouri> <omistaja>opetushallitus</omistaja> <organisaatiooid>1.2.246.562.10.00000000001</organisaatiooid> <latestkoodistoversio> <koodistouri>eutukialue</koodistouri> <versio>1</versio> <paivityspvm>2013-08-28t13:54:44.764+03:00</paivityspvm> <voimassaalkupvm>2013-01-01t00:00:00.000+02:00</voimassaalkupvm> <tila>luonnos</tila> <metadatalist> <kieli>fi</kieli> <nimi>eutukialue</nimi> <kuvaus>eutukialue</kuvaus> </metadatalist> <metadatalist> <kieli>sv</kieli> <nimi>eutukialue</nimi> <kuvaus>eutukialue</kuvaus> </metadatalist> <metadatalist> <kieli>en</kieli> <nimi>eutukialue</nimi> <kuvaus>eutukialue</kuvaus> </metadatalist> <metadatalist> <kieli>fi</kieli> <nimi>eutukialue</nimi> <kuvaus>eutukialue</kuvaus> </metadatalist> <metadatalist> <kieli>sv</kieli> <nimi>eutukialue</nimi> <kuvaus>eutukialue</kuvaus> </metadatalist> <metadatalist> <kieli>en</kieli> <nimi>eutukialue</nimi>
<kuvaus>eutukialue</kuvaus> </metadatalist> </latestkoodistoversio> <koodistoversios> <koodistouri>eutukialue</koodistouri> <versio>1</versio> <paivityspvm>2013-08-28t13:54:44.764+03:00</paivityspvm> <voimassaalkupvm>2013-01-01t00:00:00.000+02:00</voimassaalkupvm> <tila>luonnos</tila> <metadatalist> <kieli>fi</kieli> <nimi>eutukialue</nimi> <kuvaus>eutukialue</kuvaus> </metadatalist> <metadatalist> <kieli>sv</kieli> <nimi>eutukialue</nimi> <kuvaus>eutukialue</kuvaus> </metadatalist> <metadatalist> <kieli>en</kieli> <nimi>eutukialue</nimi> <kuvaus>eutukialue</kuvaus> </metadatalist> <metadatalist> <kieli>fi</kieli> <nimi>eutukialue</nimi> <kuvaus>eutukialue</kuvaus> </metadatalist> <metadatalist> <kieli>sv</kieli> <nimi>eutukialue</nimi> <kuvaus>eutukialue</kuvaus> </metadatalist> <metadatalist> <kieli>en</kieli> <nimi>eutukialue</nimi> <kuvaus>eutukialue</kuvaus> </metadatalist> </koodistoversios>
</koodistos> </koodistoryhma> </ns2:koodistoryhmacollection> GET /{koodistouri} Palautaa koodiston, jonka URI on {koodistouri}. Versionumeron voi antaa URL-parametrina. Esitysmuodot application/json application/xml Nimi Arvojoukko/tyyppi Ei käytössä olevia otsikkoparametreja. Nimi Kuvaus Arvojoukko/tyyppi Esimerkki Oletusarvo koodistoversio Palautettavan koodiston version. Ilman tätä parameteria palautetaan viimeisin versio. Integer 1 - Koodi Kuvaus ja mahdollinen entiteetti Ei käytössä olevia vastauskoodeja. GET /koodisto-service/rest/json/eutukialue
Json-esitysmuoto { "koodistouri" : "eutukialue", "resourceuri" : "http://koodistopalvelu.opintopolku.fi/eutukialue", "omistaja" : "Opetushallitus", "organisaatiooid" : "1.2.246.562.10.00000000001", "lukittu" : null, "paivityspvm" : 1377687284764, "voimassaalkupvm" : "2013-01-01", "voimassaloppupvm" : null, "tila" : "LUONNOS", "kieli" : "EN", "nimi" : "eutukialue", "kuvaus" : "eutukialue", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "SV", "nimi" : "eutukialue", "kuvaus" : "eutukialue", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null "kieli" : "FI", "nimi" : "eutukialue", "kuvaus" : "eutukialue", "kohdealue" : null, "sitovuustaso" : null, "kohdealueenosaalue" : null, "toimintaymparisto" : null, "tarkentaakoodistoa" : null, "huomioitavakoodisto" : null, "koodistonlahde" : null } Expand source
GET /koodisto-service/rest/eutukialue XML-esitysmuoto Expand <?xml version="1.0" encoding="utf-8" standalone="yes"?> source <ns2:koodisto xmlns:ns2="http://service.koodisto.sade.vm.fi/types/common"> <koodistouri>eutukialue</koodistouri> <resourceuri>http://koodistopalvelu.opintopolku.fi/eutukialue</resourceuri> <versio>1</versio> <paivityspvm>2013-08-28t13:54:44.764+03:00</paivityspvm> <voimassaalkupvm>2013-01-01t00:00:00.000+02:00</voimassaalkupvm> <tila>luonnos</tila> <omistaja>opetushallitus</omistaja> <organisaatiooid>1.2.246.562.10.00000000001</organisaatiooid> <metadatalist> <kieli>en</kieli> <nimi>eutukialue</nimi> <kuvaus>eutukialue</kuvaus> </metadatalist> <metadatalist> <kieli>sv</kieli> <nimi>eutukialue</nimi> <kuvaus>eutukialue</kuvaus> </metadatalist> <metadatalist> <kieli>fi</kieli> <nimi>eutukialue</nimi> <kuvaus>eutukialue</kuvaus> </metadatalist> <lockingversion>0</lockingversion> </ns2:koodisto> GET /{koodistouri}/koodi Palauttaa koodiston, jonka URI on {koodistouri} koodit. Koodiston versionumeron voi antaa URL-parametrina. Esitysmuodot application/json application/xml Nimi Arvojoukko/tyyppi Ei käytössä olevia otsikkoparametreja.
Nimi Kuvaus Arvojoukko/tyyppi Esimerkki Oletusarvo koodistoversio Palautettavan koodiston version. Ilman tätä parameteria palautetaan viimeisin versio. Integer 1 - Koodi Kuvaus ja mahdollinen entiteetti Ei käytössä olevia vastauskoodeja. GET /koodisto-service/rest/json/eutukialue/koodi Json-esitysmuoto [ { "koodiuri" : "eutukialue_6", "resourceuri" : "http://koodistopalvelu.opintopolku.fi/eutukialue/koodi/eutukialue_6", "koodisto" : { "koodistouri" : "eutukialue", "organisaatiooid" : "1.2.246.562.10.00000000001", "koodistoversios" : [ 1 ] }, "koodiarvo" : "6", "paivityspvm" : 1377687284902, "voimassaalkupvm" : "1995-01-01", "voimassaloppupvm" : null, "tila" : "LUONNOS", "nimi" : "6-glesbygdsområden", "kuvaus" : "6-glesbygdsområden", "lyhytnimi" : "6-glesbygdsområden", "kieli" : "SV" "nimi" : "6-harvaan asutut alueet", "kuvaus" : "6-harvaan asutut alueet", "lyhytnimi" : "6-harvaan asutut alueet", Expand source
"kieli" : "FI" "koodiuri" : "eutukialue_5", "resourceuri" : "http://koodistopalvelu.opintopolku.fi/eutukialue/koodi/eutukialue_5", "koodisto" : { "koodistouri" : "eutukialue", "organisaatiooid" : "1.2.246.562.10.00000000001", "koodistoversios" : [ 1 ] }, "koodiarvo" : "5", "paivityspvm" : 1377687284974, "voimassaalkupvm" : "1995-01-01", "voimassaloppupvm" : null, "tila" : "LUONNOS", "nimi" : "5b-maaseutualueet", "kuvaus" : "5b-maaseutualueet", "lyhytnimi" : "5b-maaseutualueet", "kieli" : "FI" "nimi" : "5b-landsbygdsområden", "kuvaus" : "5b-landsbygdsområden", "lyhytnimi" : "5b-landsbygdsområden", "kieli" : "SV" "koodiuri" : "eutukialue_0", "resourceuri" : "http://koodistopalvelu.opintopolku.fi/eutukialue/koodi/eutukialue_0", "koodisto" : { "koodistouri" : "eutukialue", "organisaatiooid" : "1.2.246.562.10.00000000001", "koodistoversios" : [ 1 ] }, "koodiarvo" : "0", "paivityspvm" : 1377687284811, "voimassaalkupvm" : "1995-01-01", "voimassaloppupvm" : null, "tila" : "LUONNOS", "nimi" : "ej EU-stödområde", "kuvaus" : "ej EU-stödområde", "lyhytnimi" : "ej EU-stödområde",
"kieli" : "SV" "nimi" : "0- ei EU-tukialue", "kuvaus" : "0- ei EU-tukialue", "lyhytnimi" : "0- ei EU-tukialue", "kieli" : "FI" "koodiuri" : "eutukialue_2", "resourceuri" : "http://koodistopalvelu.opintopolku.fi/eutukialue/koodi/eutukialue_2", "koodisto" : { "koodistouri" : "eutukialue", "organisaatiooid" : "1.2.246.562.10.00000000001", "koodistoversios" : [ 1 ] }, "koodiarvo" : "2", "paivityspvm" : 1377687284852, "voimassaalkupvm" : "1995-01-01", "voimassaloppupvm" : null, "tila" : "LUONNOS", "nimi" : "2-stagnerade industriområden", "kuvaus" : "2-stagnerade industriområden", "lyhytnimi" : "2-stagnerade industriområden", "kieli" : "SV" "nimi" : "2-taantuvat teollisuusalueet", "kuvaus" : "2-taantuvat teollisuusalueet", "lyhytnimi" : "2-taantuvat teollisuusalueet",
"kieli" : "FI" GET /koodisto-service/rest/eutukialue/koodi XML-esitysmuoto Expand <?xml version="1.0" encoding="utf-8" standalone="yes"?> source <ns2:koodicollection xmlns:ns2="http://service.koodisto.sade.vm.fi/types/common"> <koodi> <koodiuri>eutukialue_6</koodiuri> <resourceuri>http://koodistopalvelu.opintopolku.fi/eutukialue/koodi/eutukialue_6</reso urceuri> <koodisto> <koodistouri>eutukialue</koodistouri> <organisaatiooid>1.2.246.562.10.00000000001</organisaatiooid> <koodistoversio>1</koodistoversio> </koodisto> <versio>1</versio> <koodiarvo>6</koodiarvo> <paivityspvm>2013-08-28t13:54:44.902+03:00</paivityspvm> <voimassaalkupvm>1995-01-01t00:00:00.000+02:00</voimassaalkupvm> <tila>luonnos</tila> <metadata> <kieli>sv</kieli> <nimi>6-glesbygdsområden</nimi> <kuvaus>6-glesbygdsområden</kuvaus> <lyhytnimi>6-glesbygdsområden</lyhytnimi> </metadata> <metadata> <kieli>fi</kieli> <nimi>6-harvaan asutut alueet</nimi> <kuvaus>6-harvaan asutut alueet</kuvaus> <lyhytnimi>6-harvaan asutut alueet</lyhytnimi> </metadata> <lockingversion>0</lockingversion> </koodi> <koodi> <koodiuri>eutukialue_5</koodiuri> <resourceuri>http://koodistopalvelu.opintopolku.fi/eutukialue/koodi/eutukialue_5</reso urceuri> <koodisto> <koodistouri>eutukialue</koodistouri> <organisaatiooid>1.2.246.562.10.00000000001</organisaatiooid> <koodistoversio>1</koodistoversio> </koodisto> <versio>1</versio> <koodiarvo>5</koodiarvo> <paivityspvm>2013-08-28t13:54:44.974+03:00</paivityspvm> <voimassaalkupvm>1995-01-01t00:00:00.000+02:00</voimassaalkupvm> <tila>luonnos</tila> <metadata>