Application Programming Interface: verschil tussen versies

Uit Petities
Ga naar: navigatie, zoeken
(uitgeschreven in GET en POST commando's)
(tabel)
Regel 1: Regel 1:
De petities.nl-website is via de Application Programming Interface te benaderen door derden voor allerlei verschillende redenen. Praktisch alle niet-privacy-gevoelige gegevens kunnen gelezen worden en er kan tot op zekere hoogte door sommigen geschreven worden in de database.  
+
De petities.nl-website is via de Application Programming Interface ([[API]]) te benaderen door derden voor allerlei verschillende redenen. Praktisch alle niet-privacy-gevoelige gegevens kunnen gelezen worden en er kan tot op zekere hoogte door sommigen geschreven worden in de database.  
  
  
We houden rekening met onderstaande gebruikers:
+
We houden rekening met onderstaande soorten gebruikers en omgevingen.
 +
 
 +
{|class=wikitable
 +
|-
 +
!width=3% |Nr.
 +
!width=30%|Gebruiker
 +
!width=31%|Omgeving
 +
!width=3% |GET
 +
!width=3% |POST
 +
 
 +
|-
 +
|1
 +
|petitionarissen
 +
|campagnewebsites en sociale netwerken
 +
|x
 +
|x
 +
 
 +
|-
 +
|2
 +
|gemeenten en andere overheden
 +
|raadsinformatiesystemen, gemeentelijke website
 +
|x
 +
|x
 +
 
 +
|-
 +
|3
 +
|applicatie-ontwikkelaars
 +
|mobiele telefoons, websites van derden
 +
|x
 +
|
 +
 
 +
|-
 +
|4
 +
|media
 +
|nieuws-websites
 +
|x
 +
|
 +
 
 +
|-
 +
|5
 +
|journalisten
 +
|subdomein of journalistenportal
 +
|x
 +
|
 +
 
 +
|-
 +
|6
 +
|Europetition
 +
|andere petitiewebsites
 +
|x
 +
|x
 +
 
 +
|-
 +
|7
 +
|onderzoekers
 +
|statistische software
 +
|x
 +
|
 +
|}
  
* petitionarissen
 
* gemeenten en andere overheden
 
* raadsinformatiesystemen
 
* mobiele applicatie-ontwikkelaars
 
* sociale netwerken websites
 
* nieuws-websites
 
* andere petitiewebsites (EuroPetition)
 
  
 
==petitionarissen==
 
==petitionarissen==

Versie van 13 mei 2010 om 14:59

De petities.nl-website is via de Application Programming Interface (API) te benaderen door derden voor allerlei verschillende redenen. Praktisch alle niet-privacy-gevoelige gegevens kunnen gelezen worden en er kan tot op zekere hoogte door sommigen geschreven worden in de database.


We houden rekening met onderstaande soorten gebruikers en omgevingen.

Nr. Gebruiker Omgeving GET POST
1 petitionarissen campagnewebsites en sociale netwerken x x
2 gemeenten en andere overheden raadsinformatiesystemen, gemeentelijke website x x
3 applicatie-ontwikkelaars mobiele telefoons, websites van derden x
4 media nieuws-websites x
5 journalisten subdomein of journalistenportal x
6 Europetition andere petitiewebsites x x
7 onderzoekers statistische software x


petitionarissen

Een petitionaris of diens ingehuurde ICT-er moet op een eigen campagnewebsite informatie over een petitie kunnen laten zien en het ondertekenen makkelijk maken. Het actuele aantal ondertekeningen moet zichtbaar worden (de bevestigde en de onbevestigde).

  • POST met name, e-mail, city, visibility
  • GET met (petition) id + name geeft naam van een petitie
  • GET met (petition) id + name_clean geeft het stuk uit de URL met underscores die uniek is voor een petitie voor oude petities uit de 2.0-site
  • GET met (petition) id + cached_slug geeft het stuk uit de URL met underscores die uniek is voor een petitie
  • GET met (petition) id + subdomain geeft het subdomein die handmatig is toegekend aan een petitie (if any)
  • GET met (petition) id + description geeft het korte stukje aanhef boven een petitie wat de petitionaris altijd mag veranderen
  • GET met (petition) id + initiator geeft de beschrijving van de petitionarissen in de aanhef van de petitie (bezorgde burgers, actiecomité, vrouwen of iets dergelijks)
  • GET met (petition) id + statement geeft het gedeelte van de petitie met de constatering van feiten
  • GET met (petition) id + request geeft het gedeelte van de petitie met de eis, de afsluiting van de petitie
  • GET met (petition) id + date_projected geeft de datum waarop de petitie waarschijnlijk overhandigd zal worden volgens de petitionaris (of overhandigd is als het om een petitie gaat voorbij fase ondertekenbaar
  • GET met (petition) id + organisation_id geeft terug aan welke organisatie de petitie is geadresseerd
  • GET met organisation_id geeft organisation_name terug; de naam van de organisatie zoals die aan het id is gekoppeld (bv. 658 is Tweede Kamer)
  • GET met (petition) id + petitioner_organisation geeft de beschrijving van de organisatie van de petitionaris 'comité, actiegroep dit of dat'
  • GET met (petition) id + petitioner name geeft de naam van de petitionaris, voornaam + achternaam
  • GET met (petition) id + maps_query geeft de postcode die hoort bij een petitie, voor zover door petitionaris opgegeven (vooral bij lokale petities).
  • GET met (petition) id + organisation_kind geeft wat voor organisatie organisation_id of organisation_name is
  • GET met (petition) id + signatures_count geeft aan hoeveel ondertekeningen een petitie heeft
  • GET met (petition) id + number_of_signatures_on_paper geeft aan hoeveel handtekeningen de petitionaris beweert op papier te hebben (nog niet geïmplementeerd)
  • GET met (petition) id + number_of_newsletters aantal voortgangsberichten er al zijn verstuurd over een petitie.
  • GET met (petition) id + created_at wanneer de petitie is aangemaakt via de petitie-wizard op de voorpagina
  • GET met (petition) id + last_confirmed_at wanneer de link om de petitie te bevestigen voor het laatst door de petitionaris is gevolg (het eigenlijke activeren van de petitie)

onderzoekers

  • GET met (petition) id + updated_at de laatste bewerking van de petitionaris in de petitie, hoe actief een petitionaris is
  • GET met (petition) id + status geeft voor een bepaalde petitie de status weer, of een petitie al ondertekenbaar is bijvoorbeeld
  • GET met status <concept,live,draft,rejected> geeft de lijst met petities weer voor een bepaalde status

journalisten

Een interface voor journalisten kan geauthentiseerd informatie over de petitionaris opvragen: naam, e-mail en telefoonnummer. Niet voordat een petitie in de fase ondertekenbaar is en niet nadat een petitie in de fase afgehandeld is gekomen.