De gegevens
Herkomst
Elke maatregel komt uit een publicatie van een overheid. Elke record noemt zijn bron, zegt wat de licentie van die bron de record laat bevatten, en geeft de bronvermelding mee die je toont.
De herkomstvelden
Elke volledige record heeft een object provenance; de compacte weergave zet source_id, rights_mode en last_checked_at op het hoogste niveau. De velden die je het vaakst leest:
| Veld | Betekenis |
|---|---|
| provenance.source_id | De bron waaruit de record gelezen werd (curated_federal, eu_funding_tenders, ...). Dit is de id die de filter source en de webhookfilter sources aanvaarden. In de compacte weergave: source_id. |
| provenance.source_url | De pagina waarvan de record gelezen werd, ook geserveerd als links.official. |
| provenance.rights_mode | Wat de licentie van de bron de record laat bevatten: open_licence, facts_only of link_only (zie hieronder). In de compacte weergave: rights_mode. |
| provenance.source_license | De naam van de licentie die geldt. |
| provenance.attribution | De bronvermelding die de licentie vraagt, of null als ze er geen vraagt. Zie bronvermelding. |
| provenance.last_checked_at | Wanneer de bron laatst gelezen werd en nog altijd dit zei. In de compacte weergave: last_checked_at. |
| provenance.source_last_modified_at | Wanneer de pagina volgens de bron zelf laatst gewijzigd werd. |
| provenance.sources[] | Elke bron die de maatregel beschrijft, de primaire eerst. |
Elk herkomstveld staat bij het datamodel.
Rechtenmodi
Elke bron heeft een rechtenmodus, die volgt uit haar licentie. Elke record draagt hem als provenance.rights_mode, de compacte weergave als rights_mode. Hij bepaalt wat de record bevat:
| Modus | Wat de record bevat |
|---|---|
| open_licence | De licentie van de bron laat hergebruik van de tekst toe met bronvermelding (bijvoorbeeld CC BY 4.0, CC0 of de Vlaamse modellicentie voor hergebruik). De samenvatting kan die van de bron zelf zijn (summary_origin: "source"), en status_note kan de woorden van de bron overnemen. |
| facts_only | De record bevat de feiten: datums, bedragen, percentages, wie mag aanvragen, de regels, een samenvatting die uit die feiten is opgesteld (summary_origin: "generated") en de link naar de officiële pagina. De eigen tekst van de bron zit er niet in. |
| link_only | Alleen titel en link. |
Samenvattingen
summary_origin zegt waar de samenvatting in jouw taal vandaan komt: source is de eigen tekst van de bron, generated is opgesteld uit de gegevens van de record (soort steun en verstrekker, voor wie en waar, hoeveel, en wanneer). summary_basis zegt hetzelfde voor de record als geheel: een record met een Nederlandse samenvatting van de bron kan in het Frans of Engels een gegenereerde geven. Titels worden niet gegenereerd of vertaald: een titel bestaat in de talen waarin de bron hem publiceerde, en titles is null voor de andere.
Bronvermelding
Vraagt een licentie een bronvermelding, dan staat die in provenance.attribution en de licentie in provenance.source_license. Een lijstantwoord verzamelt de bronvermeldingen van zijn rijen in meta.attribution. Toon je de tekst van een record met open_licence, toon dan de bronvermelding erbij; voor inhoud van EU Funding & Tenders is dat de Europese Commissie onder CC BY 4.0. Elke record linkt ook naar de eigen pagina van de overheid in links.official: toon die, want die pagina is gezaghebbend, niet deze API. De gegevens zelf doorgeven aan derden kan alleen met een plan dat dat omvat; zie de voorwaarden.
Actualiteit
Elke record draagt de actualiteit van zijn bron in freshness, zodat een bron die een tijd niet gelezen kon worden zichtbaar is op elke maatregel die eruit komt. freshness.state is een van:
| Status | Betekenis |
|---|---|
| fresh | Met succes gelezen binnen anderhalve keer expected_refresh_seconds. |
| delayed | De laatste geslaagde lezing is ouder dan dat, maar valt binnen stale_after_seconds. |
| stale | De laatste geslaagde lezing is ouder dan stale_after_seconds. De record is wat de bron zei op last_successful_fetch; hij blijft beschikbaar, gemarkeerd als stale. |
| source_unavailable | Drie of meer lezingen na elkaar mislukten. |
| parse_error | De bron antwoordde, maar de laatste lezing kon niet verwerkt worden. |
| needs_review | De laatste lezing wacht op nazicht voor ze gepubliceerd wordt. |
| disabled | De bron staat uit. |
| never_run | De bron staat aan, maar werd nog niet gelezen. |
provenance.last_checked_at is wanneer de bron laatst gelezen werd en nog altijd dit zei; provenance.source_last_modified_at is wanneer ze volgens de bron zelf veranderde. Het zijn twee verschillende klokken, en beide worden geserveerd. GET /v1/health lijst de bronnen op die niet actueel zijn.
Wat dit voor jou betekent
- Filter met
source=als je toepassing een bepaalde licentie nodig heeft, en leesrights_modeop elke rij. - Bewaar de id en
links.official. Een maatregel die de bron niet meer publiceert, krijgtwithdrawn_aten verdwijnt uit de standaardlijsten (include_withdrawn=truetoont hem weer); de officiële link wijst naar de overheid, niet naar deze API. - Link bij een record met
facts_onlynaar de pagina van de overheid in plaats van er tekst uit over te nemen.
