Skip to content

Commit

Permalink
chore(oas): bewoning contract voor data service uit haal-centraal-brp…
Browse files Browse the repository at this point in the history
…-bewoning repo overgezet
  • Loading branch information
MelvLee committed Nov 21, 2024
1 parent 9d32a2f commit 739e4c9
Show file tree
Hide file tree
Showing 3 changed files with 95 additions and 382 deletions.
23 changes: 23 additions & 0 deletions specificatie/bewoner.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
openapi: 3.1.0
info:
title: Bewoner type definitie
version: 2.0.0
contact: {}
paths: {}
components:
schemas:
GbaBewoner:
type: object
properties:
burgerservicenummer:
$ref: 'brp/identificatienummers/burgerservicenummer-v1.yaml#/components/schemas/Burgerservicenummer'
geheimhoudingPersoonsgegevens:
$ref: 'brp/geheim/indicatie-geheim-v1.yaml#/components/schemas/IndicatieGeheim'
verblijfplaatsInOnderzoek:
$ref: 'brp/in-onderzoek-v1.yaml#/components/schemas/InOnderzoek'
geslacht:
$ref: 'brp/geslacht/geslachtsaanduiding-v1.yaml#/components/schemas/Geslachtsaanduiding'
naam:
$ref: 'brp/naam/naam-basis-v1.yaml#/components/schemas/NaamBasis'
geboorte:
$ref: 'brp/geboorte/geboorte-basis-v1.yaml#/components/schemas/GeboorteBasis'
43 changes: 43 additions & 0 deletions specificatie/bewoning.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
openapi: 3.1.0
info:
title: Bewoning type definitie
version: 2.0.0
contact: {}
paths: {}
components:
schemas:
GbaBewoning:
description: |
Een bewoning geeft aan welke personen in een periode (mogelijk) op een adresseerbaar object staan ingeschreven.
Een persoon is een mogelijke bewoner als niet met zekerheid kan worden bepaald of de persoon in de bewoningperiode op het adresseerbaar object staat/stond ingeschreven.
Dit is het geval als de datum aanvang of de datum einde van de inschrijving geheel of deels onbekend is, en de onzekerheidsperiode overlapt de bewoningperiode.
Wanneer een bewoning in totaal meer dan 100 bewoners en/of mogelijke bewoners heeft, wordt het **indicatieVeelBewoners** veld geleverd.
type: object
properties:
adresseerbaarObjectIdentificatie:
$ref: 'brp/adres/adresseerbaar-object-identificatie-v1.yaml#/components/schemas/AdresseerbaarObjectIdentificatie'
periode:
$ref: 'brp-api/datum/periode-v1.yaml#/components/schemas/Periode'
bewoners:
type: array
description: |
De personen die in de bewoning periode staan ingeschreven op het adresseerbaar object.
minItems: 0
maxItems: 100
items:
$ref: 'bewoner.yaml#/components/schemas/GbaBewoner'
mogelijkeBewoners:
type: array
description: |
De personen die in de bewoning periode mogelijk staan ingeschreven op het adresseerbaar object.
minItems: 0
maxItems: 100
items:
$ref: 'bewoner.yaml#/components/schemas/GbaBewoner'
indicatieVeelBewoners:
type: boolean
description: |
Geeft aan dat de bewoning in totaal meer dan 100 bewoners en/of mogelijke bewoners heeft.
Loading

0 comments on commit 739e4c9

Please sign in to comment.