Förstasidan > Anvisningar > Programgränssnitt (API)

Anvisningar

Läs mer om Utlåtandetjänstens användarvillkor på sidan Anvisningar. Du kan även ge respons på användningsinstruktionerna på sidan "Respons"

Anvisningar

1 Tjänstens huvudgränssnitt

De enskilda gränssnitten för utlåtande.fi finns under adress https://www.lausuntopalvelu.fi/api/v1/Lausuntopalvelu.svc/.
Av dessa kan Proposals, Organizations och Users andvändas direkt och de andra kan användas via gränssnittet proposal-n. Information om de enskilda gränssnittens datainnehåll finns nedan. 
   <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>

Det öppna gränssnittet i tjänsten utlåtande.fi följer OData-protokollet. OData ger mångsidiga möjligheter att hämta data ur tjänsten.

Med hjälp av OData kan man till exempel filtrera data som finns i tjänsten enligt informationsinhållet.

Exempel: Filtrering av alla begäran om utlåtande som publicerats av justitieministeriet:
https://www.lausuntopalvelu.fi/api/v1/Lausuntopalvelu.svc/Proposals?$filter=OrganizationName%20eq%20%27Oikeusministeri%C3%B6%27

Lägg till filter (?$filter), enligt vilken post det filtreras (?$filter=OrganizationName), önskad operatör (eq) och kriterium (Justitieministeriet). Webbläsaren kan själv lägga till de specialtecknen som behövs i URL, såsom t.ex. mellanslag, men om ett dataflöde ska läggas till på en annan sida lönar det sig att koda specialtecken färdigt. Operatören särskiljs med mellanslag, som kodas i URL med %20. Därtill ska kriteriet vara inom citationstecken (%27).

Mer information om OData finns på adressen: http://www.odata.org/documentation/odata-version-2-0/uri-conventions/

I kapitel 4.5 finns anvisningar om filtrering.

1.1 Web service schema

2 Gränssnittens datainnehåll

2.1 Allmänna uppgifter om alla publicerade begäran om utlåtande

Visar alla publicerade begäran om utlåtanden som är öppna för allmänheten.
Datainnehåll
Id
Name
Goals
Deadline
CloseDate
ApprovalStatus
ApprovedOn
PublishedOn
OrganizationName
OrganizationID
Därtill hänvisas det till begärans Participants och Reports.

2.2 Allmänna uppgifter om en enskild begäran om utlåtande

I fråga om en enskild begäran om utlåtande visas samma uppgifter som i fråga om alla begäran om utlåtanden. På detta sätt kan man dock söka närmare uppgifter om en enskild begäran om utlåtande.
Datainnehåll
Id
Name
Goals
Deadline
CloseDate
ApprovalStatus
ApprovedOn
PublishedOn
OrganizationName
OrganizationID

Exempel

Man kan söka närmare uppgifter om den enskilda begäran om utlåtande ”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

2.3 Inbjudna deltagare i en enskild begäran om utlåtande

Visar en lista över alla inbjudna deltagare i en begäran om utlåtande
Datainnehåll
Id
FirstName
LastName
Email
RespondingStarted
RespondingEnded

Exempel

Man kan söka närmare uppgifter om alla som bjudits in att yttra sig om den enskilda begäran om utlåtande”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”

2.4 Allmänna uppgifter om enskilda inbjudna deltagare i en begäran om utlåtande

I fråga om en enskild deltagare visas samma uppgifter som i fråga om alla inbjudna deltagare.
Datainnehåll
Id
FirstName
LastName
Email
RespondingStarted
RespondingEnded

Exempel

Man kan söka närmare uppgifter om Kärkölä kommun som bjudits in att yttra sig om den enskilda begäran om utlåtande ”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”

2.5 Allmänna uppgifter om rapporter som gäller en enskild begäran om utlåtande

Visar en lista över alla rapporter som gäller en enskild begäran om utlåtande
Datainnehåll
Id
ProposalId
Name
CreatedBy
CreationDate
LastEditedBy
LastEditedOn
RedirectionId
URL

Exempel

Man kan söka rapporter som gäller den enskilda begäran om utlåtande”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”

2.6 Allmänna uppgifter om en enskild rapport som gäller en begäran om utlåtande

I fråga om en enskild rapport visas samma uppgifter som i fråga om alla rapporter.
Datainnehåll
Id
ProposalId
Name
CreatedBy
CreationDate
LastEditedBy
LastEditedOn
RedirectionId
URL

Exempel

Man kan söka rapporter som gäller den enskilda begäran om utlåtande ”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”
Den begäran om utlåtande som används som exempel har inga rapporter.

2.7 Uppgifter om organisationerna som användarna av tjänsten företräder

Visar en lista över alla organisationer
Datainnehåll
Id
Name

2.8 Allmänna uppgifter om en enskild organisation

I fråga om en enskild organisation visas samma uppgifter som i fråga om alla organisationer.
Datainnehåll
Id
Name

2.9 Frågor som gäller en begäran om utlåtande

Visar alla frågor som gäller en enskild begäran om utlåtande
Datainnehåll
Id
Type
Order
Header
IsMandatory
ProposalId

Exempel

Man kan söka frågorna som gäller den enskilda begäran om utlåtande”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”

2.10 Uppgifter om en enskild fråga som gäller en begäran om utlåtande

I fråga om en enskild fråga visas samma uppgifter som i fråga om alla frågor.
Datainnehåll
Id
Type
Order
Header
IsMandatory
ProposalId

Exempel

I fråga om begäran om utlåtande: ”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” kan man söka uppgifter om den enskilda frågan ”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 Uppgifter om svarsalternativen till en enskild fråga som gäller en begäran om utlåtande

Visar en lista över alla svarsalternativ
Datainnehåll
Id
Order
Header
IsMandatory
IsRow
ParentId
QuestionId

Exempel

I fråga om begäran om utlåtande: ”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” kan man söka uppgifter om svarsalternativen till den enskilda frågan ”Tulisiko alueellisten toimielinten valitseminen suorilla vaaleilla mahdollistaa lainsäädännössä? Borde lagstiftningen möjliggöra valet av delområdesorgan genom direkta val?”

2.12Uppgifter om ett enskilt svarsalternativ till en fråga som gäller en begäran om utlåtande

I fråga om ett enskilt svarsalternativ visas samma uppgifter som i fråga om alla svarsalternativ.
Datainnehåll
Id
Order
Header
IsMandatory
IsRow
ParentId
QuestionId

Exempel

I fråga om begäran om utlåtande:”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” kan man söka uppgifter om ett enskilt svarsalternativ till frågan”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”

2.13 Svaren till en begäran om utlåtande

Visar alla svar som gäller en enskild begäran om utlåtande
Datainnehåll
Id
ProposalId
ParticipantId
QuestionId
QuestionOptionId
QuestionOptionColumnId
TextAnswer
AttachedTextAnswer

Exempel

Man kan söka svaren som gäller den enskilda begäran om utlåtande”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”

2.14 Allmänna uppgifter om svaret

I fråga om ett enskilt svar visas samma uppgifter som i fråga om alla svar.
Datainnehåll
Id
ProposalId
ParticipantId
QuestionId
QuestionOptionId
QuestionOptionColumnId
TextAnswer
AttachedTextAnswer

Exempel

Man kan söka närmare uppgifter om Kärkölä kommuns svar till den enskilda begäran om utlåtande”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”