forked from BRP-API/Haal-Centraal-BRP-bevragen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
fields_extensie.feature
67 lines (57 loc) · 4.17 KB
/
fields_extensie.feature
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# language: nl
Functionaliteit: Aanpasbare representatie met de fields parameter
Deze feature is een extensie op https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/master/features/fields.feature
In de BRP API wordt de uitgebreide variant van fields ondersteund. Velden in een groep kunnen dus worden opgevraagd zonder het hele pad op te noemen, bijvoorbeeld fields=voornamen levert naam.voornamen.
De volgende velden worden geleverd ongeacht of de fields parameter is gebruikt en ongeacht de eventueel gevraagde velden in de fields parameter:
- inOnderzoek wordt meegegeven wanneer gevraagde corresponderende velden in onderzoek zijn. Zie in_onderzoek.feature voor uitleg wanneer attributen in onderzoek zijn.
- geheimhoudingPersoonsgegevens wordt altijd meegegeven wanneer deze de waarde true heeft.
- opschortingBijhouding reden en datum worden altijd meegegeven wanneer deze een waarde hebben.
Achtergrond:
Gegeven: persoon met burgerservicenummer 999994086 heeft geboortedatum (01.03.10) in onderzoek
En persoon met burgerservicenummer 999993483 heeft geheimhoudingPersoonsgegevens=true
En persoon met burgerservicenummer 999992077 is overleden
Scenario: gevraagd gegeven is in onderzoek en geen fields gebruikt
Als persoon wordt gevraagd met "/ingeschrevenpersonen/999994086"
Dan bevat het antwoord geboorte.datum met de waarde "1986-04-01"
En bevat het antwoord geboorte.inOnderzoek.datum met de waarde true
En bevat het antwoord geboorte.inOnderzoek.datumIngangOnderzoek
En bevat het antwoord veld geboorte.plaats met een waarde
En bevat het antwoord niet geboorte.inOnderzoek.plaats
En bevat het antwoord veld geboorte.land met een waarde
En bevat het antwoord niet geboorte.inOnderzoek.land
Scenario: gevraagd gegeven is in onderzoek en het gegeven in onderzoek wordt gevraagd
Als persoon wordt gevraagd met "/ingeschrevenpersonen/999994086?fields=geboorte.datum"
Dan bevat het antwoord geboorte.datum.datum met de waarde "1986-04-01"
En bevat het antwoord geboorte.inOnderzoek.datum met de waarde true
En bevat het antwoord geboorte.inOnderzoek.datumIngangOnderzoek
Scenario: gevraagd gegeven is in onderzoek en de groep waar het gegeven in onderzoek in zit wordt gevraagd met fields
Als persoon wordt gevraagd met "/ingeschrevenpersonen/999994086?fields=geboorte"
Dan bevat het antwoord geboorte.datum met de waarde "1986-04-01"
En bevat het antwoord geboorte.inOnderzoek.datum met de waarde true
En bevat het antwoord geboorte.inOnderzoek.datumIngangOnderzoek
En bevat het antwoord veld geboorte.plaats met een waarde
En bevat het antwoord niet geboorte.inOnderzoek.plaats
En bevat het antwoord veld geboorte.land met een waarde
En bevat het antwoord niet geboorte.inOnderzoek.land
Scenario: gevraagd gegeven is in onderzoek en het gegeven in onderzoek wordt niet gevraagd met fields
Als persoon wordt gevraagd met "/ingeschrevenpersonen/999994086?fields=geboorte.plaats"
Dan bevat het antwoord veld geboorte.plaats met een waarde
En bevat het antwoord niet geboorte.datum
En bevat het antwoord niet geboorte.land
En bevat het antwoord niet geboorte.inOnderzoek
Scenario: leveren geheimhoudingPersoonsgegevens als daar niet om is gevraagd
Als persoon wordt gevraagd met "/ingeschrevenpersonen/999993483?fields=geboorte.plaats"
Dan bevat het antwoord veld geheimhoudingPersoonsgegevens met de waarde true
En bevat het antwoord veld geboorte.plaats met een waarde
En bevat het antwoord niet geboorte.datum
En bevat het antwoord niet geboorte.land
En bevat het antwoord niet geboorte.inOnderzoek
Scenario: leveren opschortingBijhouding als daar niet om is gevraagd
Als persoon wordt gevraagd met "/ingeschrevenpersonen/999992077?fields=geboorte.plaats"
Dan bevat het antwoord veld opschortingBijhouding.reden met de waarde "overlijden"
En bevat het antwoord veld opschortingBijhouding.datum.datum met de waarde "2015-10-01"
En bevat het antwoord veld geboorte.plaats met een waarde
En bevat het antwoord niet geboorte.datum
En bevat het antwoord niet geboorte.land
En bevat het antwoord niet geboorte.inOnderzoek
En bevat het antwoord niet overlijden