Ohjeet
Tutustu Ohjeet-alasivuilla Lausuntopalvelun käyttöohjeisiin. Voit myös antaa palautetta käyttöohjeista sivulla "Anna palautetta".
Ohjeet
1 Palvelun päärajapinta
Lausuntopalvelun tarjoamat rajapinnat löytyvät osoitteesta https://www.lausuntopalvelu.fi/api/v1/Lausuntopalvelu.svc/.
Näistä suoraan ajettavat ovat Proposals, Organizations ja Users, muut ajetaan proposal-n kontekstissa. Yksittäiset rajapinnat on kuvattu erikseen alla.
<service xmlns="http://www.w3.org/2007/app" xmlns:atom="http://www.w3.org/2005/Atom" xml:base="https://www.lausuntopalvelu.fi/api/v1/Lausuntopalvelu.svc/"> <workspace> <atom:title>Default</atom:title> <collection href="Organizations"> <atom:title>Organizations</atom:title> </collection> <collection href="Participants"> <atom:title>Participants</atom:title> </collection> <collection href="Proposals"> <atom:title>Proposals</atom:title> </collection> <collection href="QuestionOptions"> <atom:title>QuestionOptions</atom:title> </collection> <collection href="Questions"> <atom:title>Questions</atom:title> </collection> <collection href="Users"> <atom:title>Users</atom:title> </collection> <collection href="Answers"> <atom:title>Answers</atom:title> </collection> <collection href="Reports"> <atom:title>Reports</atom:title> </collection> </workspace> </service>
Lausuntopalvelun avoin rajapinta käyttää OData protokollaa. OData tarjoaa monipuoliset mahdollisuudet datan palauttamiseen palvelusta.
Käytetyimpinä esimerkkeinä ODatan avulla voidaan suodattaa palautuvaa dataa tietosisällön perusteella.
Esimerkiksi: Suodatetaan kaikki lausuntopyynnöt, jotka on tehnyt Oikeusministeriö:
https://www.lausuntopalvelu.fi/api/v1/Lausuntopalvelu.svc/Proposals?$filter=OrganizationName%20eq%20%27Oikeusministeri%C3%B6%27
Lisätään pyyntöön filtteri (?$filter), minkä tietueen perusteella suodatetaan (?$filter=OrganizationName), haluttu operaattori (eq) ja kriteeri (Oikeusministeriö). Selainkäytössä selain osaa itse koodata URL:n erikoismerkit kuten välilyönnit, mutta jos esim. laitetaan syöte tiedoista toiselle sivulle, kannattaa erikoismerkit koodata valmiiksi. Operaattori erotellaan välilyönnein, jotka URL:ssa tulee olla koodattuna eli %20. Lisäksi kriteeri tulee olla hipsujen (%27)sisällä.
Tarkemmin ODatan mahdollisuuksiin voi tutustua osoitteessa: http://www.odata.org/documentation/odata-version-2-0/uri-conventions/
Kappale 4.5 ohjeistaa suodattimien käytöstä.
1.1 Web service schema
2 Rajapintojen tietosisällöt
2.1 Kaikkien julkaistujen lausuntopyyntöjen yleiset tiedot
Antaa ulos kaikki julkaistut kaikille avoimet lausunnot.
Tietosisältö |
---|
Id |
Name |
Goals |
Deadline |
CloseDate |
ApprovalStatus |
ApprovedOn |
PublishedOn |
OrganizationName |
OrganizationID |
Lisäksi Lausunnot sisältävät viittauksen sen Participants ja Reports.
2.2 Yksittäisen lausuntopyynnön yleiset tiedot
Yksittäisen lausunnon tiedoissa on samat tiedot kuin lausuntolistauksessa. Tämä kuitenkin mahdollistaa tarkempien lausuntotietojen haun.
Tietosisältö |
---|
Id |
Name |
Goals |
Deadline |
CloseDate |
ApprovalStatus |
ApprovedOn |
PublishedOn |
OrganizationName |
OrganizationID |
Esimerkki
Haetaan lausuntopyynnön ”Lausuntopyyntö pormestarin ja alueellisten toimielinten suoria vaaleja koskevasta hallituksen esitysluonnoksesta/Begäran om utlåtande gällande utkast till regeringspropositionen om direkta val av borgmästare och regionala organ” tarkemmat tiedot:
2.3 Yksittäiseen lausuntopyyntöön kutsutut osallistujat
Listaa lausunnon kaikki osallistuijat
Tietosisältö |
---|
Id |
FirstName |
LastName |
RespondingStarted |
RespondingEnded |
Esimerkki
Haetaan lausuntopyynnön ”Lausuntopyyntö pormestarin ja alueellisten toimielinten suoria vaaleja koskevasta hallituksen esitysluonnoksesta/Begäran om utlåtande gällande utkast till regeringspropositionen om direkta val av borgmästare och regionala organ” kutsutut lausunnonantajat:
2.4 Yksittäisen lausuntopyyntöön kutsuttujen osallistujien yleiset tiedot
https://www.lausuntopalvelu.fi/api/v1/Lausuntopalvelu.svc/Proposals(guid'id')/Participants(guid'id')
Yksittäisen osallistujen tiedoissa on samat tiedot kuin osallistujenlistauksessa.
Tietosisältö |
---|
Id |
FirstName |
LastName |
RespondingStarted |
RespondingEnded |
Esimerkki
Haetaan lausuntopyynnön ”Lausuntopyyntö pormestarin ja alueellisten toimielinten suoria vaaleja koskevasta hallituksen esitysluonnoksesta/Begäran om utlåtande gällande utkast till regeringspropositionen om direkta val av borgmästare och regionala organ” kutsutun Kärkölän kunnan tiedot:
2.5 Yksittäisen lausuntopyynnön julkaistut raportit
Listaa lausuntopyynnön kaikki julkaistut raportit
Tietosisältö |
---|
Id |
ProposalId |
Name |
CreatedBy |
CreationDate |
LastEditedBy |
LastEditedOn |
RedirectionId |
URL |
Esimerkki
Haetaan lausuntopyynnön ”Lausuntopyyntö pormestarin ja alueellisten toimielinten suoria vaaleja koskevasta hallituksen esitysluonnoksesta/Begäran om utlåtande gällande utkast till regeringspropositionen om direkta val av borgmästare och regionala organ” julkaistut raportit:
2.6 Yksittäisen lausuntopyynnön yksittäisen raportin tiedot
Yksittäisellä raportilla on samat tiedot kuin lausuntopyynnön raporttilistauksessa.
Tietosisältö |
---|
Id |
ProposalId |
Name |
CreatedBy |
CreationDate |
LastEditedBy |
LastEditedOn |
RedirectionId |
URL |
Esimerkki
Haetaan lausuntopyynnön ”Lausuntopyyntö pormestarin ja alueellisten toimielinten suoria vaaleja koskevasta hallituksen esitysluonnoksesta/Begäran om utlåtande gällande utkast till regeringspropositionen om direkta val av borgmästare och regionala organ” julkaistut raportit:
Esimerkkilausuntopyynnöllä ei ole julkaistuja raportteja.
2.7 Lausuntopalvelun käyttäjien organisaatiotiedot
Listaa kaikki organisaatiot
Tietosisältö |
---|
Id |
Name |
2.8 Yksittäisen organisaation yleiset tiedot
Yksittäisen organisaation tietosisältö on sama kuin organisaationlistauksessa.
Tietosisältö |
---|
Id |
Name |
2.9 Lausuntopyynnön kysymykset
Listaa kaikki lausuntopyynnön kysymykset
Tietosisältö |
---|
Id |
Type |
Order |
Header |
IsMandatory |
ProposalId |
Esimerkki
Haetaan lausuntopyynnön ”Lausuntopyyntö pormestarin ja alueellisten toimielinten suoria vaaleja koskevasta hallituksen esitysluonnoksesta/Begäran om utlåtande gällande utkast till regeringspropositionen om direkta val av borgmästare och regionala organ” kysymykset:
2.10 Lausuntopyynnön yksittäisen kysymyksen tiedot
Yksittäisen kysymyksen tiedoissa on samat tiedot kuin kysymyksen listauksessa.
Tietosisältö |
---|
Id |
Type |
Order |
Header |
IsMandatory |
ProposalId |
Esimerkki
Haetaan lausuntopyynnön ”Lausuntopyyntö pormestarin ja alueellisten toimielinten suoria vaaleja koskevasta hallituksen esitysluonnoksesta/Begäran om utlåtande gällande utkast till regeringspropositionen om direkta val av borgmästare och regionala organ” kysymyksen ”Tulisiko alueellisten toimielinten valitseminen suorilla vaaleilla mahdollistaa lainsäädännössä? Borde lagstiftningen möjliggöra valet av delområdesorgan genom direkta val?” tiedot:
2.11 Lausuntopyynnön kysymyksen vastausvaihtoehtojen tiedot
Listaa kaikki kysymyksen vaihtoehdot
Tietosisältö |
---|
Id |
Order |
Header |
IsMandatory |
IsRow |
ParentId |
QuestionId |
Esimerkki
Haetaan lausuntopyynnön ”Lausuntopyyntö pormestarin ja alueellisten toimielinten suoria vaaleja koskevasta hallituksen esitysluonnoksesta/Begäran om utlåtande gällande utkast till regeringspropositionen om direkta val av borgmästare och regionala organ” kysymyksen ”Tulisiko alueellisten toimielinten valitseminen suorilla vaaleilla mahdollistaa lainsäädännössä? Borde lagstiftningen möjliggöra valet av delområdesorgan genom direkta val?” tiedot:
2.12 Lausuntopyynnön kysymyksen yksittäisen vastausvaihtoehdon tiedot
Yksittäisen kysymyksen vaihtoehdon tiedoissa on samat tiedot kuin kysymyksen vaihtoehdon listauksessa.
Tietosisältö |
---|
Id |
Order |
Header |
IsMandatory |
IsRow |
ParentId |
QuestionId |
Esimerkki
Haetaan lausuntopyynnön ”Lausuntopyyntö pormestarin ja alueellisten toimielinten suoria vaaleja koskevasta hallituksen esitysluonnoksesta/Begäran om utlåtande gällande utkast till regeringspropositionen om direkta val av borgmästare och regionala organ” kysymyksen ”Tulisiko alueellisten toimielinten valitseminen suorilla vaaleilla mahdollistaa lainsäädännössä? Borde lagstiftningen möjliggöra valet av delområdesorgan genom direkta val?” vastausvaihtoehdon “En ota kantaa/Tar inte ställning” tiedot:
2.13 Lausuntopyynnön vastaukset
Listaa kaikki lausuntopyynnön vastaukset
Tietosisältö |
---|
Id |
ProposalId |
ParticipantId |
QuestionId |
QuestionOptionId |
QuestionOptionColumnId |
TextAnswer |
AttachedTextAnswer |
Esimerkki
Haetaan lausuntopyynnön ”Lausuntopyyntö pormestarin ja alueellisten toimielinten suoria vaaleja koskevasta hallituksen esitysluonnoksesta/Begäran om utlåtande gällande utkast till regeringspropositionen om direkta val av borgmästare och regionala organ” kaikki vastaukset:
2.14 Vastauksen yleiset tiedot
Yksittäisen vastauksen tiedoissa on samat tiedot kuin vastauksen listauksessa.
Tietosisältö |
---|
Id |
ProposalId |
ParticipantId |
QuestionId |
QuestionOptionId |
QuestionOptionColumnId |
TextAnswer |
AttachedTextAnswer |
Esimerkki
Haetaan lausuntopyynnön ”Lausuntopyyntö pormestarin ja alueellisten toimielinten suoria vaaleja koskevasta hallituksen esitysluonnoksesta/Begäran om utlåtande gällande utkast till regeringspropositionen om direkta val av borgmästare och regionala organ” Kärkölän kunnan vastaus: