diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 000000000..3729ff0cd --- /dev/null +++ b/.dockerignore @@ -0,0 +1,25 @@ +**/.classpath +**/.dockerignore +**/.env +**/.git +**/.gitignore +**/.project +**/.settings +**/.toolstarget +**/.vs +**/.vscode +**/*.*proj.user +**/*.dbmdl +**/*.jfm +**/azds.yaml +**/bin +**/charts +**/docker-compose* +**/Dockerfile* +**/node_modules +**/npm-debug.log +**/obj +**/secrets.dev.yaml +**/values.dev.yaml +LICENSE +README.md \ No newline at end of file diff --git a/.github/workflows/lint-oas.yml b/.github/workflows/lint-oas.yml index 04d8f1390..0693bc574 100644 --- a/.github/workflows/lint-oas.yml +++ b/.github/workflows/lint-oas.yml @@ -32,6 +32,7 @@ jobs: git config user.name "$GITHUB_ACTOR" git config user.email "$GITHUB_ACTOR@users.noreply.github.com" git add specificatie/genereervariant/openapi.* + git add specificatie/gba-genereervariant/openapi.* git commit -m "commit resolve artifacts" git pull --ff git push diff --git a/.gitignore b/.gitignore index 0abace38a..4f06450f0 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,13 @@ node_modules # swagger-codegen-cli .swagger-codegen .swagger-codegen-ignore + +*.suo +*.user + +[Bb]in/ +[Oo]bj/ + +.vs + +Data/ \ No newline at end of file diff --git a/BRP.sln b/BRP.sln new file mode 100644 index 000000000..5200b0344 --- /dev/null +++ b/BRP.sln @@ -0,0 +1,37 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.0.32112.339 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{945585CC-ED27-4B2F-ABE9-74C93A185CB6}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "BrpService", "src\BrpService\BrpService.csproj", "{FE143889-B833-4BA0-B840-A7E29C841891}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "BrpProxy", "src\BrpProxy\BrpProxy.csproj", "{98C76098-2F31-41C4-AA5E-C12E5B22A2B9}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {FE143889-B833-4BA0-B840-A7E29C841891}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {FE143889-B833-4BA0-B840-A7E29C841891}.Debug|Any CPU.Build.0 = Debug|Any CPU + {FE143889-B833-4BA0-B840-A7E29C841891}.Release|Any CPU.ActiveCfg = Release|Any CPU + {FE143889-B833-4BA0-B840-A7E29C841891}.Release|Any CPU.Build.0 = Release|Any CPU + {98C76098-2F31-41C4-AA5E-C12E5B22A2B9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {98C76098-2F31-41C4-AA5E-C12E5B22A2B9}.Debug|Any CPU.Build.0 = Debug|Any CPU + {98C76098-2F31-41C4-AA5E-C12E5B22A2B9}.Release|Any CPU.ActiveCfg = Release|Any CPU + {98C76098-2F31-41C4-AA5E-C12E5B22A2B9}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {FE143889-B833-4BA0-B840-A7E29C841891} = {945585CC-ED27-4B2F-ABE9-74C93A185CB6} + {98C76098-2F31-41C4-AA5E-C12E5B22A2B9} = {945585CC-ED27-4B2F-ABE9-74C93A185CB6} + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {BEC9CC08-4805-4AE3-9268-E70AD74999B1} + EndGlobalSection +EndGlobal diff --git a/cucumber.js b/cucumber.js new file mode 100644 index 000000000..1fcdb6039 --- /dev/null +++ b/cucumber.js @@ -0,0 +1,3 @@ +module.exports = { + default: `--format-options '{"snippetInterface": "synchronous"}'` +} diff --git a/features/aanschrijfwijze.feature b/features/aanschrijfwijze.feature index 9936c2254..2e7228851 100644 --- a/features/aanschrijfwijze.feature +++ b/features/aanschrijfwijze.feature @@ -2,269 +2,762 @@ # User story #13 Functionaliteit: Als gemeente wil ik de juiste en consistente aanschrijfwijze van mijn burgers - Attribuut aanschrijfwijze bij een persoon wordt gevuld door de provider om op deze wijze op eenduidige wijze een persoon te kunnen aanschrijven. Bij het samenstellen van de aanschrijfwijze worden academische titels vooralsnog niet opgenomen. Academische titels zijn geen authentiek gegeven en daarom buiten scope geplaatst. - De aanschrijfwijze wordt gebruikt als eerste regel in de adressering op een envelop, of links bovenaan een brief, direct boven het adres. - Bij personen met een adellijke titel of predikaat wordt ook regelVoorafgaandAanAanschrijfwijze gevuld. Deze wordt in de adressering in de regel boven aanschrijfwijze geplaatst om een correcte aanschrijving van een adellijke persoon samen te stellen. - De aanschrijfwijze kan ook worden gebruikt in lijsten met zoekresultaten, of op een website om te tonen op wie het betrekking heeft. + De attributen aanschrijfwijze.naam en aanschrijfwijze.aanspreekvorm bij een persoon worden gevuld door de provider om op deze wijze op eenduidige wijze een persoon te kunnen aanschrijven. + Bij het samenstellen van de aanschrijfwijze worden academische titels vooralsnog niet opgenomen. Academische titels zijn geen authentiek gegeven en daarom buiten scope geplaatst. + + De aanschrijfwijze wordt gebruikt als eerste regel(s) in de adressering op een envelop, of links bovenaan een brief, direct boven het adres. + + Bij personen met een adellijke titel of predikaat bevat de aanschrijfwijze ook de aanschrijfvorm. + Deze wordt in de adressering in de regel boven de naam van de aanschrijfwijze geplaatst om een correcte aanschrijving van een adellijke persoon samen te stellen. - Attribuut aanschrijfwijze wordt samengesteld op basis van: + De aanschrijfwijze.naam kan ook worden gebruikt in lijsten met zoekresultaten, of op een website om te tonen op wie het betrekking heeft. + + Attribuut aanschrijfwijze.naam wordt samengesteld op basis van: - voornamen (wordt omgezet naar voorletters) - - adellijkeTitel_predikaat - - voorvoegselGeslachtsnaam + - adellijke titel/predikaat + - voorvoegsel geslachtsnaam - geslachtsnaam - geslachtsaanduiding - - aanduidingAanschrijving - - voorvoegselGeslachtsnaam partner + - aanduiding naamgebruik + - voorvoegsel geslachtsnaam partner - geslachtsnaam partner - - adellijkeTitel_predikaat partner + - adellijke titel/predikaat partner - geslachtsaanduiding partner - De waarde van aanduidingAanschrijving bepaalt hoe de aanschrijfwijze wordt samengesteld uit de naam van de persoon en de naam van de partner. Zie de tabel "Voorbeelden: met voorvoegsel" en "Voorbeelden: met voorvoegsel" hieronder. - - Wanneer er geen voorvoegsel is, wordt deze niet opgenomen. Er zit dan één spatie tussen de voorletters en de geslachtsnaam. Zie de tabel "Voorbeelden: met voorvoegsel" en "Voorbeelden: met voorvoegsel" hieronder. - - De voorletters worden opgenomen zoals beschreven in Voorletters.feature. - - Als er meerdere actuele (niet ontbonden) huwelijken/partnerschappen zijn - En de aanduiding aanschijving is ongelijk aan 'Eigen', - Dan wordt als partnernaam de naam van de eerste partner (oudste relatie) gebruikt. - - Als er meerdere ontbonden huwelijken/partnerschappen zijn - En er geen actueel (niet ontbonden) huwelijk/partnerschap is - En de aanduiding aanschijving is ongelijk aan 'Eigen' - Dan wordt als partnernaam de naam van de laatst ontbinden relatie gebruikt. - - Op basis van attribuut adellijkeTitel_predikaat en de geslachtsaanduiding wordt de adelijke titel of het predikaat toegevoegd in de aanschrijfwijze. - De adellijke titel of het predikaat wordt in aanschrijfwijze opgenomen in de vorm die hoort bij de geslachtsaanduiding: - | adellijkeTitel_predikaat | vrouw | man | onbekend | - | Graaf | gravin | graaf | - | - | Gravin | gravin | graaf | - | - | Baron | barones | baron | - | - | Barones | barones | baron | - | - | Hertog | hertogin | hertog | - | - | Hertogin | hertogin | hertog | - | - | Markies | markiezin | markies | - | - | Markiezin | markiezin | markies | - | - | Prins | prinses | prins | - | - | Prinses | prinses | prins | - | - | Ridder | - | ridder | - | - | Jonkheer | jonkvrouw | jonkheer | - | - | Jonkvrouw | jonkvrouw | jonkheer | - | - - Als de adellijke titel geen vorm heeft die hoort bij de geslachtsaanduiding (in bovenstaande tabel opgenomen als - teken) - Dan wordt de adellijke titel niet opgenomen in de aanschrijfwijze. - - Als de geslachtsaanduiding is "onbekend" (O) of er is geen waarde voor geslachtsaanduiding - Dan wordt de (eventuele) adellijke titel of het predikaat niet opgenomen in de aanschrijfwijze. - - Als de persoon beschikt over een predikaat - En de aanduiding aanschrijving is gelijk aan "E" (eigen) of "N" (partner na eigen geslachtsnaam) - Dan wordt deze geplaatst vóór de voorletters - En begin het predikaat in de aanschrijfwijze met een hoofdletter (J). - - Als de persoon beschikt over een predikaat - En de aanduiding aanschrijving is gelijk aan "V" (partner voor eigen geslachtsnaam) - Dan wordt deze geplaatst vóór het eigen voorvoegsel en geslachtsnaam - En begin het predikaat in de aanschrijfwijze met een kleine letter (j). - - Als de persoon beschikt over een predikaat - En de aanduiding aanschrijving is gelijk aan "P" (partner) - Dan wordt het predikaat niet gebruikt. - - Als de persoon over een adelijke titel beschikt - Dan wordt de adelijke titel geplaatst tussen voorletters en achternaam (voorvoegsel en geslachtsnaam). - - Als de persoon zelf beschikt over een adellijke titel - En de persoon gebruikt de geslachtsnaam van de echtgenoot/partner in combinatie met de eigen achternaam - Dan wordt de titel van betrokkene voor de eigen achternaam geplaatst. - - Als de persoon zelf beschikt over een adellijke titel - En de persoon de geslachtsnaam van de echtgenoot/partner gebruikt zonder de eigen geslachtsnaam (aanduiding aanschrijving is "P" - "partner") - Dan wordt de adellijke titel niet gebruikt. - - Als de partner een adellijke titel heeft - En de geslachtsaanduiding van de persoon is "vrouw" - En de geslachtsaanduiding van de partner is "man" - En de adellijke titel van de partner heeft een vrouwelijke vorm (zie tabel hieronder) - En de persoon gebruikt de naam van haar partner (aanduidingNaamgebruik ongelijk aan "E" - "eigen") - Dan wordt de adellijke titel van de partner in vrouwelijke vorm opgenomen voor het voorvoegsel van de naam van de partner - | Titel | Vrouwelijke vorm | - | Graaf | gravin | - | Baron | barones | - | Prins | prinses | - - Als de persoon een adellijke titel of predikaat heeft, wordt de regelVoorafgaandAanAanschrijfwijze bepaald op basis van adellijkeTitel_predikaat en de geslachtsaanduiding volgens de volgende tabel: - | adellijkeTitel_predikaat | geslachtsaanduiding | regelVoorafgaandAanAanschrijfwijze | - | Baron, Barones | man | De hoogwelgeboren heer | - | Baron, Barones | vrouw | De hoogwelgeboren vrouwe | - | Graaf, Gravin | man | De hooggeboren heer | - | Graaf, Gravin | vrouw | De hooggeboren vrouwe | - | Hertog, Hertogin | man | De hoogwelgeboren heer | - | Hertog, Hertogin | vrouw | De hoogwelgeboren vrouwe | - | Jonkheer, Jonkvrouw | man | De hoogwelgeboren heer | - | Jonkheer, Jonkvrouw | vrouw | De hoogwelgeboren vrouwe | - | Markies, Markiezin | man | De hoogwelgeboren heer | - | Markies, Markiezin | vrouw | De hoogwelgeboren vrouwe | - | Prins, Prinses | man | De hoogheid | - | Prins, Prinses | vrouw | De hoogheid | - | Prins, Prinses | onbekend | De hoogheid | - | Ridder | man | De hoogwelgeboren heer | - | Ridder | vrouw | De hoogwelgeboren vrouwe | - - Als de persoon een predikaat heeft - En de geslachtsaanduiding is gelijk aan "vrouw" - En betrokkene is getrouwd of heeft een geregistreerd partnerschap - En het huwelijk dan wel geregistreerd partnerschap is niet beëindigd of ontbonden - Dan wordt regelVoorafgaandAanAanschrijfwijze niet opgenomen. - - Als de persoon een predikaat heeft - En de geslachtsaanduiding is gelijk aan "vrouw" - En de persoon is getrouwd geweest of heeft een geregistreerd partnerschap gehad - En het huwelijk dan wel geregistreerd partnerschap is beëindigd of ontbonden - En de (ex)partnernaam wordt nog gebruikt (aanduiding naamgebruik is "V", "N" of "P") - Dan wordt regelVoorafgaandAanAanschrijfwijze niet opgenomen. - - Als de persoon een adellijke titel of predikaat heeft - En de geslachtsaanduiding is gelijk aan "onbekend" of er is geen waarde voor geslachtsaanduiding - En de adellijke titel is ongelijk aan "prins" of "prinses" ("De hoogheid" is gender neutraal dus kan ook bij onbekend geslacht gebruikt worden) - Dan wordt regelVoorafgaandAanAanschrijfwijze niet opgenomen. - - Als de persoon geen adellijke titel of predikaat heeft - Dan wordt regelVoorafgaandAanAanschrijfwijze niet opgenomen. - - Als de persoon een adellijke titel of predikaat heeft - En betrokkene de geslachtsnaam van de echtgenoot/partner gebruikt zonder de eigen geslachtsnaam (aanduiding aanschrijving is "P" - "partner") - Dan wordt regelVoorafgaandAanAanschrijfwijze niet opgenomen. - - - Abstract Scenario: De aanschrijfwijze wordt samengesteld op basis van aanduidingAanschrijving en naamgegevens van de persoon en de partner - Als persoon wordt geraadpleegd - Dan heeft de gevonden persoon naam.aanschrijfwijze= - - # In onderstaande tabellen betekenen de afkortingen: - # VL = voorletters - # VV = voorvoegselGeslachtsnaam - # GN = geslachtsnaam - # VP = voorvoegselGeslachtsnaam partner - # GP = geslachtsnaam partner - # AT = adelijke titel - # AP = adellijke titel partner (in andersgeslachtelijke vorm) - # PK = predikaat - - Voorbeelden: met voorvoegsel - | aanduidingAanschrijving | samenstelling aanschrijfwijze | voorvoegsel | geslachtsnaam | voornamen | voorvoegsel partner | geslachtsnaam partner | aanschrijfwijze | - | E | VL VV GN | In het | Veld | Henk | van | Velzen | H. In het Veld | - | N | VL VV GN-VP GP | van | Velzen | Ingrid | In het | Veld | I. van Velzen-In het Veld | - | P | VL VP GP | In het | Veld | Suzanne | van | Velzen | S. van Velzen | - | V | VL VP GP-VV GN | van | Velzen | Fred | In het | Veld | F. In het Veld-van Velzen | - - Voorbeelden: zonder voorvoegsel - | aanduidingAanschrijving | samenstelling aanschrijfwijze | geslachtsnaam | voornamen | aanschrijfwijze | - | E | VL GN | Groenen | Franklin | F. Groenen | - | N | VL GN-GP | Groenen | Franka | F. Groenen-Groenink | - | P | VL GP | Groenink | Johan Frank Robert | J.F.R. Groenen | - | V | VL GP-GN | Groenlo | Franka | F. Groenen-Groenlo | - - Voorbeelden: betrokkene heeft een adelijke titel en partner heeft geen adellijke titel - | geslachtsaanduiding | aanduidingAanschrijving | samenstelling aanschrijfwijze | adellijkeTitel_predikaat | geslachtsnaam | voornamen | aanschrijfwijze | regelVoorafgaandAanAanschrijfwijze | - | man | E | VL AT VV GN | Baron | Aedel | Hendrik Willem | H.W. baron van den Aedel | De hoogwelgeboren heer | - | vrouw | N | VL AT VV GN-VP GP | Gravin | Aedel | Wilhelmina | W. gravin van den Aedel-van der Veen | De hooggeboren vrouwe | - | vrouw | P | VL VP GP | Barones | Aedel | Frederique | F. van der Veen | - | - | vrouw | V | VL VP GP-AT VV GN | Gravin | Aedel | Emma Louise | E.L. van der Veen-gravin van den Aedel | De hooggeboren vrouwe | - | man | E | VL AT VV GN | Barones | Aedel | Johan | J. baron van den Aedel | De hoogwelgeboren heer | - | vrouw | N | VL AT VV GN-VP GP | Graaf | Aedel | Wilhelmina | W. gravin van den Aedel-van der Veen | De hooggeboren vrouwe | - | vrouw | P | VL VP GP | Barones | Aedel | Frederique | F. van der Veen | - | - | vrouw | V | VL VP GP-AT VV GN | Baron | Aedel | Erica | E. van der Veen-barones van den Aedel | De hoogwelgeboren vrouwe | - | vrouw | E | VL AT VV GN | Ridder | Aedel | Michael | M. van den Aedel | - | - | onbekend | E | VL VV GN | Barones | Aedel | Johanna | J. van den Aedel | - | - | onbekend | V | VL VP GP-AT VV GN | Ridder | Aedel | Simon | S. van der Veen-van den Aedel | - | - - Voorbeelden: betrokkene heeft een predikaat en partner heeft geen adellijke titel - | geslacht | adellijkeTitel_predikaat | aanduidingNaamgebruik | partner | Ontbinding huwelijk/geregistreerd partnerschap | aanschrijfwijze | regelVoorafgaandAanAanschrijfwijze | - | man | Jonkheer | Eigen | Geen | Geen | Jonkheer T. van Hoogh | De hoogwelgeboren heer | - | man | Jonkheer | Eigen | Ja | Geen | Jonkheer T. van Hoogh | De hoogwelgeboren heer | - | vrouw | Jonkvrouw | Eigen | Geen | Geen | Jonkvrouw T. van Hoogh | De hoogwelgeboren vrouwe | - | vrouw | Jonkvrouw | Eigen | Ja | Geen | Jonkvrouw T. van Hoogh | - | - | vrouw | Jonkvrouw | Eigen | Ja | Ja | Jonkvrouw T. van Hoogh | De hoogwelgeboren vrouwe | - | vrouw | Jonkheer | Eigen | Geen | Geen | Jonkvrouw T. van Hoogh | De hoogwelgeboren vrouwe | - | vrouw | Jonkheer | Eigen | Ja | Geen | Jonkvrouw T. van Hoogh | - | - | onbekend | Jonkvrouw | Eigen | Geen | Geen | T. van Hoogh | - | - | vrouw | Jonkvrouw | Partner na eigen | Ja | Geen | Jonkvrouw T. van Hoogh-in het Veld | - | - | vrouw | Jonkvrouw | Partner na eigen | Ja | Ja | Jonkvrouw T. van Hoogh-in het Veld | - | - | man | Jonkheer | Partner na eigen | Ja | Geen | Jonkheer T. van Hoogh-in het Veld | De hoogwelgeboren heer | - | vrouw | Jonkvrouw | Partner | Ja | Geen | T. in het Veld | - | - | vrouw | Jonkvrouw | Partner | Ja | Ja | T. in het Veld | - | - | man | Jonkheer | Partner | Geen | Geen | T. in het Veld | - | - | vrouw | Jonkvrouw | Partner voor eigen | Ja | Geen | T. in het Veld-jonkvrouw van Hoogh | - | - | vrouw | Jonkheer | Partner voor eigen | Ja | Geen | T. in het Veld-jonkvrouw van Hoogh | - | - | man | Jonkvrouw | Partner voor eigen | Ja | Geen | T. in het Veld-jonkheer van Hoogh | De hoogwelgeboren heer | - | onbekend | Jonkvrouw | Partner voor eigen | Ja | Geen | T. in het Veld-van Hoogh | - | - - Voorbeelden: partner heeft een adellijke titel - | geslachtsaanduiding | geslachtsaanduiding partner | adellijkeTitel_predikaat partner | aanduidingAanschrijving | samenstelling aanschrijfwijze | geslachtsnaam | voornamen | aanschrijfwijze | regelVoorafgaandAanAanschrijfwijze | - | vrouw | man | Baron | E | VL VV GN | Veen | Anna Cornelia | A.C. van der Veen | - | - | vrouw | man | Baron | N | VL VV GN-AP VP GP | Veen | Anna Cornelia | A.C. van der Veen-barones van den Aedel | - | - | vrouw | man | Baron | P | VL AP VP GP | Veen | Anna Cornelia | A.C. barones van den Aedel | - | - | vrouw | man | Baron | P | VL AP VP GP | Veen | Anna Cornelia | A.C. barones van den Aedel | - | - | vrouw | man | Baron | V | VL AP VP GP-VV GN | Veen | Anna Cornelia | A.C. barones van den Aedel-van der Veen | - | - | vrouw | man | Prins | E | VL VV GN | Veen | Anna Cornelia | A.C. van der Veen | - | - | vrouw | man | Prins | N | VL VV GN-AP VP GP | Veen | Anna Cornelia | A.C. van der Veen-prinses van den Aedel | - | - | vrouw | man | Prins | P | VL AP VP GP | Veen | Anna Cornelia | A.C. prinses van den Aedel | - | - | vrouw | man | Prins | V | VL AP VP GP-VV GN | Veen | Anna Cornelia | A.C. prinses van den Aedel-van der Veen | - | - | man | vrouw | Gravin | E | VL VV GN | Veen | Johannes | J. van der Veen | - | - | man | vrouw | Gravin | N | VL VV GN-VP GP | Veen | Johannes | J. van der Veen-van den Aedel | - | - | man | vrouw | Gravin | P | VL VP GP | Veen | Johannes | J. van den Aedel | - | - | man | vrouw | Gravin | V | VL VP GP-VV GN | Veen | Johannes | J. van den Aedel-van der Veen | - | - | vrouw | man | Ridder | E | VL VV GN | Veen | Marlies | M. van der Veen | - | - | vrouw | man | Ridder | N | VL VV GN-VP GP | Veen | Marlies | M. van der Veen-van den Aedel | - | - | vrouw | man | Ridder | P | VL VP GP | Veen | Marlies | M. van den Aedel | - | - | vrouw | man | Ridder | V | VL VP GP-VV GN | Veen | Marlies | M. van den Aedel-van der Veen | - | - | vrouw | vrouw | Gravin | E | VL VV GN | Veen | Sarah | S. van der Veen | - | - | vrouw | vrouw | Gravin | N | VL VV GN-VP GP | Veen | Sarah | S. van der Veen-van den Aedel | - | - | vrouw | vrouw | Gravin | V | VL VP GP-VV GN | Veen | Sarah | S. van den Aedel-van der Veen | - | - | man | man | Baron | E | VL VV GN | Veen | Willem | W. van der Veen | - | - | man | man | Baron | N | VL VV GN-VP GP | Veen | Willem | W. van der Veen-van den Aedel | - | - | man | man | Baron | P | VL VP GP | Veen | Willem | W. van den Aedel | - | - | man | man | Baron | V | VL VP GP-VV GN | Veen | Willem | W. van den Aedel-van der Veen | - | - | onbekend | man | Baron | P | VL AP VP GP | Veen | Anna Cornelia | A.C. van den Aedel | - | - | vrouw | onbekend | Baron | P | VL AP VP GP | Veen | Anna Cornelia | A.C. van den Aedel | - | - - Voorbeelden: partner heeft een predikaat - | aanduidingAanschrijving | samenstelling aanschrijfwijze | geslachtsnaam | voornamen | aanschrijfwijze | regelVoorafgaandAanAanschrijfwijze | - | E | VL VV GN | Berg | Sjaak | S. van der Berg | - | - | N | VL VV GN-VP GP | Berg | Peter | P. van der Berg-van Hoogh | - | - | P | VL VP GP | Berg | Marlies | M. van Hoogh | - | - | V | VL VP GP-VV GN | Berg | Fleur | F. van Hoogh-van der Berg | - | - - Voorbeelden: betrokkene heeft een adelijke titel en partner heeft een adellijke titel - | aanduidingAanschrijving | samenstelling aanschrijfwijze | geslachtsnaam | voornamen | aanschrijfwijze | regelVoorafgaandAanAanschrijfwijze | - | E | VL AT VV GN | Aedel | Hendrik Willem | H.W. graaf van den Aedel | De hooggeboren heer | - | N | VL AT VV GN-AP VP GP | Aedel | Wilhelmina | W. gravin van den Aedel-barones van Hoogh | De hooggeboren vrouwe | - | P | VL AP VP GP | Aedel | Frederique | F. barones van Hoogh | - | - | V | VL AP VP GP-AT VV GN | Aedel | Emma Louise | E.L. barones van Hoogh-gravin van den Aedel | De hooggeboren vrouwe | - - Scenario: meerdere actuele relaties - Gegeven de persoon F.C. Groen is getrouwd in 1958 met Geel - En de persoon is getrouwd in 1961 met Roodt - En geen van beide relaties is beëindigd - En de persoon heeft aanduidingAanschrijving='V' - Als de persoon wordt geraadpleegd - Dan is in het antwoord naam.aanschrijfwijze=F.C. Geel-Groen - - Scenario: meerdere ontbonden relaties gebruikt de laatst ontbonden relatie - Gegeven de persoon J. Wit is getrouwd in 1958 met Geel - En de persoon is getrouwd in 1961 met Roodt - En het huwelijk met Geel is ontbonden in 1960 - En het huwelijk met Roodt is ontbonden in 2006 - En de persoon heeft aanduidingAanschrijving='V' - Als de persoon wordt geraadpleegd - Dan is in het antwoord naam.aanschrijfwijze=J. Roodt-Wit - - Scenario: meerdere ontbonden relaties en oudste relatie is het laatst ontbonden - Gegeven de persoon de heer J. Wit is getrouwd in 1958 met Zwart - En de persoon is getrouwd in 1961 met Blaauw - En het huwelijk met Blaauw is ontbonden in 1983 - En het huwelijk met Zwart is ontbonden in 2006 - En de persoon heeft aanduidingAanschrijving='V' - Als de persoon wordt geraadpleegd - Dan is in het antwoord naam.aanhef=J. Zwart-Wit + De waarde van aanduiding naamgebruik bepaalt hoe de aanschrijfwijze.naam en aanschrijfwijze.aanspreekvorm worden samengesteld uit de naam van de persoon en de naam van de partner. + + Rule: De naam in aanschrijfwijze wordt op basis van aanduiding naamgebruik als volgt samengesteld: + | aanduiding naamgebruik | omschrijving | naam in aanschrijfwijze | + | E | eigen naam | PK VL AT VV GN | + | P | partner naam | VL AP VP GP | + | V | partner naam voor eigen naam | VL AP VP GP-PK AT VV GN | + | N | partner naam na eigen naam | PK VL AT VV GN-AP VP GP | + Betekenis afkortingen in aanschrijfwijze: + VL = voorletters + VV = voorvoegselGeslachtsnaam + GN = geslachtsnaam + VP = voorvoegselGeslachtsnaam partner + GP = geslachtsnaam partner + AT = adelijke titel + AP = adellijke titel partner (in andersgeslachtelijke vorm) + PK = predikaat + Toelichting: + - de aanschrijfwijze.naam start en eindigt niet met een spatie, heeft geen dubbele spaties en heeft geen spatie vóór en na de "-" + - de voorletters worden opgenomen zoals beschreven in voorletters.feature + - de eerste naamcomponent in de aanschrijfwijze.naam begint met een hoofdletter + - het voorvoegsel wordt met kleine letters opgenomen + - aanduiding naamgebruik "E" (eigen naam) wordt gehanteerd voor een persoon die geen actuele en geen ontbonden huwelijken/partnerschappen heeft gehad + - de adellijke titel en het predikaat wordt opgenomen in de vorm die hoort bij de geslachtsaanduiding van de persoon: + | adellijke titel/predikaat | vrouw | man | onbekend | + | JH | jonkvrouw | jonkheer | | + | JV | jonkvrouw | jonkheer | | + | R | | ridder | | + | B | barones | baron | | + | BI | barones | baron | | + | H | hertogin | hertog | | + | HI | hertogin | hertog | | + | G | gravin | graaf | | + | GI | gravin | graaf | | + | M | markiezin | markies | | + | MI | markiezin | markies | | + | P | prinses | prins | | + | PS | prinses | prins | | + - de adellijke titel en het predikaat wordt niet opgenomen als er geen vorm is horende bij het geslacht van de persoon + - de adellijke titel en het predikaat worden met kleine letters opgenomen + - de adellijke titel of het predikaat van de partner wordt niet opgenomen bij aanduiding naamgebruik "E" (eigen naam) + - de adellijke titel of het predikaat van de persoon wordt niet opgenomen bij aanduiding naamgebruik "P" (partner naam) + - De adellijke titel van de partner wordt alleen opgenomen als geslachtsaanduiding van de persoon gelijk is aan "V" (vrouw) en de geslachtsaanduiding van de partner gelijk is aan "M" (man). + - het predikaat begint met een hoofdletter als de aanschrijfwijze begint met een predikaat + - het predikaat van de partner wordt niet opgenomen + - het predikaat van de persoon wordt opgenomen achter het streepje en voor eigen voorvoegsel en geslachtsnaam bij aanduiding naamgebruik "V" (partner naam voor eigen naam) + - bij meerdere actuele (niet ontbonden) huwelijken/partnerschappen, worden de naamgegevens van de eerste partner (oudste relatie) gebruikt voor het samenstellen van de aanschrijfwijze + - bij geen actueel huwelijk/partnerschap en meerdere ontbonden huwelijken/partnerschappen, worden de naamgegevens van de laatst ontbonden partner gebruikt voor het samenstellen van de aanschrijfwijze + + Abstract Scenario: Persoon zonder voorvoegsel, zonder adellijke titel/predikaat, zonder actuele en/of ontbonden huwelijk/geregistreerd partnerschap + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | geslachtsnaam (02.40) | Groenen | + | voornamen (02.10) | Franklin | + | aanduiding naamgebruik (61.10) | | + En de persoon heeft nooit een actueel of ontbonden huwelijk of partnerschap gehad + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze.naam | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.naam | | + + Voorbeelden: + | aanduiding naamgebruik | naam in aanschrijfwijze | + | E | F. Groenen | + | P | F. Groenen | + | V | F. Groenen | + | N | F. Groenen | + + Abstract Scenario: Persoon met voorvoegsel, zonder adellijke titel/predikaat, zonder actuele en/of ontbonden huwelijk/geregistreerd partnerschap + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | Groenen | + | voornamen (02.10) | Franklin | + | aanduiding naamgebruik (61.10) | | + En de persoon heeft nooit een actueel of ontbonden huwelijk of partnerschap gehad + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze.naam | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.naam | | + + Voorbeelden: + | voorvoegsel | aanduiding naamgebruik | naam in aanschrijfwijze | + | van | E | F. van Groenen | + | Van | P | F. van Groenen | + | in het | V | F. in het Groenen | + | In Den | N | F. in den Groenen | + + Abstract Scenario: Persoon met adellijke titel/predikaat, zonder actuele en/of ontbonden huwelijk/geregistreerd partnerschap + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + | geslachtsaanduiding (04.10) | | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + | voornamen (02.10) | | + | adellijke titel of predikaat (02.20) | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze.naam | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.naam | | + + Voorbeelden: + | geslachtsaanduiding | voornamen | voorvoegsel | geslachtsnaam | titel/predikaat | naam in aanschrijfwijze | + | M | Franklin | van den | Aedel | JH | Jonkheer F. van den Aedel | + | V | Francisca | | Groenen | JV | Jonkvrouw F. Groenen | + | M | Franklin | | Groenen | JV | Jonkheer F. Groenen | + | V | Francisca | van den | Aedel | JH | Jonkvrouw F. van den Aedel | + | M | Franklin | van den | Aedel | R | F. ridder van den Aedel | + | V | Francisca | van den | Aedel | R | F. van den Aedel | + | M | Franklin | van den | Aedel | B | F. baron van den Aedel | + | V | Francisca | | Groenen | BI | F. barones Groenen | + | M | Franklin | van den | Aedel | H | F. hertog van den Aedel | + | V | Francisca | | Groenen | HI | F. hertogin Groenen | + | M | Franklin | van den | Aedel | G | F. graaf van den Aedel | + | V | Francisca | van den | Aedel | GI | F. gravin van den Aedel | + | M | Franklin | van den | Aedel | M | F. markies van den Aedel | + | V | Francisca | van den | Aedel | M | F. markiezin van den Aedel | + | M | Franklin | van den | Aedel | P | F. prins van den Aedel | + | V | Francisca | van den | Aedel | PS | F. prinses van den Aedel | + | M | Franklin | van den | Aedel | PS | F. prins van den Aedel | + | V | Francisca | van den | Aedel | P | F. prinses van den Aedel | + | O | Franklin | van den | Aedel | M | F. van den Aedel | + + Abstract Scenario: Persoon zonder adellijke titel/predikaat, met een actuele/ontbonden partner met adellijke titel/predikaat heeft aanduiding naamgebruik "E" (eigen naam) + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + | geslachtsaanduiding (04.10) | | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | geslachtsnaam (02.40) | Groenen | + | voornamen (02.10) | | + | aanduiding naamgebruik (61.10) | E | + En de persoon heeft een partner met + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze.naam | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.naam | F. Groenen | + + Voorbeelden: + | geslachtsaanduiding | voornamen | partner type | adellijke titel of predikaat type | + | M | Franklin | actuele | adellijke titel | + | V | Francisca | ontbonden | predikaat | + | O | Franklin | actuele | predikaat | + | O | Francisca | ontbonden | adellijke titel | + + Abstract Scenario: Persoon zonder adellijke titel/predikaat heeft één actuele/ontbonden partner zonder adellijke titel/predikaat + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + | voornamen (02.10) | | + | aanduiding naamgebruik (61.10) | | + En de persoon heeft een partner met de volgende gegevens + | burgerservicenummer | 999992935 | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.naam | | + + Voorbeelden: + | voornamen | voorvoegsel | geslachtsnaam | aanduiding naamgebruik | voorvoegsel partner | geslachtsnaam partner | naam in aanschrijfwijze | + | Franklin | | Groenen | E | | Groenlo | F. Groenen | + | Franklin | | Groenen | P | | Groenlo | F. Groenlo | + | Franklin | | Groenen | V | | Groenlo | F. Groenlo-Groenen | + | Franklin | | Groenen | N | | Groenlo | F. Groenen-Groenlo | + | Henk | van | Velzen | E | | Groenlo | H. van Velzen | + | Henk | van | Velzen | P | | Groenlo | H. Groenlo | + | Henk | van | Velzen | V | | Groenlo | H. Groenlo-van Velzen | + | Henk | van | Velzen | N | | Groenlo | H. van Velzen-Groenlo | + | Franklin | | Groenen | E | van den | Aedel | F. Groenen | + | Franklin | | Groenen | P | van den | Aedel | F. van den Aedel | + | Franklin | | Groenen | V | van den | Aedel | F. van den Aedel-Groenen | + | Franklin | | Groenen | N | van den | Aedel | F. Groenen-van den Aedel | + | Henk | van | Velzen | E | van den | Aedel | H. van Velzen | + | Henk | van | Velzen | P | van den | Aedel | H. van den Aedel | + | Henk | van | Velzen | V | van den | Aedel | H. van den Aedel-van Velzen | + | Henk | van | Velzen | N | van den | Aedel | H. van Velzen-van den Aedel | + + Abstract Scenario: Persoon met adellijke titel/predikaat heeft één actuele/ontbonden partner zonder adellijke titel/predikaat + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + | geslachtsaanduiding (04.10) | | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + | voornamen (02.10) | | + | adellijke titel of predikaat (02.20) | | + | aanduiding naamgebruik (61.10) | | + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992935 | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.naam | | + + Voorbeelden: + | geslacht | voornamen | voorvoegsel | geslachtsnaam | titel/predikaat | aanduiding naamgebruik | voorvoegsel partner | geslachtsnaam partner | naam in aanschrijfwijze | + | M | Franklin | | Groenen | JH | E | | Groenlo | Jonkheer F. Groenen | + | M | Franklin | | Groenen | JH | P | | Groenlo | F. Groenlo | + | M | Franklin | | Groenen | JH | V | | Groenlo | F. Groenlo-jonkheer Groenen | + | M | Franklin | | Groenen | JH | N | | Groenlo | Jonkheer F. Groenen-Groenlo | + | M | Henk | van | Velzen | B | E | | Groenlo | H. baron van Velzen | + | M | Henk | van | Velzen | B | P | | Groenlo | H. Groenlo | + | M | Henk | van | Velzen | B | V | | Groenlo | H. Groenlo-baron van Velzen | + | M | Henk | van | Velzen | B | N | | Groenlo | H. baron van Velzen-Groenlo | + + Abstract Scenario: Persoon zonder adellijke titel/predikaat heeft één actuele/ontbonden partner met adellijke titel + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + | geslachtsaanduiding (04.10) | | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + | voornamen (02.10) | | + | aanduiding naamgebruik (61.10) | | + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992935 | + | geslachtsaanduiding (04.10) | | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + | adellijke titel of predikaat (02.20) | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.naam | | + + Voorbeelden: + | geslacht | voornamen | voorvoegsel | geslachtsnaam | aanduiding naamgebruik | voorvoegsel partner | geslacht partner | geslachtsnaam partner | adellijke titel partner | naam in aanschrijfwijze | + | M | Franklin | | Groenen | E | | V | Groenlo | MI | F. Groenen | + | M | Franklin | | Groenen | P | | V | Groenlo | MI | F. Groenlo | + | M | Franklin | | Groenen | V | | V | Groenlo | MI | F. Groenlo-Groenen | + | M | Franklin | | Groenen | N | | V | Groenlo | MI | F. Groenen-Groenlo | + | V | Julia | van | Velzen | E | | M | Groenlo | G | J. van Velzen | + | V | Julia | van | Velzen | P | | M | Groenlo | G | J. gravin Groenlo | + | V | Julia | van | Velzen | V | | M | Groenlo | G | J. gravin Groenlo-van Velzen | + | V | Julia | van | Velzen | N | | M | Groenlo | G | H. van Velzen-gravin Groenlo | + | V | Julia | van | Velzen | V | | V | Groenlo | GI | J. Groenlo-van Velzen | + | M | Franklin | | Groenen | N | | M | Groenlo | M | F. Groenen-Groenlo | + | O | Julia | van | Velzen | N | | M | Groenlo | G | J. van Velzen-Groenlo | + | V | Julia | van | Velzen | P | | M | Groenlo | R | J. Groenlo | + + Abstract Scenario: Persoon zonder adellijke titel/predikaat heeft één actuele/ontbonden partner met predikaat + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + | geslachtsaanduiding (04.10) | | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + | voornamen (02.10) | | + | aanduiding naamgebruik (61.10) | | + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992935 | + | geslachtsaanduiding (04.10) | | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + | adellijke titel of predikaat (02.20) | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.naam | | + + Voorbeelden: + | geslacht | voornamen | voorvoegsel | geslachtsnaam | aanduiding naamgebruik | voorvoegsel partner | geslacht partner | geslachtsnaam partner | predikaat partner | naam in aanschrijfwijze | + | M | Franklin | | Groenen | E | | V | Groenlo | JV | F. Groenen | + | M | Franklin | | Groenen | N | | V | Groenlo | JV | F. Groenen-Groenlo | + | M | Henk | van | Velzen | P | | V | Groenlo | JV | H. Groenlo | + | M | Henk | van | Velzen | V | | V | Groenlo | JV | H. Groenlo-van Velzen | + | V | Julia | van | Velzen | E | | M | Groenlo | JH | J. van Velzen | + | V | Julia | van | Velzen | P | | M | Groenlo | JH | J. Groenlo | + | V | Julia | van | Velzen | V | | M | Groenlo | JH | J. Groenlo-van Velzen | + | V | Julia | van | Velzen | N | | M | Groenlo | JH | H. van Velzen-Groenlo | + | M | Franklin | van | Velzen | P | | M | Groenlo | JH | F. Groenlo | + | V | Julia | van | Velzen | V | | V | Groenlo | JV | J. Groenlo-van Velzen | + | O | Julia | van | Velzen | N | | M | Groenlo | JH | J. van Velzen-Groenlo | + + Abstract Scenario: Persoon met adellijke titel/predikaat heeft één actuele/ontbonden partner met adellijke titel + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + | geslachtsaanduiding (04.10) | | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + | voornamen (02.10) | | + | aanduiding naamgebruik (61.10) | | + | adellijke titel of predikaat (02.20) | | + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992935 | + | geslachtsaanduiding (04.10) | | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + | adellijke titel of predikaat (02.20) | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.naam | | + + Voorbeelden: + | geslacht | voornamen | geslachtsnaam | adellijke titel/predikaat | aanduiding naamgebruik | geslacht partner | geslachtsnaam partner | adellijke titel partner | naam in aanschrijfwijze | + | M | Franklin | Groenen | G | E | V | Groenlo | MI | F. graaf Groenen | + | M | Franklin | Groenen | G | P | V | Groenlo | MI | F. Groenlo | + | M | Franklin | Groenen | G | V | V | Groenlo | MI | F. Groenlo-graaf Groenen | + | M | Franklin | Groenen | G | N | V | Groenlo | MI | F. graaf Groenen-Groenlo | + | V | Francisca | Groenen | GI | E | M | Groenlo | M | F. gravin Groenen | + | V | Francisca | Groenen | GI | P | M | Groenlo | M | F. markiezin Groenlo | + | V | Francisca | Groenen | GI | V | M | Groenlo | M | F. markiezin Groenlo-gravin Groenen | + | V | Francisca | Groenen | GI | N | M | Groenlo | M | F. gravin Groenen-markiezin Groenlo | + + Abstract Scenario: Persoon met meerdere actuele partners + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | geslachtsnaam (02.40) | Groen | + | voornamen (02.10) | Ferdinand Cornelis | + | aanduiding naamgebruik (61.10) | | + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992935 | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | Geel | + En de partner heeft de volgende aangaanHuwelijkPartnerschap gegevens + | naam | waarde | + | datum aangaan (06.10) | 19580401 | + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992936 | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | Roodt | + En de partner heeft de volgende aangaanHuwelijkPartnerschap gegevens + | naam | waarde | + | datum aangaan (06.10) | 19610831 | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.naam | | + + Voorbeelden: + | aanduiding naamgebruik | naam in aanschrijfwijze | + | E | F.C. Groen | + | P | F.C. Geel | + | V | F.C. Geel-Groen | + | N | F.C. Groen-Geel | + + Abstract Scenario: Persoon met meerdere ontbonden partners + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | Wit | + | voornamen (02.10) | Jan | + | aanduiding naamgebruik (61.10) | | + En de laatst ontbonden partner van de persoon heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | Geel | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.naam | | + + Voorbeelden: + | aanduiding naamgebruik | naam in aanschrijfwijze | + | E | J. Wit | + | P | J. Geel | + | V | J. Geel-Wit | + | N | J. Wit-Geel | + + Abstract Scenario: persoon heeft een naamketen + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + | geslachtsaanduiding | | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | voornamen (02.10) | | + | adellijke titel of predikaat (02.20) | | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + | aanduidingNaamgebruik (61.10) | | + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992935 | + | geslachtsaanduiding (04.10) | | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | van | + | geslachtsnaam (02.40) | Velzen | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.naam | | + + Voorbeelden: + | geslacht | geslachtsnaam | naamgebruik | geslacht partner | naam in aanschrijfwijze | + | M | Ali bin Mohammed | E | V | Ali bin Mohammed | + | M | Ali bin Mohammed | P | V | Van Velzen | + | M | Ali bin Mohammed | V | V | Van Velzen-Ali bin Mohammed | + | M | Ali bin Mohammed | N | V | Ali bin Mohammed-van Velzen | + | V | Ibin binti Yalniz | E | M | Ibin binti Yalniz | + | V | Ibin binti Yalniz | P | M | Van Velzen | + | V | Ibin binti Yalniz | V | M | Van Velzen-Ibin binti Yalniz | + | V | Ibin binti Yalniz | N | M | Ibin binti Yalniz-van Velzen | + | O | Ali bin Mohammed | E | V | Ali bin Mohammed | + | O | Ali bin Mohammed | P | M | Van Velzen | + | O | Ibin binti Yalniz | V | V | Van Velzen-Ibin binti Yalniz | + | O | Ibin binti Yalniz | N | M | Ibin binti Yalniz-van Velzen | + + Abstract Scenario: persoon met een naamketen heeft een partner met adellijke titel + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + | geslachtsaanduiding | | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | voornamen (02.10) | | + | adellijke titel of predikaat (02.20) | | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + | aanduidingNaamgebruik (61.10) | | + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992935 | + | geslachtsaanduiding (04.10) | | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel (02.30) | van | + | geslachtsnaam (02.40) | Velzen | + | adellijke titel of predikaat (02.20) | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.naam | | + + Voorbeelden: + | geslacht | geslachtsnaam | naamgebruik | geslacht partner | adellijke titel partner | naam in aanschrijfwijze | + | M | Ali bin Mohammed | E | V | BI | Ali bin Mohammed | + | M | Ali bin Mohammed | P | V | GI | Van Velzen | + | M | Ali bin Mohammed | V | V | MI | Van Velzen-Ali bin Mohammed | + | M | Ali bin Mohammed | N | V | HI | Ali bin Mohammed-van Velzen | + | V | Ibin binti Yalniz | E | M | B | Ibin binti Yalniz | + | V | Ibin binti Yalniz | P | M | G | Gravin van Velzen | + | V | Ibin binti Yalniz | V | M | H | Hertogin van Velzen-Ibin binti Yalniz | + | V | Ibin binti Yalniz | N | M | M | Ibin binti Yalniz-markiezin van Velzen | + | O | Ali bin Mohammed | E | V | BI | Ali bin Mohammed | + | O | Ali bin Mohammed | P | M | G | Van Velzen | + | O | Ibin binti Yalniz | V | V | MI | Van Velzen-Ibin binti Yalniz | + | O | Ibin binti Yalniz | N | M | H | Ibin binti Yalniz-van Velzen | + + Rule: de aanspreekvorm in aanschrijfwijze wordt als volgt samengesteld: + | adellijke titel/predikaat | vrouw | man | onbekend | + | JH | De hoogwelgeboren vrouwe | De hoogwelgeboren heer | | + | JV | De hoogwelgeboren vrouwe | De hoogwelgeboren heer | | + | R | De hoogwelgeboren vrouwe | De hoogwelgeboren heer | | + | B | De hoogwelgeboren vrouwe | De hoogwelgeboren heer | | + | BI | De hoogwelgeboren vrouwe | De hoogwelgeboren heer | | + | H | De hoogwelgeboren vrouwe | De hoogwelgeboren heer | | + | HI | De hoogwelgeboren vrouwe | De hoogwelgeboren heer | | + | G | De hooggeboren vrouwe | De hooggeboren heer | | + | GI | De hooggeboren vrouwe | De hooggeboren heer | | + | M | De hoogwelgeboren vrouwe | De hoogwelgeboren heer | | + | MI | De hoogwelgeboren vrouwe | De hoogwelgeboren heer | | + | P | De hoogheid | De hoogheid | De hoogheid | + | PS | De hoogheid | De hoogheid | De hoogheid | + toelichting: + - er is geen aanspreekvorm als: + - de persoon geen adellijke titel/predikaat heeft + - de persoon gebruikt aanduiding naamgebruik "P" (naam partner) + - er geen adellijke titel/predikaat vorm is die hoort bij de geslachtsaanduiding van de persoon + - de persoon een predikaat, de geslachtsaanduiding "V" (vrouw) en een actuele (niet ontbonden) partner heeft + - de persoon een predikaat, de geslachtsaanduiding "V" (vrouw), geen actuele (maar mogelijk wel ontbonden) partner en een aanduiding naamgebruik ongelijk aan "E" (eigen naam) heeft + + Abstract Scenario: Persoon heeft geen adellijke titel/predikaat + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | geslachtsnaam (02.40) | Groenen | + | voornamen (02.10) | Franklin | + | aanduiding naamgebruik (61.10) | | + En de persoon heeft nooit een actueel of ontbonden huwelijk of partnerschap gehad + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze.aanspreekvorm | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.aanspreekvorm | | + + Voorbeelden: + | aanduiding naamgebruik | + | E | + | P | + | V | + | N | + + Abstract Scenario: Persoon heeft adellijke titel/predikaat en gebruikt aanduiding naamgebruik "P" + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + | geslachtsaanduiding (04.10) | | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | adellijke titel of predikaat (02.20) | | + | aanduiding naamgebruik (61.10) | | + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992935 | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | adellijke titel of predikaat (02.20) | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze.aanspreekvorm | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.aanspreekvorm | | + + Voorbeelden: + | geslachtsaanduiding | aanduiding naamgebruik | titel/predikaat | titel/predikaat partner | aanspreekvorm | + | M | E | JH | | De hoogwelgeboren heer | + | M | P | R | GI | | + | M | V | R | | De hoogwelgeboren heer | + | M | N | B | BI | De hoogwelgeboren heer | + | M | E | H | | De hoogwelgeboren heer | + | M | P | G | GI | | + | M | V | G | BI | De hoogwelgeboren heer | + | M | N | M | | De hoogwelgeboren heer | + | M | E | P | | De hoogheid | + | V | E | JV | | De hoogwelgeboren vrouwe | + | V | P | BI | | | + | V | V | BI | BI | De hoogwelgeboren vrouwe | + | V | N | HI | GI | De hoogwelgeboren vrouwe | + | V | E | GI | | De hoogwelgeboren vrouwe | + | V | P | MI | GI | | + | V | V | MI | BI | De hoogwelgeboren vrouwe | + | V | N | PS | | De hoogheid | + + Abstract Scenario: Persoon heeft geslachtsaanduiding O en heeft een adellijke titel/predikaat + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + | geslachtsaanduiding (04.10) | O | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | adellijke titel of predikaat (02.20) | | + | aanduiding naamgebruik (61.10) | E | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze.aanspreekvorm | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.aanspreekvorm | | + + Voorbeelden: + | titel/predikaat | aanspreekvorm | + | JH | | + | JV | | + | R | | + | B | | + | BI | | + | H | | + | HI | | + | G | | + | GI | | + | M | | + | MI | | + | P | De hoogheid | + | PS | De hoogheid | + + Abstract Scenario: Persoon heeft een predikaat, heeft geslachtsaanduiding "V" en heeft een actuele partner + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + | geslachtsaanduiding (04.10) | V | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | adellijke titel of predikaat (02.20) | | + | aanduiding naamgebruik (61.10) | | + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992935 | + En de partner heeft de volgende aangaanHuwelijkPartnerschap gegevens + | naam | waarde | + | datum aangaan (06.10) | 19580401 | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze.aanspreekvorm | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.aanspreekvorm | | + + Voorbeelden: + | predikaat | aanduiding naamgebruik | + | JH | E | + | JH | P | + | JH | V | + | JH | N | + | JV | E | + | JV | P | + | JV | V | + | JV | N | + + Abstract Scenario: Persoon heeft een predikaat, heeft geslachtsaanduiding "V" en heeft geen actuele partner(s) + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + | geslachtsaanduiding (04.10) | V | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | adellijke titel of predikaat (02.20) | | + | aanduiding naamgebruik (61.10) | | + En de persoon heeft alleen ontbonden partners + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam.aanschrijfwijze.aanspreekvorm | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'naam' gegevens + | naam | waarde | + | aanschrijfwijze.aanspreekvorm | | + + Voorbeelden: + | predikaat | aanduiding naamgebruik | aanspreekvorm | + | JH | E | De hoogwelgeboren vrouwe | + | JH | P | | + | JH | V | | + | JH | N | | + | JV | E | De hoogwelgeboren vrouwe | + | JV | P | | + | JV | V | | + | JV | N | | diff --git a/features/adres.feature b/features/adres.feature index a8b4ca714..97bb05af7 100644 --- a/features/adres.feature +++ b/features/adres.feature @@ -1,73 +1,62 @@ # language: nl +@skip-verify Functionaliteit: Adresvelden vullen Rule: Voor een binnenlands adres wordt veld "straat" gevuld met de naam openbare ruimte (11.15) wanneer die bekend is, en anders met straatnaam (11.10). Veld "korteNaam" wordt gevuld met straatnaam (11.10). Abstract Scenario: opnemen straat bij een binnenlands adres - Gegeven persoon met burgerservicenummer "{burgerservicenummer}" heeft de volgende gegevens bij verblijfplaats: - | straatnaam (11.10) | {straatnaam} | - | naam openbare ruimte (11.15) | {naam openbare ruimte} | - Als persoon met burgerservicenummer "{burgerservicenummer}" wordt opgevraagd met fields=verblijfplaats.straat,verblijfplaats.korteNaam - Dan bevat in het antwoord verblijfplaats: - """ - { - "straat": "{straat}", - "korteNaam": "{korteNaam}" - } - """ + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | identificatie | 4cbcf7fd-d788-4be5-8ebc-17decde26131 | + | burgerservicenummer | | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | + | straatnaam (11.10) | | + | naam openbare ruimte (11.15) | | + Als personen wordt geraadpleegd met de volgende parameters + | naam | waarde | + | persoonIdentificatie | 4cbcf7fd-d788-4be5-8ebc-17decde26131 | + | fields | verblijfplaats.straat,verblijfplaats.korteNaam | + Dan bevat de persoon met burgerservicenummer '' de volgende verblijfplaats gegevens + | naam | waarde | + | straat | | + | korteNaam | | Voorbeelden: | burgerservicenummer | straatnaam | naam openbare ruimte | straat | korteNaam | | 999995492 | Kappeyne v d Cappellostr | Annelien Kappeyne van de Coppellostraat | Annelien Kappeyne van de Coppellostraat | Kappeyne v d Cappellostr | | 999991802 | Zomerdijkstrtaat | | Zomerdijkstrtaat | Zomerdijkstrtaat | - - Scenario: persoon verblijft in het buitenland - Gegeven persoon met burgerservicenummer "999993483" heeft de volgende gegevens bij verblijfplaats: - | gemeente van inschrijving (09.10) | 1999 | - | land adres buitenland (13.10) | 5010 | - | regel 1 adres buitenland (13.30) | Rue du pomme 25 | - | regel 2 adres buitenland (13.40) | Bruxelles | - | regel 3 adres buitenland (13.50) | postcode 1000 | - En element woonplaatsnaam (11.70) heeft geen waarde - Als persoon met burgerservicenummer "{burgerservicenummer}" wordt opgevraagd met fields=verblijfplaats.woonplaats,verblijfplaats.gemeenteVanInschrijving - Dan bevat in het antwoord de verblijfplaats GEEN veld "straat" - En bevat in het antwoord de verblijfplaats GEEN veld "korteNaam" Rule: Voor een binnenlands adres wordt veld "woonplaats" gevuld met de woonplaatsnaam (11.70) wanneer die bekend is, en anders met de omschrijving van de gemeente van inschrijving (09.10 via tabel 33 Gemeententabel). Abstract Scenario: opnemen woonplaats binnenlands adres - Gegeven persoon met burgerservicenummer "{burgerservicenummer}" heeft de volgende gegevens bij verblijfplaats: + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | identificatie | 4cbcf7fd-d788-4be5-8ebc-17decde26131 | + | burgerservicenummer | | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | | gemeente van inschrijving (09.10) | 0518 | - | woonplaatsnaam (11.70) | {woonplaatsnaam} | - Als persoon met burgerservicenummer "{burgerservicenummer}" wordt opgevraagd met fields=verblijfplaats.woonplaats,verblijfplaats.gemeenteVanInschrijving - Dan bevat in het antwoord verblijfplaats: - """ - { - "gemeenteVanInschrijving": { - "code": "0518", - "omschrijving": "'s-Gravenhage" - }, - "woonplaats": "{woonplaats}" - } - """ + | woonplaatsnaam (11.70) | | + En de waardetabel 'Gemeenten' heeft de volgende waarden + | code | omschrijving | + | 0518 | 's-Gravenhage | + Als personen wordt geraadpleegd met de volgende parameters + | naam | waarde | + | persoonIdentificatie | 4cbcf7fd-d788-4be5-8ebc-17decde26131 | + | fields | verblijfplaats.woonplaats,verblijfplaats.gemeenteVanInschrijving | + Dan bevat de persoon met burgerservicenummer '' de volgende verblijfplaats gegevens + | naam | waarde | + | gemeenteVanInschrijving.code | 0518 | + | gemeenteVanInschrijving.omschrijving | 's-Gravenhage | + | woonplaats | | Voorbeelden: | burgerservicenummer | woonplaatsnaam | woonplaats | | 999992922 | Scheveningen | Scheveningen | | 999990639 | | 's-Gravenhage | - Scenario: persoon verblijft in het buitenland - Gegeven persoon met burgerservicenummer "999993483" heeft de volgende gegevens bij verblijfplaats: - | gemeente van inschrijving (09.10) | 1999 | - | land adres buitenland (13.10) | 5010 | - | regel 1 adres buitenland (13.30) | Rue du pomme 25 | - | regel 2 adres buitenland (13.40) | Bruxelles | - | regel 3 adres buitenland (13.50) | postcode 1000 | - En element woonplaatsnaam (11.70) heeft geen waarde - Als persoon met burgerservicenummer "{burgerservicenummer}" wordt opgevraagd met fields=verblijfplaats.woonplaats,verblijfplaats.gemeenteVanInschrijving - Dan bevat in het antwoord de verblijfplaats GEEN veld "woonplaatsnaam" - Rule: Voor een binnenlands adres wordt adresregel1 samengesteld conform NEN 5825:2002. # Veld adresregel1 wordt samengesteld uit locatiebeschrijving + korteNaam + aanduidingBijHuisnummer + huisnummer + huisletter + huisnummertoevoeging @@ -75,22 +64,27 @@ Functionaliteit: Adresvelden vullen # Tussen kortenaam en huisnummer wordt een spatie opgenomen # Tussen het huisnummer en de huisnummertoevoeging (wat in de NEN een samenstelling is van huisletter en huisnummertoevoeging, niet gecheiden van elkaar) moet een koppelteken ("-") worden geplaatst indien de huisnummertoevoeging met een cijfer begint, een spatie in alle andere gevallen - Abstract Scenario: adresregel1 voor een binnenlands adres met {omschrijving} - Gegeven persoon met burgerservicenummer "{burgerservicenummer}" heeft de volgende gegevens bij verblijfplaats: - | straatnaam (11.10) | {straatnaam} | - | naam openbare ruimte (11.15) | {naam openbare ruimte} | - | huisnummer (11.20) | {huisnummer} | - | huisletter (11.30) | {huisletter} | - | huisnummertoevoeging (11.40) | {huinummertoevoeging} | - | aanduiding bij huisnummer (11.50) | {aanduiding bij huisnummer} | - | locatiebeschrijving (12.10) | {locatiebeschrijving} | - Als persoon met burgerservicenummer "{burgerservicenummer}" wordt opgevraagd met fields=verblijfplaats.adresregel1,verblijfplaats.adresregel3,verblijfplaats.land - Dan bevat in het antwoord verblijfplaats: - """ - { - "adresregel1": "{adresregel1}" - } - """ + Abstract Scenario: adresregel1 voor een binnenlands adres met + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | identificatie | 4cbcf7fd-d788-4be5-8ebc-17decde26131 | + | burgerservicenummer | | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | + | straatnaam (11.10) | | + | naam openbare ruimte (11.15) | | + | huisnummer (11.20) | | + | huisletter (11.30) | | + | huisnummertoevoeging (11.40) | | + | aanduiding bij huisnummer (11.50) | | + | locatiebeschrijving (12.10) | | + Als personen wordt geraadpleegd met de volgende parameters + | naam | waarde | + | persoonIdentificatie | 4cbcf7fd-d788-4be5-8ebc-17decde26131 | + | fields | verblijfplaats.adresregel1,verblijfplaats.adresregel3,verblijfplaats.land | + Dan bevat de persoon met burgerservicenummer '' de volgende verblijfplaats gegevens + | naam | waarde | + | adresregel1 | | Voorbeelden: | omschrijving | burgerservicenummer | straatnaam | naam openbare ruimte | huisnummer | huisletter | huinummertoevoeging | aanduiding bij huisnummer | locatiebeschrijving | adresregel1 | @@ -111,19 +105,24 @@ Functionaliteit: Adresvelden vullen # Tussen postcode alfabetisch deel en woonplaatsnaam moeten twee spaties worden geplaatst # De woonplaatsnaam wordt in hoofdletters geschreven - Abstract Scenario: adresregel2 voor een binnenlands {omschrijving} - Gegeven persoon met burgerservicenummer "{burgerservicenummer}" heeft de volgende gegevens bij verblijfplaats: + Abstract Scenario: adresregel2 voor een binnenlandse verblijfplaats met + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | identificatie | 4cbcf7fd-d788-4be5-8ebc-17decde26131 | + | burgerservicenummer | | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | | gemeente van inschrijving (09.10) | 0518 | - | postcode (11.60) | {postcode} | - | woonplaatsnaam (11.70) | {woonplaatsnaam} | - | locatiebeschrijving (12.10) | {locatiebeschrijving} | - Als persoon met burgerservicenummer "{burgerservicenummer}" wordt opgevraagd met fields=verblijfplaats.adresregel2,verblijfplaats.adresregel3,verblijfplaats.land - Dan bevat in het antwoord verblijfplaats: - """ - { - "adresregel2": "{adresregel2}" - } - """ + | postcode (11.60) | | + | woonplaatsnaam (11.70) | | + | locatiebeschrijving (12.10) | | + Als personen wordt geraadpleegd met de volgende parameters + | naam | waarde | + | persoonIdentificatie | 4cbcf7fd-d788-4be5-8ebc-17decde26131 | + | fields | verblijfplaats.adresregel2,verblijfplaats.adresregel3,verblijfplaats.land | + Dan bevat de persoon met burgerservicenummer '' de volgende verblijfplaats gegevens + | naam | waarde | + | adresregel2 | | Voorbeelden: | omschrijving | burgerservicenummer | woonplaatsnaam | postcode | locatiebeschrijving | adresregel2 | @@ -131,62 +130,80 @@ Functionaliteit: Adresvelden vullen | geen woonplaatsnaam | 999990639 | | 2584BZ | | 2584 BZ 'S-GRAVENHAGE | | locatiebeschrijving | 000009921 | | | Woonboot in de Grote Sloot | 'S-GRAVENHAGE | - Rule: Voor een buitenlands adres worden de adresregels en land gevuld uit de gegevens over verblijf buitenland (groep 13) Scenario: persoon verblijft in het buitenland - Gegeven persoon met burgerservicenummer "999993483" heeft de volgende gegevens bij verblijfplaats: + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | identificatie | 4cbcf7fd-d788-4be5-8ebc-17decde26131 | + | burgerservicenummer | 999993483 | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | | gemeente van inschrijving (09.10) | 1999 | | land adres buitenland (13.10) | 5010 | | regel 1 adres buitenland (13.30) | Rue du pomme 25 | | regel 2 adres buitenland (13.40) | Bruxelles | | regel 3 adres buitenland (13.50) | postcode 1000 | - En element woonplaatsnaam (11.70) heeft geen waarde - Als persoon met burgerservicenummer "{burgerservicenummer}" wordt opgevraagd met fields=verblijfplaats.woonplaats,verblijfplaats.gemeenteVanInschrijving - Dan bevat in het antwoord verblijfplaats: - """ - { - "adresregel1": "Rue du pomme 25", - "adresregel2": "Bruxelles", - "adresregel3": "postcode 1000", - "land": { - "code": "5010", - "omschrijving": "België" - } - } - """ + En de waardetabel 'Landen' heeft de volgende waarden + | code | omschrijving | + | 5010 | België | + Als personen wordt geraadpleegd met de volgende parameters + | naam | waarde | + | persoonIdentificatie | 4cbcf7fd-d788-4be5-8ebc-17decde26131 | + | fields | verblijfplaats | + Dan bevat de persoon met burgerservicenummer '999993483' de volgende verblijfplaats gegevens + | naam | waarde | + | type | VerblijfplaatsBuitenland | + | adresregel1 | Rue du pomme 25 | + | adresregel2 | Bruxelles | + | adresregel3 | postcode 1000 | + | land.code | 5010 | + | land.omschrijving | België | + | gemeenteVanInschrijving | 1999 | Rule: Als het adres in het buitenland onbekend is (land adres buitenland 13.10 heeft de waarde "0000"), worden land en de adresregels niet opgenomen, en wordt vertrokkenOnbekendWaarheen opgenomen met de waarde true. Scenario: adres buitenland is onbekend - Gegeven persoon met burgerservicenummer "999993586" heeft de volgende gegevens bij verblijfplaats: - | gemeente van inschrijving (09.10) | 0518 | - | land adres buitenland (13.10) | 0000 | - | regel 1 adres buitenland (13.30) | | - | regel 2 adres buitenland (13.40) | | - | regel 3 adres buitenland (13.50) | | - Als persoon met burgerservicenummer "999993586" wordt opgevraagd met fields=verblijfplaats - Dan bevat in het antwoord verblijfplaats: - """ - { - "vertrokkenOnbekendWaarheen": true - } - """ - En bevat in het antwoord de verblijfplaats GEEN veld "adresregel1" - En bevat in het antwoord de verblijfplaats GEEN veld "adresregel2" - En bevat in het antwoord de verblijfplaats GEEN veld "adresregel3" - En bevat in het antwoord de verblijfplaats GEEN veld "land" + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | identificatie | 4cbcf7fd-d788-4be5-8ebc-17decde26131 | + | burgerservicenummer | 999993586 | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | + | gemeente van inschrijving (09.10) | 0518 | + | land adres buitenland (13.10) | 0000 | + | regel 1 adres buitenland (13.30) | | + | regel 2 adres buitenland (13.40) | | + | regel 3 adres buitenland (13.50) | | + Als personen wordt geraadpleegd met de volgende parameters + | naam | waarde | + | persoonIdentificatie | 4cbcf7fd-d788-4be5-8ebc-17decde26131 | + | fields | verblijfplaats | + Dan bevat de persoon met burgerservicenummer '999993586' de volgende verblijfplaats gegevens + | naam | waarde | + | type | VerblijfOnbekend | + | vertrokkenOnbekendWaarheen | true | Rule: Voor een binnenlandse verblijfplaats worden adresregel3 en land niet opgenomen - Abstract Scenario: persoon verblijft met een {omschrijving} in Nederland - Gegeven persoon met burgerservicenummer "{burgerservicenummer}" heeft de volgende gegevens bij verblijfplaats: - | straatnaam (11.10) | {straatnaam} | - | locatiebeschrijving (12.10) | {locatiebeschrijving} | - Als persoon met burgerservicenummer "{burgerservicenummer}" wordt opgevraagd met fields=verblijfplaats.adresregel1,verblijfplaats.adresregel3,verblijfplaats.land - Dan bevat in het antwoord de verblijfplaats GEEN veld "adresregel3" - En bevat in het antwoord de verblijfplaats GEEN veld "land" - En bevat in het antwoord de verblijfplaats GEEN veld "vertrokkenOnbekendWaarheen" + Abstract Scenario: persoon verblijft met een in Nederland + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | identificatie | 4cbcf7fd-d788-4be5-8ebc-17decde26131 | + | burgerservicenummer | | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | + | straatnaam (11.10) | | + | locatiebeschrijving (12.10) | | + Als personen wordt geraadpleegd met de volgende parameters + | naam | waarde | + | persoonIdentificatie | 4cbcf7fd-d788-4be5-8ebc-17decde26131 | + | fields | verblijfplaats.adresregel1,verblijfplaats.adresregel3,verblijfplaats.land | + Dan bevat de persoon met burgerservicenummer '' de volgende verblijfplaats gegevens NIET + | naam | + | adresregel3 | + | land | + | vertrokkenOnbekendWaarheen | Voorbeelden: | omschrijving | burgerservicenummer | straatnaam | locatiebeschrijving | diff --git a/features/fields_extensie.feature b/features/fields_extensie.feature index dc29174e5..d026a216c 100644 --- a/features/fields_extensie.feature +++ b/features/fields_extensie.feature @@ -11,57 +11,116 @@ Functionaliteit: Aanpasbare representatie met de fields parameter - 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 + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999994086 | + En de persoon heeft de volgende geboorte gegevens + | naam | waarde | + | datum (01.03.10) | 19860401 | + | land.code | 6030 | + | plaats.code | 0518 | + | inOnderzoek.aanduidingGegevensInOnderzoek | TODO | + | inOnderzoek.datum | 20200601 | + En het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999993483 | + | geheimhoudingPersoonsgegevens | 7 | + En de persoon heeft de volgende geboorte gegevens + | naam | waarde | + | plaats.code | 0518 | + En het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992077 | + En de persoon heeft de volgende geboorte gegevens + | naam | waarde | + | plaats.code | 0518 | + En de persoon heeft de volgende overlijden gegevens + | naam | waarde | + | TODO | TODO | + En de persoon heeft de volgende opschortingBijhouding gegevens + | naam | waarde | + | reden.code | overlijden | + | datum | 20151001 | + En de waardetabel 'Gemeenten' heeft de volgende waarden + | code | omschrijving | + | 0518 | 's-Gravenhage | + En de waardetabel 'Landen' heeft de volgende waarden + | code | omschrijving | + | 6030 | Nederland | - 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: geboortedatum is in onderzoek en geboorte wordt gevraagd met de fields parameter + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999994086 | + | fields | geboorte | + Dan bevat de persoon met burgerservicenummer '999994086' de volgende geboorte gegevens + | naam | waarde | + | datum.type | Datum | + | datum.datum | 1986-04-01 | + | land.code | 6030 | + | land.omschrijving | Nederland | + | plaats.code | 0518 | + | plaats.omschrijving | 's-Gravenhage | + | inOnderzoek.datumIngangOnderzoek | 2020-06-01 | + | inOnderzoek.datum | true | + | inOnderzoek.land | | + | inOnderzoek.plaats | | - 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: geboortedatum is in onderzoek en geboortedatum wordt gevraagd met de fields parameter + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999994086 | + | fields | geboorte.datum | + Dan bevat de persoon met burgerservicenummer '999994086' de volgende geboorte gegevens + | naam | waarde | + | datum.type | Datum | + | datum.datum | 1986-04-01 | + | inOnderzoek.datumIngangOnderzoek | 2020-06-01 | + | inOnderzoek.datum | true | - 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: geboortedatum is in onderzoek en een ander gegeven in de gegevens groep wordt gevraagd met de fields parameter + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999994086 | + | fields | geboorte.plaats | + Dan bevat de persoon met burgerservicenummer '999994086' de volgende geboorte gegevens + | naam | waarde | + | plaats.code | 0518 | + | plaats.omschrijving | 's-Gravenhage | + En bevat de persoon met burgerservicenummer '999994086' de volgende geboorte gegevens NIET + | naam | + | inOnderzoek | - 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: persoon heeft geheimhouding en andere gegevens wordt gevraagd met de fields parameter + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999993483 | + | fields | geboorte.plaats | + Dan bevat de persoon met burgerservicenummer '999993483' de volgende gegevens + | naam | waarde | + | geheimhoudingPersoonsgegevens | true | + En bevat de persoon met burgerservicenummer '999994086' de volgende geboorte gegevens + | naam | waarde | + | plaats.code | 0518 | + | plaats.omschrijving | 's-Gravenhage | - 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 + Scenario: persoon heeft opschorting bijhouding en andere gegevens wordt gevraagd met de fields parameter + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992077 | + | fields | geboorte.plaats | + Dan bevat de persoon met burgerservicenummer '999992077' de volgende geboorte gegevens + | naam | waarde | + | plaats.code | 0518 | + | plaats.omschrijving | 's-Gravenhage | + En bevat de persoon met burgerservicenummer '999992077' de volgende opschortingBijhouding gegevens + | naam | waarde | + | reden.code | overlijden | + | reden.datum.datum | 2015-10-01 | + | reden.datum.type | Datum | + En bevat de persoon met burgerservicenummet '999992077' geen overlijden gegevens diff --git a/features/historie_links.feature b/features/historie_links.feature deleted file mode 100644 index acce4cd53..000000000 --- a/features/historie_links.feature +++ /dev/null @@ -1,47 +0,0 @@ -# language: nl - -Functionaliteit: Links naar historie resources van een persoon - Als gebruiker van de bevragingen personen API wil ik bij een persoon hyperlinks naar de historische resources van de persoon, - zodat ik deze makkelijk kan vinden (discoverability) en gebruiken. - - In de _links van een persoon kunnen links worden opgenomen naar de historische resources van dezelfde persoon. - - Wanneer de API "Historie personen" beschikbaar is, MOET de resource ingeschrevenpersonen de volgende links bevatten naar historische resources: - - partnerhistorie - - verblijfsplaatsenhistorie - - verblijfstitelshistorie - - nationaliteithistorie - - Wanneer de API "Historie personen" NIET beschikbaar is, mag de resource ingeschrevenpersonen GEEN links bevatten naar historische resources. - - Scenario: historie-API is beschikbaar en resource wordt geraadpleegd - Gegeven de API "Historie personen" is beschikbaar - En de te raadplegen persoon heeft een actuele partner - Als persoon met burgerservicenummer 999999102 wordt geraadpleegd zonder fields-parameter - Dan bevat het antwoord _links.partnerhistorie.href met een waarde - En bevat het antwoord _links.verblijfplaatsenhistorie.href met een waarde - En bevat het antwoord _links.verblijfstitelshistorie.href met een waarde - En eindigt attribuut _links.partnerhistorie.href met /api/bevragingen_ingeschreven_personen/v1/historie/ingeschrevenpersonen/999999102/partners - En eindigt attribuut _links.verblijfplaatsenhistorie.href met /api/bevragingen_ingeschreven_personen/v1/historie/ingeschrevenpersonen/999999102/verblijfplaatsen - En eindigt attribuut _links.verblijfstitelshistorie.href met /api/bevragingen_ingeschreven_personen/v1/historie/ingeschrevenpersonen/999999102/verblijfstitels - - Scenario: historie-API is NIET beschikbaar en resource wordt geraadpleegd - Gegeven de API "Historie personen" is niet beschikbaar - Als persoon met burgerservicenummer 999999102 wordt geraadpleegd zonder fields-parameter - Dan is in het antwoord attribuut _links.partnerhistorie null, leeg of afwezig - En is in het antwoord attribuut _links.verblijfplaatsenhistorie null, leeg of afwezig - En is in het antwoord attribuut _links.verblijfstitelshistorie null, leeg of afwezig - - Scenario: historie-API is beschikbaar en er worden personen gezocht - Gegeven de API "Historie personen" is beschikbaar - Als personen gezocht worden met ?naam__geslachtsnaam=groenen&geboorte__datum=1983-05-26 - Dan heeft elke gevonden persoon attribuut _links.partnerhistorie.href met een waarde - En heeft elke gevonden persoon attribuut _links.verblijfplaatsenhistorie.href met een waarde - En heeft elke gevonden persoon attribuut _links.verblijfstitelshistorie.href met een waarde - - Scenario: historie-API is NIET beschikbaar en er worden personen gezocht - Gegeven de API "Historie personen" is beschikbaar - Als personen gezocht worden met ?naam__geslachtsnaam=groenen&geboorte__datum=1983-05-26 - Dan is in elke van de gevonden ingeschrevenpersonen attribuut _links.partnerhistorie.href niet aanwezig of null - En is in elke van de gevonden ingeschrevenpersonen attribuut _links.verblijfplaatsenhistorie.href niet aanwezig of null - En is in elke van de gevonden ingeschrevenpersonen attribuut _links.verblijfstitelshistorie.href niet aanwezig of null diff --git a/features/in onderzoek.xlsx b/features/in onderzoek.xlsx index 6abfc349a..34d0515de 100755 Binary files a/features/in onderzoek.xlsx and b/features/in onderzoek.xlsx differ diff --git a/features/in_onderzoek.feature b/features/in_onderzoek.feature index 747677358..55189522d 100644 --- a/features/in_onderzoek.feature +++ b/features/in_onderzoek.feature @@ -1,70 +1,140 @@ # language: nl Functionaliteit: in onderzoek - Wanneer een attribuut in onderzoek is, krijgt in het antwoord het attribuut met dezelfde naam binnen inOnderzoek de waarde true. - - Een categorie kan in zijn geheel in onderzoek zijn, maar er kunnen ook individuele groepen of attributen binnen de categorie in onderzoek zijn. - Wanneer een categorie in zijn geheel in onderzoek is, krijgt in het antwoord in inOnderzoek elk attribuut van deze categorie de waarde true. - Wanneer een categorie in zijn geheel in onderzoek is, krijgt in het antwoord in inOnderzoek in elke groep van de categorie elk attribuut van deze categorie de waarde true. - Voor de categorie 01 persoon betreft dit in het antwoord alleen de groepen naam en geboorte. - - Een groep kan in zijn geheel in onderzoek zijn, maar er kunnen ook individuele attributen binnen de groep in onderzoek zijn. - Wanneer een groep in zijn geheel in onderzoek is, krijgt in het antwoord in inOnderzoek elk attribuut van deze groep de waarde true. - - Een attribuut dat niet in onderzoek is, wordt niet in het antwoord in inOnderzoek opgenomen, ook niet met de waarde false of null. - - Scenario: hele categorie persoon in onderzoek - Gegeven de te raadplegen persoon heeft de hele persoon in onderzoek (01.83.10=010000) - En geen enkele andere categorie, groep of attribuut is in onderzoek - Als de persoon met burgerservicenummer 999991449 wordt geraadpleegd - Dan is in het antwoord inOnderzoek.burgerservicenummer=true - En is in het antwoord inOnderzoek.geslachtsaanduiding=true - En is in het antwoord inOnderzoek.datumOpschortingBijhouding=true - En is in het antwoord inOnderzoek.indicatieOpschortingBijhouding=true - En is in het antwoord inOnderzoek.indicatieGeheim=true - En is in het antwoord inOnderzoek.datumEersteInschrijvingGBA=true - En is in het antwoord inOnderzoek.redenOpschortingBijhouding=true - Dan is in het antwoord naam.inOnderzoek.geslachtsnaam=true - En is in het antwoord naam.inOnderzoek.voornamen=true - En is in het antwoord naam.inOnderzoek.voorvoegsel=true - En is in het antwoord naam.inOnderzoek.adellijkeTitelPredikaat=true - Dan is in het antwoord geboorte.inOnderzoek.plaats=true - En is in het antwoord geboorte.inOnderzoek.datum=true - En is in het antwoord geboorte.inOnderzoek.land=true - En is in het antwoord attribuut nationaliteit.inOnderzoek null, leeg of afwezig - En is in het antwoord attribuut overlijden.inOnderzoek null, leeg of afwezig - En is in het antwoord attribuut verblijfplaats.inOnderzoek null, leeg of afwezig - En is in het antwoord attribuut gezagsverhouding.inOnderzoek null, leeg of afwezig - En is in het antwoord attribuut verblijfstitel.inOnderzoek null, leeg of afwezig - - Scenario: hele categorie in onderzoek - Gegeven de te raadplegen persoon heeft categorie nationaliteit in onderzoek - Als de persoon met burgerservicenummer 999999102 wordt geraadpleegd - Dan is in het antwoord nationaliteit.inOnderzoek.nationaliteit=true - En is in het antwoord nationaliteit.inOnderzoek.redenOpname=true - En is in het antwoord nationaliteit.inOnderzoek.redenBeindigen=true - En is in het antwoord nationaliteit.inOnderzoek.aanduidingBijzonderNederlanderschap=true - - Scenario: Hele groep in onderzoek - Gegeven de te raadplegen persoon heeft groep naam in onderzoek - Als de persoon met burgerservicenummer 999999151 wordt geraadpleegd - Dan is in het antwoord inOnderzoek.naam.geslachtsnaam=true - En is in het antwoord inOnderzoek.naam.voornamen=true - En is in het antwoord inOnderzoek.naam.voorvoegsel=true - - Scenario: Een attribuut is in inOnderzoek - Gegeven de te raadplegen persoon heeft attribuut naam.voornamen in onderzoek - Als de persoon met burgerservicenummer 999999163 wordt geraadpleegd - Dan is in het antwoord inOnderzoek.naam.geslachtsnaam niet aanwezig of null - En is in het antwoord inOnderzoek.naam.voornamen=true - En is in het antwoord inOnderzoek.naam.voorvoegsel niet aanwezig of null - - Scenario: Het onderzoek is beëindigd - Gegeven de te raadplegen persoon heeft in onderzoek gevuld (010000), met datum einde in onderzoek ook gevuld - Als de persoon met burgerservicenummer 999994888 wordt geraadpleegd - Dan is in het antwoord inOnderzoek niet aanwezig of null - - Scenario: Een attribuut is in onderzoek dat niet opgenomen is in de API - Gegeven de te raadplegen persoon heeft in onderzoek gevuld op attribuut (048510) - Als de persoon wordt geraadpleegd - Dan is in het antwoord nationaliteit..inOnderzoek niet aanwezig of null + Wanneer de juistheid van een gegeven onderzocht wordt, en daardoor de waarde van een geleverd gegeven mogelijk onjuist is, wordt naast het betreffende veld ook in inOnderzoek een veld met dezelfde naam opgenomen. Deze krijgt dan de boolean waarde true. + + Een categorie kan in zijn geheel in onderzoek zijn, maar er kunnen ook individuele groepen of elementen binnen de categorie in onderzoek zijn. + + Een veld dat niet in onderzoek is, wordt niet in inOnderzoek opgenomen, ook niet met de waarde false of null. + + De vertaling van een inOnderzoek elementwaarde (gegeven 83.10) naar inOnderzoek velden in het antwoord staat in /features/in onderzoek.xlsx + + Ook wanneer een gegeven geen waarde heeft en daardoor niet in het antwoord opgenomen wordt kan het in onderzoek zijn. In dat geval wordt alleen in inOnderzoek een veld opgenomen met die naam en de waarde true. + +Rule: wanneer een element in de bron in onderzoek is, wordt het gegeven in het antwoord dat daaruit gevuld wordt ook in inOnderzoek opgenomen met de waarde true + + Abstract Scenario: adres heeft in onderzoek + + Voorbeelden: + | waarde | veld | + | 081120 | huisnummer | + | 081130 | huisletter | + | 081140 | huisnummertoevoeging | + | 081150 | aanduidingBijHuisnummer | + | 081160 | postcode | + | 081170 | woonplaats | + | 081210 | locatiebeschrijving | + + Abstract Scenario: in onderzoek + + Voorbeelden: + | gegeven | nationaliteit | aanduidingBijzonderNederlanderschap | waarde | in onderzoek | + | nationaliteit | 0001 | | 040510 | nationaliteit | + | nationaliteit | 0052 | | 040510 | nationaliteit | + | aanduidingBijzonderNederlanderschap | | V | 046510 | type | + | aanduidingBijzonderNederlanderschap | | B | 046510 | type | + | redenOpname van nationaliteit | 0001 | | 046310 | redenOpname | + | redenOpname bijz. Nederlanderschap | | B | 046310 | redenOpname | + + + +Rule: wanneer een groep in de bron in onderzoek is, wordt elk gegeven in het antwoord dat gevuld wordt uit een van de elementen in die groep ook in inOnderzoek opgenomen met de waarde true + - de elementcode voor onderzoek eindigt op 00 + +Rule: wanneer een categorie in de bron in onderzoek is, wordt elk gegeven in het antwoord dat gevuld wordt uit een van de elementen in die categorie ook in inOnderzoek opgenomen met de waarde true + - de elementcode voor onderzoek eindigt op 0000 + +Rule: in onderzoek wordt niet opgenomen wanneer het onderzoek beëindigd is + - Datum einde onderzoek (83.30) heeft een waarde + + @gba + Scenario: onderzoek is beëindigd + Als de persoon met burgerservicenummer 999994888 wordt geraadpleegd + Dan is in het antwoord inOnderzoek niet aanwezig of null + +Rule: een afgeleid gegeven wordt in inOnderzoek opgenomen wanneer ten minste één van de gegevens waaruit het wordt afgeleid in onderzoek staat + + Abstract Scenario: leeftijd van de persoon in onderzoek omdat + + Voorbeelden: + | reden | waarde | + | geboortedatum van de persoon is in onderzoek | 010310 | + | groep geboorte is in onderzoek | 010300 | + | categorie persoon is in onderzoek | 010000 | + + Abstract Scenario: indicatieOverleden van de persoon in onderzoek omdat + + Voorbeelden: + | reden | waarde | + | voornamen van het kind is in onderzoek | 090210 | + | groep naam van het kind is in onderzoek | 090200 | + | categorie kind is in onderzoek | 090000 | + + Abstract Scenario: voorletters van een ouder in onderzoek omdat + + Voorbeelden: + | reden | waarde | ouder | + | voornamen van ouder 1 is in onderzoek | 020210 | ouder1 | + | groep naam van ouder 1 is in onderzoek | 020200 | ouder1 | + | categorie ouder 1 is in onderzoek | 020000 | ouder1 | + | voornamen van ouder 2 is in onderzoek | 030210 | ouder2 | + | groep naam van ouder 2 is in onderzoek | 030200 | ouder2 | + | categorie ouder 2 is in onderzoek | 030000 | ouder2 | + + Abstract Scenario: verblijfplaats datumVan in onderzoek omdat + + Scenario: indicatieVestigingVanuitBuitenland in onderzoek omdat landVanWaarIngeschreven is in onderzoek + + Abstract Scenario: verblijfplaats datumVan in onderzoek omdat in onderzoek + + Voorbeelden: + | reden | waarde | + | datumAanvangAdreshouding | 081030 | + | datumAanvangAdresBuitenland | 081320 | + | groep adreshouding | 081000 | + | groep verblijf buitenland | 081300 | + | categorie verblijfplaats | 080000 | + + Abstract Scenario: verblijfplaats woonplaats in onderzoek omdat in onderzoek + + Voorbeelden: + | reden | waarde | + | woonplaatsnaam | 081170 | + | gemeenteVanInschrijving | 080910 | + | groep adres | 081100 | + | groep gemeente | 080900 | + | categorie verblijfplaats | 080000 | + + Abstract Scenario: verblijfplaats adresregels in onderzoek omdat + Voorbeelden: + | reden | waarde | adresregel1 | adresregel2 | + | huisnummer is in onderzoek | 081130 | WEL | NIET | + | postcode is in onderzoek | 081160 | NIET | WEL | + | woonplaats is in onderzoek | 081170 | NIET | WEL | + | gemeenteVanInschrijving is in onderzoek | 080910 | NIET | WEL | + | locatiebeschrijving is in onderzoek | 081210 | WEL | NIET | + | regel 1 adres buitenland is in onderzoek | 081330 | WEL | NIET | + | regel 2 adres buitenland is in onderzoek | 081340 | WEL | NIET | + | land adres buitenland is in onderzoek | 081310 | NIET | NIET | + | groep adres is in onderzoek | 081100 | WEL | WEL | + | groep verblijf buitenland is in onderzoek | 081300 | WEL | WEL | + | categorie verblijfplaats is in onderzoek | 080000 | WEL | WEL | + +Rule: onderzoek van een partnergegeven leidt alleen tot inOnderzoek van een samengesteld naamgegeven wanneer daarin de partnernaam wordt gebruikt + - naam.aanduidingNaamgebruik is ongelijk aan 'E' + - een of meerdere van de partner naamgegevens voorvoegsel, adellijkeTitelPredicaat of geslachtsnaam zijn in onderzoek + - betreft aanhef, aanschrijfwijze en gebruikInLopendeTekst + + Abstract Scenario: samengestelde namen bij + Voorbeelden: + | omschrijving | waarde | aanduidingNaamgebruik | inOnderzoek | + | partner in onderzoek en gebruik eigen naam | 050000 | E | NIET | + | partner in onderzoek en gebruik partner naam | 050000 | P | WEL | + | partner in onderzoek en gebruik partner na eigen naam | 050000 | N | WEL | + | partner in onderzoek en gebruik partner voor eigen naam | 050000 | V | WEL | + | groep naam van partner in onderzoek | 050200 | P | WEL | + | voornamen in onderzoek | 050210 | P | NIET | + | voorvoegsel in onderzoek | 050210 | P | WEL | + | adellijkeTitelPredicaat in onderzoek | 050210 | P | WEL | + | geslachtsnaam in onderzoek | 050210 | P | WEL | + | aangaanHuwelijkPartnerschap in onderzoek | 050600 | P | NIET | diff --git a/features/partners.feature b/features/partners.feature index 67f628d98..e05d06499 100644 --- a/features/partners.feature +++ b/features/partners.feature @@ -5,49 +5,134 @@ Functionaliteit: Huwelijken en geregistreerd partnerschappen van een persoon raa Dit bevat de gegevens over de relatie (huwelijk of partnerschap) plus enkele identificerende eigenschappen van de persoon waarmee het huwelijk of partnerschap is aangegaan. Rule: Alleen een actueel huwelijk of geregistreerd partnerschap wordt teruggegeven. - # Een huwelijk of partnerschap is actueel wanneer het niet is ontbonden: groep 07 Ontbinding huwelijk/geregistreerd partnerschap komt niet voor (heeft geen waarde) - - # N.B. Je kan ontbonden/beëindigde huwelijken of partnerschappen raadplegen met de Haal-Centraal-BRP-historie-bevragen API. + Een huwelijk of partnerschap is actueel wanneer het niet is ontbonden: groep 07 Ontbinding huwelijk/geregistreerd partnerschap komt niet voor (heeft geen waarde) Scenario: Actueel huwelijk - Gegeven de persoon met burgerservicenummer 999990184 heeft de volgende huwelijken/partnerschappen in de registratie - | Categorie | soort verbintenis (15.10) | Voornamen (02.10) | Datum aangaan (06.10) | Datum ontbinding (07.10) | Onjuist (84.10) | - | 5 | H | Merel | 20010215 | | | - Als de persoon met burgerservicenummer 999990184 wordt geraadpleegd met fields=partners - Dan bevat het antwoord een partner met naam.voornamen "Merel" + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999990184 | + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992935 | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voornamen (02.10) | Merel | + En de partner heeft de volgende aangaanHuwelijkPartnerschap gegevens + | naam | waarde | + | datum aangaan (06.10) | 20010215 | + | soort verbintenis (15.10) | H | + En de partner heeft GEEN ontbindingHuwelijkPartnerschap gegevens + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999990184 | + | fields | partners | + Dan heeft de persoon met burgerservicenummer '999990184' alleen 'partners' met de volgende gegevens + | burgerservicenummer | + | 999992935 | + En heeft de partner met burgerservicenummer '999992935' de volgende 'naam' gegevens + | naam | waarde | + | voornamen | Merel | Scenario: Actueel partnerschap - Gegeven de persoon met burgerservicenummer 999993380 heeft de volgende huwelijken/partnerschappen in de registratie - | Categorie | soort verbintenis (15.10) | Voornamen (02.10) | Datum aangaan (06.10) | Datum ontbinding (07.10) | Onjuist (84.10) | - | 5 | P | Reindert | 20040506 | | | - Als de persoon met burgerservicenummer 999993380 wordt geraadpleegd met fields=partners - Dan bevat het antwoord een partner met naam.voornamen "Reindert" + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999993380 | + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992935 | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voornamen (02.10) | Reindert | + En de partner heeft de volgende aangaanHuwelijkPartnerschap gegevens + | naam | waarde | + | datum aangaan (06.10) | 20040506 | + | soort verbintenis (15.10) | P | + En de partner heeft GEEN ontbindingHuwelijkPartnerschap gegevens + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999993380 | + | fields | partners | + Dan heeft de persoon met burgerservicenummer '999993380' alleen 'partners' met de volgende gegevens + | burgerservicenummer | + | 999992935 | + En heeft de partner met burgerservicenummer '999992935' de volgende 'naam' gegevens + | naam | waarde | + | voornamen | Reindert | Scenario: Huwelijk/partnerschap is ontbonden - Gegeven de persoon met burgerservicenummer 999992806 heeft de volgende huwelijken/partnerschappen in de registratie - | Categorie | Voornamen (02.10) | Datum aangaan (06.10) | Datum ontbinding (07.10) | Onjuist (84.10) | - | 5 | Osama | | 20011109 | | - | 55 | Osama | 20000115 | | | - Als de persoon met burgerservicenummer 999992806 wordt geraadpleegd met fields=partners - Dan bevat het antwoord GEEN partners + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992806 | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | aanduiding naamgebruik (61.10) | E | + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992935 | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voornamen (02.10) | Osama | + En de partner heeft de volgende aangaanHuwelijkPartnerschap gegevens + | naam | waarde | + | datum aangaan (06.10) | 20000115 | + En de partner heeft de volgende ontbindingHuwelijkPartnerschap gegevens + | naam | waarde | + | datum ontbinding (07.10) | 20011109 | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999993380 | + | fields | partners | + Dan heeft de persoon met burgerservicenummer '999993380' GEEN 'partners' Scenario: Een actueel huwelijk en een ontbonden huwelijk - Gegeven de persoon met burgerservicenummer 999991553 heeft de volgende huwelijken/partnerschappen in de registratie - | Categorie | Voornamen | Datum aangaan (06.10) | Datum ontbinding (07.10) | - | 5 | Karel | 20091102 | | - | 5 | Björn | | 20080706 | - | 55 | Björn | 19870714 | | - | 55 | Björn | 19870714 | | - Als de persoon met burgerservicenummer 999991553 wordt geraadpleegd met fields=partners - Dan bevat het antwoord 1 partner - En bevat het antwoord de partner met naam.voornamen "Karel" - En bevat het antwoord GEEN partner met naam.voornamen "Björn" - + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999991553 | + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992935 | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voornamen (02.10) | Karel | + En de partner heeft de volgende aangaanHuwelijkPartnerschap gegevens + | naam | waarde | + | datum aangaan (06.10) | 20091102 | + En de partner heeft GEEN ontbindingHuwelijkPartnerschap gegevens + En de persoon heeft een partner met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992936 | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voornamen (02.10) | Björn | + En de partner heeft de volgende aangaanHuwelijkPartnerschap gegevens + | naam | waarde | + | datum aangaan (06.10) | 19870714 | + | indicatie onjuist (84.10) | | + En de partner heeft de volgende ontbindingHuwelijkPartnerschap gegevens + | naam | waarde | + | datum ontbinding (07.10) | 20080706 | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999991553 | + | fields | partners | + Dan heeft de persoon met burgerservicenummer '999991553' alleen 'partners' met de volgende gegevens + | burgerservicenummer | + | 999992935 | + En heeft de partner met burgerservicenummer '999992935' de volgende 'naam' gegevens + | naam | waarde | + | voornamen | Karel | Rule: Een partner wordt niet opgenomen wanneer het huwelijk of het partnerschap onjuist is - # Een huwelijk of partnerschap is onjuist wanneer het categorie 5 voorkomen geen (waarden in) groepen 01, 02, 03, 04, 06, 07 en 15 heeft. + Een huwelijk of partnerschap is onjuist wanneer het categorie 5 voorkomen geen (waarden in) groepen 01, 02, 03, 04, 06, 07 en 15 heeft. + # N.B. Het meest recente categorie 55 voorkomen heeft dan een waarde voor Onjuist (84.10). + # N.B. Wanneer een van de gegevens in groepen 01, 02, 03, 04, 06, 07 en 15 een standaardwaarde heeft, geldt dat hier als het bestaan van een waarde en is de partner niet onjuist + @gba Scenario: Huwelijk/partnerschap is onjuist Gegeven de persoon met burgerservicenummer 999993008 heeft de volgende huwelijken/partnerschappen in de registratie | Categorie | Voornamen (02.10) | Datum aangaan (06.10) | soort verbintenis (15.10) | Datum ontbinding (07.10) | Reden ontbinding (07.40) | Onjuist (84.10) | Registergemeente akte (81.10) | Aktenummer (81.20) | Ingangsdatum geldigheid (85.10) | Datum van opneming (86.10) | @@ -57,10 +142,22 @@ Functionaliteit: Huwelijken en geregistreerd partnerschappen van een persoon raa Als de persoon met burgerservicenummer 999993008 wordt geraadpleegd met fields=partners Dan bevat het antwoord GEEN partners + @gba + Scenario: Partner is volledig onbekend + Gegeven de persoon met burgerservicenummer 999993008 heeft de volgende huwelijken/partnerschappen in de registratie + | Categorie | Voornamen (02.10) | Geslachtsnaam (02.40) | Datum aangaan (06.10) | soort verbintenis (15.10) | Datum ontbinding (07.10) | Reden ontbinding (07.40) | Onjuist (84.10) | Registergemeente akte (81.10) | Aktenummer (81.20) | Ingangsdatum geldigheid (85.10) | Datum van opneming (86.10) | + | 5 | | . | 00000000 | . | | | | 0518 | 5XC1111 | 20050818 | 20050818 | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999993380 | + | fields | partners | + Dan heeft de persoon met burgerservicenummer '999993380' exact 1 'partners' Rule: de geleverde partnergegevens zijn de gegevens zoals die staan op de persoonslijst van de gevraagde persoon - # bij het raadplegen van een persoon worden alleen gegevens uit de persoonslijst van de gevraagde persoon gebruikt, en nooit gegevens van de persoonslijst van de partner + Bij het raadplegen van een persoon worden alleen gegevens uit de persoonslijst van de gevraagde persoon gebruikt, en nooit gegevens van de persoonslijst van de partner + @gba Scenario: De partner heeft geslachtswijziging ondergaan, maar de gevraagde persoon erkent dit niet Gegeven de persoon met burgerservicenummer 555550001 heeft de volgende huwelijken/partnerschappen in de registratie | Categorie | Burgerservicenummer (01.20) | Voornamen | Geslachtsaanduiding (04.10) | Datum aangaan (06.10) | Datum ontbinding (07.10) | @@ -69,7 +166,365 @@ Functionaliteit: Huwelijken en geregistreerd partnerschappen van een persoon raa | Categorie | Voornamen | Geslachtsaanduiding (04.10) | | 1 | Charlotte | V | | 51 | Karel | M | - Als de persoon met burgerservicenummer 555550001 wordt geraadpleegd met fields=partners - Dan bevat het antwoord 1 partner - En bevat het antwoord de partner met naam.voornamen "Karel" en geslachtsaanduiding "man" - En bevat het antwoord GEEN partner met naam.voornamen "Charlotte" en geslachtsaanduiding "vrouw" + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 555550001 | + | fields | partners | + Dan heeft de persoon met burgerservicenummer '555550001' exact 1 'partners' + En heeft de persoon met burgerservicenummer '555550001' alleen 'partners' met de volgende gegevens + | burgerservicenummer | + | 555550002 | + En heeft de partner met burgerservicenummer '555550001' de volgende 'naam' gegevens + | naam | waarde | + | voornamen | Karel | + + Rule: wanneer een samengestelde naam wordt gevraagd waarin de geslachtsnaam van de partner wordt gebruikt, dan wordt de partner geleverd, ook wanneer daar niet om gevraagd is met fields + Wanneer in fields NIET is gevraagd om 'partners' wordt toch de partner geleverd in GbaPersoon wanneer aan alle volgende condities is voldaan: + - naam.aanschrijfwijze, naam.aanhef of naam.gebruikinlopendetekst is gevraagd in fields + - de naam van de partner wordt gebruikt: naam.aanduidingNaamgebruik ongelijk is aan 'E' + + Van een partner waar niet in fields om wordt gevraagd worden de volgende gegevens geleverd: + - naam.adellijkeTitelPredikaat + - naam.voorvoegsel + - naam.geslachtsnaam + - geslachtsaanduiding + - ontbindingHuwelijkPartnerschap.datum + + # RvIG levert personen in de vorm GbaPersoon, waarin alleen onbewerkte GBA-V gegevens worden geleverd + # Een proxy vertaalt dit naar de vorm Persoon, waarin sommige gegevens in bewerkte vorm worden opgenomen en waarin informatievragen kunnen zitten + # Een voorbeeld van een informatievraag is naam.aanschrijfwijze, waarin op basis van de aanduiding naamgebruik, de naam van de persoon en de naam van de partner een aanschrijfnaam wordt samengesteld + # Wanneer een persoon de naam van de ex-partner of overleden partner nog gebruikt, wordt in de GbaPersoon ook de ex-partner aan de proxy geleverd. + + @gba + Abstract Scenario: Leveren actuele partner bij en + Gegeven de persoon met burgerservicenummer 999992930 heeft de volgende persoonsgegevens in de registratie + | Categorie | Voornamen (02.10) | adellijke titel of predikaat (02.20) | voorvoegsel (02.30) | Geslachtsnaam (02.40) | Aanduiding naamgebruik (61.10) | + | 1 | Rie | | de | Wit | | + En de persoon met burgerservicenummer 999992930 heeft de volgende huwelijken/partnerschappen in de registratie + | Categorie | Burgerservicenummer (01.20) | Voornamen (02.10) | adellijke titel of predikaat (02.20) | voorvoegsel (02.30) | Geslachtsnaam (02.40) | Geslachtsaanduiding (04.10) | Datum aangaan (06.10) | soort verbintenis (15.10) | Datum ontbinding (07.10) | Reden ontbinding (07.40) | + | 5 | 999992931 | Jan | JH | van | Aedel | M | 20090314 | H | | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992930 | + | fields | naam | + Dan heeft de persoon met burgerservicenummer '999992930' exact 1 'partners' + En heeft de partner de volgende 'geslachtsaanduiding' gegevens + | naam | waarde | + | code | M | + | omschrijving | man | + En heeft de partner alleen de volgende 'naam' gegevens + | naam | waarde | + | adellijkeTitelPredikaat.code | JH | + | adellijkeTitelPredikaat.omschrijving | Jonkheer | + | adellijkeTitelPredikaat.soort | predikaat | + | voorvoegsel | van | + | geslachtsnaam | Aedel | + En heeft de partner geen andere gegevens dan 'naam' en 'geslachtsaanduiding' + + Voorbeelden: + | naamgebruik | fields | + | P | naam.aanschrijfwijze | + | V | naam.aanschrijfwijze | + | N | naam.aanschrijfwijze | + | P | naam.aanhef | + | P | naam.gebruikInLopendeTekst | + | P | naam.geslachtsnaam | + | P | naam.aanschrijfwijze.naam | + | P | naam | + | P | leeftijd,naam.aanschrijfwijze | + | P | naam.aanschrijfwijze,partners | + + @gba + Abstract Scenario: Niet leveren huwelijk/partnerschap bij en + Gegeven de persoon met burgerservicenummer 999992932 heeft de volgende persoonsgegevens in de registratie + | Categorie | Voornamen (02.10) | adellijke titel of predikaat (02.20) | voorvoegsel (02.30) | Geslachtsnaam (02.40) | Aanduiding naamgebruik (61.10) | + | 1 | Rie | | de | Wit | | + En de persoon met burgerservicenummer 999992932 heeft de volgende huwelijken/partnerschappen in de registratie + | Categorie | Burgerservicenummer (01.20) | Voornamen (02.10) | adellijke titel of predikaat (02.20) | voorvoegsel (02.30) | Geslachtsnaam (02.40) | Geslachtsaanduiding (04.10) | Datum aangaan (06.10) | soort verbintenis (15.10) | Datum ontbinding (07.10) | Reden ontbinding (07.40) | + | 5 | 999992933 | Jan | JH | van | Aedel | M | 20090314 | H | | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992932 | + | fields | | + Dan heeft de persoon met burgerservicenummer '999992932' GEEN 'partners' + + Voorbeelden: + | naamgebruik | fields | + | E | naam.aanschrijfwijze | + | E | partners,naam.aanschrijfwijze | + | P | naam.geslachtsnaam | + | P | naam.voorletters | + | P | naam.aanduidingNaamgebruik | + | P | leeftijd | + + @gba + Scenario: Vragen om ander partnergegeven + Gegeven de persoon met burgerservicenummer 999992934 heeft de volgende persoonsgegevens in de registratie + | Categorie | Voornamen (02.10) | adellijke titel of predikaat (02.20) | voorvoegsel (02.30) | Geslachtsnaam (02.40) | Aanduiding naamgebruik (61.10) | + | 1 | Rie | | de | Wit | P | + En de persoon met burgerservicenummer 999992934 heeft de volgende huwelijken/partnerschappen in de registratie + | Categorie | Burgerservicenummer (01.20) | Voornamen (02.10) | adellijke titel of predikaat (02.20) | voorvoegsel (02.30) | Geslachtsnaam (02.40) | Geslachtsaanduiding (04.10) | Datum aangaan (06.10) | soort verbintenis (15.10) | Datum ontbinding (07.10) | Reden ontbinding (07.40) | + | 5 | 999992935 | Jan | JH | van | Aedel | M | 20090314 | H | | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam,partners.aangaanHuwelijkPartnerschap.datum | + Dan heeft de persoon met burgerservicenummer '999992934' exact 1 'partners' + En heeft de partner de volgende 'geslachtsaanduiding' gegevens + | naam | waarde | + | code | M | + | omschrijving | man | + En heeft de partner alleen de volgende 'naam' gegevens + | naam | waarde | + | adellijkeTitelPredikaat.code | JH | + | adellijkeTitelPredikaat.omschrijving | Jonkheer | + | adellijkeTitelPredikaat.soort | predikaat | + | voorvoegsel | van | + | geslachtsnaam | Aedel | + En heeft de partner de volgende 'aangaanHuwelijkPartnerschap' gegevens + | naam | waarde | + | datum.datum | 20090314 | + En heeft de partner geen andere gegevens dan 'naam' en 'geslachtsaanduiding' en 'aangaanHuwelijkPartnerschap' + + Rule: Wanneer er geen actueel huwelijk of geregistreerd partnerschap is en er is een samengestelde naam gevraagd waarin de geslachtsnaam van de partner wordt gebruikt, dan wordt de laatst ontbonden partner geleverd + Een ontbonden huwelijk of partnerschap wordt geleverd in GbaPersoon wanneer aan alle volgende condities is voldaan: + - naam.aanschrijfwijze, naam.aanhef of naam.gebruikinlopendetekst is gevraagd in fields + - de naam van de partner wordt gebruikt: naam.aanduidingNaamgebruik ongelijk is aan 'E' + + Van een ontbonden partner worden de volgende gegevens geleverd: + - naam.adellijkeTitelPredikaat + - naam.voorvoegsel + - naam.geslachtsnaam + - geslachtsaanduiding + - ontbindingHuwelijkPartnerschap.datum + + @gba + Abstract Scenario: Leveren ontbonden huwelijk/partnerschap bij en + Gegeven de persoon met burgerservicenummer 999992934 heeft de volgende persoonsgegevens in de registratie + | Categorie | Voornamen (02.10) | adellijke titel of predikaat (02.20) | voorvoegsel (02.30) | Geslachtsnaam (02.40) | Aanduiding naamgebruik (61.10) | + | 1 | Rie | | de | Wit | | + En de persoon met burgerservicenummer 999992934 heeft de volgende huwelijken/partnerschappen in de registratie + | Categorie | Burgerservicenummer (01.20) | Voornamen (02.10) | adellijke titel of predikaat (02.20) | voorvoegsel (02.30) | Geslachtsnaam (02.40) | Geslachtsaanduiding (04.10) | Datum aangaan (06.10) | soort verbintenis (15.10) | Datum ontbinding (07.10) | Reden ontbinding (07.40) | + | 5 | | | | | | | | | 20171103 | O | + | 55 | 999992935 | Jan | JH | van | Aedel | M | 20090314 | H | | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | | + Dan heeft de persoon met burgerservicenummer '999992934' exact 1 'partners' + En heeft de partner de volgende 'geslachtsaanduiding' gegevens + | naam | waarde | + | code | M | + | omschrijving | man | + En heeft de partner alleen de volgende 'naam' gegevens + | naam | waarde | + | adellijkeTitelPredikaat.code | JH | + | adellijkeTitelPredikaat.omschrijving | Jonkheer | + | adellijkeTitelPredikaat.soort | predikaat | + | voorvoegsel | van | + | geslachtsnaam | Aedel | + En heeft de partner de volgende 'ontbindingHuwelijkPartnerschap' gegevens + | naam | waarde | + | datum.datum | 20171103 | + En heeft de partner geen andere gegevens dan 'naam' en 'geslachtsaanduiding' en 'ontbindingHuwelijkPartnerschap' + + Voorbeelden: + | naamgebruik | fields | + | P | naam.aanschrijfwijze | + | V | naam.aanschrijfwijze | + | N | naam.aanschrijfwijze | + | P | naam.aanhef | + | P | naam.gebruikInLopendeTekst | + | P | naam.geslachtsnaam | + | P | naam.aanschrijfwijze.naam | + | P | naam | + | P | leeftijd,naam.aanschrijfwijze | + | P | naam.aanschrijfwijze,partners | + + @gba + Abstract Scenario: Niet leveren ontbonden huwelijk/partnerschap bij en + Gegeven de persoon met burgerservicenummer 999992934 heeft de volgende persoonsgegevens in de registratie + | Categorie | Voornamen (02.10) | adellijke titel of predikaat (02.20) | voorvoegsel (02.30) | Geslachtsnaam (02.40) | Aanduiding naamgebruik (61.10) | + | 1 | Rie | | de | Wit | | + En de persoon met burgerservicenummer 999992934 heeft de volgende huwelijken/partnerschappen in de registratie + | Categorie | Burgerservicenummer (01.20) | Voornamen (02.10) | adellijke titel of predikaat (02.20) | voorvoegsel (02.30) | Geslachtsnaam (02.40) | Geslachtsaanduiding (04.10) | Datum aangaan (06.10) | soort verbintenis (15.10) | Datum ontbinding (07.10) | Reden ontbinding (07.40) | + | 5 | | | | | | | | | 20171103 | O | + | 55 | 999992935 | Jan | JH | van | Aedel | M | 20090314 | H | | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | | + Dan heeft de persoon met burgerservicenummer '999993380' GEEN 'partners' + + Voorbeelden: + | naamgebruik | fields | + | E | naam.aanschrijfwijze | + | E | partners,naam.aanschrijfwijze | + | P | naam.geslachtsnaam | + | P | naam.voorletters | + | P | naam.aanduidingNaamgebruik | + | P | partners | + | P | partners.naam | + | P | leeftijd | + + @gba + Scenario: Persoon met meerdere ontbonden partners + Gegeven de persoon met burgerservicenummer 999992936 heeft de volgende persoonsgegevens in de registratie + | Categorie | Voornamen (02.10) | adellijke titel of predikaat (02.20) | voorvoegsel (02.30) | Geslachtsnaam (02.40) | Aanduiding naamgebruik (61.10) | + | 1 | Rie | | de | Wit | P | + En de persoon met burgerservicenummer 999992936 heeft de volgende huwelijken/partnerschappen in de registratie + | Categorie | Burgerservicenummer (01.20) | Voornamen (02.10) | adellijke titel of predikaat (02.20) | voorvoegsel (02.30) | Geslachtsnaam (02.40) | Geslachtsaanduiding (04.10) | Datum aangaan (06.10) | soort verbintenis (15.10) | Datum ontbinding (07.10) | Reden ontbinding (07.40) | + | 5 | | | | | | | | | 20190116 | S | + | 55 | 999992938 | Cees | | de | Vries | M | 20180622 | H | | | + | 5 | | | | | | | | | 20171103 | O | + | 55 | 999992937 | Jan | JH | van | Aedel | M | 20090314 | H | | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992936 | + | fields | naam | + Dan heeft de persoon met burgerservicenummer '999992934' exact 1 'partners' + En heeft de partner de volgende 'geslachtsaanduiding' gegevens + | naam | waarde | + | code | M | + | omschrijving | man | + En heeft de partner alleen de volgende 'naam' gegevens + | naam | waarde | + | voorvoegsel | de | + | geslachtsnaam | Vries | + En heeft de partner alleen de volgende 'ontbindingHuwelijkPartnerschap' gegevens + | naam | waarde | + | datum.datum | 20190116 | + En heeft de partner geen andere gegevens dan 'naam' en 'geslachtsaanduiding' en 'ontbindingHuwelijkPartnerschap' + + @gba + Scenario: Persoon met actuele en meerdere ontbonden partners + Gegeven de persoon met burgerservicenummer 999992939 heeft de volgende persoonsgegevens in de registratie + | Categorie | Voornamen (02.10) | adellijke titel of predikaat (02.20) | voorvoegsel (02.30) | Geslachtsnaam (02.40) | Aanduiding naamgebruik (61.10) | + | 1 | Rie | | de | Wit | P | + En de persoon met burgerservicenummer 999992934 heeft de volgende huwelijken/partnerschappen in de registratie + | Categorie | Burgerservicenummer (01.20) | Voornamen (02.10) | adellijke titel of predikaat (02.20) | voorvoegsel (02.30) | Geslachtsnaam (02.40) | Geslachtsaanduiding (04.10) | Datum aangaan (06.10) | soort verbintenis (15.10) | Datum ontbinding (07.10) | Reden ontbinding (07.40) | + | 55 | 999992942 | Wim | | | Zwart | M | 20190828 | P | | | + | 5 | | | | | | | | | 20190116 | S | + | 55 | 999992941 | Cees | | de | Vries | M | 20180622 | H | | | + | 5 | | | | | | | | | 20171103 | O | + | 55 | 999992940 | Jan | JH | van | Aedel | M | 20090314 | H | | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | naam | + Dan heeft de persoon met burgerservicenummer '999992939' exact 1 'partners' + En heeft de partner de volgende 'geslachtsaanduiding' gegevens + | naam | waarde | + | code | M | + | omschrijving | man | + En heeft de partner alleen de volgende 'naam' gegevens + | naam | waarde | + | geslachtsnaam | Zwart | + En heeft de partner geen andere gegevens dan 'naam' en 'geslachtsaanduiding' + + Rule: Partnergegevens die zijn toegevoegd ten behoeve van het samenstellen van een naam worden verwijderd uit het antwoord + Een partner in GbaPersoon met een waarde in ontbindingHuwelijkPartnerschap.datum wordt niet opgenomen in Persoon + Partnergegevens in GbaPersoon waar niet om gevraagd is met fields worden niet opgenomen in Persoon + + @proxy + Scenario: Niet leveren van ontbonden partner + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992806 | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | aanduiding naamgebruik (61.10) | P | + En de persoon heeft exact 1 'partners' + En heeft de partner de volgende 'geslachtsaanduiding' gegevens + | naam | waarde | + | code | M | + | omschrijving | man | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel | de | + | geslachtsnaam | Vries | + En de partner heeft de volgende ontbindingHuwelijkPartnerschap gegevens + | naam | waarde | + | datum.datum | 20190116 | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992806 | + | fields | naam,partners | + Dan heeft de persoon met burgerservicenummer '999992806' GEEN 'partners' + + @proxy + Scenario: Niet leveren van partner waar niet om gevraagd is met fields + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992807 | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | aanduiding naamgebruik (61.10) | P | + En de persoon heeft exact 1 'partners' + En heeft de partner de volgende 'geslachtsaanduiding' gegevens + | naam | waarde | + | code | M | + | omschrijving | man | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voorvoegsel | de | + | geslachtsnaam | Vries | + En de partner heeft GEEN ontbindingHuwelijkPartnerschap gegevens + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992807 | + | fields | naam | + Dan heeft de persoon met burgerservicenummer '999992807' GEEN 'partners' + + @proxy + Scenario: Niet leveren van partnergegevens waar niet om gevraagd is met fields + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992807 | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | aanduiding naamgebruik (61.10) | P | + En de persoon heeft exact 1 'partners' + En heeft de partner de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992808 | + En heeft de partner de volgende 'geslachtsaanduiding' gegevens + | naam | waarde | + | code | M | + | omschrijving | man | + En de partner heeft de volgende naam gegevens + | naam | waarde | + | voornamen | Cees | + | voorvoegsel | de | + | geslachtsnaam | Vries | + En de partner heeft GEEN ontbindingHuwelijkPartnerschap gegevens + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992807 | + | fields | naam,partners.naam.voornamen,partners.burgerservicenummer | + En heeft de persoon met burgerservicenummer '999992807' alleen 'partners' met de volgende gegevens + | burgerservicenummer | + | 999992808 | + En heeft de partner met burgerservicenummer '999992807' alleen de volgende 'naam' gegevens + | naam | waarde | + | voornamen | Cees | + En heeft de partner geen andere gegevens dan 'naam' en 'burgerservicenummer' + + TODO: bepalen OnbekendPartner + @proxy + Scenario: Partner is volledig onbekend + + @proxy + Scenario: Met fields zijn alleen velden zonder waarde gevraagd + diff --git a/features/step_definitions/step_defs.js b/features/step_definitions/step_defs.js new file mode 100644 index 000000000..fe3d6f385 --- /dev/null +++ b/features/step_definitions/step_defs.js @@ -0,0 +1,330 @@ +const { World } = require('./world'); +const { Given, When, Then, setWorldConstructor } = require('@cucumber/cucumber'); +const axios = require('axios').default; +const fs = require('fs'); +const should = require('chai').should(); + +setWorldConstructor(World); + +const propertyNameMap = new Map([ + ['aanduiding bij huisnummer (11.50)', 'aanduidingBijHuisnummer.code'], + ['adellijke titel of predikaat (02.20)', 'adellijkeTitelPredikaat.code'], + ['geslachtsnaam (02.40)', 'geslachtsnaam'], + ['huisletter (11.30)', 'huisletter'], + ['huisnummer (11.20)', 'huisnummer'], + ['huisnummertoevoeging (11.40)', 'huisnummertoevoeging'], + ['locatiebeschrijving (12.10)', 'locatiebeschrijving'], + ['postcode (11.60)', 'postcode'], + ['regel 1 adres buitenland (13.30)', 'adresregel1'], + ['regel 2 adres buitenland (13.40)', 'adresregel2'], + ['regel 3 adres buitenland (13.50)', 'adresregel3'], + ['gemeente van inschrijving (09.10)', 'gemeenteVanInschrijving'], + ['land adres buitenland (13.10)', 'land.code'], + ['naam openbare ruimte (11.15)', 'naamOpenbareRuimte'], + ['straatnaam (11.10)', 'straat'], + ['voornamen (02.10)', 'voornamen'], + ['voorvoegsel (02.30)', 'voorvoegsel'], + ['woonplaatsnaam (11.70)', 'woonplaats'] +]); + +function mapRowToProperty(obj, row) { + let propertyName = propertyNameMap.get(row.naam); + if(propertyName === undefined) { + propertyName = row.naam; + } + + if(row.waarde !== undefined && row.waarde !== '') { + if(propertyName.includes('.')) { + let propertyNames = propertyName.split('.'); + let property = obj; + + propertyNames.forEach(function(propertyName, index) { + if(index === propertyNames.length-1) { + property[propertyName] = String(row.waarde); + } + else { + if(property[propertyName] === undefined) { + property[propertyName] = {}; + } + property = property[propertyName]; + } + }); + } + else { + obj[propertyName] = String(row.waarde); + } + } +} + +Given('het systeem heeft een persoon met de volgende gegevens', function (dataTable) { + if(this.context.persoon.burgerservicenummer !== undefined) { + this.context.zoekResponse.personen.push(this.context.persoon); + this.context.persoon = {}; + } + let persoon = this.context.persoon; + + dataTable.hashes().forEach(function(row) { + mapRowToProperty(persoon, row); + }); +}); + +Given('de persoon heeft de volgende geboorte gegevens', function (dataTable) { + if(this.context.persoon.geboorte === undefined) { + this.context.persoon.geboorte = {}; + } + let geboorte = this.context.persoon.geboorte; + + dataTable.hashes().forEach(function(row) { + mapRowToProperty(geboorte, row); + }); +}); + +Given('de persoon heeft de volgende naam gegevens', function (dataTable) { + if(this.context.persoon.naam === undefined) { + this.context.persoon.naam = {}; + } + let naam = this.context.persoon.naam; + + dataTable.hashes().forEach(function(row) { + mapRowToProperty(naam, row); + }); +}); + +Given('de persoon heeft de volgende verblijfplaats gegevens', function (dataTable) { + if(this.context.persoon.verblijfplaats === undefined) { + this.context.persoon.verblijfplaats = { + type: 'GbaVerblijfplaats' + }; + } + let verblijfplaats = this.context.persoon.verblijfplaats; + + dataTable.hashes().forEach(function(row) { + mapRowToProperty(verblijfplaats, row); + }); +}); + +Given('de waardetabel {string} heeft de volgende waarden', function (string, dataTable) { + // Write code here that turns the phrase above into concrete actions + return 'pending'; +}); + +function determineDataPath(baseDataPath, config) { + switch(config.data.type) { + case "RaadpleegMetBurgerservicenummer": + return config.data.burgerservicenummer !== undefined + ? `${baseDataPath}/bsn-${config.data.burgerservicenummer.join("-")}.json` + : `${baseDataPath}/bsn.json`; + case "ZoekMetGeslachtsnaamEnGeboortedatum": + return config.data.geslachtsnaam !== undefined && + config.data.geboortedatum !== undefined + ? `${baseDataPath}/geslachtsnaam-geboortedatum-${config.data.geslachtsnaam}-${config.data.geboortedatum}.json` + : `${baseDataPath}/geslachtsnaam-geboortedatum.json`; + case "ZoekMetGeslachtsnaamEnGemeenteVanInschrijving": + return config.data.geslachtsnaam !== undefined && + config.data.gemeenteVanInschrijving !== undefined + ? `${baseDataPath}/geslachtsnaam-gemeente-${config.data.geslachtsnaam}-${config.data.gemeenteVanInschrijving}.json` + : `${baseDataPath}/geslachtsnaam-gemeente.json`; + case "ZoekMetPostcodeEnHuisnummer": + return config.data.postcode !== undefined && + config.data.huisnummer !== undefined + ? `${baseDataPath}/postcode-huisnummer-${config.data.postcode}-${config.data.huisnummer}.json` + : `${baseDataPath}/postcode-huisnummer.json`; + default: + console.log(`Onbekend zoek type: ${config.data.type}`); + return ''; + } +} + +When('personen wordt gezocht met de volgende parameters', async function (dataTable) { + let requestBody = {}; + dataTable.hashes().forEach(function(param) { + if(param.naam === "burgerservicenummer") { + requestBody[param.naam] = param.waarde.split(','); + } + else { + requestBody[param.naam] = param.waarde; + } + }); + + const config = { + method: 'post', + url: '/personen', + baseURL: this.context.serverUrl, + data: requestBody + }; + + this.context.zoekResponse.personen.push(this.context.persoon); + this.context.zoekResponse.type = config.data.type; + + let path = determineDataPath(this.context.dataPath, config); + fs.writeFileSync(path, JSON.stringify(this.context.zoekResponse, null, "\t")); + + try { + this.context.response = await axios(config); + } + catch(e) { + this.context.response = e.response; + } +}); + +When('personen wordt geraadpleegd met de volgende parameters', async function (dataTable) { + const persoonIdentificatie = dataTable.hashes()[0].waarde; + const fields = dataTable.hashes()[1].waarde; + + const config = { + method: 'get', + url: `/personen/${persoonIdentificatie}?fields=${fields}`, + baseURL: this.context.serverUrl + }; + + let path = `${this.context.dataPath}/${persoonIdentificatie}.json`; + fs.writeFileSync(path, JSON.stringify(this.context.persoon, null, "\t")); + + try { + this.context.response = await axios(config); + } + catch(e) { + this.context.response = e.response; + } +}); + +Then('bevat de response alleen personen met de volgende gegevens', function (dataTable) { + const personen = this.context.response.data.personen; + + personen.length.should.equal(dataTable.hashes().length, `aantal personen in response ${personen.length} is ongelijk aan aantal expected ${dataTable.hashes().length}`); + + dataTable.hashes().forEach(function(value) { + const persoon = personen.find(function(p){ + return p.burgerservicenummer === value.burgerservicenummer; + }); + should.exist(persoon, `geen persoon gevonden met bsn: ${value.burgerservicenummer}\npersonen: ${JSON.stringify(personen, null, "\t")}`) + + for(const [key, expected] of Object.entries(value)) { + let actual = String(persoon[key]); + + actual.should.equal(expected, `geen persoon gevonden met ${key}: ${expected}\npersoon: ${JSON.stringify(persoon, null, "\t")}`); + } + }); +}); + +Then('bevat de response een persoon met de volgende gegevens', function (dataTable) { + const persoon = this.context.response.data; + + should.exist(persoon, `geen persoon gevonden\nresponse payload: ${JSON.stringify(persoon, null, "\t")}`) + + dataTable.hashes().forEach(function(row) { + const actual = String(persoon[row.naam]); + const expected = row.waarde; + + actual.should.equal(expected, `geen persoon gevonden met ${row.naam}: ${expected}\npersoon: ${JSON.stringify(persoon, null, "\t")}`); + }); +}); + +Then('bevat de persoon met burgerservicenummer {string} de volgende geboorte datum', function (burgerservicenummer, dataTable) { + const personen = this.context.response.data.personen; + + const persoon = personen.find(function(p) { + return p.burgerservicenummer === burgerservicenummer; + }); + + dataTable.hashes().forEach(function(value) { + for(const [key, expected] of Object.entries(value)) { + let actual = String(persoon.geboorte.datum[key]); + + actual.should.equal(expected, `geen geboortedatum gevonden met ${key}: ${expected}\npersoon: ${JSON.stringify(persoon, null, "\t")}`); + } + }); +}); + +Then('bevat de persoon met burgerservicenummer {string} de volgende naam gegevens', function (burgerservicenummer, dataTable) { + const personen = this.context.response.data.personen; + + const persoon = personen.find(function(p) { + return p.burgerservicenummer === burgerservicenummer; + }); + + dataTable.hashes().forEach(function(row) { + let actual = String(persoon.naam[row.naam]); + const expected = row.waarde; + + actual.should.equal(expected, `geen persoon gevonden met ${row.naam}: ${expected}\npersoon: ${JSON.stringify(persoon, null, "\t")}`); + }); +}); + +Then('bevat de persoon met burgerservicenummer {string} de volgende geboorte gegevens', function (burgerservicenummer, dataTable) { + const personen = this.context.response.data.personen; + + const persoon = personen.find(function(p) { + return p.burgerservicenummer === burgerservicenummer; + }); + + dataTable.hashes().forEach(function(row) { + let obj = persoon.geboorte; + + let propertyNames = row.naam.split('.'); + propertyNames.forEach(function(propertyName, index) { + obj = obj[propertyName]; + }); + let actual = String(obj); + const expected = row.waarde; + + actual.should.equal(expected, `geen persoon gevonden met ${row.naam}: ${expected}\npersoon: ${JSON.stringify(persoon, null, "\t")}`); + }); +}); + +Then('bevat de response de volgende gegevens', function (dataTable) { + const data = this.context.response.data; + + dataTable.hashes().forEach(function(value){ + let expected = value.waarde; + let actual = String(data[value.naam]); + + actual.should.equal(expected, JSON.stringify(data, null, "\t")); + }); +}); + +Then('bevat de response een invalidParams met de volgende gegevens', function (dataTable) { + const invalidParams = this.context.response.data.invalidParams; + + dataTable.hashes().forEach(function(expected) { + const actual = invalidParams.find(function(invalidParam) { + return invalidParam.name === expected.name && + invalidParam.code === expected.code && + invalidParam.reason === expected.reason; + }); + should.exist(actual, `geen invalidParam gevonden met name '${expected.name}', code '${expected.code}', reason '${expected.reason}'\n${JSON.stringify(invalidParams, null, "\t")}`); + }); +}); + +Then('bevat de persoon met burgerservicenummer {string} de volgende verblijfplaats gegevens', function (burgerservicenummer, dataTable) { + let persoon; + if(this.context.response.data._embedded !== undefined) { + const personen = this.context.response.data._embedded.personen; + persoon = personen.find(function(p) { + return p.burgerservicenummer === burgerservicenummer; + }); + } + else { + persoon = this.context.response.data; + } + + dataTable.hashes().forEach(function(row) { + let actual = String(persoon.verblijfplaats[row.naam]); + + actual.should.equal(row.waarde, `geen verblijf gegeven '${row.naam}' gevonden met waarde '${row.waarde}'\npersoon: ${JSON.stringify(persoon, null, "\t")}`); + }); +}); + +Then('bevat de persoon met burgerservicenummer {string} de volgende verblijfplaats gegevens NIET', function (burgerservicenummer, dataTable) { + const personen = this.context.response.data.personen; + + const persoon = personen.find(function(p) { + return p.burgerservicenummer === burgerservicenummer; + }); + + dataTable.hashes().forEach(function(row) { + let actual = persoon.verblijfplaats[row.naam]; + + should.not.exist(actual, `verblijf gegeven '${row.naam}' gevonden\npersoon: ${JSON.stringify(persoon, null, "\t")}`); + }); +}); diff --git a/features/step_definitions/world.js b/features/step_definitions/world.js new file mode 100644 index 000000000..ec017cb4d --- /dev/null +++ b/features/step_definitions/world.js @@ -0,0 +1,18 @@ +class World { + constructor({parameters}) { + this.context = { + dataPath: "src/BrpService/Data", + // serverUrl: "https://localhost:7098/haalcentraal/api/brp", + serverUrl: "https://localhost:7074", + persoon: {}, + zoekResponse: { + personen: [] + } + }; + } +} + +// set this environment variable to bypass DEPTH_ZERO_SELF_SIGNED_CERT error when using self-signed certificates +process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0"; + +module.exports = {World} diff --git a/features/volledigeNaam.feature b/features/volledigeNaam.feature index 7c4d5ac0b..3a53ef7c4 100644 --- a/features/volledigeNaam.feature +++ b/features/volledigeNaam.feature @@ -5,46 +5,50 @@ Functionaliteit: volledige naam Rule: de volledige naam wordt samengesteld door achter elkaar plaatsen van voornamen, voorvoegsels en geslachtsnaam Abstract Scenario: volledige naam van persoon - Gegeven de persoon met burgerservicenummer "{burgerservicenummer}" heeft de volgende gegevens: - | voornamen (02.10) | {voornamen} | - | adellijke titel of predikaat (02.20) | {adellijkeTitelPredikaat} | - | voorvoegsel (02.30) | {voorvoegsel} | - | geslachtsnaam (02.40) | {geslachtsnaam} | - Als persoon met burgerservicenummer "{burgerservicenummer}" wordt opgevraagd met fields=naam.volledigeNaam - Dan is in het antwoord naam.volledigeNaam gelijk aan "{volledigeNaam}" + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | voornamen (02.10) | | + | adellijke titel of predikaat (02.20) | | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | | + | fields | naam.volledigeNaam | + Dan bevat de persoon met burgerservicenummer '' de volgende naam gegevens + | naam | waarde | + | volledigeNaam | | Voorbeelden: - | burgerservicenummer | voornamen | adellijkeTitelPredikaat | voorvoegsel | geslachtsnaam | volledigeNaam | - | 999995078 | Christina Maria | | | Maassen | Christina Maria Maassen | - | 999994542 | Gerrit | | den | Braber | Gerrit den Braber | - | 999994074 | | | | Obbadah | Obbadah | - - - Abstract Scenario: volledige naam van ouder - Gegeven de persoon met burgerservicenummer "{burgerservicenummer}" heeft de volgende gegevens van ouder 1: - | voornamen (02.10) | {voornamen} | - | adellijke titel of predikaat (02.20) | {adellijkeTitelPredikaat} | - | voorvoegsel (02.30) | {voorvoegsel} | - | geslachtsnaam (02.40) | {geslachtsnaam} | - Als persoon met burgerservicenummer "{burgerservicenummer}" wordt opgevraagd met fields=ouders.naam.volledigeNaam - Dan is in het antwoord in de ouder met ouderAanduiding gelijk aan "ouder1" de naam.volledigeNaam gelijk aan "{volledigeNaam}" - - Voorbeelden: - | burgerservicenummer | voornamen | adellijkeTitelPredikaat | voorvoegsel | geslachtsnaam | volledigeNaam | - | 999991711 | Barbara | | | Bultenaar | Barbara Bultenaar | - | 999995078 | Karin Monique | | du | Burck | Karin Monique du Burck | - | 999992077 | | | | | | + | burgerservicenummer | voornamen | voorvoegsel | geslachtsnaam | volledigeNaam | + | 999995078 | Christina Maria | | Maassen | Christina Maria Maassen | + | 999994542 | Gerrit | den | Braber | Gerrit den Braber | + | 999994074 | | | Obbadah | Obbadah | Rule: een predikaat wordt opgenomen voor de voornamen met de omschrijving horend bij de waarde in tabel 38 en geschreven in kleine letters - Abstract Scenario: volledige naam van persoon met adellijke titel of predikaat - Gegeven de persoon met burgerservicenummer "{burgerservicenummer}" heeft de volgende gegevens: - | voornamen (02.10) | {voornamen} | - | adellijke titel of predikaat (02.20) | {adellijkeTitelPredikaat} | - | voorvoegsel (02.30) | {voorvoegsel} | - | geslachtsnaam (02.40) | {geslachtsnaam} | - Als persoon met burgerservicenummer "{burgerservicenummer}" wordt opgevraagd met fields=naam.volledigeNaam - Dan is in het antwoord naam.volledigeNaam gelijk aan "{volledigeNaam}" + Abstract Scenario: volledige naam van persoon met predikaat + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | voornamen (02.10) | | + | adellijke titel of predikaat (02.20) | | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | | + | fields | naam.volledigeNaam | + Dan bevat de persoon met burgerservicenummer '' de volgende naam gegevens + | naam | waarde | + | volledigeNaam | | Voorbeelden: | burgerservicenummer | voornamen | adellijkeTitelPredikaat | voorvoegsel | geslachtsnaam | volledigeNaam | @@ -52,16 +56,26 @@ Rule: een predikaat wordt opgenomen voor de voornamen met de omschrijving horend Rule: een adellijke titel wordt opgenomen tussen de voornamen en het voorvoegsel met de omschrijving horend bij de waarde in tabel 38 en geschreven in kleine letters - Abstract Scenario: volledige naam van persoon met adellijke titel of predikaat - Gegeven de persoon met burgerservicenummer "{burgerservicenummer}" heeft de volgende gegevens: - | voornamen (02.10) | {voornamen} | - | adellijke titel of predikaat (02.20) | {adellijkeTitelPredikaat} | - | voorvoegsel (02.30) | {voorvoegsel} | - | geslachtsnaam (02.40) | {geslachtsnaam} | - Als persoon met burgerservicenummer "{burgerservicenummer}" wordt opgevraagd met fields=naam.volledigeNaam - Dan is in het antwoord naam.volledigeNaam gelijk aan "{volledigeNaam}" + Abstract Scenario: volledige naam van persoon met adellijke titel + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | voornamen (02.10) | | + | adellijke titel of predikaat (02.20) | | + | voorvoegsel (02.30) | | + | geslachtsnaam (02.40) | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | | + | fields | naam.volledigeNaam | + Dan bevat de persoon met burgerservicenummer '' de volgende naam gegevens + | naam | waarde | + | volledigeNaam | | Voorbeelden: - | burgerservicenummer | voornamen | adellijkeTitelPredikaat | voorvoegsel | geslachtsnaam | volledigeNaam | - | 999993951 | Carolina | BS | Van | Naersen | Carolina barones Van Naersen | - | 999990160 | Hendrik Jan | R | de | Brink | Hendrik Jan ridder de Brink | + | burgerservicenummer | voornamen | adellijkeTitelPredikaat | voorvoegsel | geslachtsnaam | volledigeNaam | + | 999993951 | Carolina | BS | Van | Naersen | Carolina barones Van Naersen | + | 999990160 | Hendrik Jan | R | de | Brink | Hendrik Jan ridder de Brink | diff --git a/features/voorletters.feature b/features/voorletters.feature index 630c1eb1c..1391e9b90 100644 --- a/features/voorletters.feature +++ b/features/voorletters.feature @@ -10,22 +10,32 @@ Als een voornaam een samengestelde naam is gescheiden door een koppelteken (-), Als een voornaam begint met een dubbelklank (Th, Ph, Ch, IJ, enz.), Dan wordt deze voornaam (ook) afgekort tot één voorletter. Als één of meerdere voornamen uit één letter bestaan, dan volgt er na de letter geen . Wanneer na een voorletter zonder punt (voornaam had één letter) nog een andere voorletter volgt, wordt daartussen een spatie gezet. -Als de rubriek Voornamen is gevuld met de standaardwaarde '.' (punt), Dan wordt geen extra (scheidings)punt toegevoegd; de inhoud van de attribuut voorletters is na afleiding Dan '.' +Rule: Voorletters wordt samengesteld uit de eerste letter van de voornamen gescheiden door een punt -Abstract Scenario: Voorletters wordt samengesteld uit de eerste letter van de voornamen gescheiden door een punt - Gegeven een persoon met voornamen - Als de persoon wordt geraadpleegd - Dan zijn de voorletters van de persoon gelijk aan + Abstract Scenario: + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999995078 | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | voornamen (02.10) | | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999995078 | + | fields | naam.voorletters | + Dan bevat de persoon met burgerservicenummer '999995078' de volgende naam gegevens + | naam | waarde | + | voorletters | | - Voorbeelden: - | voornamen | voorletters | - | Henk | H. | - | Anna Cornelia | A.C. | - | Johan Frank Robert | J.F.R. | - | Theo Philip IJsbrand | T.P.I. | - | Anne-Fleur Belle | A.B. | - | Suzie Q | S.Q | - | J P | J P | - | A | A | - | . | . | + Voorbeelden: + | voornamen | voorletters | titel | description | + | Henk | H. | Één voornaam | | + | Anna Cornelia | A.C. | Meerdere voornamen (1) | | + | Johan Frank Robert | J.F.R. | Meerdere voornamen (2) | | + | Theo Philip IJsbrand | T.P.I. | Voornaam met een dubbelklank (Th, Ph, Ch, IJ, enz.) | Een voornaam dat begint met een dubbelklank (Th, Ph, Ch, IJ, enz.), wordt (ook) afgekort tot één voorletter. | + | Anne-Fleur Belle | A.B. | Voornaam is een samengestelde naam | | + | Suzie Q | S.Q | Één voornaam bestaat uit één letter | | + | A | A | Voornaam bestaat uit één letter | Een voornaam bestaand uit één letter, wordt afgekort tot een letter zonder . | + | J P | J P | Meerdere voornamen bestaan uit één letter | Een voornaam bestaand uit één letter, gevolgd door een andere voornaam, wordt afgekort tot voorletters gescheiden door een spatie | diff --git a/features/woonplaats.feature b/features/woonplaats.feature index 9a0bd881e..dcce1addb 100644 --- a/features/woonplaats.feature +++ b/features/woonplaats.feature @@ -12,31 +12,79 @@ Functionaliteit: Woonplaats wordt altijd gevuld voor een Nederlandse verblijfpla Consequentie is dat woonplaats niet wordt gevuld wanneer het een verblijfplaats in het buitenland betreft. Scenario: persoon heeft BAG adres met woonplaats gevuld - Gegeven persoon met burgerservicenummer 999992934 heeft in de registratie element 08.11.70 met waarde "Scharwoude" - Als persoon met burgerservicenummer 999993653 wordt geraadpleegd - Dan is in het antwoord verblijfplaats.woonplaatsnaam gelijk aan "Scharwoude" + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999992934 | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | + | woonplaatsnaam (11.70) | Scharwoude | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999992934 | + | fields | verblijfplaats.woonplaats | + Dan bevat de persoon met burgerservicenummer '999992934' de volgende 'verblijfplaats' gegevens + | naam | waarde | + | woonplaats | Scharwoude | Scenario: persoon heeft niet-BAG adres in Nederland - Gegeven persoon met burgerservicenummer 999990482 heeft in de registratie geen waarde voor element 08.11.70 - En element 08.11.10 heeft een waarde - En element 09.09.10 heeft de waarde "1681" - En in de landelijke tabel 33 (gemeententabel) komt code "1681" voor met omschrijving "Borger-Odoorn" - Als persoon met burgerservicenummer 999990482 wordt geraadpleegd - Dan is in het antwoord verblijfplaats.woonplaatsnaam gelijk aan "Borger-Odoorn" + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999990482 | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | + | woonplaatsnaam (11.70) | | + | straatnaam (11.10) | een straatnaam | + | gemeente van inschrijving (09.10) | 1681 | + En de waardetabel 'Gemeenten' heeft de volgende waarden + | code | omschrijving | + | 1681 | Borger-Odoorn | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999990482 | + | fields | verblijfplaats.woonplaats | + Dan bevat de persoon met burgerservicenummer '999990482' de volgende 'verblijfplaats' gegevens + | naam | waarde | + | woonplaats | Borger-Odoorn | Scenario: persoon heeft een locatiebeschrijving voor de verblijfplaats - Gegeven persoon met burgerservicenummer 000009921 heeft in de registratie geen waarde voor element 08.11.70 - En element 08.11.10 heeft geen waarde - En element 08.12.10 heeft een waarde - En element 09.09.10 heeft de waarde "0599" - En in de landelijke tabel 33 (gemeententabel) komt code "0599" voor met omschrijving "Rotterdam" - Als persoon met burgerservicenummer 000009921 wordt geraadpleegd - Dan is in het antwoord verblijfplaats.woonplaatsnaam gelijk aan "Rotterdam" + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 000009921 | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | + | woonplaatsnaam (11.70) | | + | straatnaam (11.10) | | + | locatiebeschrijving (12.10) | een locatie beschrijving | + | gemeente van inschrijving (09.10) | 0599 | + En de waardetabel 'Gemeenten' heeft de volgende waarden + | code | omschrijving | + | 0599 | Rotterdam | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 000009921 | + | fields | verblijfplaats.woonplaats | + Dan bevat de persoon met burgerservicenummer '000009921' de volgende 'verblijfplaats' gegevens + | naam | waarde | + | woonplaats | Rotterdam | Scenario: persoon verblijft in het buitenland - Gegeven persoon met burgerservicenummer 999993483 heeft in de registratie geen waarde voor element 08.11.70 - En element 08.11.10 heeft geen waarde - En element 08.12.10 heeft geen waarde - En element 08.13.10 heeft een waarde - Als persoon met burgerservicenummer 000009921 wordt geraadpleegd - Dan komt in het antwoord verblijfplaats.woonplaatsnaam niet voor met een waarde + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999993483 | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | + | woonplaatsnaam (11.70) | | + | straatnaam (11.10) | | + | locatiebeschrijving (12.10) | | + | land adres buitenland (13.10) | 5010 | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999993483 | + | fields | verblijfplaats.woonplaats | + Dan bevat de persoon met burgerservicenummer '999993483' de volgende 'verblijfplaats' gegevens NIET + | naam | + | woonplaats | diff --git a/features/zoek-met-bsn.feature b/features/zoek-met-bsn.feature new file mode 100644 index 000000000..e5c281982 --- /dev/null +++ b/features/zoek-met-bsn.feature @@ -0,0 +1,101 @@ +#language: nl + +Functionaliteit: Zoek met burgerservicenummer(s) + +Rule: Er moet minimaal één burgerservicenummer worden opgegeven + + Scenario: Zoek met valide burgerservicenummer + + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999999321 | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999999321 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999999321 | + + Scenario: Zoek met meerdere valide burgerservicenummers + + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999999321 | + En het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999995492 | + En het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999991802 | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999999321,999995492,999991802 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999999321 | + | 999995492 | + | 999991802 | + + @fout-case + Scenario: Zoek zonder burgerservicenummers + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | fields | burgerservicenummer | + Dan bevat de response de volgende gegevens + | naam | waarde | + | title | Een of meerdere parameters zijn niet correct. | + | status | 400 | + | detail | De foutieve parameter(s) zijn: burgerservicenummer. | + | code | paramsValidation | + | instance | /personen | + En bevat de response een invalidParams met de volgende gegevens + | code | name | reason | + | required | burgerservicenummer | Parameter is verplicht. | + + @fout-case + Abstract Scenario: + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | | + | fields | burgerservicenummer | + Dan bevat de response de volgende gegevens + | naam | waarde | + | title | Één of meerdere parameters zijn niet correct. | + | status | 400 | + | detail | TODO | + | code | TODO | + | instance | TODO | + En bevat de response een invalidParams met de volgende gegevens + | code | name | reason | + | | burgerservicenummer | | + + Voorbeelden: + | burgerservicenummers | titel | code | reason | + | | Zoek met leeg burgerservicenummer lijst | minItems | TODO | + | 1234567890 | Zoek met ongeldig burgerservicenummer | pattern | TODO | + +Rule: Er mag maximaal 20 burgerservicenummers worden opgegeven + + @fout-case + Scenario: Zoek met meer dan 20 burgerservicenummers + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | RaadpleegMetBurgerservicenummer | + | burgerservicenummer | 999999321,999995492,999991802,999995492,999991802,999995492,999991802,999995492,999991802,999995492,999991802,999995492,999991802,999995492,999991802,999995492,999991802,999995492,999991802,999995492,999991802 | + | fields | burgerservicenummer | + Dan bevat de response de volgende gegevens + | naam | waarde | + | title | Één of meerdere parameters zijn niet correct. | + | status | 400 | + | detail | TODO | + | code | TODO | + | instance | TODO | + En bevat de response een invalidParams met de volgende gegevens + | code | name | reason | + | maxItems | burgerservicenummer | TODO | diff --git a/features/zoek-met-geslachtsnaam-geboortedatum.feature b/features/zoek-met-geslachtsnaam-geboortedatum.feature new file mode 100644 index 000000000..8fc3d6018 --- /dev/null +++ b/features/zoek-met-geslachtsnaam-geboortedatum.feature @@ -0,0 +1,523 @@ +#language: nl + +Functionaliteit: Zoek met geslachtsnaam en geboortedatum + + Achtergrond: + Gegeven het systeem heeft personen met de volgende gegevens + | burgerservicenummer | geslachtsaanduiding (04.10) | + | 999995078 | M | + | 999995079 | M | + | 999995080 | M | + | 999995081 | M | + | 999995082 | M | + | 999995083 | M | + | 999995084 | V | + | 999995085 | V | + En het systeem heeft personen met de volgende geboorte gegevens + | burgerservicenummer | datum | plaats.omschrijving | + | 999995078 | 19830526 | Noordwijk | + | 999995079 | 19830526 | Leiden | + | 999995080 | 19830526 | Katwijk | + | 999995081 | 19830526 | Lisse | + | 999995082 | 19830526 | Wassenaar | + | 999995083 | 19830526 | | + | 999995084 | 19830526 | | + | 999995085 | 19830526 | | + En het systeem heeft de volgende naam gegevens + | burgerservicenummer | geslachtsnaam (02.40) | voornamen (02.10) | voorvoegsel (02.30) | + | 999995078 | Maassen | Pieter | | + | 999995079 | Groen | | | + | 999995080 | Groot | | | + | 999995081 | Jansen | | | + | 999995082 | Maassen | Jan Peter | van | + | 999995083 | Groenlo | | | + | 999995084 | Aedel | Petra | van den | + | 999995085 | Jansen | | | + En het systeem heeft de volgende overlijden gegevens + | burgerservicenummer | datum | + | 999995085 | 20220301 | + +Rule: Geslachtsnaam en geboortedatum zijn verplichte parameters + Zoeken is niet hoofdlettergevoelig + + @gba + Abstract Scenario: Zoek met volledige geslachtsnaam en geboortedatum + + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995078 | + | 999995082 | + + Voorbeelden: + | geslachtsnaam | + | Maassen | + | maassen | + | MAASSEN | + + @gba + Abstract Scenario: Zoek met deel van geslachtsnaam en geboortedatum + + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer,geboorte.datum,naam.geslachtsnaam | + Dan bevat de response geen personen + + Voorbeelden: + | geslachtsnaam | + | Maas | + | jans | + | MAAS | + + @gba + Abstract Scenario: Zoek met volledige voornaam + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | voornamen | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | | + + Voorbeelden: + | geslachtsnaam | voornamen | burgerservicenummer | + | Maassen | Pieter | 999995078 | + | maassen | PIETER | 999995078 | + | MAASSEN | pieter | 999995078 | + | maassen | jan peter | 999995082 | + + @gba + Abstract Scenario: Zoek met volledige voorvoegsel + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | voorvoegsel | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995082 | + + Voorbeelden: + | geslachtsnaam | voorvoegsel | + | Maassen | van | + | maassen | VAN | + | MAASSEN | Van | + + @gba + Abstract Scenario: Zoek met geslachtsaanduiding + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | Aedel | + | geslachtsaanduiding | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995084 | + + Voorbeelden: + | geslachtsaanduiding | + | v | + | V | + + @gba + Abstract Scenario: Zoek met geboorteplaats + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | Maassen | + | geboorteplaats | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995082 | + + Voorbeelden: + | geboorteplaats | + | Wassenaar | + | wassenaar | + | WASSENAAR | + + @gba + Scenario: Zoek met inclusiefOverledenPersonen + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | Jansen | + | inclusiefOverledenPersonen | true | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995081 | + | 999995085 | + + @fout-case + Abstract Scenario: + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | geboortedatum | | + | fields | burgerservicenummer | + Dan bevat de response de volgende gegevens + | naam | waarde | + | type | https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?#System_Net_HttpStatusCode_BadRequest | + | title | Minimale combinatie van parameters moet worden opgegeven. | + | status | 400 | + | detail | Combinatie van gevulde velden was niet correct. Geef waarde aan één van de volgende veld combinaties: burgerservicenummer of geboortedatum en geslachtsnaam of gemeenteVanInschrijving, voornamen en geslachtsnaam of postcode en huisnummer of straat, gemeenteVanInschrijving en huisnummer of nummeraanduidingIdentificatie | + | code | paramsCombination | + | instance | /personen | + En bevat de response geen invalidParams + + Voorbeelden: + | titel | geboortedatum | geslachtsnaam | + | Zoek zonder geslachtsnaam en geboortedatum | | | + | Zoek met alleen valide geslachtsnaam | | maassen | + | Zoek met alleen valide geboortedatum | 1983-05-26 | | + + @fout-case + Abstract Scenario: Zoek met invalide geboortedatum + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | Maassen | + | geboortedatum | | + | fields | burgerservicenummer | + Dan bevat de response de volgende gegevens + | naam | waarde | + | type | https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?#System_Net_HttpStatusCode_BadRequest | + | title | Een of meerdere parameters zijn niet correct. | + | status | 400 | + | detail | De foutieve parameter(s) zijn: geboortedatum. | + | code | paramsValidation | + | instance | /personen | + En bevat de response een invalidParams met de volgende gegevens + | code | name | reason | + | date | geboortedatum | Waarde is geen geldige datum. | + + Voorbeelden: + | geboortedatum | + | 19830526 | + | 26 mei 1983 | + + @fout-case + Abstract Scenario: + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response de volgende gegevens + | naam | waarde | + | type | https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?#System_Net_HttpStatusCode_BadRequest | + | title | Een of meerdere parameters zijn niet correct. | + | status | 400 | + | detail | De foutieve parameter(s) zijn: geslachtsnaam. | + | code | paramsValidation | + | instance | /personen | + En bevat de response een invalidParams met de volgende gegevens + | code | name | reason | + | | geslachtsnaam | | + + Voorbeelden: + | titel | code | reason | geslachtsnaam | + | Geslachtsnaam is meer dan 200 karakters lang | maxLength | Waarde is langer dan maximale lengte 200. | abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ | + | Geslachtsnaam bevat ongeldige karakters | pattern | Waarde voldoet niet aan patroon TODO | | + + @fout-case + Scenario: Meerdere invalide parameters + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | geboortedatum | 19830526 | + | fields | burgerservicenummer | + Dan bevat de response de volgende gegevens + | naam | waarde | + | type | https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?#System_Net_HttpStatusCode_BadRequest | + | title | Een of meerdere parameters zijn niet correct. | + | status | 400 | + | detail | De foutieve parameter(s) zijn: geboortedatum, geslachtsnaam. | + | code | paramsValidation | + | instance | /personen | + En bevat de response een invalidParams met de volgende gegevens + | code | name | reason | + | pattern | geslachtsnaam | Waarde voldoet niet aan patroon TODO | + | date | geboortedatum | Waarde is geen geldige datum. | + +Rule: Bij zoeken met de "*" wildcard moet minimaal 2 letters (exclusief de wildcard teken) worden opgegeven + De "*" wildcard komt overeen met nul of meer (niet-spatie) karakters + + @gba + Abstract Scenario: Zoek met "*" wildcard als laatste karakter in geslachtsnaam + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995079 | + | 999995080 | + + Voorbeelden: + | geslachtsnaam filter | + | gro* | + | Gro* | + | GRO* | + + @gba + Abstract Scenario: Zoek met "*" wildcard als eerste karakter in geslachtsnaam + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995078 | + | 999995081 | + | 999995082 | + + Voorbeelden: + | geslachtsnaam filter | + | *sen | + | *SEN | + + @gba + Abstract Scenario: Zoek met "*" wildcard als eerste en laatste karakter in geslachtsnaam + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995079 | + | 999995083 | + + Voorbeelden: + | geslachtsnaam filter | + | *oen* | + | *OEN* | + + @gba + Abstract Scenario: Zoek met "*" wildcard als laatste karakter in voornamen + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | maassen | + | voornamen | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995082 | + + Voorbeelden: + | voornamen filter | + | Jan* | + | jan* | + | JAN* | + + @fout-case + Abstract Scenario: Zoek met "*" wildcard als eerste karakter in voornamen + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | maassen | + | voornamen | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response de volgende gegevens + | naam | waarde | + | type | https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?#System_Net_HttpStatusCode_BadRequest | + | title | Een of meerdere parameters zijn niet correct. | + | status | 400 | + | detail | De foutieve parameter(s) zijn: geslachtsnaam. | + | code | paramsValidation | + | instance | /personen | + En bevat de response een invalidParams met de volgende gegevens + | code | name | reason | + | wildcard | voornamen | Incorrect gebruik van wildcard karakter *. | + + Voorbeelden: + | voornamen filter | + | *eter | + | *ETER | + + @fout-case + Abstract Scenario: geslachtsnaam met maximimaal één letter exclusief "*" wildcard karakter + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response de volgende gegevens + | naam | waarde | + | type | https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?#System_Net_HttpStatusCode_BadRequest | + | title | Een of meerdere parameters zijn niet correct. | + | status | 400 | + | detail | De foutieve parameter(s) zijn: geslachtsnaam. | + | code | paramsValidation | + | instance | /personen | + En bevat de response een invalidParams met de volgende gegevens + | code | name | reason | + | wildcard | geslachtsnaam | Incorrect gebruik van wildcard karakter *. | + + Voorbeelden: + | geslachtsnaam filter | + | * | + | *n | + | n* | + | *** | + + @fout-case + Abstract Scenario: De "*" wildcard karakter staat niet aan het begin en/of aan het eind van de geslachtsnaam zoekstring + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response de volgende gegevens + | naam | waarde | + | type | https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?#System_Net_HttpStatusCode_BadRequest | + | title | Een of meerdere parameters zijn niet correct. | + | status | 400 | + | detail | De foutieve parameter(s) zijn: geslachtsnaam. | + | code | paramsValidation | + | instance | /personen | + En bevat de response een invalidParams met de volgende gegevens + | code | name | reason | + | wildcard | geslachtsnaam | Incorrect gebruik van wildcard karakter *. | + + Voorbeelden: + | geslachtsnaam filter | + | *r*ot | + | gr*o* | + | gr*t | + | gr** | + +Rule: Bij zoeken met de "?" wildcard moet minimaal 2 letters (exclusief de wildcard teken) worden opgegeven + De "?" wildcard mag meerdere keren achter elkaar voorkomen in een zoekstring + De "?" wildcard komt overeen met één (niet-spatie) karakter + + @gba + Abstract Scenario: Zoek (case insensitive) met "?" wildcard karakter in geslachtsnaam + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995083 | + + Voorbeelden: + | geslachtsnaam filter | + | groen?? | + | Groen?? | + | GROEN?? | + | ??OENLO | + + @fout-case + Abstract Scenario: geslachtsnaam met maximimaal één letter exclusief "?" wildcard karakter + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response de volgende gegevens + | naam | waarde | + | type | https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?#System_Net_HttpStatusCode_BadRequest | + | title | Een of meerdere parameters zijn niet correct. | + | status | 400 | + | detail | De foutieve parameter(s) zijn: geslachtsnaam. | + | code | paramsValidation | + | instance | /personen | + En bevat de response een invalidParams met de volgende gegevens + | code | name | reason | + | wildcard | geslachtsnaam | Incorrect gebruik van wildcard karakter ?. | + + Voorbeelden: + | geslachtsnaam filter | + | ? | + | ?n | + | n? | + | ??? | + + @fout-case + Abstract Scenario: De "?" wildcard karakter staat niet aan het begin en/of aan het eind van de geslachtsnaam zoekstring + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response de volgende gegevens + | naam | waarde | + | type | https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?#System_Net_HttpStatusCode_BadRequest | + | title | Een of meerdere parameters zijn niet correct. | + | status | 400 | + | detail | De foutieve parameter(s) zijn: geslachtsnaam. | + | code | paramsValidation | + | instance | /personen | + En bevat de response een invalidParams met de volgende gegevens + | code | name | reason | + | wildcard | geslachtsnaam | Incorrect gebruik van wildcard karakter ?. | + + Voorbeelden: + | geslachtsnaam filter | + | ?r?ot | + | gr?o? | + | gr?t | + + @fout-case: + Abstract Scenario: Het aantal opgegeven "?" wildcard karakters achter elkaar is meer dan het toegestane maximum + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGeboortedatum | + | geslachtsnaam | | + | geboortedatum | 1983-05-26 | + | fields | burgerservicenummer | + Dan bevat de response de volgende gegevens + | naam | waarde | + | type | https://docs.microsoft.com/en-us/dotnet/api/system.net.httpstatuscode?#System_Net_HttpStatusCode_BadRequest | + | title | Een of meerdere parameters zijn niet correct. | + | status | 400 | + | detail | De foutieve parameter(s) zijn: geslachtsnaam. | + | code | paramsValidation | + | instance | /personen | + En bevat de response een invalidParams met de volgende gegevens + | code | name | reason | + | wildcard | geslachtsnaam | Incorrect gebruik van wildcard karakter ?. | + + Voorbeelden: + | geslachtsnaam filter | + | ??????rot | + | gro?????? | + | ??????rot?????? | diff --git a/features/zoek-met-geslachtsnaam-gemeentevaninschrijving.feature b/features/zoek-met-geslachtsnaam-gemeentevaninschrijving.feature new file mode 100644 index 000000000..44d687c4b --- /dev/null +++ b/features/zoek-met-geslachtsnaam-gemeentevaninschrijving.feature @@ -0,0 +1,29 @@ +#language: nl + +Functionaliteit: Zoek met geslachtsnaam en gemeente van inschrijving + +Rule: Geslachtsnaam en gemeenteVanInschrijving zijn verplichte parameters + + Scenario: Zoek met valide geslachtsnaam en gemeenteVanInschrijving + + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999995078 | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | geslachtsnaam | Groen | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | + | gemeenteVanInschrijving | 0014 | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetGeslachtsnaamEnGemeenteVanInschrijving | + | geslachtsnaam | groen | + | gemeenteVanInschrijving | 0014 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995078 | + En bevat de persoon met burgerservicenummer '999995078' de volgende naam gegevens + | naam | waarde | + | geslachtsnaam | Groen | diff --git a/features/zoek-met-postcode-huisnummer.feature b/features/zoek-met-postcode-huisnummer.feature new file mode 100644 index 000000000..b5ae6ec27 --- /dev/null +++ b/features/zoek-met-postcode-huisnummer.feature @@ -0,0 +1,85 @@ +#language: nl + +Functionaliteit: Zoek met postcode en huisnummer + +Rule: Postcode en huisnummer zijn verplichte parameters + + Scenario: Zoek met valide postcode en huisnummer + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999995078 | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | + | postcode | 2628HJ | + | huisnummer | 2 | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetPostcodeEnHuisnummer | + | postcode | 2628HJ | + | huisnummer | 2 | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995078 | + + Scenario: Zoek met huisletter + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999995078 | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | + | postcode | 2628HJ | + | huisnummer | 3 | + | huisletter | A | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetPostcodeEnHuisnummer | + | postcode | 2628HJ | + | huisnummer | 3 | + | huisletter | A | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995078 | + + Scenario: Zoek met huisnummertoevoeging + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999995078 | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | + | postcode | 2628HJ | + | huisnummer | 4 | + | huisnummertoevoeging | to | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetPostcodeEnHuisnummer | + | postcode | 2628HJ | + | huisnummer | 4 | + | huisnummertoevoeging | to | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995078 | + + Scenario: Zoek met geslachtsnaam + Gegeven het systeem heeft een persoon met de volgende gegevens + | naam | waarde | + | burgerservicenummer | 999995078 | + En de persoon heeft de volgende naam gegevens + | naam | waarde | + | geslachtsnaam (02.40) | Maassen | + En de persoon heeft de volgende verblijfplaats gegevens + | naam | waarde | + | postcode | 2628HJ | + | huisnummer | 5 | + Als personen wordt gezocht met de volgende parameters + | naam | waarde | + | type | ZoekMetPostcodeEnHuisnummer | + | postcode | 2628HJ | + | huisnummer | 5 | + | geslachtsnaam | Maassen | + | fields | burgerservicenummer | + Dan bevat de response alleen personen met de volgende gegevens + | burgerservicenummer | + | 999995078 | diff --git a/package-lock.json b/package-lock.json index 408800bfa..f4730904b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,10 +9,14 @@ "version": "1.0.0", "license": "ISC", "devDependencies": { + "@cucumber/cucumber": "^8.0.0-rc.2", "@openapitools/openapi-generator-cli": "^2.4.25", "@stoplight/spectral-cli": "^6.2.0", + "axios": "^0.25.0", + "chai": "^4.3.6", "husky": "^4.3.8", "mvn-dl": "^6.0.0", + "nswag": "^13.15.7", "openapi-to-postmanv2": "^2.13.0" } }, @@ -113,6 +117,192 @@ "node": ">=4" } }, + "node_modules/@cspotcode/source-map-consumer": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-consumer/-/source-map-consumer-0.8.0.tgz", + "integrity": "sha512-41qniHzTU8yAGbCp04ohlmSrZf8bkf/iJsl3V0dRGsQN/5GFfx+LbCSsCpp2gqrqjTVg/K6O8ycoV35JIwAzAg==", + "dev": true, + "engines": { + "node": ">= 12" + } + }, + "node_modules/@cspotcode/source-map-support": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.7.0.tgz", + "integrity": "sha512-X4xqRHqN8ACt2aHVe51OxeA2HjbcL4MqFqXkrmQszJ1NOUuUu5u6Vqx/0lZSVNku7velL5FC/s5uEAj1lsBMhA==", + "dev": true, + "dependencies": { + "@cspotcode/source-map-consumer": "0.8.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@cucumber/ci-environment": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/@cucumber/ci-environment/-/ci-environment-8.0.1.tgz", + "integrity": "sha512-oQ6nifJ5MRyHFyCsBQU+D0CERSPbxezOxlVpJXcSrcOdKbdqGojZcu17Ww13dyHUGN8c417pWUifIlOrxrsZTQ==", + "dev": true + }, + "node_modules/@cucumber/cucumber": { + "version": "8.0.0-rc.2", + "resolved": "https://registry.npmjs.org/@cucumber/cucumber/-/cucumber-8.0.0-rc.2.tgz", + "integrity": "sha512-cYcZEIkYl2BmdTa0VS62JUty2Vg/N+EC81xujNajaQQfXiKamwbunGFQhaqxrXIFmlFpuSASnEm4UudELbOfJw==", + "dev": true, + "dependencies": { + "@cspotcode/source-map-support": "^0.7.0", + "@cucumber/ci-environment": "8.0.1", + "@cucumber/cucumber-expressions": "14.0.0", + "@cucumber/gherkin": "22.0.0", + "@cucumber/gherkin-streams": "4.0.0", + "@cucumber/html-formatter": "17.0.0", + "@cucumber/messages": "17.1.1", + "@cucumber/tag-expressions": "4.1.0", + "assertion-error-formatter": "^3.0.0", + "capital-case": "^1.0.4", + "cli-table3": "0.6.1", + "colors": "1.4.0", + "commander": "^8.0.0", + "duration": "^0.2.2", + "durations": "^3.4.2", + "figures": "^3.2.0", + "glob": "^7.1.6", + "indent-string": "^4.0.0", + "is-stream": "^2.0.0", + "knuth-shuffle-seeded": "^1.0.6", + "mz": "^2.7.0", + "progress": "^2.0.3", + "resolve": "^1.19.0", + "resolve-pkg": "^2.0.0", + "stack-chain": "^2.0.0", + "string-argv": "^0.3.1", + "tmp": "^0.2.1", + "util-arity": "^1.1.0", + "verror": "^1.10.0" + }, + "bin": { + "cucumber-js": "bin/cucumber-js" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@cucumber/cucumber-expressions": { + "version": "14.0.0", + "resolved": "https://registry.npmjs.org/@cucumber/cucumber-expressions/-/cucumber-expressions-14.0.0.tgz", + "integrity": "sha512-QiuFBrj4dZRc1Igvp2/nOjUNFyDtO7uHTrzgY9DbwzebYAYOvM6CKGOSxSuPUzxowuc1nuRkzJfFUI1kHaZgPQ==", + "dev": true, + "dependencies": { + "regexp-match-indices": "1.0.2" + } + }, + "node_modules/@cucumber/cucumber/node_modules/tmp": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.2.1.tgz", + "integrity": "sha512-76SUhtfqR2Ijn+xllcI5P1oyannHNHByD80W1q447gU3mp9G9PSpGdWmjUOHRDPiHYacIk66W7ubDTuPF3BEtQ==", + "dev": true, + "dependencies": { + "rimraf": "^3.0.0" + }, + "engines": { + "node": ">=8.17.0" + } + }, + "node_modules/@cucumber/gherkin": { + "version": "22.0.0", + "resolved": "https://registry.npmjs.org/@cucumber/gherkin/-/gherkin-22.0.0.tgz", + "integrity": "sha512-D5OghXE8kkZm7pcwo8TvQMgrrXGMXEjERdKLU0T7dQIbc6k0BmMX8dTRh2cwAjH8c7vhwdd0qLU8FPQgGGj+bg==", + "dev": true, + "dependencies": { + "@cucumber/message-streams": "^3.0.0", + "@cucumber/messages": "^17.1.1" + } + }, + "node_modules/@cucumber/gherkin-streams": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@cucumber/gherkin-streams/-/gherkin-streams-4.0.0.tgz", + "integrity": "sha512-b/guGNeuxr3ghoJOK47QpLhwa2BOdRq+cs2hBYulMLPTiVfwvRBiZlq7P6xdjR9dIpUKBSpzYR6NwaLMgV5DTg==", + "dev": true, + "dependencies": { + "@cucumber/gherkin": "^21.0.0", + "@cucumber/message-streams": "^3.0.0", + "@cucumber/messages": "^17.1.0", + "commander": "8.1.0", + "source-map-support": "0.5.19" + }, + "bin": { + "gherkin-javascript": "bin/gherkin" + } + }, + "node_modules/@cucumber/gherkin-streams/node_modules/@cucumber/gherkin": { + "version": "21.0.0", + "resolved": "https://registry.npmjs.org/@cucumber/gherkin/-/gherkin-21.0.0.tgz", + "integrity": "sha512-S6YFmTg56iEn563ReePL6Sygb77vwYrGHEr7NwuLIgg20Hi1pp7P80BAYVYNRgU7nK9vG2II9O6kaZbiOXF/5g==", + "dev": true, + "dependencies": { + "@cucumber/message-streams": "^3.0.0", + "@cucumber/messages": "^17.1.0" + } + }, + "node_modules/@cucumber/gherkin-streams/node_modules/commander": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-8.1.0.tgz", + "integrity": "sha512-mf45ldcuHSYShkplHHGKWb4TrmwQadxOn7v4WuhDJy0ZVoY5JFajaRDKD0PNe5qXzBX0rhovjTnP6Kz9LETcuA==", + "dev": true, + "engines": { + "node": ">= 12" + } + }, + "node_modules/@cucumber/html-formatter": { + "version": "17.0.0", + "resolved": "https://registry.npmjs.org/@cucumber/html-formatter/-/html-formatter-17.0.0.tgz", + "integrity": "sha512-yegA8LY1HYUONyMtTvAYj+aG4zc/6WRtKQxqJahjcdmjgXWcL1BTe8y0lw4BFVqFjaZNI9onOM5KDnMHDm3J/w==", + "dev": true, + "dependencies": { + "@cucumber/messages": "^17.1.0", + "commander": "8.1.0", + "source-map-support": "0.5.19" + }, + "bin": { + "cucumber-html-formatter": "bin/cucumber-html-formatter.js" + } + }, + "node_modules/@cucumber/html-formatter/node_modules/commander": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-8.1.0.tgz", + "integrity": "sha512-mf45ldcuHSYShkplHHGKWb4TrmwQadxOn7v4WuhDJy0ZVoY5JFajaRDKD0PNe5qXzBX0rhovjTnP6Kz9LETcuA==", + "dev": true, + "engines": { + "node": ">= 12" + } + }, + "node_modules/@cucumber/message-streams": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/@cucumber/message-streams/-/message-streams-3.0.0.tgz", + "integrity": "sha512-ABx91nKUebV8mLmpf7BsB3bmQ57CDAfj2EIZswThz+nJHYPAFlZ1JewI6ykFsR9RzJ7/QhgQs0KHeQh7nH/u1Q==", + "dev": true, + "dependencies": { + "@cucumber/messages": "^17.0.0" + } + }, + "node_modules/@cucumber/messages": { + "version": "17.1.1", + "resolved": "https://registry.npmjs.org/@cucumber/messages/-/messages-17.1.1.tgz", + "integrity": "sha512-KQMn2Ag+1g1CXp/zKQ7LLqmuHjuQwuXw0N2u5SrDk8r72zPt36SxmDSJK7w6HiFTI+3p5ZuzwLi4S5jop3Tx4g==", + "dev": true, + "dependencies": { + "@types/uuid": "8.3.1", + "class-transformer": "0.4.0", + "reflect-metadata": "0.1.13", + "uuid": "8.3.2" + } + }, + "node_modules/@cucumber/tag-expressions": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@cucumber/tag-expressions/-/tag-expressions-4.1.0.tgz", + "integrity": "sha512-chTnjxV3vryL75N90wJIMdMafXmZoO2JgNJLYpsfcALL2/IQrRiny3vM9DgD5RDCSt1LNloMtb7rGey9YWxCsA==", + "dev": true + }, "node_modules/@jsep-plugin/regex": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/@jsep-plugin/regex/-/regex-1.0.1.tgz", @@ -171,6 +361,15 @@ } } }, + "node_modules/@nestjs/common/node_modules/axios": { + "version": "0.24.0", + "resolved": "https://registry.npmjs.org/axios/-/axios-0.24.0.tgz", + "integrity": "sha512-Q6cWsys88HoPgAaFAVUb0WpPk0O8iTeisR9IMqy9G8AbO4NlpVknrnQS03zzF9PGAWgO3cgletO3VjV/P7VztA==", + "dev": true, + "dependencies": { + "follow-redirects": "^1.14.4" + } + }, "node_modules/@nestjs/common/node_modules/tslib": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.1.tgz", @@ -877,6 +1076,12 @@ "integrity": "sha512-tjftsOLuIWFLJxcpgFeehNnMhpMIv0ELJl0/i31jiV3au1GQpnd3/pTTDQg2zO5cSGJxtrDzMgebOH7+cqh3Vg==", "dev": true }, + "node_modules/@types/uuid": { + "version": "8.3.1", + "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-8.3.1.tgz", + "integrity": "sha512-Y2mHTRAbqfFkpjldbkHGY8JIzRN6XqYRliG8/24FcHm2D2PwW24fl5xMRTVGdrb7iMrwCaIEbLWerGIkXuFWVg==", + "dev": true + }, "node_modules/abort-controller": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/abort-controller/-/abort-controller-3.0.0.tgz", @@ -996,6 +1201,12 @@ "url": "https://github.com/chalk/ansi-styles?sponsor=1" } }, + "node_modules/any-promise": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/any-promise/-/any-promise-1.3.0.tgz", + "integrity": "sha1-q8av7tzqUugJzcA3au0845Y10X8=", + "dev": true + }, "node_modules/argparse": { "version": "1.0.10", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", @@ -1005,6 +1216,35 @@ "sprintf-js": "~1.0.2" } }, + "node_modules/assert-plus": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", + "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", + "dev": true, + "engines": { + "node": ">=0.8" + } + }, + "node_modules/assertion-error": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-1.1.0.tgz", + "integrity": "sha512-jgsaNduz+ndvGyFt3uSuWqvy4lCnIJiovtouQN5JZHOKCS2QuhEdbcQHFhVksz2N2U9hXJo8odG7ETyWlEeuDw==", + "dev": true, + "engines": { + "node": "*" + } + }, + "node_modules/assertion-error-formatter": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/assertion-error-formatter/-/assertion-error-formatter-3.0.0.tgz", + "integrity": "sha512-6YyAVLrEze0kQ7CmJfUgrLHb+Y7XghmL2Ie7ijVa2Y9ynP3LV+VDiwFk62Dn0qtqbmY0BT0ss6p1xxpiF2PYbQ==", + "dev": true, + "dependencies": { + "diff": "^4.0.1", + "pad-right": "^0.2.2", + "repeat-string": "^1.6.1" + } + }, "node_modules/ast-types": { "version": "0.14.2", "resolved": "https://registry.npmjs.org/ast-types/-/ast-types-0.14.2.tgz", @@ -1033,12 +1273,12 @@ "dev": true }, "node_modules/axios": { - "version": "0.24.0", - "resolved": "https://registry.npmjs.org/axios/-/axios-0.24.0.tgz", - "integrity": "sha512-Q6cWsys88HoPgAaFAVUb0WpPk0O8iTeisR9IMqy9G8AbO4NlpVknrnQS03zzF9PGAWgO3cgletO3VjV/P7VztA==", + "version": "0.25.0", + "resolved": "https://registry.npmjs.org/axios/-/axios-0.25.0.tgz", + "integrity": "sha512-cD8FOb0tRH3uuEe6+evtAbgJtfxr7ly3fQjYcMcuPlgkwVS9xboaVIpcDV+cYQe+yGykgwZCs1pzjntcGa6l5g==", "dev": true, "dependencies": { - "follow-redirects": "^1.14.4" + "follow-redirects": "^1.14.7" } }, "node_modules/balanced-match": { @@ -1130,6 +1370,12 @@ "ieee754": "^1.1.13" } }, + "node_modules/buffer-from": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", + "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", + "dev": true + }, "node_modules/builtins": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/builtins/-/builtins-1.0.3.tgz", @@ -1163,6 +1409,35 @@ "node": ">=6" } }, + "node_modules/capital-case": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/capital-case/-/capital-case-1.0.4.tgz", + "integrity": "sha512-ds37W8CytHgwnhGGTi88pcPyR15qoNkOpYwmMMfnWqqWgESapLqvDx6huFjQ5vqWSn2Z06173XNA7LtMOeUh1A==", + "dev": true, + "dependencies": { + "no-case": "^3.0.4", + "tslib": "^2.0.3", + "upper-case-first": "^2.0.2" + } + }, + "node_modules/chai": { + "version": "4.3.6", + "resolved": "https://registry.npmjs.org/chai/-/chai-4.3.6.tgz", + "integrity": "sha512-bbcp3YfHCUzMOvKqsztczerVgBKSsEijCySNlHHbX3VG1nskvqjz5Rfso1gGwD6w6oOV3eI60pKuMOV5MV7p3Q==", + "dev": true, + "dependencies": { + "assertion-error": "^1.1.0", + "check-error": "^1.0.2", + "deep-eql": "^3.0.1", + "get-func-name": "^2.0.0", + "loupe": "^2.3.1", + "pathval": "^1.1.1", + "type-detect": "^4.0.5" + }, + "engines": { + "node": ">=4" + } + }, "node_modules/chalk": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", @@ -1194,12 +1469,27 @@ "node": ">=4.0.0" } }, + "node_modules/check-error": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.2.tgz", + "integrity": "sha1-V00xLt2Iu13YkS6Sht1sCu1KrII=", + "dev": true, + "engines": { + "node": "*" + } + }, "node_modules/ci-info": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-2.0.0.tgz", "integrity": "sha512-5tK7EtrZ0N+OLFMthtqOj4fI2Jeb88C4CAZPu25LDVUgXJ0A3Js4PMGqrn0JU1W0Mh1/Z8wZzYPxqUrXeBboCQ==", "dev": true }, + "node_modules/class-transformer": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/class-transformer/-/class-transformer-0.4.0.tgz", + "integrity": "sha512-ETWD/H2TbWbKEi7m9N4Km5+cw1hNcqJSxlSYhsLsNjQzWWiZIYA1zafxpK9PwVfaZ6AqR5rrjPVUBGESm5tQUA==", + "dev": true + }, "node_modules/cli-cursor": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", @@ -1224,6 +1514,21 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/cli-table3": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/cli-table3/-/cli-table3-0.6.1.tgz", + "integrity": "sha512-w0q/enDHhPLq44ovMGdQeeDLvwxwavsJX7oQGYt/LrBlYsyaxyDnp6z3QzFut/6kLLKnlcUVJLrpB7KBfgG/RA==", + "dev": true, + "dependencies": { + "string-width": "^4.2.0" + }, + "engines": { + "node": "10.* || >= 12.*" + }, + "optionalDependencies": { + "colors": "1.4.0" + } + }, "node_modules/cli-width": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-3.0.0.tgz", @@ -1271,6 +1576,15 @@ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true }, + "node_modules/colors": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", + "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", + "dev": true, + "engines": { + "node": ">=0.1.90" + } + }, "node_modules/commander": { "version": "8.3.0", "resolved": "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz", @@ -1434,6 +1748,16 @@ "node": ">=10" } }, + "node_modules/d": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/d/-/d-1.0.1.tgz", + "integrity": "sha512-m62ShEObQ39CfralilEQRjH6oAMtNCV1xJyEx5LpRYUVN+EviphDgUc/F3hnYbADmkiNs67Y+3ylmlG7Lnu+FA==", + "dev": true, + "dependencies": { + "es5-ext": "^0.10.50", + "type": "^1.0.1" + } + }, "node_modules/data-uri-to-buffer": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-3.0.1.tgz", @@ -1482,6 +1806,18 @@ "node": ">=0.10.0" } }, + "node_modules/deep-eql": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-3.0.1.tgz", + "integrity": "sha512-+QeIQyN5ZuO+3Uk5DYh6/1eKO0m0YmJFGNmFHGACpf1ClL1nmlV/p4gNgbl2pJGxgXb4faqo6UE+M5ACEMyVcw==", + "dev": true, + "dependencies": { + "type-detect": "^4.0.0" + }, + "engines": { + "node": ">=0.12" + } + }, "node_modules/deep-is": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", @@ -1542,6 +1878,15 @@ "node": ">= 0.6.0" } }, + "node_modules/diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "dev": true, + "engines": { + "node": ">=0.3.1" + } + }, "node_modules/docopt": { "version": "0.6.2", "resolved": "https://registry.npmjs.org/docopt/-/docopt-0.6.2.tgz", @@ -1551,6 +1896,25 @@ "node": ">=0.10.0" } }, + "node_modules/duration": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/duration/-/duration-0.2.2.tgz", + "integrity": "sha512-06kgtea+bGreF5eKYgI/36A6pLXggY7oR4p1pq4SmdFBn1ReOL5D8RhG64VrqfTTKNucqqtBAwEj8aB88mcqrg==", + "dev": true, + "dependencies": { + "d": "1", + "es5-ext": "~0.10.46" + } + }, + "node_modules/durations": { + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/durations/-/durations-3.4.2.tgz", + "integrity": "sha512-V/lf7y33dGaypZZetVI1eu7BmvkbC4dItq12OElLRpKuaU5JxQstV2zHwLv8P7cNbQ+KL1WD80zMCTx5dNC4dg==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/easy-table": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/easy-table/-/easy-table-1.1.0.tgz", @@ -1581,6 +1945,38 @@ "is-arrayish": "^0.2.1" } }, + "node_modules/es5-ext": { + "version": "0.10.53", + "resolved": "https://registry.npmjs.org/es5-ext/-/es5-ext-0.10.53.tgz", + "integrity": "sha512-Xs2Stw6NiNHWypzRTY1MtaG/uJlwCk8kH81920ma8mvN8Xq1gsfhZvpkImLQArw8AHnv8MT2I45J3c0R8slE+Q==", + "dev": true, + "dependencies": { + "es6-iterator": "~2.0.3", + "es6-symbol": "~3.1.3", + "next-tick": "~1.0.0" + } + }, + "node_modules/es6-iterator": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/es6-iterator/-/es6-iterator-2.0.3.tgz", + "integrity": "sha1-p96IkUGgWpSwhUQDstCg+/qY87c=", + "dev": true, + "dependencies": { + "d": "1", + "es5-ext": "^0.10.35", + "es6-symbol": "^3.1.1" + } + }, + "node_modules/es6-symbol": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/es6-symbol/-/es6-symbol-3.1.3.tgz", + "integrity": "sha512-NJ6Yn3FuDinBaBRWl/q5X/s4koRHBrgKAu+yGI6JCBeiu3qrcbJhwT2GeR/EXVfylRk8dpQVJoLEFhK+Mu31NA==", + "dev": true, + "dependencies": { + "d": "^1.0.1", + "ext": "^1.1.2" + } + }, "node_modules/escalade": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz", @@ -1667,6 +2063,21 @@ "node": ">=6" } }, + "node_modules/ext": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/ext/-/ext-1.6.0.tgz", + "integrity": "sha512-sdBImtzkq2HpkdRLtlLWDa6w4DX22ijZLKx8BMPUuKe1c5lbN6xwQDQCxSfxBQnHZ13ls/FH0MQZx/q/gr6FQg==", + "dev": true, + "dependencies": { + "type": "^2.5.0" + } + }, + "node_modules/ext/node_modules/type": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/type/-/type-2.5.0.tgz", + "integrity": "sha512-180WMDQaIMm3+7hGXWf12GtdniDEy7nYcyFMKJn/eZz/6tSLXrUN9V0wKSbMjej0I1WHWbpREDEKHtqPQa9NNw==", + "dev": true + }, "node_modules/external-editor": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/external-editor/-/external-editor-3.1.0.tgz", @@ -1681,6 +2092,15 @@ "node": ">=4" } }, + "node_modules/extsprintf": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/extsprintf/-/extsprintf-1.4.1.tgz", + "integrity": "sha512-Wrk35e8ydCKDj/ArClo1VrPVmN8zph5V4AtHwIuHhvMXsKf73UT3BOD+azBIW+3wOJ4FhEH7zyaJCFvChjYvMA==", + "dev": true, + "engines": [ + "node >=0.6.0" + ] + }, "node_modules/faker": { "version": "5.5.3", "resolved": "https://registry.npmjs.org/faker/-/faker-5.5.3.tgz", @@ -1918,6 +2338,15 @@ "node": "6.* || 8.* || >= 10.*" } }, + "node_modules/get-func-name": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.0.tgz", + "integrity": "sha1-6td0q+5y4gQJQzoGY2YCPdaIekE=", + "dev": true, + "engines": { + "node": "*" + } + }, "node_modules/get-uri": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/get-uri/-/get-uri-3.0.2.tgz", @@ -2169,6 +2598,15 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/indent-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz", + "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", @@ -2291,6 +2729,18 @@ "@types/estree": "*" } }, + "node_modules/is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "dev": true, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/sponsors/sindresorhus" + } + }, "node_modules/is-unicode-supported": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-0.1.0.tgz", @@ -2423,6 +2873,15 @@ "node": ">=0.10.0" } }, + "node_modules/knuth-shuffle-seeded": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/knuth-shuffle-seeded/-/knuth-shuffle-seeded-1.0.6.tgz", + "integrity": "sha1-AfG2VzOqdUDuCNiwF0Fk0iCB5OE=", + "dev": true, + "dependencies": { + "seed-random": "~2.2.0" + } + }, "node_modules/leven": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", @@ -2515,6 +2974,24 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/loupe": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/loupe/-/loupe-2.3.1.tgz", + "integrity": "sha512-EN1D3jyVmaX4tnajVlfbREU4axL647hLec1h/PXAb8CPDMJiYitcWF2UeLVNttRqaIqQs4x+mRvXf+d+TlDrCA==", + "dev": true, + "dependencies": { + "get-func-name": "^2.0.0" + } + }, + "node_modules/lower-case": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz", + "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==", + "dev": true, + "dependencies": { + "tslib": "^2.0.3" + } + }, "node_modules/lru-cache": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", @@ -2681,6 +3158,17 @@ "node": ">=12" } }, + "node_modules/mz": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/mz/-/mz-2.7.0.tgz", + "integrity": "sha512-z81GNO7nnYMEhrGh9LeymoE4+Yr0Wn5McHIZMK5cfQCl+NDX08sCZgUc9/6MHni9IWuFLm1Z3HTCXu2z9fN62Q==", + "dev": true, + "dependencies": { + "any-promise": "^1.0.0", + "object-assign": "^4.0.1", + "thenify-all": "^1.0.0" + } + }, "node_modules/netmask": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/netmask/-/netmask-2.0.2.tgz", @@ -2690,6 +3178,12 @@ "node": ">= 0.4.0" } }, + "node_modules/next-tick": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/next-tick/-/next-tick-1.0.0.tgz", + "integrity": "sha1-yobR/ogoFpsBICCOPchCS524NCw=", + "dev": true + }, "node_modules/nimma": { "version": "0.1.7", "resolved": "https://registry.npmjs.org/nimma/-/nimma-0.1.7.tgz", @@ -2709,6 +3203,16 @@ "lodash.topath": "^4.5.2" } }, + "node_modules/no-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz", + "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==", + "dev": true, + "dependencies": { + "lower-case": "^2.0.2", + "tslib": "^2.0.3" + } + }, "node_modules/node-fetch": { "version": "2.6.7", "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz", @@ -2741,6 +3245,18 @@ "node": "4.x || >=6.0.0" } }, + "node_modules/nswag": { + "version": "13.15.7", + "resolved": "https://registry.npmjs.org/nswag/-/nswag-13.15.7.tgz", + "integrity": "sha512-3PLCWU3yEL2f27Pfi1t7CyT7fFCei9GiHowM4x8S6/MnYBgBIo2fMPTKXyf8RyMSG3t+BpcU07dM1AE578Axmg==", + "dev": true, + "bin": { + "nswag": "bin/nswag.js" + }, + "engines": { + "npm": ">=3.10.8" + } + }, "node_modules/oas-kit-common": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/oas-kit-common/-/oas-kit-common-1.0.8.tgz", @@ -2888,6 +3404,15 @@ "node": ">=6" } }, + "node_modules/object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/object-hash": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/object-hash/-/object-hash-2.2.0.tgz", @@ -3104,6 +3629,18 @@ "node": ">= 8" } }, + "node_modules/pad-right": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/pad-right/-/pad-right-0.2.2.tgz", + "integrity": "sha1-b7ySQEXSRPKiokRQMGDTv8YAl3Q=", + "dev": true, + "dependencies": { + "repeat-string": "^1.5.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/parent-module": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", @@ -3179,6 +3716,15 @@ "node": ">=8" } }, + "node_modules/pathval": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/pathval/-/pathval-1.1.1.tgz", + "integrity": "sha512-Dp6zGqpTdETdR63lehJYPeIOqpiNBNtc7BpWSLrOje7UaIsE5aY92r/AunQA7rsXvet3lrJ3JnZX29UPTKXyKQ==", + "dev": true, + "engines": { + "node": "*" + } + }, "node_modules/picomatch": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", @@ -3276,6 +3822,15 @@ "node": ">= 0.8.0" } }, + "node_modules/progress": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", + "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", + "dev": true, + "engines": { + "node": ">=0.4.0" + } + }, "node_modules/proxy-agent": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/proxy-agent/-/proxy-agent-5.0.0.tgz", @@ -3374,6 +3929,33 @@ "url": "https://github.com/Mermade/oas-kit?sponsor=1" } }, + "node_modules/regexp-match-indices": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/regexp-match-indices/-/regexp-match-indices-1.0.2.tgz", + "integrity": "sha512-DwZuAkt8NF5mKwGGER1EGh2PRqyvhRhhLviH+R8y8dIuaQROlUfXjt4s9ZTXstIsSkptf06BSvwcEmmfheJJWQ==", + "dev": true, + "dependencies": { + "regexp-tree": "^0.1.11" + } + }, + "node_modules/regexp-tree": { + "version": "0.1.24", + "resolved": "https://registry.npmjs.org/regexp-tree/-/regexp-tree-0.1.24.tgz", + "integrity": "sha512-s2aEVuLhvnVJW6s/iPgEGK6R+/xngd2jNQ+xy4bXNDKxZKJH6jpPHY6kVeVv1IeLCHgswRj+Kl3ELaDjG6V1iw==", + "dev": true, + "bin": { + "regexp-tree": "bin/regexp-tree" + } + }, + "node_modules/repeat-string": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", + "integrity": "sha1-jcrkcOHIirwtYA//Sndihtp15jc=", + "dev": true, + "engines": { + "node": ">=0.10" + } + }, "node_modules/require-directory": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", @@ -3433,6 +4015,27 @@ "node": ">=4" } }, + "node_modules/resolve-pkg": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/resolve-pkg/-/resolve-pkg-2.0.0.tgz", + "integrity": "sha512-+1lzwXehGCXSeryaISr6WujZzowloigEofRB+dj75y9RRa/obVcYgbHJd53tdYw8pvZj8GojXaaENws8Ktw/hQ==", + "dev": true, + "dependencies": { + "resolve-from": "^5.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/resolve-pkg/node_modules/resolve-from": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-5.0.0.tgz", + "integrity": "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/restore-cursor": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", @@ -3456,6 +4059,21 @@ "node": ">=0.10.0" } }, + "node_modules/rimraf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "dev": true, + "dependencies": { + "glob": "^7.1.3" + }, + "bin": { + "rimraf": "bin.js" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/rollup": { "version": "2.66.1", "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.66.1.tgz", @@ -3557,6 +4175,12 @@ "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==", "dev": true }, + "node_modules/seed-random": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/seed-random/-/seed-random-2.2.0.tgz", + "integrity": "sha1-KpsZ4lCoFwmSMaW5mk2vgLf77VQ=", + "dev": true + }, "node_modules/semver": { "version": "7.3.5", "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", @@ -3690,11 +4314,20 @@ "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", "dev": true, - "optional": true, "engines": { "node": ">=0.10.0" } }, + "node_modules/source-map-support": { + "version": "0.5.19", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.19.tgz", + "integrity": "sha512-Wonm7zOCIJzBGQdB+thsPar0kYuCIzYvxZwlBa87yi/Mdjv7Tip2cyVbLj5o0cFPN4EVkuTwb3GDDyUx2DGnGw==", + "dev": true, + "dependencies": { + "buffer-from": "^1.0.0", + "source-map": "^0.6.0" + } + }, "node_modules/sourcemap-codec": { "version": "1.4.8", "resolved": "https://registry.npmjs.org/sourcemap-codec/-/sourcemap-codec-1.4.8.tgz", @@ -3713,6 +4346,12 @@ "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", "dev": true }, + "node_modules/stack-chain": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/stack-chain/-/stack-chain-2.0.0.tgz", + "integrity": "sha512-GGrHXePi305aW7XQweYZZwiRwR7Js3MWoK/EHzzB9ROdc75nCnjSJVi21rdAGxFl+yCx2L2qdfl5y7NO4lTyqg==", + "dev": true + }, "node_modules/statuses": { "version": "1.5.0", "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz", @@ -3731,6 +4370,15 @@ "safe-buffer": "~5.2.0" } }, + "node_modules/string-argv": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz", + "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==", + "dev": true, + "engines": { + "node": ">=0.6.19" + } + }, "node_modules/string-width": { "version": "4.2.3", "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", @@ -3787,6 +4435,27 @@ "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", "dev": true }, + "node_modules/thenify": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/thenify/-/thenify-3.3.1.tgz", + "integrity": "sha512-RVZSIV5IG10Hk3enotrhvz0T9em6cyHBLkH/YAZuKqd8hRkKhSfCGIcP2KUY0EPxndzANBmNllzWPwak+bheSw==", + "dev": true, + "dependencies": { + "any-promise": "^1.0.0" + } + }, + "node_modules/thenify-all": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/thenify-all/-/thenify-all-1.6.0.tgz", + "integrity": "sha1-GhkY1ALY/D+Y+/I02wvMjMEOlyY=", + "dev": true, + "dependencies": { + "thenify": ">= 3.1.0 < 4" + }, + "engines": { + "node": ">=0.8" + } + }, "node_modules/through": { "version": "2.3.8", "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", @@ -3847,6 +4516,12 @@ "integrity": "sha512-uZtkfKblCEQtZKBF6EBXVZeQNl82yqtDQdv+eck8u7tdPxjLu2/lp5/uPW+um2tpuxINHWy3GhiccY7QgEaVHQ==", "dev": true }, + "node_modules/type": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/type/-/type-1.2.0.tgz", + "integrity": "sha512-+5nt5AAniqsCnu2cEQQdpzCAh33kVx8n0VoFidKpB1dVVLAN/F+bgVOqOJqOnEnrhp222clB5p3vUlD+1QAnfg==", + "dev": true + }, "node_modules/type-check": { "version": "0.3.2", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz", @@ -3859,6 +4534,15 @@ "node": ">= 0.8.0" } }, + "node_modules/type-detect": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/type-detect/-/type-detect-4.0.8.tgz", + "integrity": "sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==", + "dev": true, + "engines": { + "node": ">=4" + } + }, "node_modules/type-fest": { "version": "0.21.3", "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", @@ -3889,6 +4573,15 @@ "node": ">= 0.8" } }, + "node_modules/upper-case-first": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/upper-case-first/-/upper-case-first-2.0.2.tgz", + "integrity": "sha512-514ppYHBaKwfJRK/pNC6c/OxfGa0obSnAl106u97Ed0I625Nin96KAjttZF6ZL3e1XLtphxnqrOi9iWgm+u+bg==", + "dev": true, + "dependencies": { + "tslib": "^2.0.3" + } + }, "node_modules/uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -3904,6 +4597,12 @@ "integrity": "sha512-Id+IKjdU0Hx+7Zx717jwLPsPeUqz7rAtuVBRLLs+qn+J2nf9NGITWVCxcijgYxBqe83C7sqsQPs6H1pyz3x9gA==", "dev": true }, + "node_modules/util-arity": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/util-arity/-/util-arity-1.1.0.tgz", + "integrity": "sha1-WdAa8f2z/t4KxOYysKtfbOl8kzA=", + "dev": true + }, "node_modules/util-deprecate": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", @@ -3974,6 +4673,26 @@ "integrity": "sha1-9j/+2iSL8opnqNSODjtGGhZluvg=", "dev": true }, + "node_modules/verror": { + "version": "1.10.1", + "resolved": "https://registry.npmjs.org/verror/-/verror-1.10.1.tgz", + "integrity": "sha512-veufcmxri4e3XSrT0xwfUR7kguIkaxBeosDg00yDWhk49wdwkSUrvvsm7nc75e1PUyvIeZj6nS8VQRYz2/S4Xg==", + "dev": true, + "dependencies": { + "assert-plus": "^1.0.0", + "core-util-is": "1.0.2", + "extsprintf": "^1.2.0" + }, + "engines": { + "node": ">=0.6.0" + } + }, + "node_modules/verror/node_modules/core-util-is": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", + "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=", + "dev": true + }, "node_modules/vm2": { "version": "3.9.5", "resolved": "https://registry.npmjs.org/vm2/-/vm2-3.9.5.tgz", @@ -4209,32 +4928,197 @@ "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", "dev": true, "requires": { - "color-name": "1.1.3" + "color-name": "1.1.3" + } + }, + "color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", + "dev": true + }, + "has-flag": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", + "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + "dev": true + }, + "supports-color": { + "version": "5.5.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", + "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, + "requires": { + "has-flag": "^3.0.0" + } + } + } + }, + "@cspotcode/source-map-consumer": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-consumer/-/source-map-consumer-0.8.0.tgz", + "integrity": "sha512-41qniHzTU8yAGbCp04ohlmSrZf8bkf/iJsl3V0dRGsQN/5GFfx+LbCSsCpp2gqrqjTVg/K6O8ycoV35JIwAzAg==", + "dev": true + }, + "@cspotcode/source-map-support": { + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.7.0.tgz", + "integrity": "sha512-X4xqRHqN8ACt2aHVe51OxeA2HjbcL4MqFqXkrmQszJ1NOUuUu5u6Vqx/0lZSVNku7velL5FC/s5uEAj1lsBMhA==", + "dev": true, + "requires": { + "@cspotcode/source-map-consumer": "0.8.0" + } + }, + "@cucumber/ci-environment": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/@cucumber/ci-environment/-/ci-environment-8.0.1.tgz", + "integrity": "sha512-oQ6nifJ5MRyHFyCsBQU+D0CERSPbxezOxlVpJXcSrcOdKbdqGojZcu17Ww13dyHUGN8c417pWUifIlOrxrsZTQ==", + "dev": true + }, + "@cucumber/cucumber": { + "version": "8.0.0-rc.2", + "resolved": "https://registry.npmjs.org/@cucumber/cucumber/-/cucumber-8.0.0-rc.2.tgz", + "integrity": "sha512-cYcZEIkYl2BmdTa0VS62JUty2Vg/N+EC81xujNajaQQfXiKamwbunGFQhaqxrXIFmlFpuSASnEm4UudELbOfJw==", + "dev": true, + "requires": { + "@cspotcode/source-map-support": "^0.7.0", + "@cucumber/ci-environment": "8.0.1", + "@cucumber/cucumber-expressions": "14.0.0", + "@cucumber/gherkin": "22.0.0", + "@cucumber/gherkin-streams": "4.0.0", + "@cucumber/html-formatter": "17.0.0", + "@cucumber/messages": "17.1.1", + "@cucumber/tag-expressions": "4.1.0", + "assertion-error-formatter": "^3.0.0", + "capital-case": "^1.0.4", + "cli-table3": "0.6.1", + "colors": "1.4.0", + "commander": "^8.0.0", + "duration": "^0.2.2", + "durations": "^3.4.2", + "figures": "^3.2.0", + "glob": "^7.1.6", + "indent-string": "^4.0.0", + "is-stream": "^2.0.0", + "knuth-shuffle-seeded": "^1.0.6", + "mz": "^2.7.0", + "progress": "^2.0.3", + "resolve": "^1.19.0", + "resolve-pkg": "^2.0.0", + "stack-chain": "^2.0.0", + "string-argv": "^0.3.1", + "tmp": "^0.2.1", + "util-arity": "^1.1.0", + "verror": "^1.10.0" + }, + "dependencies": { + "tmp": { + "version": "0.2.1", + "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.2.1.tgz", + "integrity": "sha512-76SUhtfqR2Ijn+xllcI5P1oyannHNHByD80W1q447gU3mp9G9PSpGdWmjUOHRDPiHYacIk66W7ubDTuPF3BEtQ==", + "dev": true, + "requires": { + "rimraf": "^3.0.0" + } + } + } + }, + "@cucumber/cucumber-expressions": { + "version": "14.0.0", + "resolved": "https://registry.npmjs.org/@cucumber/cucumber-expressions/-/cucumber-expressions-14.0.0.tgz", + "integrity": "sha512-QiuFBrj4dZRc1Igvp2/nOjUNFyDtO7uHTrzgY9DbwzebYAYOvM6CKGOSxSuPUzxowuc1nuRkzJfFUI1kHaZgPQ==", + "dev": true, + "requires": { + "regexp-match-indices": "1.0.2" + } + }, + "@cucumber/gherkin": { + "version": "22.0.0", + "resolved": "https://registry.npmjs.org/@cucumber/gherkin/-/gherkin-22.0.0.tgz", + "integrity": "sha512-D5OghXE8kkZm7pcwo8TvQMgrrXGMXEjERdKLU0T7dQIbc6k0BmMX8dTRh2cwAjH8c7vhwdd0qLU8FPQgGGj+bg==", + "dev": true, + "requires": { + "@cucumber/message-streams": "^3.0.0", + "@cucumber/messages": "^17.1.1" + } + }, + "@cucumber/gherkin-streams": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/@cucumber/gherkin-streams/-/gherkin-streams-4.0.0.tgz", + "integrity": "sha512-b/guGNeuxr3ghoJOK47QpLhwa2BOdRq+cs2hBYulMLPTiVfwvRBiZlq7P6xdjR9dIpUKBSpzYR6NwaLMgV5DTg==", + "dev": true, + "requires": { + "@cucumber/gherkin": "^21.0.0", + "@cucumber/message-streams": "^3.0.0", + "@cucumber/messages": "^17.1.0", + "commander": "8.1.0", + "source-map-support": "0.5.19" + }, + "dependencies": { + "@cucumber/gherkin": { + "version": "21.0.0", + "resolved": "https://registry.npmjs.org/@cucumber/gherkin/-/gherkin-21.0.0.tgz", + "integrity": "sha512-S6YFmTg56iEn563ReePL6Sygb77vwYrGHEr7NwuLIgg20Hi1pp7P80BAYVYNRgU7nK9vG2II9O6kaZbiOXF/5g==", + "dev": true, + "requires": { + "@cucumber/message-streams": "^3.0.0", + "@cucumber/messages": "^17.1.0" } }, - "color-name": { - "version": "1.1.3", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", - "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", + "commander": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-8.1.0.tgz", + "integrity": "sha512-mf45ldcuHSYShkplHHGKWb4TrmwQadxOn7v4WuhDJy0ZVoY5JFajaRDKD0PNe5qXzBX0rhovjTnP6Kz9LETcuA==", "dev": true - }, - "has-flag": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", - "integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=", + } + } + }, + "@cucumber/html-formatter": { + "version": "17.0.0", + "resolved": "https://registry.npmjs.org/@cucumber/html-formatter/-/html-formatter-17.0.0.tgz", + "integrity": "sha512-yegA8LY1HYUONyMtTvAYj+aG4zc/6WRtKQxqJahjcdmjgXWcL1BTe8y0lw4BFVqFjaZNI9onOM5KDnMHDm3J/w==", + "dev": true, + "requires": { + "@cucumber/messages": "^17.1.0", + "commander": "8.1.0", + "source-map-support": "0.5.19" + }, + "dependencies": { + "commander": { + "version": "8.1.0", + "resolved": "https://registry.npmjs.org/commander/-/commander-8.1.0.tgz", + "integrity": "sha512-mf45ldcuHSYShkplHHGKWb4TrmwQadxOn7v4WuhDJy0ZVoY5JFajaRDKD0PNe5qXzBX0rhovjTnP6Kz9LETcuA==", "dev": true - }, - "supports-color": { - "version": "5.5.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", - "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", - "dev": true, - "requires": { - "has-flag": "^3.0.0" - } } } }, + "@cucumber/message-streams": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/@cucumber/message-streams/-/message-streams-3.0.0.tgz", + "integrity": "sha512-ABx91nKUebV8mLmpf7BsB3bmQ57CDAfj2EIZswThz+nJHYPAFlZ1JewI6ykFsR9RzJ7/QhgQs0KHeQh7nH/u1Q==", + "dev": true, + "requires": { + "@cucumber/messages": "^17.0.0" + } + }, + "@cucumber/messages": { + "version": "17.1.1", + "resolved": "https://registry.npmjs.org/@cucumber/messages/-/messages-17.1.1.tgz", + "integrity": "sha512-KQMn2Ag+1g1CXp/zKQ7LLqmuHjuQwuXw0N2u5SrDk8r72zPt36SxmDSJK7w6HiFTI+3p5ZuzwLi4S5jop3Tx4g==", + "dev": true, + "requires": { + "@types/uuid": "8.3.1", + "class-transformer": "0.4.0", + "reflect-metadata": "0.1.13", + "uuid": "8.3.2" + } + }, + "@cucumber/tag-expressions": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/@cucumber/tag-expressions/-/tag-expressions-4.1.0.tgz", + "integrity": "sha512-chTnjxV3vryL75N90wJIMdMafXmZoO2JgNJLYpsfcALL2/IQrRiny3vM9DgD5RDCSt1LNloMtb7rGey9YWxCsA==", + "dev": true + }, "@jsep-plugin/regex": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/@jsep-plugin/regex/-/regex-1.0.1.tgz", @@ -4261,6 +5145,15 @@ "uuid": "8.3.2" }, "dependencies": { + "axios": { + "version": "0.24.0", + "resolved": "https://registry.npmjs.org/axios/-/axios-0.24.0.tgz", + "integrity": "sha512-Q6cWsys88HoPgAaFAVUb0WpPk0O8iTeisR9IMqy9G8AbO4NlpVknrnQS03zzF9PGAWgO3cgletO3VjV/P7VztA==", + "dev": true, + "requires": { + "follow-redirects": "^1.14.4" + } + }, "tslib": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.3.1.tgz", @@ -4858,6 +5751,12 @@ "integrity": "sha512-tjftsOLuIWFLJxcpgFeehNnMhpMIv0ELJl0/i31jiV3au1GQpnd3/pTTDQg2zO5cSGJxtrDzMgebOH7+cqh3Vg==", "dev": true }, + "@types/uuid": { + "version": "8.3.1", + "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-8.3.1.tgz", + "integrity": "sha512-Y2mHTRAbqfFkpjldbkHGY8JIzRN6XqYRliG8/24FcHm2D2PwW24fl5xMRTVGdrb7iMrwCaIEbLWerGIkXuFWVg==", + "dev": true + }, "abort-controller": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/abort-controller/-/abort-controller-3.0.0.tgz", @@ -4935,6 +5834,12 @@ "color-convert": "^2.0.1" } }, + "any-promise": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/any-promise/-/any-promise-1.3.0.tgz", + "integrity": "sha1-q8av7tzqUugJzcA3au0845Y10X8=", + "dev": true + }, "argparse": { "version": "1.0.10", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", @@ -4944,6 +5849,29 @@ "sprintf-js": "~1.0.2" } }, + "assert-plus": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/assert-plus/-/assert-plus-1.0.0.tgz", + "integrity": "sha1-8S4PPF13sLHN2RRpQuTpbB5N1SU=", + "dev": true + }, + "assertion-error": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/assertion-error/-/assertion-error-1.1.0.tgz", + "integrity": "sha512-jgsaNduz+ndvGyFt3uSuWqvy4lCnIJiovtouQN5JZHOKCS2QuhEdbcQHFhVksz2N2U9hXJo8odG7ETyWlEeuDw==", + "dev": true + }, + "assertion-error-formatter": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/assertion-error-formatter/-/assertion-error-formatter-3.0.0.tgz", + "integrity": "sha512-6YyAVLrEze0kQ7CmJfUgrLHb+Y7XghmL2Ie7ijVa2Y9ynP3LV+VDiwFk62Dn0qtqbmY0BT0ss6p1xxpiF2PYbQ==", + "dev": true, + "requires": { + "diff": "^4.0.1", + "pad-right": "^0.2.2", + "repeat-string": "^1.6.1" + } + }, "ast-types": { "version": "0.14.2", "resolved": "https://registry.npmjs.org/ast-types/-/ast-types-0.14.2.tgz", @@ -4966,12 +5894,12 @@ "dev": true }, "axios": { - "version": "0.24.0", - "resolved": "https://registry.npmjs.org/axios/-/axios-0.24.0.tgz", - "integrity": "sha512-Q6cWsys88HoPgAaFAVUb0WpPk0O8iTeisR9IMqy9G8AbO4NlpVknrnQS03zzF9PGAWgO3cgletO3VjV/P7VztA==", + "version": "0.25.0", + "resolved": "https://registry.npmjs.org/axios/-/axios-0.25.0.tgz", + "integrity": "sha512-cD8FOb0tRH3uuEe6+evtAbgJtfxr7ly3fQjYcMcuPlgkwVS9xboaVIpcDV+cYQe+yGykgwZCs1pzjntcGa6l5g==", "dev": true, "requires": { - "follow-redirects": "^1.14.4" + "follow-redirects": "^1.14.7" } }, "balanced-match": { @@ -5032,6 +5960,12 @@ "ieee754": "^1.1.13" } }, + "buffer-from": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", + "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", + "dev": true + }, "builtins": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/builtins/-/builtins-1.0.3.tgz", @@ -5056,6 +5990,32 @@ "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", "dev": true }, + "capital-case": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/capital-case/-/capital-case-1.0.4.tgz", + "integrity": "sha512-ds37W8CytHgwnhGGTi88pcPyR15qoNkOpYwmMMfnWqqWgESapLqvDx6huFjQ5vqWSn2Z06173XNA7LtMOeUh1A==", + "dev": true, + "requires": { + "no-case": "^3.0.4", + "tslib": "^2.0.3", + "upper-case-first": "^2.0.2" + } + }, + "chai": { + "version": "4.3.6", + "resolved": "https://registry.npmjs.org/chai/-/chai-4.3.6.tgz", + "integrity": "sha512-bbcp3YfHCUzMOvKqsztczerVgBKSsEijCySNlHHbX3VG1nskvqjz5Rfso1gGwD6w6oOV3eI60pKuMOV5MV7p3Q==", + "dev": true, + "requires": { + "assertion-error": "^1.1.0", + "check-error": "^1.0.2", + "deep-eql": "^3.0.1", + "get-func-name": "^2.0.0", + "loupe": "^2.3.1", + "pathval": "^1.1.1", + "type-detect": "^4.0.5" + } + }, "chalk": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", @@ -5078,12 +6038,24 @@ "integrity": "sha512-6dVyOOYjpfFcL1Y4qChrAoQLRHvj2ziyhcm0QJlhOcAhykL/k1kTUPbeo+87MNRTRdk2OIIsIXbuF3x2wi5EXg==", "dev": true }, + "check-error": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/check-error/-/check-error-1.0.2.tgz", + "integrity": "sha1-V00xLt2Iu13YkS6Sht1sCu1KrII=", + "dev": true + }, "ci-info": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/ci-info/-/ci-info-2.0.0.tgz", "integrity": "sha512-5tK7EtrZ0N+OLFMthtqOj4fI2Jeb88C4CAZPu25LDVUgXJ0A3Js4PMGqrn0JU1W0Mh1/Z8wZzYPxqUrXeBboCQ==", "dev": true }, + "class-transformer": { + "version": "0.4.0", + "resolved": "https://registry.npmjs.org/class-transformer/-/class-transformer-0.4.0.tgz", + "integrity": "sha512-ETWD/H2TbWbKEi7m9N4Km5+cw1hNcqJSxlSYhsLsNjQzWWiZIYA1zafxpK9PwVfaZ6AqR5rrjPVUBGESm5tQUA==", + "dev": true + }, "cli-cursor": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/cli-cursor/-/cli-cursor-3.1.0.tgz", @@ -5099,6 +6071,16 @@ "integrity": "sha512-x/5fWmGMnbKQAaNwN+UZlV79qBLM9JFnJuJ03gIi5whrob0xV0ofNVHy9DhwGdsMJQc2OKv0oGmLzvaqvAVv+g==", "dev": true }, + "cli-table3": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/cli-table3/-/cli-table3-0.6.1.tgz", + "integrity": "sha512-w0q/enDHhPLq44ovMGdQeeDLvwxwavsJX7oQGYt/LrBlYsyaxyDnp6z3QzFut/6kLLKnlcUVJLrpB7KBfgG/RA==", + "dev": true, + "requires": { + "colors": "1.4.0", + "string-width": "^4.2.0" + } + }, "cli-width": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/cli-width/-/cli-width-3.0.0.tgz", @@ -5137,6 +6119,12 @@ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true }, + "colors": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", + "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", + "dev": true + }, "commander": { "version": "8.3.0", "resolved": "https://registry.npmjs.org/commander/-/commander-8.3.0.tgz", @@ -5275,6 +6263,16 @@ "yaml": "^1.10.0" } }, + "d": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/d/-/d-1.0.1.tgz", + "integrity": "sha512-m62ShEObQ39CfralilEQRjH6oAMtNCV1xJyEx5LpRYUVN+EviphDgUc/F3hnYbADmkiNs67Y+3ylmlG7Lnu+FA==", + "dev": true, + "requires": { + "es5-ext": "^0.10.50", + "type": "^1.0.1" + } + }, "data-uri-to-buffer": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-3.0.1.tgz", @@ -5302,6 +6300,15 @@ "integrity": "sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=", "dev": true }, + "deep-eql": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/deep-eql/-/deep-eql-3.0.1.tgz", + "integrity": "sha512-+QeIQyN5ZuO+3Uk5DYh6/1eKO0m0YmJFGNmFHGACpf1ClL1nmlV/p4gNgbl2pJGxgXb4faqo6UE+M5ACEMyVcw==", + "dev": true, + "requires": { + "type-detect": "^4.0.0" + } + }, "deep-is": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", @@ -5352,12 +6359,34 @@ "integrity": "sha512-JeMq7fEshyepOWDfcfHK06N3MhyPhz++vtqWhMT5O9A3K42rdsEDpfdVqjaqaAhsw6a+ZqeDvQVtD0hFHQWrzg==", "dev": true }, + "diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "dev": true + }, "docopt": { "version": "0.6.2", "resolved": "https://registry.npmjs.org/docopt/-/docopt-0.6.2.tgz", "integrity": "sha1-so6eIiDaXsSffqW7JKR3h0Be6xE=", "dev": true }, + "duration": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/duration/-/duration-0.2.2.tgz", + "integrity": "sha512-06kgtea+bGreF5eKYgI/36A6pLXggY7oR4p1pq4SmdFBn1ReOL5D8RhG64VrqfTTKNucqqtBAwEj8aB88mcqrg==", + "dev": true, + "requires": { + "d": "1", + "es5-ext": "~0.10.46" + } + }, + "durations": { + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/durations/-/durations-3.4.2.tgz", + "integrity": "sha512-V/lf7y33dGaypZZetVI1eu7BmvkbC4dItq12OElLRpKuaU5JxQstV2zHwLv8P7cNbQ+KL1WD80zMCTx5dNC4dg==", + "dev": true + }, "easy-table": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/easy-table/-/easy-table-1.1.0.tgz", @@ -5388,6 +6417,38 @@ "is-arrayish": "^0.2.1" } }, + "es5-ext": { + "version": "0.10.53", + "resolved": "https://registry.npmjs.org/es5-ext/-/es5-ext-0.10.53.tgz", + "integrity": "sha512-Xs2Stw6NiNHWypzRTY1MtaG/uJlwCk8kH81920ma8mvN8Xq1gsfhZvpkImLQArw8AHnv8MT2I45J3c0R8slE+Q==", + "dev": true, + "requires": { + "es6-iterator": "~2.0.3", + "es6-symbol": "~3.1.3", + "next-tick": "~1.0.0" + } + }, + "es6-iterator": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/es6-iterator/-/es6-iterator-2.0.3.tgz", + "integrity": "sha1-p96IkUGgWpSwhUQDstCg+/qY87c=", + "dev": true, + "requires": { + "d": "1", + "es5-ext": "^0.10.35", + "es6-symbol": "^3.1.1" + } + }, + "es6-symbol": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/es6-symbol/-/es6-symbol-3.1.3.tgz", + "integrity": "sha512-NJ6Yn3FuDinBaBRWl/q5X/s4koRHBrgKAu+yGI6JCBeiu3qrcbJhwT2GeR/EXVfylRk8dpQVJoLEFhK+Mu31NA==", + "dev": true, + "requires": { + "d": "^1.0.1", + "ext": "^1.1.2" + } + }, "escalade": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz", @@ -5443,6 +6504,23 @@ "integrity": "sha512-i/2XbnSz/uxRCU6+NdVJgKWDTM427+MqYbkQzD321DuCQJUqOuJKIA0IM2+W2xtYHdKOmZ4dR6fExsd4SXL+WQ==", "dev": true }, + "ext": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/ext/-/ext-1.6.0.tgz", + "integrity": "sha512-sdBImtzkq2HpkdRLtlLWDa6w4DX22ijZLKx8BMPUuKe1c5lbN6xwQDQCxSfxBQnHZ13ls/FH0MQZx/q/gr6FQg==", + "dev": true, + "requires": { + "type": "^2.5.0" + }, + "dependencies": { + "type": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/type/-/type-2.5.0.tgz", + "integrity": "sha512-180WMDQaIMm3+7hGXWf12GtdniDEy7nYcyFMKJn/eZz/6tSLXrUN9V0wKSbMjej0I1WHWbpREDEKHtqPQa9NNw==", + "dev": true + } + } + }, "external-editor": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/external-editor/-/external-editor-3.1.0.tgz", @@ -5454,6 +6532,12 @@ "tmp": "^0.0.33" } }, + "extsprintf": { + "version": "1.4.1", + "resolved": "https://registry.npmjs.org/extsprintf/-/extsprintf-1.4.1.tgz", + "integrity": "sha512-Wrk35e8ydCKDj/ArClo1VrPVmN8zph5V4AtHwIuHhvMXsKf73UT3BOD+azBIW+3wOJ4FhEH7zyaJCFvChjYvMA==", + "dev": true + }, "faker": { "version": "5.5.3", "resolved": "https://registry.npmjs.org/faker/-/faker-5.5.3.tgz", @@ -5633,6 +6717,12 @@ "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", "dev": true }, + "get-func-name": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/get-func-name/-/get-func-name-2.0.0.tgz", + "integrity": "sha1-6td0q+5y4gQJQzoGY2YCPdaIekE=", + "dev": true + }, "get-uri": { "version": "3.0.2", "resolved": "https://registry.npmjs.org/get-uri/-/get-uri-3.0.2.tgz", @@ -5814,6 +6904,12 @@ "resolve-from": "^4.0.0" } }, + "indent-string": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/indent-string/-/indent-string-4.0.0.tgz", + "integrity": "sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==", + "dev": true + }, "inflight": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", @@ -5915,6 +7011,12 @@ "@types/estree": "*" } }, + "is-stream": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.1.tgz", + "integrity": "sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==", + "dev": true + }, "is-unicode-supported": { "version": "0.1.0", "resolved": "https://registry.npmjs.org/is-unicode-supported/-/is-unicode-supported-0.1.0.tgz", @@ -6021,6 +7123,15 @@ "integrity": "sha512-PNYZIdMjVIvVgDSYKTT63Y+KZ6IZvGRNNWcxwD+GNnUz1MKPfv30J8ueCjdwcN0nDx2SlshgyB7Oy0epAzVRRg==", "dev": true }, + "knuth-shuffle-seeded": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/knuth-shuffle-seeded/-/knuth-shuffle-seeded-1.0.6.tgz", + "integrity": "sha1-AfG2VzOqdUDuCNiwF0Fk0iCB5OE=", + "dev": true, + "requires": { + "seed-random": "~2.2.0" + } + }, "leven": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", @@ -6092,6 +7203,24 @@ "is-unicode-supported": "^0.1.0" } }, + "loupe": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/loupe/-/loupe-2.3.1.tgz", + "integrity": "sha512-EN1D3jyVmaX4tnajVlfbREU4axL647hLec1h/PXAb8CPDMJiYitcWF2UeLVNttRqaIqQs4x+mRvXf+d+TlDrCA==", + "dev": true, + "requires": { + "get-func-name": "^2.0.0" + } + }, + "lower-case": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz", + "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==", + "dev": true, + "requires": { + "tslib": "^2.0.3" + } + }, "lru-cache": { "version": "5.1.1", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-5.1.1.tgz", @@ -6222,12 +7351,29 @@ "mvn-artifact-download": "^6.0.0" } }, + "mz": { + "version": "2.7.0", + "resolved": "https://registry.npmjs.org/mz/-/mz-2.7.0.tgz", + "integrity": "sha512-z81GNO7nnYMEhrGh9LeymoE4+Yr0Wn5McHIZMK5cfQCl+NDX08sCZgUc9/6MHni9IWuFLm1Z3HTCXu2z9fN62Q==", + "dev": true, + "requires": { + "any-promise": "^1.0.0", + "object-assign": "^4.0.1", + "thenify-all": "^1.0.0" + } + }, "netmask": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/netmask/-/netmask-2.0.2.tgz", "integrity": "sha512-dBpDMdxv9Irdq66304OLfEmQ9tbNRFnFTuZiLo+bD+r332bBmMJ8GBLXklIXXgxd3+v9+KUnZaUR5PJMa75Gsg==", "dev": true }, + "next-tick": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/next-tick/-/next-tick-1.0.0.tgz", + "integrity": "sha1-yobR/ogoFpsBICCOPchCS524NCw=", + "dev": true + }, "nimma": { "version": "0.1.7", "resolved": "https://registry.npmjs.org/nimma/-/nimma-0.1.7.tgz", @@ -6242,6 +7388,16 @@ "lodash.topath": "^4.5.2" } }, + "no-case": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz", + "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==", + "dev": true, + "requires": { + "lower-case": "^2.0.2", + "tslib": "^2.0.3" + } + }, "node-fetch": { "version": "2.6.7", "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz", @@ -6260,6 +7416,12 @@ "http2-client": "^1.2.5" } }, + "nswag": { + "version": "13.15.7", + "resolved": "https://registry.npmjs.org/nswag/-/nswag-13.15.7.tgz", + "integrity": "sha512-3PLCWU3yEL2f27Pfi1t7CyT7fFCei9GiHowM4x8S6/MnYBgBIo2fMPTKXyf8RyMSG3t+BpcU07dM1AE578Axmg==", + "dev": true + }, "oas-kit-common": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/oas-kit-common/-/oas-kit-common-1.0.8.tgz", @@ -6379,6 +7541,12 @@ } } }, + "object-assign": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", + "integrity": "sha1-IQmtx5ZYh8/AXLvUQsrIv7s2CGM=", + "dev": true + }, "object-hash": { "version": "2.2.0", "resolved": "https://registry.npmjs.org/object-hash/-/object-hash-2.2.0.tgz", @@ -6542,6 +7710,15 @@ "netmask": "^2.0.1" } }, + "pad-right": { + "version": "0.2.2", + "resolved": "https://registry.npmjs.org/pad-right/-/pad-right-0.2.2.tgz", + "integrity": "sha1-b7ySQEXSRPKiokRQMGDTv8YAl3Q=", + "dev": true, + "requires": { + "repeat-string": "^1.5.2" + } + }, "parent-module": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", @@ -6599,6 +7776,12 @@ "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", "dev": true }, + "pathval": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/pathval/-/pathval-1.1.1.tgz", + "integrity": "sha512-Dp6zGqpTdETdR63lehJYPeIOqpiNBNtc7BpWSLrOje7UaIsE5aY92r/AunQA7rsXvet3lrJ3JnZX29UPTKXyKQ==", + "dev": true + }, "picomatch": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", @@ -6674,6 +7857,12 @@ "integrity": "sha1-IZMqVJ9eUv/ZqCf1cOBL5iqX2lQ=", "dev": true }, + "progress": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz", + "integrity": "sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==", + "dev": true + }, "proxy-agent": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/proxy-agent/-/proxy-agent-5.0.0.tgz", @@ -6743,6 +7932,27 @@ "integrity": "sha512-OVede/NQE13xBQ+ob5CKd5KyeJYU2YInb1bmV4nRoOfquZPkAkxuOXicSe1PvqIuZZ4kD13sPKBbR7UFDmli6w==", "dev": true }, + "regexp-match-indices": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/regexp-match-indices/-/regexp-match-indices-1.0.2.tgz", + "integrity": "sha512-DwZuAkt8NF5mKwGGER1EGh2PRqyvhRhhLviH+R8y8dIuaQROlUfXjt4s9ZTXstIsSkptf06BSvwcEmmfheJJWQ==", + "dev": true, + "requires": { + "regexp-tree": "^0.1.11" + } + }, + "regexp-tree": { + "version": "0.1.24", + "resolved": "https://registry.npmjs.org/regexp-tree/-/regexp-tree-0.1.24.tgz", + "integrity": "sha512-s2aEVuLhvnVJW6s/iPgEGK6R+/xngd2jNQ+xy4bXNDKxZKJH6jpPHY6kVeVv1IeLCHgswRj+Kl3ELaDjG6V1iw==", + "dev": true + }, + "repeat-string": { + "version": "1.6.1", + "resolved": "https://registry.npmjs.org/repeat-string/-/repeat-string-1.6.1.tgz", + "integrity": "sha1-jcrkcOHIirwtYA//Sndihtp15jc=", + "dev": true + }, "require-directory": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", @@ -6784,6 +7994,23 @@ "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==", "dev": true }, + "resolve-pkg": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/resolve-pkg/-/resolve-pkg-2.0.0.tgz", + "integrity": "sha512-+1lzwXehGCXSeryaISr6WujZzowloigEofRB+dj75y9RRa/obVcYgbHJd53tdYw8pvZj8GojXaaENws8Ktw/hQ==", + "dev": true, + "requires": { + "resolve-from": "^5.0.0" + }, + "dependencies": { + "resolve-from": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-5.0.0.tgz", + "integrity": "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==", + "dev": true + } + } + }, "restore-cursor": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/restore-cursor/-/restore-cursor-3.1.0.tgz", @@ -6800,6 +8027,15 @@ "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", "dev": true }, + "rimraf": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.2.tgz", + "integrity": "sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==", + "dev": true, + "requires": { + "glob": "^7.1.3" + } + }, "rollup": { "version": "2.66.1", "resolved": "https://registry.npmjs.org/rollup/-/rollup-2.66.1.tgz", @@ -6866,6 +8102,12 @@ "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==", "dev": true }, + "seed-random": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/seed-random/-/seed-random-2.2.0.tgz", + "integrity": "sha1-KpsZ4lCoFwmSMaW5mk2vgLf77VQ=", + "dev": true + }, "semver": { "version": "7.3.5", "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", @@ -6968,8 +8210,17 @@ "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true + }, + "source-map-support": { + "version": "0.5.19", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.19.tgz", + "integrity": "sha512-Wonm7zOCIJzBGQdB+thsPar0kYuCIzYvxZwlBa87yi/Mdjv7Tip2cyVbLj5o0cFPN4EVkuTwb3GDDyUx2DGnGw==", "dev": true, - "optional": true + "requires": { + "buffer-from": "^1.0.0", + "source-map": "^0.6.0" + } }, "sourcemap-codec": { "version": "1.4.8", @@ -6989,6 +8240,12 @@ "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", "dev": true }, + "stack-chain": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/stack-chain/-/stack-chain-2.0.0.tgz", + "integrity": "sha512-GGrHXePi305aW7XQweYZZwiRwR7Js3MWoK/EHzzB9ROdc75nCnjSJVi21rdAGxFl+yCx2L2qdfl5y7NO4lTyqg==", + "dev": true + }, "statuses": { "version": "1.5.0", "resolved": "https://registry.npmjs.org/statuses/-/statuses-1.5.0.tgz", @@ -7004,6 +8261,12 @@ "safe-buffer": "~5.2.0" } }, + "string-argv": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz", + "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==", + "dev": true + }, "string-width": { "version": "4.2.3", "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", @@ -7045,6 +8308,24 @@ "integrity": "sha1-f17oI66AUgfACvLfSoTsP8+lcLQ=", "dev": true }, + "thenify": { + "version": "3.3.1", + "resolved": "https://registry.npmjs.org/thenify/-/thenify-3.3.1.tgz", + "integrity": "sha512-RVZSIV5IG10Hk3enotrhvz0T9em6cyHBLkH/YAZuKqd8hRkKhSfCGIcP2KUY0EPxndzANBmNllzWPwak+bheSw==", + "dev": true, + "requires": { + "any-promise": "^1.0.0" + } + }, + "thenify-all": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/thenify-all/-/thenify-all-1.6.0.tgz", + "integrity": "sha1-GhkY1ALY/D+Y+/I02wvMjMEOlyY=", + "dev": true, + "requires": { + "thenify": ">= 3.1.0 < 4" + } + }, "through": { "version": "2.3.8", "resolved": "https://registry.npmjs.org/through/-/through-2.3.8.tgz", @@ -7093,6 +8374,12 @@ "integrity": "sha512-uZtkfKblCEQtZKBF6EBXVZeQNl82yqtDQdv+eck8u7tdPxjLu2/lp5/uPW+um2tpuxINHWy3GhiccY7QgEaVHQ==", "dev": true }, + "type": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/type/-/type-1.2.0.tgz", + "integrity": "sha512-+5nt5AAniqsCnu2cEQQdpzCAh33kVx8n0VoFidKpB1dVVLAN/F+bgVOqOJqOnEnrhp222clB5p3vUlD+1QAnfg==", + "dev": true + }, "type-check": { "version": "0.3.2", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.3.2.tgz", @@ -7102,6 +8389,12 @@ "prelude-ls": "~1.1.2" } }, + "type-detect": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/type-detect/-/type-detect-4.0.8.tgz", + "integrity": "sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==", + "dev": true + }, "type-fest": { "version": "0.21.3", "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.21.3.tgz", @@ -7120,6 +8413,15 @@ "integrity": "sha1-sr9O6FFKrmFltIF4KdIbLvSZBOw=", "dev": true }, + "upper-case-first": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/upper-case-first/-/upper-case-first-2.0.2.tgz", + "integrity": "sha512-514ppYHBaKwfJRK/pNC6c/OxfGa0obSnAl106u97Ed0I625Nin96KAjttZF6ZL3e1XLtphxnqrOi9iWgm+u+bg==", + "dev": true, + "requires": { + "tslib": "^2.0.3" + } + }, "uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -7135,6 +8437,12 @@ "integrity": "sha512-Id+IKjdU0Hx+7Zx717jwLPsPeUqz7rAtuVBRLLs+qn+J2nf9NGITWVCxcijgYxBqe83C7sqsQPs6H1pyz3x9gA==", "dev": true }, + "util-arity": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/util-arity/-/util-arity-1.1.0.tgz", + "integrity": "sha1-WdAa8f2z/t4KxOYysKtfbOl8kzA=", + "dev": true + }, "util-deprecate": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz", @@ -7199,6 +8507,25 @@ "integrity": "sha1-9j/+2iSL8opnqNSODjtGGhZluvg=", "dev": true }, + "verror": { + "version": "1.10.1", + "resolved": "https://registry.npmjs.org/verror/-/verror-1.10.1.tgz", + "integrity": "sha512-veufcmxri4e3XSrT0xwfUR7kguIkaxBeosDg00yDWhk49wdwkSUrvvsm7nc75e1PUyvIeZj6nS8VQRYz2/S4Xg==", + "dev": true, + "requires": { + "assert-plus": "^1.0.0", + "core-util-is": "1.0.2", + "extsprintf": "^1.2.0" + }, + "dependencies": { + "core-util-is": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/core-util-is/-/core-util-is-1.0.2.tgz", + "integrity": "sha1-tf1UIgqivFq1eqtxQMlAdUUDwac=", + "dev": true + } + } + }, "vm2": { "version": "3.9.5", "resolved": "https://registry.npmjs.org/vm2/-/vm2-3.9.5.tgz", diff --git a/package.json b/package.json index 4356b18f9..ff3efcb89 100644 --- a/package.json +++ b/package.json @@ -8,19 +8,21 @@ "test": "test" }, "scripts": { + "nswag:gen": "nswag run src/BrpService/Server.nswag /runtime:Net60 && nswag run src/BrpProxy/DataTransferObjects.nswag /runtime:Net60", "oas:generate-client": "openapi-generator-cli generate -i ./specificatie/genereervariant/openapi.yaml --global-property=modelTests=false,apiTests=false,modelDocs=false,apiDocs=false", "oas:generate-java-client": "npm run oas:generate-client -- -o ./code/java -g java --additional-properties=dateLibrary=java8,java8=true,optionalProjectFile=false,optionalAssemblyInfo=false", "oas:generate-netcore-client": "npm run oas:generate-client -- -o ./code/netcore -g csharp-netcore --additional-properties=optionalProjectFile=false,optionalAssemblyInfo=false", "oas:generate-net-client": "npm run oas:generate-client -- -o ./code/net -g csharp --additional-properties=optionalProjectFile=false,optionalAssemblyInfo=false", "oas:generate-python-client": "npm run oas:generate-client -- -o ./code/python -g python --additional-properties=optionalProjectFile=false,optionalAssemblyInfo=false", "oas:generate-postman-collection": "openapi2postmanv2 -s ./specificatie/genereervariant/openapi.yaml -o ./test/BRP-Bevragen-postman-collection.json --pretty", - "oas:lint": "spectral lint ./specificatie/openapi.yaml", - "oas:lint-genereervariant": "spectral lint ./specificatie/genereervariant/openapi.yaml", + "oas:lint": "bash scripts/lint-oas.sh", + "oas:lint-genereervariant": "bash scripts/lint-oas-genereervariant.sh", "preoas:resolve": "mvn-dl io.swagger.codegen.v3:swagger-codegen-cli:3.0.19 -f swagger-codegen-cli.jar", - "oas:resolve": "java -jar swagger-codegen-cli.jar generate -i ./specificatie/openapi.yaml -l openapi-yaml -o ./specificatie/genereervariant && java -jar swagger-codegen-cli.jar generate -i ./specificatie/openapi.yaml -l openapi -o ./specificatie/genereervariant", + "oas:resolve": "bash scripts/resolve-oas.sh", "postoas:resolve": "rm swagger-codegen-cli.jar", "unstage-generated": "git reset HEAD ./specificatie/genereervariant/openapi.* ./test/BRP-bevragen-postman-collection.json ./code/**", - "rollback-generated": "git checkout ./specificatie/genereervariant/openapi.* ./test/BRP-bevragen-postman-collection.json ./code/**" + "rollback-generated": "git checkout ./specificatie/genereervariant/openapi.* ./test/BRP-bevragen-postman-collection.json ./code/**", + "specs:verify": "cucumber-js -f html:docs/features/test-result.html -f json:docs/features/test-result.json features/zoek-met-*.feature features/voorletters.feature features/volledigenaam.feature --tags \"not @fout-case\" --tags \"not @skip-verify\"" }, "repository": { "type": "git", @@ -33,10 +35,14 @@ }, "homepage": "https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen#readme", "devDependencies": { + "@cucumber/cucumber": "^8.0.0-rc.2", "@openapitools/openapi-generator-cli": "^2.4.25", "@stoplight/spectral-cli": "^6.2.0", + "axios": "^0.25.0", + "chai": "^4.3.6", "husky": "^4.3.8", "mvn-dl": "^6.0.0", + "nswag": "^13.15.7", "openapi-to-postmanv2": "^2.13.0" }, "husky": { diff --git a/scripts/lint-oas-genereervariant.sh b/scripts/lint-oas-genereervariant.sh new file mode 100644 index 000000000..1dbd4ec97 --- /dev/null +++ b/scripts/lint-oas-genereervariant.sh @@ -0,0 +1,4 @@ +#!/bin/bash + +spectral lint ./specificatie/genereervariant/openapi.yaml +spectral lint ./specificatie/gba-genereervariant/openapi.yaml diff --git a/scripts/lint-oas.sh b/scripts/lint-oas.sh new file mode 100644 index 000000000..edc1eccdb --- /dev/null +++ b/scripts/lint-oas.sh @@ -0,0 +1,4 @@ +#!/bin/bash + +spectral lint ./specificatie/openapi.yaml +spectral lint ./specificatie/gba-openapi.yaml \ No newline at end of file diff --git a/scripts/resolve-oas.sh b/scripts/resolve-oas.sh new file mode 100644 index 000000000..8989e48dc --- /dev/null +++ b/scripts/resolve-oas.sh @@ -0,0 +1,6 @@ +#!/bin/bash + +java -jar swagger-codegen-cli.jar generate -i ./specificatie/openapi.yaml -l openapi-yaml -o ./specificatie/genereervariant +java -jar swagger-codegen-cli.jar generate -i ./specificatie/openapi.yaml -l openapi -o ./specificatie/genereervariant +java -jar swagger-codegen-cli.jar generate -i ./specificatie/gba-openapi.yaml -l openapi-yaml -o ./specificatie/gba-genereervariant +java -jar swagger-codegen-cli.jar generate -i ./specificatie/gba-openapi.yaml -l openapi -o ./specificatie/gba-genereervariant diff --git a/specificatie/common.yaml b/specificatie/common.yaml new file mode 100644 index 000000000..fa3923922 --- /dev/null +++ b/specificatie/common.yaml @@ -0,0 +1,349 @@ +openapi: 3.0.3 +info: + title: Header, foutresponse en waardetabel definities + version: 2.0.0 + contact: {} +paths: {} +components: + headers: + api_version: + schema: + type: string + pattern: ^[1-9][0-9]{0,2}.[0-9]{1,3}.[0-9]{1,3}$ + description: Geeft een specifieke API-versie aan in de context van een specifieke aanroep. + example: 1.0.0 + warning: + schema: + type: string + maxLength: 500 + description: 'zie RFC 7234. In het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 ("Miscellaneous Persistent Warning") en het API end-point (inclusief versienummer) als de warn-agent van de warning, gevolgd door de warn-text met de human-readable waarschuwing' + example: '299 https://service.../api/.../v1 "Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1".' + X_Rate_Limit_Limit: + schema: + type: integer + X_Rate_Limit_Remaining: + schema: + type: integer + X_Rate_Limit_Reset: + schema: + type: integer + responses: + '204': + description: No content + headers: + api-version: + $ref: "#/components/headers/api_version" + '400': + description: Bad Request + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/BadRequestFoutbericht" + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 + title: Ten minste één parameter moet worden opgegeven. + status: 400 + detail: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: paramsRequired + invalidParams: + - type: https://www.vng.nl/realisatie/api/validaties/integer + name: verblijfplaats__huisnummer + code: integer + reason: Waarde is geen geldige integer. + '401': + description: Unauthorized + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/Foutbericht" + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 + title: Niet correct geauthenticeerd. + status: 401 + detail: The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: authentication + '403': + description: Forbidden + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/Foutbericht" + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 + title: U bent niet geautoriseerd voor deze operatie. + status: 403 + detail: The server understood the request, but is refusing to fulfill it. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: autorisation + '404': + description: Not Found + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/Foutbericht" + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 + title: Opgevraagde resource bestaat niet. + status: 404 + detail: The server has not found anything matching the Request-URI. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: notFound + '406': + description: Not Acceptable + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/Foutbericht" + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 + title: Gevraagde contenttype wordt niet ondersteund. + status: 406 + detail: The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: notAcceptable + '409': + description: Conflict + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/Foutbericht" + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10 + title: Conflict + status: 409 + detail: The request could not be completed due to a conflict with the current state of the resource + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: conflict + '410': + description: Gone + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/Foutbericht" + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11 + title: Gone + status: 410 + detail: The request could not be completed due to a conflict with the current state of the resource + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: gone + '412': + description: Precondition failed + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/Foutbericht" + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13 + title: Precondition Failed + status: 412 + detail: The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: preconditionFailed + '415': + description: Unsupported Media Type + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/Foutbericht" + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16 + title: Unsupported Media Type + status: 415 + detail: The server is refusing the request because the entity of the request is in a format not supported by the requested resource for the requested method. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: unsupported + '422': + description: Unprocessable entity + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/Foutbericht" + example: + type: https://tools.ietf.org/html/rfc4918#section-11.2 + title: Aanvraag kan niet verwerkt worden + status: 422 + detail: The server understands the content type of the request entity and the syntax of the request entity is correct but was unable to process the contained instructions. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: unprocessableEntity + '429': + description: Too Many Requests + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/Foutbericht" + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html + title: Too many request + status: 429 + detail: The user has sent too many requests in a given amount of time (rate limiting). + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: tooManyRequests + '500': + description: Internal Server Error + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/Foutbericht" + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 + title: Interne server fout. + status: 500 + detail: The server encountered an unexpected condition which prevented it from fulfilling the request. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: serverError + '501': + description: Not Implemented + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/Foutbericht" + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2 + title: Not Implemented + status: 501 + detail: The server does not support the functionality required to fulfill the request. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: notImplemented + '503': + description: Service Unavailable + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/Foutbericht" + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 + title: Bronservice BRP is tijdelijk niet beschikbaar. + status: 503 + detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: notAvailable + 'default': + description: Er is een onverwachte fout opgetreden + headers: + api-version: + $ref: "#/components/headers/api_version" + content: + application/problem+json: + schema: + $ref: "#/components/schemas/Foutbericht" + schemas: + Foutbericht: + type: object + description: Terugmelding bij een fout. JSON representatie in lijn met [RFC7807](https://tools.ietf.org/html/rfc7807). + properties: + type: + type: string + format: uri + description: Link naar meer informatie over deze fout + title: + type: string + pattern: ^[a-zA-Z0-9À-ž \.\-]{1,80}$ + description: Beschrijving van de fout + status: + type: integer + minimum: 100 + maximum: 600 + description: Http status code + detail: + type: string + pattern: ^[a-zA-Z0-9À-ž \.\-\(\)\,]{1,200}$ + description: Details over de fout + instance: + type: string + format: uri + description: Uri van de aanroep die de fout heeft veroorzaakt + code: + type: string + pattern: ^[a-zA-Z0-9]{1,25}$ + description: Systeemcode die het type fout aangeeft + minLength: 1 + InvalidParams: + type: object + description: Details over fouten in opgegeven parameters + properties: + type: + type: string + format: uri + example: "https://www.vng.nl/realisatie/api/{major-versie}/validaties/integer" + name: + type: string + pattern: ^[a-zA-Z0-9\.,_]{1,30}$ + description: Naam van de parameter + example: "verblijfplaats__huisnummer" + code: + type: string + pattern: ^[a-zA-Z0-9\.,_]{1,25}$ + description: Systeemcode die het type fout aangeeft + minLength: 1 + example: "integer" + reason: + type: string + pattern: ^[a-zA-Z0-9\.,_ ]{1,80}$ + description: Beschrijving van de fout op de parameterwaarde + example: "Waarde is geen geldige integer." + BadRequestFoutbericht: + allOf: + - $ref: "#/components/schemas/Foutbericht" + - type: "object" + properties: + invalidParams: + description: Foutmelding per fout in een parameter. Alle gevonden fouten worden één keer teruggemeld. + type: array + items: + $ref: "#/components/schemas/InvalidParams" + Waardetabel: + type: "object" + properties: + code: + type: "string" + pattern: ^[a-zA-Z0-9 \.]+$ + example: "6030" + omschrijving: + type: "string" + pattern: ^[a-zA-Z0-9À-ž \'\,\(\)\.\-]{1,200}$ + example: "Nederland" diff --git a/specificatie/datum.yaml b/specificatie/datum.yaml new file mode 100644 index 000000000..3c8ee93e5 --- /dev/null +++ b/specificatie/datum.yaml @@ -0,0 +1,105 @@ +openapi: 3.0.3 +info: + title: Datum definities + description: | + Definities voor de volgende datum types: + - datum conform LO GBA + - onbekend datum + - 'volledig' datum conform ISO-8601 + - datum waarvan de dag onbekend is + - datum waarvan de maand en dag onbekend is + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + AbstractDatum: + type: object + required: + - type + properties: + type: + type: string + discriminator: + propertyName: type + mapping: + Datum: '#/components/schemas/VolledigeDatum' + OnbekendDatum: '#/components/schemas/OnbekendDatum' + JaarDatum: '#/components/schemas/JaarDatum' + JaarMaandDatum: '#/components/schemas/JaarMaandDatum' + GbaDatum: + type: string + pattern: ^[0-9]{8}$ + example: "20180700" + VolledigeDatum: + description: Datum conform iso8601 + allOf: + - $ref: '#/components/schemas/AbstractDatum' + - type: object + properties: + datum: + type: string + format: date + required: + - datum + example: + value: + type: Datum + datum: "2018-07-01" + OnbekendDatum: + description: representatie voor een volledig onbekend datum + allOf: + - $ref: '#/components/schemas/AbstractDatum' + - type: object + properties: + onbekend: + type: boolean + default: true + required: + - onbekend + example: + value: + type: OnbekendDatum + onbekend: true + JaarDatum: + description: representatie voor een datum waarvan maand en dag onbekend zijn + allOf: + - $ref: '#/components/schemas/AbstractDatum' + - type: object + properties: + jaar: + $ref: '#/components/schemas/Jaar' + required: + - jaar + example: + value: + type: JaarDatum + jaar: 2018 + JaarMaandDatum: + description: representatie voor een datum waarvan de dag onbekend is + allOf: + - $ref: '#/components/schemas/AbstractDatum' + - type: object + properties: + jaar: + $ref: '#/components/schemas/Jaar' + maand: + $ref: '#/components/schemas/Maand' + required: + - jaar + - maand + example: + value: + type: JaarMaandDatum + jaar: 2018 + maand: 7 + Jaar: + type: integer + format: int32 + minimum: 1 + maximum: 9999 + Maand: + type: integer + format: int32 + minimum: 1 + maximum: 12 diff --git a/specificatie/filter.yaml b/specificatie/filter.yaml new file mode 100644 index 000000000..c1e77a44e --- /dev/null +++ b/specificatie/filter.yaml @@ -0,0 +1,66 @@ +openapi: 3.0.3 +info: + title: Filter definities + version: 2.0.0 + contact: {} +paths: {} +components: + parameters: + Fields: + name: fields + in: query + required: true + schema: + $ref: '#/components/schemas/Fields' + + schemas: + Fields: + description: | + Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. + Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. + Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature) + type: string + pattern: ^[a-zA-Z0-9\.,_]+$ + maxLength: 924 + GeboorteplaatsFilter: + description: | + Gemeentenaam of een buitenlandse plaats of een plaatsbepaling, die aangeeft waar de persoon is geboren. **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + type: string + pattern: ^[a-zA-Z0-9À-ž \,\.\-\'()]{1,80}$ + example: "Utrecht" + GeslachtsaanduidingFilter: + description: | + Geeft aan dat de persoon een man of een vrouw is, of dat het geslacht (nog) onbekend is. + type: string + pattern: ^([Mm]|[Vv]|[Oo])$ + example: "V" + GeslachtsnaamFilter: + description: | + De (geslachts)naam waarvan de eventueel aanwezige voorvoegsels zijn afgesplitst. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + type: string + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,200}$|^[a-zA-Z0-9À-ž \.\-\']{3,199}\*{1}$ + example: "Vries" + StraatFilter: + description: | + Een naam die door de gemeente aan een openbare ruimte is gegeven. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature). + type: string + pattern: ^[a-zA-Z0-9À-ž \-\']{1,80}$|^[a-zA-Z0-9À-ž \-\']{7,79}\*{1}$|^\*{1}[a-zA-Z0-9À-ž \-\']{7,79}$ + example: "Tulpstraat" + VoornamenOptioneelFilter: + description: | + De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + type: string + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,199}\*{1}$ + example: "Dirk" + VoornamenVerplichtFilter: + description: | + De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + type: string + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,200}$|^[a-zA-Z0-9À-ž \.\-\']{3,199}\*{1}$ + example: "Dirk" + VoorvoegselFilter: + description: | + Deel van de geslachtsnaam dat vooraf gaat aan de rest van de geslachtsnaam. Het zoeken op het voorvoegsel is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + type: string + pattern: ^[a-zA-Z \']{1,10}$ + example: "de" diff --git a/specificatie/gba-genereervariant/openapi.json b/specificatie/gba-genereervariant/openapi.json new file mode 100644 index 000000000..753c3c1dc --- /dev/null +++ b/specificatie/gba-genereervariant/openapi.json @@ -0,0 +1,1417 @@ +{ + "openapi" : "3.0.3", + "info" : { + "title" : "Bevragen Personen", + "description" : "API voor het bevragen van personen uit de basisregistratie personen (BRP), inclusief de registratie niet-ingezeten (RNI). Met deze API kun je personen zoeken en actuele gegevens over personen, kinderen, partners en ouders raadplegen.\n\nGegevens die er niet zijn of niet actueel zijn krijg je niet terug. Heeft een persoon bijvoorbeeld geen geldige nationaliteit, en alleen een beëindigd partnerschap, dan krijg je geen gegevens over nationaliteit en partner.\n\nZie de [Functionele documentatie](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/tree/v1.1.0/features) voor nadere toelichting.\n", + "contact" : { + "url" : "https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen" + }, + "license" : { + "name" : "European Union Public License, version 1.2 (EUPL-1.2)", + "url" : "https://eupl.eu/1.2/nl/" + }, + "version" : "2.0.0" + }, + "servers" : [ { + "url" : "https://www.haalcentraal.nl/haalcentraal/api/brp", + "description" : "APILAB testserver\n" + } ], + "tags" : [ { + "name" : "Personen", + "description" : "Zoeken personen" + } ], + "paths" : { + "/personen" : { + "post" : { + "tags" : [ "Personen" ], + "summary" : "Vindt personen", + "description" : "Zoek personen met één van de onderstaande verplichte combinaties van parameters en vul ze evt. aan met optionele parameters.\n\n\nDefault krijg je personen terug die nog in leven zijn, tenzij je de inclusiefoverledenpersonen=true opgeeft.\n\n\nGebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/fields_extensie.feature)\n\n\n1. Zoek met geslachtsnaam en geboortedatum\n - geboortedatum\n - geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature))\n\n\n2. Zoek met geslachtsnaam, voornamen en gemeente van inschrijving\n - gemeenteVanInschrijving\n - geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature))\n\n\n3. Raadpleeg met burgerservicenummer\n - burgerservicenummer\n\n\n4. Zoek met postcode en huisnummer\n - postcode\n - huisnummer\n\n\n5. Zoek met straat, huisnummer en gemeente van inschrijving\n - straat (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature))\n - gemeenteVanInschrijving\n - huisnummer\n\n\n6. Zoek met nummeraanduiding identificatie\n - nummeraanduidingIdentificatie\n", + "operationId" : "GetPersonen", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PersonenQuery" + } + } + } + }, + "responses" : { + "200" : { + "description" : "Zoekactie geslaagd\n", + "headers" : { + "api-version" : { + "$ref" : "#/components/headers/api_version" + }, + "warning" : { + "$ref" : "#/components/headers/warning" + }, + "X-Rate-Limit-Limit" : { + "$ref" : "#/components/headers/X_Rate_Limit_Limit" + }, + "X-Rate-Limit-Remaining" : { + "$ref" : "#/components/headers/X_Rate_Limit_Remaining" + }, + "X-Rate-Limit-Reset" : { + "$ref" : "#/components/headers/X_Rate_Limit_Reset" + } + }, + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PersonenQueryResponse" + } + } + } + }, + "400" : { + "description" : "Bad Request", + "headers" : { + "api-version" : { + "$ref" : "#/components/headers/api_version" + } + }, + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/BadRequestFoutbericht" + }, + "example" : { + "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", + "title" : "Ten minste één parameter moet worden opgegeven.", + "status" : 400, + "detail" : "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", + "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", + "code" : "paramsRequired", + "invalidParams" : [ { + "type" : "https://www.vng.nl/realisatie/api/validaties/integer", + "name" : "verblijfplaats__huisnummer", + "code" : "integer", + "reason" : "Waarde is geen geldige integer." + } ] + } + } + } + }, + "401" : { + "description" : "Unauthorized", + "headers" : { + "api-version" : { + "$ref" : "#/components/headers/api_version" + } + }, + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/Foutbericht" + }, + "example" : { + "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", + "title" : "Niet correct geauthenticeerd.", + "status" : 401, + "detail" : "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", + "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", + "code" : "authentication" + } + } + } + }, + "403" : { + "description" : "Forbidden", + "headers" : { + "api-version" : { + "$ref" : "#/components/headers/api_version" + } + }, + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/Foutbericht" + }, + "example" : { + "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", + "title" : "U bent niet geautoriseerd voor deze operatie.", + "status" : 403, + "detail" : "The server understood the request, but is refusing to fulfill it.", + "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", + "code" : "autorisation" + } + } + } + }, + "406" : { + "description" : "Not Acceptable", + "headers" : { + "api-version" : { + "$ref" : "#/components/headers/api_version" + } + }, + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/Foutbericht" + }, + "example" : { + "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", + "title" : "Gevraagde contenttype wordt niet ondersteund.", + "status" : 406, + "detail" : "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request", + "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", + "code" : "notAcceptable" + } + } + } + }, + "429" : { + "description" : "Too Many Requests", + "headers" : { + "api-version" : { + "$ref" : "#/components/headers/api_version" + } + }, + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/Foutbericht" + }, + "example" : { + "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", + "title" : "Too many request", + "status" : 429, + "detail" : "The user has sent too many requests in a given amount of time (rate limiting).", + "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", + "code" : "tooManyRequests" + } + } + } + }, + "500" : { + "description" : "Internal Server Error", + "headers" : { + "api-version" : { + "$ref" : "#/components/headers/api_version" + } + }, + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/Foutbericht" + }, + "example" : { + "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", + "title" : "Interne server fout.", + "status" : 500, + "detail" : "The server encountered an unexpected condition which prevented it from fulfilling the request.", + "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", + "code" : "serverError" + } + } + } + }, + "501" : { + "description" : "Not Implemented", + "headers" : { + "api-version" : { + "$ref" : "#/components/headers/api_version" + } + }, + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/Foutbericht" + }, + "example" : { + "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2", + "title" : "Not Implemented", + "status" : 501, + "detail" : "The server does not support the functionality required to fulfill the request.", + "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", + "code" : "notImplemented" + } + } + } + }, + "503" : { + "description" : "Service Unavailable", + "headers" : { + "api-version" : { + "$ref" : "#/components/headers/api_version" + } + }, + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/Foutbericht" + }, + "example" : { + "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", + "title" : "Bronservice BRP is tijdelijk niet beschikbaar.", + "status" : 503, + "detail" : "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", + "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", + "code" : "notAvailable" + } + } + } + }, + "default" : { + "description" : "Er is een onverwachte fout opgetreden", + "headers" : { + "api-version" : { + "$ref" : "#/components/headers/api_version" + } + }, + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/Foutbericht" + } + } + } + } + } + } + } + }, + "components" : { + "schemas" : { + "PersonenQueryResponse" : { + "required" : [ "type" ], + "type" : "object", + "properties" : { + "type" : { + "type" : "string" + } + }, + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "ZoekMetGeslachtsnaamEnGeboortedatum" : "#/components/schemas/ZoekMetGeslachtsnaamEnGeboortedatumResponse", + "ZoekMetNaamEnGemeenteVanInschrijving" : "#/components/schemas/ZoekMetNaamEnGemeenteVanInschrijvingResponse", + "RaadpleegMetBurgerservicenummer" : "#/components/schemas/RaadpleegMetBurgerservicenummerResponse", + "ZoekMetPostcodeEnHuisnummer" : "#/components/schemas/ZoekMetPostcodeEnHuisnummerResponse", + "ZoekMetStraatHuisnummerEnGemeenteVanInschrijving" : "#/components/schemas/ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse", + "ZoekMetNummeraanduidingIdentificatie" : "#/components/schemas/ZoekMetNummeraanduidingIdentificatieResponse" + } + } + }, + "ZoekMetGeslachtsnaamEnGeboortedatumResponse" : { + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQueryResponse" + }, { + "type" : "object", + "properties" : { + "personen" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GbaPersoonBeperkt" + } + } + } + } ] + }, + "ZoekMetNaamEnGemeenteVanInschrijvingResponse" : { + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQueryResponse" + }, { + "type" : "object", + "properties" : { + "personen" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GbaPersoonBeperkt" + } + } + } + } ] + }, + "RaadpleegMetBurgerservicenummerResponse" : { + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQueryResponse" + }, { + "type" : "object", + "properties" : { + "personen" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GbaPersoon" + } + } + } + } ] + }, + "ZoekMetPostcodeEnHuisnummerResponse" : { + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQueryResponse" + }, { + "type" : "object", + "properties" : { + "personen" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GbaPersoonBeperkt" + } + } + } + } ] + }, + "ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse" : { + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQueryResponse" + }, { + "type" : "object", + "properties" : { + "personen" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GbaPersoonBeperkt" + } + } + } + } ] + }, + "ZoekMetNummeraanduidingIdentificatieResponse" : { + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQueryResponse" + }, { + "type" : "object", + "properties" : { + "personen" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GbaPersoonBeperkt" + } + } + } + } ] + }, + "PersonenQuery" : { + "required" : [ "fields", "type" ], + "type" : "object", + "properties" : { + "type" : { + "type" : "string" + }, + "fields" : { + "$ref" : "#/components/schemas/Fields" + }, + "gemeenteVanInschrijving" : { + "$ref" : "#/components/schemas/GemeenteVanInschrijving" + } + }, + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "ZoekMetGeslachtsnaamEnGeboortedatum" : "#/components/schemas/ZoekMetGeslachtsnaamEnGeboortedatum", + "ZoekMetNaamEnGemeenteVanInschrijving" : "#/components/schemas/ZoekMetNaamEnGemeenteVanInschrijving", + "RaadpleegMetBurgerservicenummer" : "#/components/schemas/RaadpleegMetBurgerservicenummer", + "ZoekMetPostcodeEnHuisnummer" : "#/components/schemas/ZoekMetPostcodeEnHuisnummer", + "ZoekMetStraatHuisnummerEnGemeenteVanInschrijving" : "#/components/schemas/ZoekMetStraatHuisnummerEnGemeenteVanInschrijving", + "ZoekMetNummeraanduidingIdentificatie" : "#/components/schemas/ZoekMetNummeraanduidingIdentificatie" + } + } + }, + "ZoekMetGeslachtsnaamEnGeboortedatum" : { + "required" : [ "geboortedatum", "geslachtsnaam" ], + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQuery" + }, { + "type" : "object", + "properties" : { + "inclusiefOverledenPersonen" : { + "$ref" : "#/components/schemas/InclusiefOverledenPersonen" + }, + "geboortedatum" : { + "type" : "string", + "description" : "Je kunt alleen zoeken met een volledig geboortedatum. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/parametervalidatie.feature)\n", + "format" : "date", + "example" : "1964-09-24" + }, + "geboorteplaats" : { + "$ref" : "#/components/schemas/GeboorteplaatsFilter" + }, + "geslachtsnaam" : { + "$ref" : "#/components/schemas/GeslachtsnaamFilter" + }, + "geslachtsaanduiding" : { + "$ref" : "#/components/schemas/GeslachtsaanduidingFilter" + }, + "voorvoegsel" : { + "$ref" : "#/components/schemas/VoorvoegselFilter" + }, + "voornamen" : { + "$ref" : "#/components/schemas/VoornamenOptioneelFilter" + } + } + } ] + }, + "InclusiefOverledenPersonen" : { + "type" : "boolean", + "description" : "Als je ook overleden personen in het antwoord wilt, geef dan de parameter inclusiefOverledenPersonen op met waarde True. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/overleden_personen.feature)\n", + "example" : true + }, + "ZoekMetNaamEnGemeenteVanInschrijving" : { + "required" : [ "gemeenteVanInschrijving", "geslachtsnaam", "voornamen" ], + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQuery" + }, { + "type" : "object", + "properties" : { + "inclusiefOverledenPersonen" : { + "$ref" : "#/components/schemas/InclusiefOverledenPersonen" + }, + "geslachtsaanduiding" : { + "$ref" : "#/components/schemas/GeslachtsaanduidingFilter" + }, + "geslachtsnaam" : { + "$ref" : "#/components/schemas/GeslachtsnaamFilter" + }, + "voorvoegsel" : { + "$ref" : "#/components/schemas/VoorvoegselFilter" + }, + "voornamen" : { + "$ref" : "#/components/schemas/VoornamenVerplichtFilter" + } + } + } ] + }, + "RaadpleegMetBurgerservicenummer" : { + "required" : [ "burgerservicenummer" ], + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQuery" + }, { + "type" : "object", + "properties" : { + "burgerservicenummer" : { + "maxItems" : 20, + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Burgerservicenummer" + } + } + } + } ] + }, + "ZoekMetPostcodeEnHuisnummer" : { + "required" : [ "huisnummer", "postcode" ], + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQuery" + }, { + "type" : "object", + "properties" : { + "inclusiefOverledenPersonen" : { + "$ref" : "#/components/schemas/InclusiefOverledenPersonen" + }, + "huisletter" : { + "$ref" : "#/components/schemas/Huisletter" + }, + "huisnummer" : { + "$ref" : "#/components/schemas/Huisnummer" + }, + "huisnummertoevoeging" : { + "$ref" : "#/components/schemas/Huisnummertoevoeging" + }, + "postcode" : { + "$ref" : "#/components/schemas/Postcode" + } + } + } ] + }, + "ZoekMetStraatHuisnummerEnGemeenteVanInschrijving" : { + "required" : [ "gemeenteVanInschrijving", "huisnummer", "straat" ], + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQuery" + }, { + "type" : "object", + "properties" : { + "inclusiefOverledenPersonen" : { + "$ref" : "#/components/schemas/InclusiefOverledenPersonen" + }, + "huisletter" : { + "$ref" : "#/components/schemas/Huisletter" + }, + "huisnummer" : { + "$ref" : "#/components/schemas/Huisnummer" + }, + "huisnummertoevoeging" : { + "$ref" : "#/components/schemas/Huisnummertoevoeging" + }, + "straat" : { + "$ref" : "#/components/schemas/StraatFilter" + } + } + } ] + }, + "ZoekMetNummeraanduidingIdentificatie" : { + "required" : [ "nummeraanduidingIdentificatie" ], + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQuery" + }, { + "type" : "object", + "properties" : { + "inclusiefOverledenPersonen" : { + "$ref" : "#/components/schemas/InclusiefOverledenPersonen" + }, + "nummeraanduidingIdentificatie" : { + "$ref" : "#/components/schemas/NummeraanduidingIdentificatie" + } + } + } ] + }, + "BadRequestFoutbericht" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Foutbericht" + }, { + "type" : "object", + "properties" : { + "invalidParams" : { + "type" : "array", + "description" : "Foutmelding per fout in een parameter. Alle gevonden fouten worden één keer teruggemeld.", + "items" : { + "$ref" : "#/components/schemas/InvalidParams" + } + } + } + } ] + }, + "Foutbericht" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "Link naar meer informatie over deze fout", + "format" : "uri" + }, + "title" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-]{1,80}$", + "type" : "string", + "description" : "Beschrijving van de fout" + }, + "status" : { + "maximum" : 600, + "minimum" : 100, + "type" : "integer", + "description" : "Http status code" + }, + "detail" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-\\(\\)\\,]{1,200}$", + "type" : "string", + "description" : "Details over de fout" + }, + "instance" : { + "type" : "string", + "description" : "Uri van de aanroep die de fout heeft veroorzaakt", + "format" : "uri" + }, + "code" : { + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9]{1,25}$", + "type" : "string", + "description" : "Systeemcode die het type fout aangeeft" + } + }, + "description" : "Terugmelding bij een fout. JSON representatie in lijn met [RFC7807](https://tools.ietf.org/html/rfc7807)." + }, + "InvalidParams" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "format" : "uri", + "example" : "https://www.vng.nl/realisatie/api/{major-versie}/validaties/integer" + }, + "name" : { + "pattern" : "^[a-zA-Z0-9\\.,_]{1,30}$", + "type" : "string", + "description" : "Naam van de parameter", + "example" : "verblijfplaats__huisnummer" + }, + "code" : { + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9\\.,_]{1,25}$", + "type" : "string", + "description" : "Systeemcode die het type fout aangeeft", + "example" : "integer" + }, + "reason" : { + "pattern" : "^[a-zA-Z0-9\\.,_ ]{1,80}$", + "type" : "string", + "description" : "Beschrijving van de fout op de parameterwaarde", + "example" : "Waarde is geen geldige integer." + } + }, + "description" : "Details over fouten in opgegeven parameters" + }, + "GbaPersoonBeperkt" : { + "type" : "object", + "properties" : { + "burgerservicenummer" : { + "$ref" : "#/components/schemas/Burgerservicenummer" + }, + "geboorte" : { + "$ref" : "#/components/schemas/GbaGeboorteBeperkt" + }, + "geheimhoudingPersoonsgegevens" : { + "$ref" : "#/components/schemas/GbaGeheimhoudingPersoonsgegevens" + }, + "geslachtsaanduiding" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "naam" : { + "$ref" : "#/components/schemas/GbaNaamBasis" + }, + "opschortingBijhouding" : { + "$ref" : "#/components/schemas/OpschortingBijhoudingBasis" + }, + "overlijden" : { + "$ref" : "#/components/schemas/GbaOverlijdenBasis" + }, + "verblijfplaats" : { + "$ref" : "#/components/schemas/GbaVerblijfplaatsBeperkt" + } + } + }, + "Burgerservicenummer" : { + "pattern" : "^[0-9]{9}$", + "type" : "string", + "example" : "555555021" + }, + "GbaGeheimhoudingPersoonsgegevens" : { + "type" : "integer" + }, + "GbaPersoon" : { + "type" : "object", + "properties" : { + "aNummer" : { + "$ref" : "#/components/schemas/ANummer" + }, + "burgerservicenummer" : { + "$ref" : "#/components/schemas/Burgerservicenummer" + }, + "datumEersteInschrijvingGBA" : { + "$ref" : "#/components/schemas/GbaDatum" + }, + "geheimhoudingPersoonsgegevens" : { + "$ref" : "#/components/schemas/GbaGeheimhoudingPersoonsgegevens" + }, + "geslachtsaanduiding" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/GbaInOnderzoek" + }, + "kiesrecht" : { + "$ref" : "#/components/schemas/GbaKiesrecht" + }, + "naam" : { + "$ref" : "#/components/schemas/GbaNaamPersoon" + }, + "nationaliteiten" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GbaNationaliteit" + } + }, + "geboorte" : { + "$ref" : "#/components/schemas/GbaGeboorte" + }, + "opschortingBijhouding" : { + "$ref" : "#/components/schemas/GbaOpschortingBijhouding" + }, + "overlijden" : { + "$ref" : "#/components/schemas/GbaOverlijden" + }, + "verblijfplaats" : { + "$ref" : "#/components/schemas/GbaVerblijfplaats" + }, + "gezagsverhouding" : { + "$ref" : "#/components/schemas/GbaGezagsverhouding" + }, + "verblijfstitel" : { + "$ref" : "#/components/schemas/GbaVerblijfstitel" + }, + "reisdocumentnummers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Reisdocumentnummer" + } + }, + "kinderen" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GbaKind" + } + }, + "ouders" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GbaOuder" + } + }, + "partners" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GbaPartner" + } + } + } + }, + "ANummer" : { + "pattern" : "^[0-9]{10}$", + "type" : "string", + "description" : "Het A-nummer van de persoon\n" + }, + "Reisdocumentnummer" : { + "pattern" : "^[0-9a-zA-Z]{9}$", + "type" : "string", + "description" : "Het nummer van het verstrekte Nederlandse reisdocument.\n", + "example" : "546376728" + }, + "Fields" : { + "maxLength" : 924, + "pattern" : "^[a-zA-Z0-9\\.,_]+$", + "type" : "string", + "description" : "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven.\nBij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven.\nZie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)\n" + }, + "GemeenteVanInschrijving" : { + "pattern" : "^[0-9]{4}$", + "type" : "string", + "description" : "Een code die aangeeft in welke gemeente de persoon woont, of de laatste gemeente waar de persoon heeft gewoond, of de gemeente waar de persoon voor het eerst is ingeschreven.\n", + "example" : "0518" + }, + "GeboorteplaatsFilter" : { + "pattern" : "^[a-zA-Z0-9À-ž \\,\\.\\-\\'()]{1,80}$", + "type" : "string", + "description" : "Gemeentenaam of een buitenlandse plaats of een plaatsbepaling, die aangeeft waar de persoon is geboren. **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).**\n", + "example" : "Utrecht" + }, + "GeslachtsnaamFilter" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-\\']{1,200}$|^[a-zA-Z0-9À-ž \\.\\-\\']{3,199}\\*{1}$", + "type" : "string", + "description" : "De (geslachts)naam waarvan de eventueel aanwezige voorvoegsels zijn afgesplitst. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).**\n", + "example" : "Vries" + }, + "GeslachtsaanduidingFilter" : { + "pattern" : "^([Mm]|[Vv]|[Oo])$", + "type" : "string", + "description" : "Geeft aan dat de persoon een man of een vrouw is, of dat het geslacht (nog) onbekend is.\n", + "example" : "V" + }, + "VoorvoegselFilter" : { + "pattern" : "^[a-zA-Z \\']{1,10}$", + "type" : "string", + "description" : "Deel van de geslachtsnaam dat vooraf gaat aan de rest van de geslachtsnaam. Het zoeken op het voorvoegsel is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).**\n", + "example" : "de" + }, + "VoornamenOptioneelFilter" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-\\']{1,199}\\*{1}$", + "type" : "string", + "description" : "De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).**\n", + "example" : "Dirk" + }, + "VoornamenVerplichtFilter" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-\\']{1,200}$|^[a-zA-Z0-9À-ž \\.\\-\\']{3,199}\\*{1}$", + "type" : "string", + "description" : "De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).**\n", + "example" : "Dirk" + }, + "Huisletter" : { + "pattern" : "^[a-zA-Z]{1}$", + "type" : "string", + "description" : "Een toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven.\n", + "example" : "a" + }, + "Huisnummer" : { + "maximum" : 99999, + "minimum" : 1, + "type" : "integer", + "description" : "Een nummer dat door de gemeente aan een adresseerbaar object is gegeven.\n", + "example" : 14 + }, + "Huisnummertoevoeging" : { + "pattern" : "^[a-zA-Z0-9 \\-]{1,4}$", + "type" : "string", + "description" : "Een toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven.\n", + "example" : "bis" + }, + "Postcode" : { + "pattern" : "^[1-9]{1}[0-9]{3}[ ]?[A-Za-z]{2}$", + "type" : "string", + "description" : "De door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort.\n", + "example" : "2341SX" + }, + "StraatFilter" : { + "pattern" : "^[a-zA-Z0-9À-ž \\-\\']{1,80}$|^[a-zA-Z0-9À-ž \\-\\']{7,79}\\*{1}$|^\\*{1}[a-zA-Z0-9À-ž \\-\\']{7,79}$", + "type" : "string", + "description" : "Een naam die door de gemeente aan een openbare ruimte is gegeven. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).\n", + "example" : "Tulpstraat" + }, + "NummeraanduidingIdentificatie" : { + "pattern" : "^[0-9]{16}$", + "type" : "string", + "description" : "Unieke identificatie van een nummeraanduiding (en het bijbehorende adres) in de BAG.\n", + "example" : "0518200000366054" + }, + "GbaGeboorteBeperkt" : { + "type" : "object", + "properties" : { + "datum" : { + "$ref" : "#/components/schemas/GbaDatum" + } + } + }, + "Waardetabel" : { + "type" : "object", + "properties" : { + "code" : { + "pattern" : "^[a-zA-Z0-9 \\.]+$", + "type" : "string", + "example" : "6030" + }, + "omschrijving" : { + "pattern" : "^[a-zA-Z0-9À-ž \\'\\,\\(\\)\\.\\-]{1,200}$", + "type" : "string", + "example" : "Nederland" + } + } + }, + "GbaNaamBasis" : { + "type" : "object", + "properties" : { + "voornamen" : { + "$ref" : "#/components/schemas/Voornamen" + }, + "adellijkeTitelPredicaat" : { + "$ref" : "#/components/schemas/AdellijkeTitelPredicaatType" + }, + "voorvoegsel" : { + "$ref" : "#/components/schemas/Voorvoegsel" + }, + "geslachtsnaam" : { + "$ref" : "#/components/schemas/Geslachtsnaam" + } + } + }, + "Voornamen" : { + "maxLength" : 200, + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-\\']{1,200}$", + "type" : "string", + "description" : "De verzameling namen voor de geslachtsnaam, gescheiden door spaties.\n" + }, + "AdellijkeTitelPredicaatType" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Waardetabel" + }, { + "properties" : { + "soort" : { + "$ref" : "#/components/schemas/AdellijkeTitelPredicaatSoort" + } + }, + "example" : { + "value" : { + "code" : "JV", + "omschrijving" : "jonkvrouw", + "soort" : "predicaat" + } + } + } ] + }, + "AdellijkeTitelPredicaatSoort" : { + "type" : "string", + "enum" : [ "titel", "predicaat" ] + }, + "Voorvoegsel" : { + "maxLength" : 10, + "pattern" : "^[a-zA-Z \\']{1,10}$", + "type" : "string", + "example" : "de" + }, + "Geslachtsnaam" : { + "maxLength" : 200, + "type" : "string", + "description" : "De achternaam van een persoon.\n", + "example" : "Vries" + }, + "OpschortingBijhoudingBasis" : { + "type" : "object", + "properties" : { + "reden" : { + "$ref" : "#/components/schemas/Waardetabel" + } + }, + "description" : "* **reden** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'redenopschortingbijhouding' uit de Haal-Centraal-BRP-tabellen-bevragen API.\n" + }, + "GbaOverlijdenBasis" : { + "type" : "object", + "properties" : { + "datum" : { + "$ref" : "#/components/schemas/GbaDatum" + } + } + }, + "GbaVerblijfplaatsBeperkt" : { + "type" : "object", + "properties" : { + "functieAdres" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "woonplaats" : { + "$ref" : "#/components/schemas/Woonplaats" + }, + "straat" : { + "$ref" : "#/components/schemas/Straat" + }, + "huisnummer" : { + "$ref" : "#/components/schemas/Huisnummer" + }, + "huisletter" : { + "$ref" : "#/components/schemas/Huisletter" + }, + "huisnummertoevoeging" : { + "$ref" : "#/components/schemas/Huisnummertoevoeging" + }, + "aanduidingBijHuisnummer" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "postcode" : { + "$ref" : "#/components/schemas/Postcode" + }, + "locatiebeschrijving" : { + "$ref" : "#/components/schemas/Locatiebeschrijving" + }, + "land" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "gemeenteVanInschrijving" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "adresregel1" : { + "$ref" : "#/components/schemas/Adresregel1" + }, + "adresregel2" : { + "$ref" : "#/components/schemas/Adresregel2" + }, + "adresregel3" : { + "$ref" : "#/components/schemas/Adresregel3" + } + } + }, + "Woonplaats" : { + "title" : "woonplaats naam", + "pattern" : "^[a-zA-Z0-9À-ž \\(\\)\\,\\.\\-\\']{1,80}$", + "type" : "string", + "description" : "Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam.\n", + "example" : "Duiven" + }, + "Straat" : { + "maxLength" : 80, + "type" : "string", + "example" : "Tulpstraat" + }, + "Locatiebeschrijving" : { + "maxLength" : 35, + "type" : "string", + "description" : "Omschrijving van de ligging van een verblijfsobject, standplaats of ligplaats.\n", + "example" : "Naast de derde brug" + }, + "Adresregel1" : { + "maxLength" : 40, + "type" : "string", + "description" : "Het eerste deel van een adres is een combinatie van de straat en huisnummer.\n", + "example" : "Laan van de landinrichtingscommissie Duiven-Westervoort 26A-3" + }, + "Adresregel2" : { + "maxLength" : 50, + "type" : "string", + "description" : "Het tweede deel van een adres is een combinatie van woonplaats eventueel in combinatie met de postcode.\n", + "example" : "1234AA Nootdorp" + }, + "Adresregel3" : { + "maxLength" : 35, + "type" : "string", + "description" : "Het derde deel van een adres is optioneel. Het gaat om een of meer geografische gebieden van het adres in het buitenland.\n", + "example" : "Selangor" + }, + "GbaDatum" : { + "pattern" : "^[0-9]{8}$", + "type" : "string", + "example" : "20180700" + }, + "GbaInOnderzoek" : { + "required" : [ "aanduidingGegevensInOnderzoek", "datumIngangInOnderzoek" ], + "type" : "object", + "properties" : { + "aanduidingGegevensInOnderzoek" : { + "pattern" : "^[0-9]{6}$", + "type" : "string" + }, + "datumIngangOnderzoek" : { + "$ref" : "#/components/schemas/GbaDatum" + } + } + }, + "GbaKiesrecht" : { + "type" : "object", + "properties" : { + "europeesKiesrecht" : { + "type" : "boolean", + "description" : "Geeft aan of persoon een oproep moet ontvangen voor verkiezingen voor het Europees parlement.\n", + "example" : true + }, + "uitgeslotenVanKiesrecht" : { + "type" : "boolean", + "example" : true + }, + "einddatumUitsluitingEuropeesKiesrecht" : { + "$ref" : "#/components/schemas/GbaDatum" + }, + "einddatumUitsluitingKiesrecht" : { + "$ref" : "#/components/schemas/GbaDatum" + } + } + }, + "GbaNaamPersoon" : { + "allOf" : [ { + "$ref" : "#/components/schemas/GbaNaamBasis" + }, { + "properties" : { + "aanduidingNaamgebruik" : { + "$ref" : "#/components/schemas/Waardetabel" + } + } + } ] + }, + "GbaNationaliteit" : { + "type" : "object", + "properties" : { + "aanduidingBijzonderNederlandschap" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "datumIngangGeldigheid" : { + "$ref" : "#/components/schemas/GbaDatum" + }, + "nationaliteit" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "redenOpname" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/GbaInOnderzoek" + } + }, + "description" : "Bij de LO GBA versie kunnen datums, bijv datumIngangGeldigheid de LoGbaDatum refereren\nHet hoeft niet van AbstractDatum af te leiden omdat het nooit een andere type kan zijn\n" + }, + "GbaGeboorte" : { + "allOf" : [ { + "$ref" : "#/components/schemas/GbaGeboorteBeperkt" + }, { + "type" : "object", + "properties" : { + "land" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "plaats" : { + "$ref" : "#/components/schemas/Waardetabel" + } + } + } ] + }, + "GbaOpschortingBijhouding" : { + "allOf" : [ { + "$ref" : "#/components/schemas/OpschortingBijhoudingBasis" + }, { + "type" : "object", + "properties" : { + "datum" : { + "$ref" : "#/components/schemas/GbaDatum" + } + }, + "description" : "* **datum**: de datum waarop de bijhouding van de persoonsgegevens is gestaakt.\n" + } ] + }, + "GbaOverlijden" : { + "allOf" : [ { + "$ref" : "#/components/schemas/GbaOverlijdenBasis" + }, { + "type" : "object", + "properties" : { + "land" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "plaats" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/GbaInOnderzoek" + } + } + } ] + }, + "GbaVerblijfplaats" : { + "type" : "object", + "properties" : { + "adresregel1" : { + "$ref" : "#/components/schemas/Adresregel1" + }, + "adresregel2" : { + "$ref" : "#/components/schemas/Adresregel2" + }, + "adresregel3" : { + "$ref" : "#/components/schemas/Adresregel3" + }, + "adresseerbaarObjectIdentificatie" : { + "$ref" : "#/components/schemas/AdresseerbaarObjectIdentificatie" + }, + "nummeraanduidingIdentificatie" : { + "$ref" : "#/components/schemas/NummeraanduidingIdentificatie" + }, + "functieAdres" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "woonplaats" : { + "$ref" : "#/components/schemas/Woonplaats" + }, + "landVanwaarIngeschreven" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "straat" : { + "$ref" : "#/components/schemas/Straat" + }, + "huisnummer" : { + "$ref" : "#/components/schemas/Huisnummer" + }, + "huisletter" : { + "$ref" : "#/components/schemas/Huisletter" + }, + "huisnummertoevoeging" : { + "$ref" : "#/components/schemas/Huisnummertoevoeging" + }, + "aanduidingBijHuisnummer" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "postcode" : { + "$ref" : "#/components/schemas/Postcode" + }, + "locatiebeschrijving" : { + "$ref" : "#/components/schemas/Locatiebeschrijving" + }, + "land" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "datumAanvangAdreshouding" : { + "$ref" : "#/components/schemas/GbaDatum" + }, + "datumAanvangAdresBuitenland" : { + "$ref" : "#/components/schemas/GbaDatum" + }, + "datumIngangGeldigheid" : { + "$ref" : "#/components/schemas/GbaDatum" + }, + "datumInschrijvingInGemeente" : { + "$ref" : "#/components/schemas/GbaDatum" + }, + "datumVestigingInNederland" : { + "$ref" : "#/components/schemas/GbaDatum" + }, + "gemeenteVanInschrijving" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "naamOpenbareRuimte" : { + "$ref" : "#/components/schemas/NaamOpenbareRuimte" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/GbaInOnderzoek" + } + } + }, + "AdresseerbaarObjectIdentificatie" : { + "pattern" : "^[0-9]{16}$", + "type" : "string", + "description" : "De verblijfplaats van de persoon kan een ligplaats, een standplaats of een verblijfsobject zijn.\n", + "example" : "0226010000038820" + }, + "NaamOpenbareRuimte" : { + "maxLength" : 80, + "type" : "string" + }, + "GbaGezagsverhouding" : { + "allOf" : [ { + "$ref" : "#/components/schemas/GezagsverhoudingBasis" + }, { + "type" : "object", + "properties" : { + "inOnderzoek" : { + "$ref" : "#/components/schemas/GbaInOnderzoek" + } + } + } ] + }, + "GezagsverhoudingBasis" : { + "type" : "object", + "properties" : { + "indicatieCurateleRegister" : { + "type" : "boolean", + "description" : "Geeft aan dat de persoon onder curatele is gesteld.\n", + "example" : true + }, + "indicatieGezagMinderjarige" : { + "$ref" : "#/components/schemas/Waardetabel" + } + }, + "description" : "Gegevens over het gezag over de persoon.\n" + }, + "GbaVerblijfstitel" : { + "type" : "object", + "properties" : { + "aanduiding" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "datumEinde" : { + "$ref" : "#/components/schemas/GbaDatum" + }, + "datumIngang" : { + "$ref" : "#/components/schemas/GbaDatum" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/GbaInOnderzoek" + } + }, + "description" : "Gegevens over de verblijfsrechtelijke status van de persoon.\n* **datumEinde**: Datum waarop de geldigheid van de gegevens over de verblijfstitel is beëindigd.\n* **datumIngang**: Datum waarop de gegevens over de verblijfstitel geldig zijn geworden.\n* **aanduiding** : Verblijfstiteltabel die aangeeft over welke verblijfsrechtelijke status de persoon beschikt.\n" + }, + "GbaKind" : { + "type" : "object", + "properties" : { + "burgerservicenummer" : { + "$ref" : "#/components/schemas/Burgerservicenummer" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/GbaInOnderzoek" + }, + "naam" : { + "$ref" : "#/components/schemas/GbaNaamBasis" + }, + "geboorte" : { + "$ref" : "#/components/schemas/GbaGeboorte" + } + } + }, + "GbaOuder" : { + "type" : "object", + "properties" : { + "burgerservicenummer" : { + "$ref" : "#/components/schemas/Burgerservicenummer" + }, + "geslachtsaanduiding" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "ouderAanduiding" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "datumIngangFamilierechtelijkeBetrekking" : { + "$ref" : "#/components/schemas/GbaDatum" + }, + "naam" : { + "$ref" : "#/components/schemas/GbaNaamBasis" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/GbaInOnderzoek" + }, + "geboorte" : { + "$ref" : "#/components/schemas/GbaGeboorte" + } + }, + "description" : "Gegevens over de ouder van de persoon.\n* **datumIngangFamilierechtelijkeBetrekking** - De datum waarop de familierechtelijke betrekking is ontstaan.\n" + }, + "GbaPartner" : { + "type" : "object", + "properties" : { + "burgerservicenummer" : { + "$ref" : "#/components/schemas/Burgerservicenummer" + }, + "geslachtsaanduiding" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "soortVerbintenis" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "naam" : { + "$ref" : "#/components/schemas/GbaNaamBasis" + }, + "geboorte" : { + "$ref" : "#/components/schemas/GbaGeboorte" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/GbaInOnderzoek" + }, + "aangaanHuwelijkPartnerschap" : { + "$ref" : "#/components/schemas/GbaAangaanHuwelijkPartnerschap" + }, + "ontbindingHuwelijkPartnerschap" : { + "$ref" : "#/components/schemas/GbaOntbindingHuwelijkPartnerschap" + } + } + }, + "GbaAangaanHuwelijkPartnerschap" : { + "type" : "object", + "properties" : { + "datum" : { + "$ref" : "#/components/schemas/GbaDatum" + }, + "land" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "plaats" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/GbaInOnderzoek" + } + }, + "description" : "Gegevens over de voltrekking van het huwelijk of het aangaan van het geregistreerd partnerschap.\n* **datum** : De datum waarop het huwelijk is voltrokken of het partnerschap is aangegaan.\n* **land** : Het land waar het huwelijk is voltrokken of het partnerschap is aangegaan.\n* **plaats** : De gemeente waar het huwelijk is voltrokken of het partnerschap is aangegaan. Voor een plaats buiten Nederland bevat het antwoord een buitenlandse plaatsnaam of aanduiding.\n" + }, + "GbaOntbindingHuwelijkPartnerschap" : { + "type" : "object", + "properties" : { + "datum" : { + "$ref" : "#/components/schemas/GbaDatum" + } + } + } + }, + "headers" : { + "api_version" : { + "schema" : { + "pattern" : "^[1-9][0-9]{0,2}.[0-9]{1,3}.[0-9]{1,3}$", + "type" : "string", + "description" : "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", + "example" : "1.0.0" + } + }, + "warning" : { + "schema" : { + "maxLength" : 500, + "type" : "string", + "description" : "zie RFC 7234. In het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 (\"Miscellaneous Persistent Warning\") en het API end-point (inclusief versienummer) als de warn-agent van de warning, gevolgd door de warn-text met de human-readable waarschuwing", + "example" : "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\"." + } + }, + "X_Rate_Limit_Limit" : { + "schema" : { + "type" : "integer" + } + }, + "X_Rate_Limit_Remaining" : { + "schema" : { + "type" : "integer" + } + }, + "X_Rate_Limit_Reset" : { + "schema" : { + "type" : "integer" + } + } + } + } +} \ No newline at end of file diff --git a/specificatie/gba-genereervariant/openapi.yaml b/specificatie/gba-genereervariant/openapi.yaml new file mode 100644 index 000000000..0179df4a7 --- /dev/null +++ b/specificatie/gba-genereervariant/openapi.yaml @@ -0,0 +1,1099 @@ +openapi: 3.0.3 +info: + title: Bevragen Personen + description: | + API voor het bevragen van personen uit de basisregistratie personen (BRP), inclusief de registratie niet-ingezeten (RNI). Met deze API kun je personen zoeken en actuele gegevens over personen, kinderen, partners en ouders raadplegen. + + Gegevens die er niet zijn of niet actueel zijn krijg je niet terug. Heeft een persoon bijvoorbeeld geen geldige nationaliteit, en alleen een beëindigd partnerschap, dan krijg je geen gegevens over nationaliteit en partner. + + Zie de [Functionele documentatie](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/tree/v1.1.0/features) voor nadere toelichting. + contact: + url: https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen + license: + name: European Union Public License, version 1.2 (EUPL-1.2) + url: https://eupl.eu/1.2/nl/ + version: 2.0.0 +servers: +- url: https://www.haalcentraal.nl/haalcentraal/api/brp + description: | + APILAB testserver +tags: +- name: Personen + description: Zoeken personen +paths: + /personen: + post: + tags: + - Personen + summary: Vindt personen + description: | + Zoek personen met één van de onderstaande verplichte combinaties van parameters en vul ze evt. aan met optionele parameters. + + + Default krijg je personen terug die nog in leven zijn, tenzij je de inclusiefoverledenpersonen=true opgeeft. + + + Gebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/fields_extensie.feature) + + + 1. Zoek met geslachtsnaam en geboortedatum + - geboortedatum + - geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)) + + + 2. Zoek met geslachtsnaam, voornamen en gemeente van inschrijving + - gemeenteVanInschrijving + - geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)) + + + 3. Raadpleeg met burgerservicenummer + - burgerservicenummer + + + 4. Zoek met postcode en huisnummer + - postcode + - huisnummer + + + 5. Zoek met straat, huisnummer en gemeente van inschrijving + - straat (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)) + - gemeenteVanInschrijving + - huisnummer + + + 6. Zoek met nummeraanduiding identificatie + - nummeraanduidingIdentificatie + operationId: GetPersonen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PersonenQuery' + responses: + "200": + description: | + Zoekactie geslaagd + headers: + api-version: + $ref: '#/components/headers/api_version' + warning: + $ref: '#/components/headers/warning' + X-Rate-Limit-Limit: + $ref: '#/components/headers/X_Rate_Limit_Limit' + X-Rate-Limit-Remaining: + $ref: '#/components/headers/X_Rate_Limit_Remaining' + X-Rate-Limit-Reset: + $ref: '#/components/headers/X_Rate_Limit_Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/PersonenQueryResponse' + "400": + description: Bad Request + headers: + api-version: + $ref: '#/components/headers/api_version' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/BadRequestFoutbericht' + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 + title: Ten minste één parameter moet worden opgegeven. + status: 400 + detail: The request could not be understood by the server due to malformed + syntax. The client SHOULD NOT repeat the request without modification. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: paramsRequired + invalidParams: + - type: https://www.vng.nl/realisatie/api/validaties/integer + name: verblijfplaats__huisnummer + code: integer + reason: Waarde is geen geldige integer. + "401": + description: Unauthorized + headers: + api-version: + $ref: '#/components/headers/api_version' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Foutbericht' + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 + title: Niet correct geauthenticeerd. + status: 401 + detail: The request requires user authentication. The response MUST + include a WWW-Authenticate header field (section 14.47) containing + a challenge applicable to the requested resource. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: authentication + "403": + description: Forbidden + headers: + api-version: + $ref: '#/components/headers/api_version' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Foutbericht' + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 + title: U bent niet geautoriseerd voor deze operatie. + status: 403 + detail: The server understood the request, but is refusing to fulfill + it. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: autorisation + "406": + description: Not Acceptable + headers: + api-version: + $ref: '#/components/headers/api_version' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Foutbericht' + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 + title: Gevraagde contenttype wordt niet ondersteund. + status: 406 + detail: The resource identified by the request is only capable of + generating response entities which have content characteristics + not acceptable according to thr accept headers sent in the request + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: notAcceptable + "429": + description: Too Many Requests + headers: + api-version: + $ref: '#/components/headers/api_version' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Foutbericht' + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html + title: Too many request + status: 429 + detail: The user has sent too many requests in a given amount of time + (rate limiting). + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: tooManyRequests + "500": + description: Internal Server Error + headers: + api-version: + $ref: '#/components/headers/api_version' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Foutbericht' + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 + title: Interne server fout. + status: 500 + detail: The server encountered an unexpected condition which prevented + it from fulfilling the request. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: serverError + "501": + description: Not Implemented + headers: + api-version: + $ref: '#/components/headers/api_version' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Foutbericht' + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2 + title: Not Implemented + status: 501 + detail: The server does not support the functionality required to + fulfill the request. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: notImplemented + "503": + description: Service Unavailable + headers: + api-version: + $ref: '#/components/headers/api_version' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Foutbericht' + example: + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 + title: Bronservice BRP is tijdelijk niet beschikbaar. + status: 503 + detail: The service is currently unable to handle the request due + to a temporary overloading or maintenance of the server. + instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde + code: notAvailable + default: + description: Er is een onverwachte fout opgetreden + headers: + api-version: + $ref: '#/components/headers/api_version' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Foutbericht' +components: + schemas: + PersonenQueryResponse: + required: + - type + type: object + properties: + type: + type: string + discriminator: + propertyName: type + mapping: + ZoekMetGeslachtsnaamEnGeboortedatum: '#/components/schemas/ZoekMetGeslachtsnaamEnGeboortedatumResponse' + ZoekMetNaamEnGemeenteVanInschrijving: '#/components/schemas/ZoekMetNaamEnGemeenteVanInschrijvingResponse' + RaadpleegMetBurgerservicenummer: '#/components/schemas/RaadpleegMetBurgerservicenummerResponse' + ZoekMetPostcodeEnHuisnummer: '#/components/schemas/ZoekMetPostcodeEnHuisnummerResponse' + ZoekMetStraatHuisnummerEnGemeenteVanInschrijving: '#/components/schemas/ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse' + ZoekMetNummeraanduidingIdentificatie: '#/components/schemas/ZoekMetNummeraanduidingIdentificatieResponse' + ZoekMetGeslachtsnaamEnGeboortedatumResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: '#/components/schemas/GbaPersoonBeperkt' + ZoekMetNaamEnGemeenteVanInschrijvingResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: '#/components/schemas/GbaPersoonBeperkt' + RaadpleegMetBurgerservicenummerResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: '#/components/schemas/GbaPersoon' + ZoekMetPostcodeEnHuisnummerResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: '#/components/schemas/GbaPersoonBeperkt' + ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: '#/components/schemas/GbaPersoonBeperkt' + ZoekMetNummeraanduidingIdentificatieResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: '#/components/schemas/GbaPersoonBeperkt' + PersonenQuery: + required: + - fields + - type + type: object + properties: + type: + type: string + fields: + $ref: '#/components/schemas/Fields' + gemeenteVanInschrijving: + $ref: '#/components/schemas/GemeenteVanInschrijving' + discriminator: + propertyName: type + mapping: + ZoekMetGeslachtsnaamEnGeboortedatum: '#/components/schemas/ZoekMetGeslachtsnaamEnGeboortedatum' + ZoekMetNaamEnGemeenteVanInschrijving: '#/components/schemas/ZoekMetNaamEnGemeenteVanInschrijving' + RaadpleegMetBurgerservicenummer: '#/components/schemas/RaadpleegMetBurgerservicenummer' + ZoekMetPostcodeEnHuisnummer: '#/components/schemas/ZoekMetPostcodeEnHuisnummer' + ZoekMetStraatHuisnummerEnGemeenteVanInschrijving: '#/components/schemas/ZoekMetStraatHuisnummerEnGemeenteVanInschrijving' + ZoekMetNummeraanduidingIdentificatie: '#/components/schemas/ZoekMetNummeraanduidingIdentificatie' + ZoekMetGeslachtsnaamEnGeboortedatum: + required: + - geboortedatum + - geslachtsnaam + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + geboortedatum: + type: string + description: | + Je kunt alleen zoeken met een volledig geboortedatum. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/parametervalidatie.feature) + format: date + example: 1964-09-24 + geboorteplaats: + $ref: '#/components/schemas/GeboorteplaatsFilter' + geslachtsnaam: + $ref: '#/components/schemas/GeslachtsnaamFilter' + geslachtsaanduiding: + $ref: '#/components/schemas/GeslachtsaanduidingFilter' + voorvoegsel: + $ref: '#/components/schemas/VoorvoegselFilter' + voornamen: + $ref: '#/components/schemas/VoornamenOptioneelFilter' + InclusiefOverledenPersonen: + type: boolean + description: | + Als je ook overleden personen in het antwoord wilt, geef dan de parameter inclusiefOverledenPersonen op met waarde True. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/overleden_personen.feature) + example: true + ZoekMetNaamEnGemeenteVanInschrijving: + required: + - gemeenteVanInschrijving + - geslachtsnaam + - voornamen + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + geslachtsaanduiding: + $ref: '#/components/schemas/GeslachtsaanduidingFilter' + geslachtsnaam: + $ref: '#/components/schemas/GeslachtsnaamFilter' + voorvoegsel: + $ref: '#/components/schemas/VoorvoegselFilter' + voornamen: + $ref: '#/components/schemas/VoornamenVerplichtFilter' + RaadpleegMetBurgerservicenummer: + required: + - burgerservicenummer + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + burgerservicenummer: + maxItems: 20 + minItems: 1 + type: array + items: + $ref: '#/components/schemas/Burgerservicenummer' + ZoekMetPostcodeEnHuisnummer: + required: + - huisnummer + - postcode + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + huisletter: + $ref: '#/components/schemas/Huisletter' + huisnummer: + $ref: '#/components/schemas/Huisnummer' + huisnummertoevoeging: + $ref: '#/components/schemas/Huisnummertoevoeging' + postcode: + $ref: '#/components/schemas/Postcode' + ZoekMetStraatHuisnummerEnGemeenteVanInschrijving: + required: + - gemeenteVanInschrijving + - huisnummer + - straat + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + huisletter: + $ref: '#/components/schemas/Huisletter' + huisnummer: + $ref: '#/components/schemas/Huisnummer' + huisnummertoevoeging: + $ref: '#/components/schemas/Huisnummertoevoeging' + straat: + $ref: '#/components/schemas/StraatFilter' + ZoekMetNummeraanduidingIdentificatie: + required: + - nummeraanduidingIdentificatie + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + nummeraanduidingIdentificatie: + $ref: '#/components/schemas/NummeraanduidingIdentificatie' + BadRequestFoutbericht: + allOf: + - $ref: '#/components/schemas/Foutbericht' + - type: object + properties: + invalidParams: + type: array + description: Foutmelding per fout in een parameter. Alle gevonden fouten + worden één keer teruggemeld. + items: + $ref: '#/components/schemas/InvalidParams' + Foutbericht: + type: object + properties: + type: + type: string + description: Link naar meer informatie over deze fout + format: uri + title: + pattern: ^[a-zA-Z0-9À-ž \.\-]{1,80}$ + type: string + description: Beschrijving van de fout + status: + maximum: 600 + minimum: 100 + type: integer + description: Http status code + detail: + pattern: ^[a-zA-Z0-9À-ž \.\-\(\)\,]{1,200}$ + type: string + description: Details over de fout + instance: + type: string + description: Uri van de aanroep die de fout heeft veroorzaakt + format: uri + code: + minLength: 1 + pattern: ^[a-zA-Z0-9]{1,25}$ + type: string + description: Systeemcode die het type fout aangeeft + description: Terugmelding bij een fout. JSON representatie in lijn met [RFC7807](https://tools.ietf.org/html/rfc7807). + InvalidParams: + type: object + properties: + type: + type: string + format: uri + example: https://www.vng.nl/realisatie/api/{major-versie}/validaties/integer + name: + pattern: ^[a-zA-Z0-9\.,_]{1,30}$ + type: string + description: Naam van de parameter + example: verblijfplaats__huisnummer + code: + minLength: 1 + pattern: ^[a-zA-Z0-9\.,_]{1,25}$ + type: string + description: Systeemcode die het type fout aangeeft + example: integer + reason: + pattern: ^[a-zA-Z0-9\.,_ ]{1,80}$ + type: string + description: Beschrijving van de fout op de parameterwaarde + example: Waarde is geen geldige integer. + description: Details over fouten in opgegeven parameters + GbaPersoonBeperkt: + type: object + properties: + burgerservicenummer: + $ref: '#/components/schemas/Burgerservicenummer' + geboorte: + $ref: '#/components/schemas/GbaGeboorteBeperkt' + geheimhoudingPersoonsgegevens: + $ref: '#/components/schemas/GbaGeheimhoudingPersoonsgegevens' + geslachtsaanduiding: + $ref: '#/components/schemas/Waardetabel' + naam: + $ref: '#/components/schemas/GbaNaamBasis' + opschortingBijhouding: + $ref: '#/components/schemas/OpschortingBijhoudingBasis' + overlijden: + $ref: '#/components/schemas/GbaOverlijdenBasis' + verblijfplaats: + $ref: '#/components/schemas/GbaVerblijfplaatsBeperkt' + Burgerservicenummer: + pattern: ^[0-9]{9}$ + type: string + example: "555555021" + GbaGeheimhoudingPersoonsgegevens: + type: integer + GbaPersoon: + type: object + properties: + aNummer: + $ref: '#/components/schemas/ANummer' + burgerservicenummer: + $ref: '#/components/schemas/Burgerservicenummer' + datumEersteInschrijvingGBA: + $ref: '#/components/schemas/GbaDatum' + geheimhoudingPersoonsgegevens: + $ref: '#/components/schemas/GbaGeheimhoudingPersoonsgegevens' + geslachtsaanduiding: + $ref: '#/components/schemas/Waardetabel' + inOnderzoek: + $ref: '#/components/schemas/GbaInOnderzoek' + kiesrecht: + $ref: '#/components/schemas/GbaKiesrecht' + naam: + $ref: '#/components/schemas/GbaNaamPersoon' + nationaliteiten: + type: array + items: + $ref: '#/components/schemas/GbaNationaliteit' + geboorte: + $ref: '#/components/schemas/GbaGeboorte' + opschortingBijhouding: + $ref: '#/components/schemas/GbaOpschortingBijhouding' + overlijden: + $ref: '#/components/schemas/GbaOverlijden' + verblijfplaats: + $ref: '#/components/schemas/GbaVerblijfplaats' + gezagsverhouding: + $ref: '#/components/schemas/GbaGezagsverhouding' + verblijfstitel: + $ref: '#/components/schemas/GbaVerblijfstitel' + reisdocumentnummers: + type: array + items: + $ref: '#/components/schemas/Reisdocumentnummer' + kinderen: + type: array + items: + $ref: '#/components/schemas/GbaKind' + ouders: + type: array + items: + $ref: '#/components/schemas/GbaOuder' + partners: + type: array + items: + $ref: '#/components/schemas/GbaPartner' + ANummer: + pattern: ^[0-9]{10}$ + type: string + description: | + Het A-nummer van de persoon + Reisdocumentnummer: + pattern: ^[0-9a-zA-Z]{9}$ + type: string + description: | + Het nummer van het verstrekte Nederlandse reisdocument. + example: "546376728" + Fields: + maxLength: 924 + pattern: ^[a-zA-Z0-9\.,_]+$ + type: string + description: | + Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. + Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. + Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature) + GemeenteVanInschrijving: + pattern: ^[0-9]{4}$ + type: string + description: | + Een code die aangeeft in welke gemeente de persoon woont, of de laatste gemeente waar de persoon heeft gewoond, of de gemeente waar de persoon voor het eerst is ingeschreven. + example: "0518" + GeboorteplaatsFilter: + pattern: ^[a-zA-Z0-9À-ž \,\.\-\'()]{1,80}$ + type: string + description: | + Gemeentenaam of een buitenlandse plaats of een plaatsbepaling, die aangeeft waar de persoon is geboren. **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + example: Utrecht + GeslachtsnaamFilter: + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,200}$|^[a-zA-Z0-9À-ž \.\-\']{3,199}\*{1}$ + type: string + description: | + De (geslachts)naam waarvan de eventueel aanwezige voorvoegsels zijn afgesplitst. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + example: Vries + GeslachtsaanduidingFilter: + pattern: ^([Mm]|[Vv]|[Oo])$ + type: string + description: | + Geeft aan dat de persoon een man of een vrouw is, of dat het geslacht (nog) onbekend is. + example: V + VoorvoegselFilter: + pattern: ^[a-zA-Z \']{1,10}$ + type: string + description: | + Deel van de geslachtsnaam dat vooraf gaat aan de rest van de geslachtsnaam. Het zoeken op het voorvoegsel is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + example: de + VoornamenOptioneelFilter: + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,199}\*{1}$ + type: string + description: | + De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + example: Dirk + VoornamenVerplichtFilter: + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,200}$|^[a-zA-Z0-9À-ž \.\-\']{3,199}\*{1}$ + type: string + description: | + De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + example: Dirk + Huisletter: + pattern: ^[a-zA-Z]{1}$ + type: string + description: | + Een toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven. + example: a + Huisnummer: + maximum: 99999 + minimum: 1 + type: integer + description: | + Een nummer dat door de gemeente aan een adresseerbaar object is gegeven. + example: 14 + Huisnummertoevoeging: + pattern: ^[a-zA-Z0-9 \-]{1,4}$ + type: string + description: | + Een toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven. + example: bis + Postcode: + pattern: ^[1-9]{1}[0-9]{3}[ ]?[A-Za-z]{2}$ + type: string + description: | + De door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort. + example: 2341SX + StraatFilter: + pattern: ^[a-zA-Z0-9À-ž \-\']{1,80}$|^[a-zA-Z0-9À-ž \-\']{7,79}\*{1}$|^\*{1}[a-zA-Z0-9À-ž + \-\']{7,79}$ + type: string + description: | + Een naam die door de gemeente aan een openbare ruimte is gegeven. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature). + example: Tulpstraat + NummeraanduidingIdentificatie: + pattern: ^[0-9]{16}$ + type: string + description: | + Unieke identificatie van een nummeraanduiding (en het bijbehorende adres) in de BAG. + example: "0518200000366054" + GbaGeboorteBeperkt: + type: object + properties: + datum: + $ref: '#/components/schemas/GbaDatum' + Waardetabel: + type: object + properties: + code: + pattern: ^[a-zA-Z0-9 \.]+$ + type: string + example: "6030" + omschrijving: + pattern: ^[a-zA-Z0-9À-ž \'\,\(\)\.\-]{1,200}$ + type: string + example: Nederland + GbaNaamBasis: + type: object + properties: + voornamen: + $ref: '#/components/schemas/Voornamen' + adellijkeTitelPredicaat: + $ref: '#/components/schemas/AdellijkeTitelPredicaatType' + voorvoegsel: + $ref: '#/components/schemas/Voorvoegsel' + geslachtsnaam: + $ref: '#/components/schemas/Geslachtsnaam' + Voornamen: + maxLength: 200 + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,200}$ + type: string + description: | + De verzameling namen voor de geslachtsnaam, gescheiden door spaties. + AdellijkeTitelPredicaatType: + allOf: + - $ref: '#/components/schemas/Waardetabel' + - properties: + soort: + $ref: '#/components/schemas/AdellijkeTitelPredicaatSoort' + example: + value: + code: JV + omschrijving: jonkvrouw + soort: predicaat + AdellijkeTitelPredicaatSoort: + type: string + enum: + - titel + - predicaat + Voorvoegsel: + maxLength: 10 + pattern: ^[a-zA-Z \']{1,10}$ + type: string + example: de + Geslachtsnaam: + maxLength: 200 + type: string + description: | + De achternaam van een persoon. + example: Vries + OpschortingBijhoudingBasis: + type: object + properties: + reden: + $ref: '#/components/schemas/Waardetabel' + description: | + * **reden** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'redenopschortingbijhouding' uit de Haal-Centraal-BRP-tabellen-bevragen API. + GbaOverlijdenBasis: + type: object + properties: + datum: + $ref: '#/components/schemas/GbaDatum' + GbaVerblijfplaatsBeperkt: + type: object + properties: + functieAdres: + $ref: '#/components/schemas/Waardetabel' + woonplaats: + $ref: '#/components/schemas/Woonplaats' + straat: + $ref: '#/components/schemas/Straat' + huisnummer: + $ref: '#/components/schemas/Huisnummer' + huisletter: + $ref: '#/components/schemas/Huisletter' + huisnummertoevoeging: + $ref: '#/components/schemas/Huisnummertoevoeging' + aanduidingBijHuisnummer: + $ref: '#/components/schemas/Waardetabel' + postcode: + $ref: '#/components/schemas/Postcode' + locatiebeschrijving: + $ref: '#/components/schemas/Locatiebeschrijving' + land: + $ref: '#/components/schemas/Waardetabel' + gemeenteVanInschrijving: + $ref: '#/components/schemas/Waardetabel' + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + adresregel3: + $ref: '#/components/schemas/Adresregel3' + Woonplaats: + title: woonplaats naam + pattern: ^[a-zA-Z0-9À-ž \(\)\,\.\-\']{1,80}$ + type: string + description: | + Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam. + example: Duiven + Straat: + maxLength: 80 + type: string + example: Tulpstraat + Locatiebeschrijving: + maxLength: 35 + type: string + description: | + Omschrijving van de ligging van een verblijfsobject, standplaats of ligplaats. + example: Naast de derde brug + Adresregel1: + maxLength: 40 + type: string + description: | + Het eerste deel van een adres is een combinatie van de straat en huisnummer. + example: Laan van de landinrichtingscommissie Duiven-Westervoort 26A-3 + Adresregel2: + maxLength: 50 + type: string + description: | + Het tweede deel van een adres is een combinatie van woonplaats eventueel in combinatie met de postcode. + example: 1234AA Nootdorp + Adresregel3: + maxLength: 35 + type: string + description: | + Het derde deel van een adres is optioneel. Het gaat om een of meer geografische gebieden van het adres in het buitenland. + example: Selangor + GbaDatum: + pattern: ^[0-9]{8}$ + type: string + example: "20180700" + GbaInOnderzoek: + required: + - aanduidingGegevensInOnderzoek + - datumIngangInOnderzoek + type: object + properties: + aanduidingGegevensInOnderzoek: + pattern: ^[0-9]{6}$ + type: string + datumIngangOnderzoek: + $ref: '#/components/schemas/GbaDatum' + GbaKiesrecht: + type: object + properties: + europeesKiesrecht: + type: boolean + description: | + Geeft aan of persoon een oproep moet ontvangen voor verkiezingen voor het Europees parlement. + example: true + uitgeslotenVanKiesrecht: + type: boolean + example: true + einddatumUitsluitingEuropeesKiesrecht: + $ref: '#/components/schemas/GbaDatum' + einddatumUitsluitingKiesrecht: + $ref: '#/components/schemas/GbaDatum' + GbaNaamPersoon: + allOf: + - $ref: '#/components/schemas/GbaNaamBasis' + - properties: + aanduidingNaamgebruik: + $ref: '#/components/schemas/Waardetabel' + GbaNationaliteit: + type: object + properties: + aanduidingBijzonderNederlandschap: + $ref: '#/components/schemas/Waardetabel' + datumIngangGeldigheid: + $ref: '#/components/schemas/GbaDatum' + nationaliteit: + $ref: '#/components/schemas/Waardetabel' + redenOpname: + $ref: '#/components/schemas/Waardetabel' + inOnderzoek: + $ref: '#/components/schemas/GbaInOnderzoek' + description: | + Bij de LO GBA versie kunnen datums, bijv datumIngangGeldigheid de LoGbaDatum refereren + Het hoeft niet van AbstractDatum af te leiden omdat het nooit een andere type kan zijn + GbaGeboorte: + allOf: + - $ref: '#/components/schemas/GbaGeboorteBeperkt' + - type: object + properties: + land: + $ref: '#/components/schemas/Waardetabel' + plaats: + $ref: '#/components/schemas/Waardetabel' + GbaOpschortingBijhouding: + allOf: + - $ref: '#/components/schemas/OpschortingBijhoudingBasis' + - type: object + properties: + datum: + $ref: '#/components/schemas/GbaDatum' + description: | + * **datum**: de datum waarop de bijhouding van de persoonsgegevens is gestaakt. + GbaOverlijden: + allOf: + - $ref: '#/components/schemas/GbaOverlijdenBasis' + - type: object + properties: + land: + $ref: '#/components/schemas/Waardetabel' + plaats: + $ref: '#/components/schemas/Waardetabel' + inOnderzoek: + $ref: '#/components/schemas/GbaInOnderzoek' + GbaVerblijfplaats: + type: object + properties: + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + adresregel3: + $ref: '#/components/schemas/Adresregel3' + adresseerbaarObjectIdentificatie: + $ref: '#/components/schemas/AdresseerbaarObjectIdentificatie' + nummeraanduidingIdentificatie: + $ref: '#/components/schemas/NummeraanduidingIdentificatie' + functieAdres: + $ref: '#/components/schemas/Waardetabel' + woonplaats: + $ref: '#/components/schemas/Woonplaats' + landVanwaarIngeschreven: + $ref: '#/components/schemas/Waardetabel' + straat: + $ref: '#/components/schemas/Straat' + huisnummer: + $ref: '#/components/schemas/Huisnummer' + huisletter: + $ref: '#/components/schemas/Huisletter' + huisnummertoevoeging: + $ref: '#/components/schemas/Huisnummertoevoeging' + aanduidingBijHuisnummer: + $ref: '#/components/schemas/Waardetabel' + postcode: + $ref: '#/components/schemas/Postcode' + locatiebeschrijving: + $ref: '#/components/schemas/Locatiebeschrijving' + land: + $ref: '#/components/schemas/Waardetabel' + datumAanvangAdreshouding: + $ref: '#/components/schemas/GbaDatum' + datumAanvangAdresBuitenland: + $ref: '#/components/schemas/GbaDatum' + datumIngangGeldigheid: + $ref: '#/components/schemas/GbaDatum' + datumInschrijvingInGemeente: + $ref: '#/components/schemas/GbaDatum' + datumVestigingInNederland: + $ref: '#/components/schemas/GbaDatum' + gemeenteVanInschrijving: + $ref: '#/components/schemas/Waardetabel' + naamOpenbareRuimte: + $ref: '#/components/schemas/NaamOpenbareRuimte' + inOnderzoek: + $ref: '#/components/schemas/GbaInOnderzoek' + AdresseerbaarObjectIdentificatie: + pattern: ^[0-9]{16}$ + type: string + description: | + De verblijfplaats van de persoon kan een ligplaats, een standplaats of een verblijfsobject zijn. + example: "0226010000038820" + NaamOpenbareRuimte: + maxLength: 80 + type: string + GbaGezagsverhouding: + allOf: + - $ref: '#/components/schemas/GezagsverhoudingBasis' + - type: object + properties: + inOnderzoek: + $ref: '#/components/schemas/GbaInOnderzoek' + GezagsverhoudingBasis: + type: object + properties: + indicatieCurateleRegister: + type: boolean + description: | + Geeft aan dat de persoon onder curatele is gesteld. + example: true + indicatieGezagMinderjarige: + $ref: '#/components/schemas/Waardetabel' + description: | + Gegevens over het gezag over de persoon. + GbaVerblijfstitel: + type: object + properties: + aanduiding: + $ref: '#/components/schemas/Waardetabel' + datumEinde: + $ref: '#/components/schemas/GbaDatum' + datumIngang: + $ref: '#/components/schemas/GbaDatum' + inOnderzoek: + $ref: '#/components/schemas/GbaInOnderzoek' + description: | + Gegevens over de verblijfsrechtelijke status van de persoon. + * **datumEinde**: Datum waarop de geldigheid van de gegevens over de verblijfstitel is beëindigd. + * **datumIngang**: Datum waarop de gegevens over de verblijfstitel geldig zijn geworden. + * **aanduiding** : Verblijfstiteltabel die aangeeft over welke verblijfsrechtelijke status de persoon beschikt. + GbaKind: + type: object + properties: + burgerservicenummer: + $ref: '#/components/schemas/Burgerservicenummer' + inOnderzoek: + $ref: '#/components/schemas/GbaInOnderzoek' + naam: + $ref: '#/components/schemas/GbaNaamBasis' + geboorte: + $ref: '#/components/schemas/GbaGeboorte' + GbaOuder: + type: object + properties: + burgerservicenummer: + $ref: '#/components/schemas/Burgerservicenummer' + geslachtsaanduiding: + $ref: '#/components/schemas/Waardetabel' + ouderAanduiding: + $ref: '#/components/schemas/Waardetabel' + datumIngangFamilierechtelijkeBetrekking: + $ref: '#/components/schemas/GbaDatum' + naam: + $ref: '#/components/schemas/GbaNaamBasis' + inOnderzoek: + $ref: '#/components/schemas/GbaInOnderzoek' + geboorte: + $ref: '#/components/schemas/GbaGeboorte' + description: | + Gegevens over de ouder van de persoon. + * **datumIngangFamilierechtelijkeBetrekking** - De datum waarop de familierechtelijke betrekking is ontstaan. + GbaPartner: + type: object + properties: + burgerservicenummer: + $ref: '#/components/schemas/Burgerservicenummer' + geslachtsaanduiding: + $ref: '#/components/schemas/Waardetabel' + soortVerbintenis: + $ref: '#/components/schemas/Waardetabel' + naam: + $ref: '#/components/schemas/GbaNaamBasis' + geboorte: + $ref: '#/components/schemas/GbaGeboorte' + inOnderzoek: + $ref: '#/components/schemas/GbaInOnderzoek' + aangaanHuwelijkPartnerschap: + $ref: '#/components/schemas/GbaAangaanHuwelijkPartnerschap' + ontbindingHuwelijkPartnerschap: + $ref: '#/components/schemas/GbaOntbindingHuwelijkPartnerschap' + GbaAangaanHuwelijkPartnerschap: + type: object + properties: + datum: + $ref: '#/components/schemas/GbaDatum' + land: + $ref: '#/components/schemas/Waardetabel' + plaats: + $ref: '#/components/schemas/Waardetabel' + inOnderzoek: + $ref: '#/components/schemas/GbaInOnderzoek' + description: | + Gegevens over de voltrekking van het huwelijk of het aangaan van het geregistreerd partnerschap. + * **datum** : De datum waarop het huwelijk is voltrokken of het partnerschap is aangegaan. + * **land** : Het land waar het huwelijk is voltrokken of het partnerschap is aangegaan. + * **plaats** : De gemeente waar het huwelijk is voltrokken of het partnerschap is aangegaan. Voor een plaats buiten Nederland bevat het antwoord een buitenlandse plaatsnaam of aanduiding. + GbaOntbindingHuwelijkPartnerschap: + type: object + properties: + datum: + $ref: '#/components/schemas/GbaDatum' + headers: + api_version: + schema: + pattern: ^[1-9][0-9]{0,2}.[0-9]{1,3}.[0-9]{1,3}$ + type: string + description: Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. + example: 1.0.0 + warning: + schema: + maxLength: 500 + type: string + description: zie RFC 7234. In het geval een major versie wordt uitgefaseerd, + gebruiken we warn-code 299 ("Miscellaneous Persistent Warning") en het API + end-point (inclusief versienummer) als de warn-agent van de warning, gevolgd + door de warn-text met de human-readable waarschuwing + example: '299 https://service.../api/.../v1 "Deze versie van de API is verouderd + en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie + hier de documentatie: https://omgevingswet.../api/.../v1".' + X_Rate_Limit_Limit: + schema: + type: integer + X_Rate_Limit_Remaining: + schema: + type: integer + X_Rate_Limit_Reset: + schema: + type: integer diff --git a/specificatie/gba-inonderzoek.yaml b/specificatie/gba-inonderzoek.yaml new file mode 100644 index 000000000..a070730ab --- /dev/null +++ b/specificatie/gba-inonderzoek.yaml @@ -0,0 +1,19 @@ +openapi: 3.0.3 +info: + title: GbaInOnderzoek definities + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + GbaInOnderzoek: + type: object + required: + - aanduidingGegevensInOnderzoek + - datumIngangInOnderzoek + properties: + aanduidingGegevensInOnderzoek: + type: string + pattern: ^[0-9]{6}$ + datumIngangOnderzoek: + $ref: 'datum.yaml#/components/schemas/GbaDatum' diff --git a/specificatie/gba-openapi.yaml b/specificatie/gba-openapi.yaml new file mode 100644 index 000000000..995c66f98 --- /dev/null +++ b/specificatie/gba-openapi.yaml @@ -0,0 +1,25 @@ +openapi: 3.0.3 +servers: + - description: | + APILAB testserver + url: https://www.haalcentraal.nl/haalcentraal/api/brp +info: + title: Bevragen Personen + description: | + API voor het bevragen van personen uit de basisregistratie personen (BRP), inclusief de registratie niet-ingezeten (RNI). Met deze API kun je personen zoeken en actuele gegevens over personen, kinderen, partners en ouders raadplegen. + + Gegevens die er niet zijn of niet actueel zijn krijg je niet terug. Heeft een persoon bijvoorbeeld geen geldige nationaliteit, en alleen een beëindigd partnerschap, dan krijg je geen gegevens over nationaliteit en partner. + + Zie de [Functionele documentatie](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/tree/v1.1.0/features) voor nadere toelichting. + version: 2.0.0 + contact: + url: https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen + license: + name: European Union Public License, version 1.2 (EUPL-1.2) + url: https://eupl.eu/1.2/nl/ +tags: + - name: Personen + description: Zoeken personen +paths: + /personen: + $ref: 'zoek-gba-personen.yaml#/paths/~1personen' diff --git a/specificatie/geboorte.yaml b/specificatie/geboorte.yaml new file mode 100644 index 000000000..88e928303 --- /dev/null +++ b/specificatie/geboorte.yaml @@ -0,0 +1,54 @@ +openapi: 3.0.3 +info: + title: Geboorte definities + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + GbaGeboorteBeperkt: + type: object + properties: + datum: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + GbaGeboorte: + allOf: + - $ref: '#/components/schemas/GbaGeboorteBeperkt' + - type: object + properties: + land: + $ref: 'common.yaml#/components/schemas/Waardetabel' + plaats: + $ref: 'common.yaml#/components/schemas/Waardetabel' + GeboorteBeperkt: + type: object + properties: + datum: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + Geboorte: + description: | + Gegevens over de geboorte. + * **datum** : datum waarop de persoon is geboren. + * **land** : land waar de persoon is geboren + * **plaats** : gemeente waar de persoon is geboren. Is de persoon geboren buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding. + allOf: + - $ref: '#/components/schemas/GeboorteBeperkt' + - type: object + properties: + land: + $ref: 'common.yaml#/components/schemas/Waardetabel' + plaats: + $ref: 'common.yaml#/components/schemas/Waardetabel' + inOnderzoek: + $ref: '#/components/schemas/GeboorteInOnderzoek' + GeboorteInOnderzoek: + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + datum: + type: boolean + land: + type: boolean + plaats: + type: boolean diff --git a/specificatie/genereervariant/openapi.json b/specificatie/genereervariant/openapi.json index d6111455f..ad6305b34 100644 --- a/specificatie/genereervariant/openapi.json +++ b/specificatie/genereervariant/openapi.json @@ -1,8 +1,8 @@ { - "openapi" : "3.0.0", + "openapi" : "3.0.3", "info" : { - "title" : "Bevragen Ingeschreven Personen", - "description" : "API voor het bevragen van ingeschreven personen uit de basisregistratie personen (BRP), inclusief de registratie niet-ingezeten (RNI). Met deze API kun je personen zoeken en actuele gegevens over personen, kinderen, partners en ouders raadplegen.\n\nGegevens die er niet zijn of niet actueel zijn krijg je niet terug. Heeft een persoon bijvoorbeeld geen geldige nationaliteit, en alleen een beëindigd partnerschap, dan krijg je geen gegevens over nationaliteit en partner.\n\nZie de [Functionele documentatie](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/tree/v1.1.0/features) voor nadere toelichting.\n", + "title" : "Bevragen Personen", + "description" : "API voor het bevragen van personen uit de basisregistratie personen (BRP), inclusief de registratie niet-ingezeten (RNI). Met deze API kun je personen zoeken en actuele gegevens over personen, kinderen, partners en ouders raadplegen.\n\nGegevens die er niet zijn of niet actueel zijn krijg je niet terug. Heeft een persoon bijvoorbeeld geen geldige nationaliteit, en alleen een beëindigd partnerschap, dan krijg je geen gegevens over nationaliteit en partner.\n\nZie de [Functionele documentatie](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/tree/v1.1.0/features) voor nadere toelichting.\n", "contact" : { "url" : "https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen" }, @@ -10,224 +10,32 @@ "name" : "European Union Public License, version 1.2 (EUPL-1.2)", "url" : "https://eupl.eu/1.2/nl/" }, - "version" : "1.3.1" + "version" : "2.0.0" }, "servers" : [ { "url" : "https://www.haalcentraal.nl/haalcentraal/api/brp", "description" : "APILAB testserver\n" } ], "tags" : [ { - "name" : "Ingeschreven Personen", - "description" : "Zoeken en raadplegen van ingeschreven personen" + "name" : "Personen", + "description" : "Zoeken personen" } ], "paths" : { - "/ingeschrevenpersonen" : { - "get" : { - "tags" : [ "Ingeschreven Personen" ], + "/personen" : { + "post" : { + "tags" : [ "Personen" ], "summary" : "Vindt personen", - "description" : "Zoek personen met één van de onderstaande verplichte combinaties van parameters en vul ze evt. aan met parameters uit de andere combinaties.\n\n\nDefault krijg je personen terug die nog in leven zijn, tenzij je de inclusiefoverledenpersonen=true opgeeft.\n\n\nGebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/fields_extensie.feature)\n\n\n1. Persoon\n - geboorte__datum\n - naam__geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature)\n\n\n2. Persoon\n - verblijfplaats__gemeenteVanInschrijving\n - naam__geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature)\n\n\n3. Persoon\n - burgerservicenummer\n\n\n4. Postcode\n - verblijfplaats__postcode\n - verblijfplaats__huisnummer\n\n\n5. Straat\n - verblijfplaats__straat (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature) )\n - verblijfplaats__gemeenteVanInschrijving\n - verblijfplaats__huisnummer\n\n\n6. Adres\n - verblijfplaats__nummeraanduidingIdentificatie\n", - "operationId" : "GetIngeschrevenPersonen", - "parameters" : [ { - "name" : "expand", - "in" : "query", - "description" : "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature).", - "required" : false, - "deprecated" : true, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "fields", - "in" : "query", - "description" : "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)", - "required" : false, - "schema" : { - "type" : "string" - } - }, { - "name" : "burgerservicenummer", - "in" : "query", - "description" : "Uniek persoonsnummer.\n", - "required" : false, - "style" : "form", - "explode" : false, - "schema" : { - "type" : "array", - "items" : { - "pattern" : "^[0-9]{9}$", - "type" : "string" + "description" : "Zoek personen met één van de onderstaande verplichte combinaties van parameters en vul ze evt. aan met optionele parameters.\n\n\nDefault krijg je personen terug die nog in leven zijn, tenzij je de inclusiefoverledenpersonen=true opgeeft.\n\n\nGebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/fields_extensie.feature)\n\n\n1. Zoek met geslachtsnaam en geboortedatum\n - geboortedatum\n - geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature))\n\n\n2. Zoek met geslachtsnaam, voornamen en gemeente van inschrijving\n - gemeenteVanInschrijving\n - geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature))\n\n\n3. Raadpleeg met burgerservicenummer\n - burgerservicenummer\n\n\n4. Zoek met postcode en huisnummer\n - postcode\n - huisnummer\n\n\n5. Zoek met straat, huisnummer en gemeente van inschrijving\n - straat (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature))\n - gemeenteVanInschrijving\n - huisnummer\n\n\n6. Zoek met nummeraanduiding identificatie\n - nummeraanduidingIdentificatie\n", + "operationId" : "GetPersonen", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PersonenQuery" + } } - }, - "example" : [ "999993653", "999991723", "999995078" ] - }, { - "name" : "geboorte__datum", - "in" : "query", - "description" : "Je kunt alleen zoeken met een volledig geboortedatum. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/parametervalidatie.feature)\n", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string", - "format" : "date", - "example" : "1964-09-24" - } - }, { - "name" : "geboorte__plaats", - "in" : "query", - "description" : "Gemeentenaam of een buitenlandse plaats of een plaatsbepaling, die aangeeft waar de persoon is geboren. **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).**\n", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "maxLength" : 40, - "type" : "string", - "example" : "Utrecht" - } - }, { - "name" : "geslachtsaanduiding", - "in" : "query", - "description" : "Geeft aan wat het geslacht is van persoon.\n", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string", - "example" : "V" - } - }, { - "name" : "inclusiefOverledenPersonen", - "in" : "query", - "description" : "Als je ook overleden personen in het antwoord wilt, geef dan de parameter inclusiefOverledenPersonen op met waarde True. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/overleden_personen.feature)\n", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "boolean", - "example" : true - } - }, { - "name" : "naam__geslachtsnaam", - "in" : "query", - "description" : "De (geslachts)naam waarvan de eventueel aanwezige voorvoegsels zijn afgesplitst. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).**\n", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "maxLength" : 200, - "type" : "string", - "example" : "Vries" - } - }, { - "name" : "naam__voorvoegsel", - "in" : "query", - "description" : "Deel van de geslachtsnaam dat vooraf gaat aan de rest van de geslachtsnaam. Het zoeken op het voorvoegsel is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).**\n", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "maxLength" : 10, - "type" : "string", - "example" : "de" - } - }, { - "name" : "naam__voornamen", - "in" : "query", - "description" : "De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).**\n", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "maxLength" : 200, - "type" : "string", - "example" : "Dirk" - } - }, { - "name" : "verblijfplaats__gemeenteVanInschrijving", - "in" : "query", - "description" : "Een code die aangeeft in welke gemeente de persoon woont, of de laatste gemeente waar de persoon heeft gewoond, of de gemeente waar de persoon voor het eerst is ingeschreven.\n", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "maxLength" : 4, - "type" : "string", - "example" : "0518" - } - }, { - "name" : "verblijfplaats__huisletter", - "in" : "query", - "description" : "Een toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven.\n", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "maxLength" : 1, - "type" : "string", - "example" : "a" - } - }, { - "name" : "verblijfplaats__huisnummer", - "in" : "query", - "description" : "Een nummer dat door de gemeente aan een adresseerbaar object is gegeven.\n", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "maximum" : 99999, - "type" : "integer", - "example" : 14 - } - }, { - "name" : "verblijfplaats__huisnummertoevoeging", - "in" : "query", - "description" : "Een toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven.\n", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "maxLength" : 4, - "type" : "string", - "example" : "bis" - } - }, { - "name" : "verblijfplaats__nummeraanduidingIdentificatie", - "in" : "query", - "description" : "Unieke identificatie van een nummeraanduiding (en het bijbehorende adres) in de BAG.\n", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "maxLength" : 16, - "type" : "string", - "example" : "0518200000366054" - } - }, { - "name" : "verblijfplaats__straat", - "in" : "query", - "description" : "Een naam die door de gemeente aan een openbare ruimte is gegeven. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).\n", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "maxLength" : 80, - "type" : "string", - "example" : "Tulpstraat" - } - }, { - "name" : "verblijfplaats__postcode", - "in" : "query", - "description" : "De door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort.\n", - "required" : false, - "style" : "form", - "explode" : true, - "schema" : { - "pattern" : "^[1-9]{1}[0-9]{3}[A-Z]{2}$", - "type" : "string", - "example" : "2341SX" } - } ], + }, "responses" : { "200" : { "description" : "Zoekactie geslaagd\n", @@ -237,12 +45,21 @@ }, "warning" : { "$ref" : "#/components/headers/warning" + }, + "X-Rate-Limit-Limit" : { + "$ref" : "#/components/headers/X_Rate_Limit_Limit" + }, + "X-Rate-Limit-Remaining" : { + "$ref" : "#/components/headers/X_Rate_Limit_Remaining" + }, + "X-Rate-Limit-Reset" : { + "$ref" : "#/components/headers/X_Rate_Limit_Reset" } }, "content" : { - "application/hal+json" : { + "application/json" : { "schema" : { - "$ref" : "#/components/schemas/IngeschrevenPersoonHalCollectie" + "$ref" : "#/components/schemas/PersonenQueryResponse" } } } @@ -345,6 +162,29 @@ } } }, + "429" : { + "description" : "Too Many Requests", + "headers" : { + "api-version" : { + "$ref" : "#/components/headers/api_version" + } + }, + "content" : { + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/Foutbericht" + }, + "example" : { + "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", + "title" : "Too many request", + "status" : 429, + "detail" : "The user has sent too many requests in a given amount of time (rate limiting).", + "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", + "code" : "tooManyRequests" + } + } + } + }, "500" : { "description" : "Internal Server Error", "headers" : { @@ -405,7 +245,7 @@ }, "example" : { "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title" : "Bronservice {bron} is tijdelijk niet beschikbaar.", + "title" : "Bronservice BRP is tijdelijk niet beschikbaar.", "status" : 503, "detail" : "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", @@ -431,2323 +271,1368 @@ } } } - }, - "/ingeschrevenpersonen/{burgerservicenummer}" : { - "get" : { - "tags" : [ "Ingeschreven Personen" ], - "summary" : "Raadpleeg een persoon", - "description" : "Raadpleeg een (overleden) persoon.\n\nGebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/fields_extensie.feature).\n", - "operationId" : "GetIngeschrevenPersoon", - "parameters" : [ { - "name" : "burgerservicenummer", - "in" : "path", - "description" : "Uniek persoonsnummer\n", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "pattern" : "^[0-9]{9}$", - "type" : "string", - "example" : "555555021" + } + }, + "components" : { + "schemas" : { + "PersonenQueryResponse" : { + "required" : [ "type" ], + "type" : "object", + "properties" : { + "type" : { + "type" : "string" + } + }, + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "ZoekMetGeslachtsnaamEnGeboortedatum" : "#/components/schemas/ZoekMetGeslachtsnaamEnGeboortedatumResponse", + "ZoekMetNaamEnGemeenteVanInschrijving" : "#/components/schemas/ZoekMetNaamEnGemeenteVanInschrijvingResponse", + "RaadpleegMetBurgerservicenummer" : "#/components/schemas/RaadpleegMetBurgerservicenummerResponse", + "ZoekMetPostcodeEnHuisnummer" : "#/components/schemas/ZoekMetPostcodeEnHuisnummerResponse", + "ZoekMetStraatHuisnummerEnGemeenteVanInschrijving" : "#/components/schemas/ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse", + "ZoekMetNummeraanduidingIdentificatie" : "#/components/schemas/ZoekMetNummeraanduidingIdentificatieResponse" } + } + }, + "ZoekMetGeslachtsnaamEnGeboortedatumResponse" : { + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQueryResponse" }, { - "name" : "expand", - "in" : "query", - "description" : "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature).", - "required" : false, - "deprecated" : true, - "style" : "form", - "explode" : true, - "schema" : { - "type" : "string" + "type" : "object", + "properties" : { + "personen" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PersoonBeperkt" + } + } } + } ] + }, + "ZoekMetNaamEnGemeenteVanInschrijvingResponse" : { + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQueryResponse" }, { - "name" : "fields", - "in" : "query", - "description" : "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)", - "required" : false, - "schema" : { - "type" : "string" + "type" : "object", + "properties" : { + "personen" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PersoonBeperkt" + } + } } - } ], - "responses" : { - "200" : { - "description" : "Zoekactie geslaagd\n", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - }, - "warning" : { - "$ref" : "#/components/headers/warning" + } ] + }, + "RaadpleegMetBurgerservicenummerResponse" : { + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQueryResponse" + }, { + "type" : "object", + "properties" : { + "personen" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Persoon" } - }, - "content" : { - "application/hal+json" : { - "schema" : { - "$ref" : "#/components/schemas/IngeschrevenPersoonHal" - } + } + } + } ] + }, + "ZoekMetPostcodeEnHuisnummerResponse" : { + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQueryResponse" + }, { + "type" : "object", + "properties" : { + "personen" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PersoonBeperkt" } } - }, - "400" : { - "description" : "Bad Request", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" + } + } ] + }, + "ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse" : { + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQueryResponse" + }, { + "type" : "object", + "properties" : { + "personen" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PersoonBeperkt" } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/BadRequestFoutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title" : "Ten minste één parameter moet worden opgegeven.", - "status" : 400, - "detail" : "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "paramsRequired", - "invalidParams" : [ { - "type" : "https://www.vng.nl/realisatie/api/validaties/integer", - "name" : "verblijfplaats__huisnummer", - "code" : "integer", - "reason" : "Waarde is geen geldige integer." - } ] - } + } + } + } ] + }, + "ZoekMetNummeraanduidingIdentificatieResponse" : { + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQueryResponse" + }, { + "type" : "object", + "properties" : { + "personen" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/PersoonBeperkt" } } + } + } ] + }, + "PersonenQuery" : { + "required" : [ "fields", "type" ], + "type" : "object", + "properties" : { + "type" : { + "type" : "string" }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } + "fields" : { + "$ref" : "#/components/schemas/Fields" + }, + "gemeenteVanInschrijving" : { + "$ref" : "#/components/schemas/GemeenteVanInschrijving" + } + }, + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "ZoekMetGeslachtsnaamEnGeboortedatum" : "#/components/schemas/ZoekMetGeslachtsnaamEnGeboortedatum", + "ZoekMetNaamEnGemeenteVanInschrijving" : "#/components/schemas/ZoekMetNaamEnGemeenteVanInschrijving", + "RaadpleegMetBurgerservicenummer" : "#/components/schemas/RaadpleegMetBurgerservicenummer", + "ZoekMetPostcodeEnHuisnummer" : "#/components/schemas/ZoekMetPostcodeEnHuisnummer", + "ZoekMetStraatHuisnummerEnGemeenteVanInschrijving" : "#/components/schemas/ZoekMetStraatHuisnummerEnGemeenteVanInschrijving", + "ZoekMetNummeraanduidingIdentificatie" : "#/components/schemas/ZoekMetNummeraanduidingIdentificatie" + } + } + }, + "ZoekMetGeslachtsnaamEnGeboortedatum" : { + "required" : [ "geboortedatum", "geslachtsnaam" ], + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQuery" + }, { + "type" : "object", + "properties" : { + "inclusiefOverledenPersonen" : { + "$ref" : "#/components/schemas/InclusiefOverledenPersonen" }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title" : "Niet correct geauthenticeerd.", - "status" : 401, - "detail" : "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "authentication" - } - } + "geboortedatum" : { + "type" : "string", + "description" : "Je kunt alleen zoeken met een volledig geboortedatum. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/parametervalidatie.feature)\n", + "format" : "date", + "example" : "1964-09-24" + }, + "geboorteplaats" : { + "$ref" : "#/components/schemas/GeboorteplaatsFilter" + }, + "geslachtsnaam" : { + "$ref" : "#/components/schemas/GeslachtsnaamFilter" + }, + "geslachtsaanduiding" : { + "$ref" : "#/components/schemas/GeslachtsaanduidingFilter" + }, + "voorvoegsel" : { + "$ref" : "#/components/schemas/VoorvoegselFilter" + }, + "voornamen" : { + "$ref" : "#/components/schemas/VoornamenOptioneelFilter" } - }, - "403" : { - "description" : "Forbidden", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } + } + } ] + }, + "InclusiefOverledenPersonen" : { + "type" : "boolean", + "description" : "Als je ook overleden personen in het antwoord wilt, geef dan de parameter inclusiefOverledenPersonen op met waarde True. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/overleden_personen.feature)\n", + "example" : true + }, + "ZoekMetNaamEnGemeenteVanInschrijving" : { + "required" : [ "gemeenteVanInschrijving", "geslachtsnaam", "voornamen" ], + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQuery" + }, { + "type" : "object", + "properties" : { + "inclusiefOverledenPersonen" : { + "$ref" : "#/components/schemas/InclusiefOverledenPersonen" }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title" : "U bent niet geautoriseerd voor deze operatie.", - "status" : 403, - "detail" : "The server understood the request, but is refusing to fulfill it.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "autorisation" - } - } + "geslachtsaanduiding" : { + "$ref" : "#/components/schemas/GeslachtsaanduidingFilter" + }, + "geslachtsnaam" : { + "$ref" : "#/components/schemas/GeslachtsnaamFilter" + }, + "voorvoegsel" : { + "$ref" : "#/components/schemas/VoorvoegselFilter" + }, + "voornamen" : { + "$ref" : "#/components/schemas/VoornamenVerplichtFilter" } - }, - "404" : { - "description" : "Not Found", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5", - "title" : "Opgevraagde resource bestaat niet.", - "status" : 404, - "detail" : "The server has not found anything matching the Request-URI.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notFound" - } + } + } ] + }, + "RaadpleegMetBurgerservicenummer" : { + "required" : [ "burgerservicenummer" ], + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQuery" + }, { + "type" : "object", + "properties" : { + "burgerservicenummer" : { + "maxItems" : 20, + "minItems" : 1, + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Burgerservicenummer" } } - }, - "406" : { - "description" : "Not Acceptable", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } + } + } ] + }, + "ZoekMetPostcodeEnHuisnummer" : { + "required" : [ "huisnummer", "postcode" ], + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQuery" + }, { + "type" : "object", + "properties" : { + "inclusiefOverledenPersonen" : { + "$ref" : "#/components/schemas/InclusiefOverledenPersonen" }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title" : "Gevraagde contenttype wordt niet ondersteund.", - "status" : 406, - "detail" : "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notAcceptable" - } - } - } - }, - "500" : { - "description" : "Internal Server Error", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } + "huisletter" : { + "$ref" : "#/components/schemas/Huisletter" }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title" : "Interne server fout.", - "status" : 500, - "detail" : "The server encountered an unexpected condition which prevented it from fulfilling the request.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "serverError" - } - } - } - }, - "501" : { - "description" : "Not Implemented", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } + "huisnummer" : { + "$ref" : "#/components/schemas/Huisnummer" }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2", - "title" : "Not Implemented", - "status" : 501, - "detail" : "The server does not support the functionality required to fulfill the request.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notImplemented" - } - } - } - }, - "503" : { - "description" : "Service Unavailable", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } + "huisnummertoevoeging" : { + "$ref" : "#/components/schemas/Huisnummertoevoeging" }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title" : "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status" : 503, - "detail" : "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notAvailable" - } - } + "postcode" : { + "$ref" : "#/components/schemas/Postcode" } - }, - "default" : { - "description" : "Er is een onverwachte fout opgetreden", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } + } + } ] + }, + "ZoekMetStraatHuisnummerEnGemeenteVanInschrijving" : { + "required" : [ "gemeenteVanInschrijving", "huisnummer", "straat" ], + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQuery" + }, { + "type" : "object", + "properties" : { + "inclusiefOverledenPersonen" : { + "$ref" : "#/components/schemas/InclusiefOverledenPersonen" }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - } - } + "huisletter" : { + "$ref" : "#/components/schemas/Huisletter" + }, + "huisnummer" : { + "$ref" : "#/components/schemas/Huisnummer" + }, + "huisnummertoevoeging" : { + "$ref" : "#/components/schemas/Huisnummertoevoeging" + }, + "straat" : { + "$ref" : "#/components/schemas/StraatFilter" } } - } - } - }, - "/ingeschrevenpersonen/{burgerservicenummer}/kinderen/{id}" : { - "get" : { - "tags" : [ "Ingeschreven Personen" ], - "summary" : "Raadpleeg een kind van een persoon", - "description" : "Raadpleeg een kind van een persoon\n", - "operationId" : "GetKind", - "parameters" : [ { - "name" : "burgerservicenummer", - "in" : "path", - "description" : "Uniek persoonsnummer\n", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "pattern" : "^[0-9]{9}$", - "type" : "string", - "example" : "555555021" - } + } ] + }, + "ZoekMetNummeraanduidingIdentificatie" : { + "required" : [ "nummeraanduidingIdentificatie" ], + "allOf" : [ { + "$ref" : "#/components/schemas/PersonenQuery" }, { - "name" : "id", - "in" : "path", - "description" : "De identificatie van het kind.\n", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Zoekactie geslaagd\n", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - }, - "warning" : { - "$ref" : "#/components/headers/warning" - } + "type" : "object", + "properties" : { + "inclusiefOverledenPersonen" : { + "$ref" : "#/components/schemas/InclusiefOverledenPersonen" }, - "content" : { - "application/hal+json" : { - "schema" : { - "$ref" : "#/components/schemas/KindHalBasis" - } - } + "nummeraanduidingIdentificatie" : { + "$ref" : "#/components/schemas/NummeraanduidingIdentificatie" } - }, - "400" : { - "description" : "Bad Request", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/BadRequestFoutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title" : "Ten minste één parameter moet worden opgegeven.", - "status" : 400, - "detail" : "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "paramsRequired", - "invalidParams" : [ { - "type" : "https://www.vng.nl/realisatie/api/validaties/integer", - "name" : "verblijfplaats__huisnummer", - "code" : "integer", - "reason" : "Waarde is geen geldige integer." - } ] - } + } + } ] + }, + "BadRequestFoutbericht" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Foutbericht" + }, { + "type" : "object", + "properties" : { + "invalidParams" : { + "type" : "array", + "description" : "Foutmelding per fout in een parameter. Alle gevonden fouten worden één keer teruggemeld.", + "items" : { + "$ref" : "#/components/schemas/InvalidParams" } } + } + } ] + }, + "Foutbericht" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "description" : "Link naar meer informatie over deze fout", + "format" : "uri" }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title" : "Niet correct geauthenticeerd.", - "status" : 401, - "detail" : "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "authentication" - } - } - } + "title" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-]{1,80}$", + "type" : "string", + "description" : "Beschrijving van de fout" }, - "403" : { - "description" : "Forbidden", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title" : "U bent niet geautoriseerd voor deze operatie.", - "status" : 403, - "detail" : "The server understood the request, but is refusing to fulfill it.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "autorisation" - } - } - } + "status" : { + "maximum" : 600, + "minimum" : 100, + "type" : "integer", + "description" : "Http status code" }, - "404" : { - "description" : "Not Found", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5", - "title" : "Opgevraagde resource bestaat niet.", - "status" : 404, - "detail" : "The server has not found anything matching the Request-URI.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notFound" - } - } - } + "detail" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-\\(\\)\\,]{1,200}$", + "type" : "string", + "description" : "Details over de fout" }, - "406" : { - "description" : "Not Acceptable", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title" : "Gevraagde contenttype wordt niet ondersteund.", - "status" : 406, - "detail" : "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notAcceptable" - } - } - } + "instance" : { + "type" : "string", + "description" : "Uri van de aanroep die de fout heeft veroorzaakt", + "format" : "uri" }, - "500" : { - "description" : "Internal Server Error", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title" : "Interne server fout.", - "status" : 500, - "detail" : "The server encountered an unexpected condition which prevented it from fulfilling the request.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "serverError" - } - } - } + "code" : { + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9]{1,25}$", + "type" : "string", + "description" : "Systeemcode die het type fout aangeeft" + } + }, + "description" : "Terugmelding bij een fout. JSON representatie in lijn met [RFC7807](https://tools.ietf.org/html/rfc7807)." + }, + "InvalidParams" : { + "type" : "object", + "properties" : { + "type" : { + "type" : "string", + "format" : "uri", + "example" : "https://www.vng.nl/realisatie/api/{major-versie}/validaties/integer" }, - "501" : { - "description" : "Not Implemented", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2", - "title" : "Not Implemented", - "status" : 501, - "detail" : "The server does not support the functionality required to fulfill the request.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notImplemented" - } - } - } + "name" : { + "pattern" : "^[a-zA-Z0-9\\.,_]{1,30}$", + "type" : "string", + "description" : "Naam van de parameter", + "example" : "verblijfplaats__huisnummer" }, - "503" : { - "description" : "Service Unavailable", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title" : "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status" : 503, - "detail" : "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notAvailable" - } - } - } + "code" : { + "minLength" : 1, + "pattern" : "^[a-zA-Z0-9\\.,_]{1,25}$", + "type" : "string", + "description" : "Systeemcode die het type fout aangeeft", + "example" : "integer" }, - "default" : { - "description" : "Er is een onverwachte fout opgetreden", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - } - } - } - } - }, - "deprecated" : true - } - }, - "/ingeschrevenpersonen/{burgerservicenummer}/kinderen" : { - "get" : { - "tags" : [ "Ingeschreven Personen" ], - "summary" : "Levert de kinderen van een persoon", - "description" : "Levert de kinderen van een persoon\n", - "operationId" : "GetKinderen", - "parameters" : [ { - "name" : "burgerservicenummer", - "in" : "path", - "description" : "Uniek persoonsnummer\n", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "pattern" : "^[0-9]{9}$", + "reason" : { + "pattern" : "^[a-zA-Z0-9\\.,_ ]{1,80}$", "type" : "string", - "example" : "555555021" + "description" : "Beschrijving van de fout op de parameterwaarde", + "example" : "Waarde is geen geldige integer." } - } ], - "responses" : { - "200" : { - "description" : "Zoekactie geslaagd\n", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - }, - "warning" : { - "$ref" : "#/components/headers/warning" - } - }, - "content" : { - "application/hal+json" : { - "schema" : { - "$ref" : "#/components/schemas/KindHalCollectie" - } - } - } + }, + "description" : "Details over fouten in opgegeven parameters" + }, + "PersoonBeperkt" : { + "type" : "object", + "properties" : { + "burgerservicenummer" : { + "$ref" : "#/components/schemas/Burgerservicenummer" }, - "400" : { - "description" : "Bad Request", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/BadRequestFoutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title" : "Ten minste één parameter moet worden opgegeven.", - "status" : 400, - "detail" : "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "paramsRequired", - "invalidParams" : [ { - "type" : "https://www.vng.nl/realisatie/api/validaties/integer", - "name" : "verblijfplaats__huisnummer", - "code" : "integer", - "reason" : "Waarde is geen geldige integer." - } ] - } - } - } + "geboorte" : { + "$ref" : "#/components/schemas/GeboorteBeperkt" }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title" : "Niet correct geauthenticeerd.", - "status" : 401, - "detail" : "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "authentication" - } - } - } + "geheimhoudingPersoonsgegevens" : { + "$ref" : "#/components/schemas/GeheimhoudingPersoonsgegevens" }, - "403" : { - "description" : "Forbidden", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title" : "U bent niet geautoriseerd voor deze operatie.", - "status" : 403, - "detail" : "The server understood the request, but is refusing to fulfill it.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "autorisation" - } - } - } - }, - "404" : { - "description" : "Not Found", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5", - "title" : "Opgevraagde resource bestaat niet.", - "status" : 404, - "detail" : "The server has not found anything matching the Request-URI.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notFound" - } - } - } + "geslachtsaanduiding" : { + "$ref" : "#/components/schemas/Waardetabel" }, - "406" : { - "description" : "Not Acceptable", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title" : "Gevraagde contenttype wordt niet ondersteund.", - "status" : 406, - "detail" : "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notAcceptable" - } - } - } + "leeftijd" : { + "$ref" : "#/components/schemas/Leeftijd" }, - "500" : { - "description" : "Internal Server Error", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title" : "Interne server fout.", - "status" : 500, - "detail" : "The server encountered an unexpected condition which prevented it from fulfilling the request.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "serverError" - } - } - } + "naam" : { + "$ref" : "#/components/schemas/NaamBasis" }, - "501" : { - "description" : "Not Implemented", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2", - "title" : "Not Implemented", - "status" : 501, - "detail" : "The server does not support the functionality required to fulfill the request.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notImplemented" - } - } - } + "opschortingBijhouding" : { + "$ref" : "#/components/schemas/OpschortingBijhoudingBasis" }, - "503" : { - "description" : "Service Unavailable", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title" : "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status" : 503, - "detail" : "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notAvailable" - } - } - } + "overlijden" : { + "$ref" : "#/components/schemas/OverlijdenBasis" }, - "default" : { - "description" : "Er is een onverwachte fout opgetreden", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - } - } - } - } - }, - "deprecated" : true - } - }, - "/ingeschrevenpersonen/{burgerservicenummer}/ouders/{id}" : { - "get" : { - "tags" : [ "Ingeschreven Personen" ], - "summary" : "Raadpleeg een ouder van een persoon", - "description" : "Raadpleeg een ouder van een persoon\n", - "operationId" : "GetOuder", - "parameters" : [ { - "name" : "burgerservicenummer", - "in" : "path", - "description" : "Uniek persoonsnummer\n", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "pattern" : "^[0-9]{9}$", - "type" : "string", - "example" : "555555021" - } - }, { - "name" : "id", - "in" : "path", - "description" : "De identificatie van de ouder.\n", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" + "verblijfplaats" : { + "$ref" : "#/components/schemas/AbstractVerblijfplaatsBeperkt" } - } ], - "responses" : { - "200" : { - "description" : "Zoekactie geslaagd\n", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - }, - "warning" : { - "$ref" : "#/components/headers/warning" - } - }, - "content" : { - "application/hal+json" : { - "schema" : { - "$ref" : "#/components/schemas/OuderHalBasis" - } - } - } + } + }, + "Burgerservicenummer" : { + "pattern" : "^[0-9]{9}$", + "type" : "string", + "example" : "555555021" + }, + "GeheimhoudingPersoonsgegevens" : { + "type" : "boolean", + "description" : "Gegevens mogen niet worden verstrekt aan derden / maatschappelijke instellingen.\n" + }, + "Leeftijd" : { + "maximum" : 150, + "minimum" : 0, + "type" : "integer", + "description" : "Leeftijd in jaren op het moment van bevragen.\n", + "example" : 34 + }, + "Persoon" : { + "type" : "object", + "properties" : { + "aNummer" : { + "$ref" : "#/components/schemas/ANummer" }, - "400" : { - "description" : "Bad Request", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/BadRequestFoutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title" : "Ten minste één parameter moet worden opgegeven.", - "status" : 400, - "detail" : "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "paramsRequired", - "invalidParams" : [ { - "type" : "https://www.vng.nl/realisatie/api/validaties/integer", - "name" : "verblijfplaats__huisnummer", - "code" : "integer", - "reason" : "Waarde is geen geldige integer." - } ] - } - } - } + "burgerservicenummer" : { + "$ref" : "#/components/schemas/Burgerservicenummer" }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title" : "Niet correct geauthenticeerd.", - "status" : 401, - "detail" : "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "authentication" - } - } - } + "datumEersteInschrijvingGBA" : { + "$ref" : "#/components/schemas/AbstractDatum" }, - "403" : { - "description" : "Forbidden", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title" : "U bent niet geautoriseerd voor deze operatie.", - "status" : 403, - "detail" : "The server understood the request, but is refusing to fulfill it.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "autorisation" - } - } - } + "geheimhoudingPersoonsgegevens" : { + "$ref" : "#/components/schemas/GeheimhoudingPersoonsgegevens" }, - "404" : { - "description" : "Not Found", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5", - "title" : "Opgevraagde resource bestaat niet.", - "status" : 404, - "detail" : "The server has not found anything matching the Request-URI.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notFound" - } - } - } + "geslachtsaanduiding" : { + "$ref" : "#/components/schemas/Waardetabel" }, - "406" : { - "description" : "Not Acceptable", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title" : "Gevraagde contenttype wordt niet ondersteund.", - "status" : 406, - "detail" : "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notAcceptable" - } - } - } - }, - "500" : { - "description" : "Internal Server Error", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title" : "Interne server fout.", - "status" : 500, - "detail" : "The server encountered an unexpected condition which prevented it from fulfilling the request.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "serverError" - } - } - } - }, - "501" : { - "description" : "Not Implemented", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2", - "title" : "Not Implemented", - "status" : 501, - "detail" : "The server does not support the functionality required to fulfill the request.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notImplemented" - } - } - } - }, - "503" : { - "description" : "Service Unavailable", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title" : "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status" : 503, - "detail" : "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notAvailable" - } - } - } - }, - "default" : { - "description" : "Er is een onverwachte fout opgetreden", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - } - } - } - } - }, - "deprecated" : true - } - }, - "/ingeschrevenpersonen/{burgerservicenummer}/ouders" : { - "get" : { - "tags" : [ "Ingeschreven Personen" ], - "summary" : "Levert de ouders van een persoon", - "description" : "Levert de ouders van een persoon\n", - "operationId" : "GetOuders", - "parameters" : [ { - "name" : "burgerservicenummer", - "in" : "path", - "description" : "Uniek persoonsnummer\n", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "pattern" : "^[0-9]{9}$", - "type" : "string", - "example" : "555555021" - } - } ], - "responses" : { - "200" : { - "description" : "Zoekactie geslaagd\n", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - }, - "warning" : { - "$ref" : "#/components/headers/warning" - } - }, - "content" : { - "application/hal+json" : { - "schema" : { - "$ref" : "#/components/schemas/OuderHalCollectie" - } - } - } - }, - "400" : { - "description" : "Bad Request", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/BadRequestFoutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title" : "Ten minste één parameter moet worden opgegeven.", - "status" : 400, - "detail" : "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "paramsRequired", - "invalidParams" : [ { - "type" : "https://www.vng.nl/realisatie/api/validaties/integer", - "name" : "verblijfplaats__huisnummer", - "code" : "integer", - "reason" : "Waarde is geen geldige integer." - } ] - } - } - } - }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title" : "Niet correct geauthenticeerd.", - "status" : 401, - "detail" : "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "authentication" - } - } - } - }, - "403" : { - "description" : "Not Found", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5", - "title" : "Opgevraagde resource bestaat niet.", - "status" : 404, - "detail" : "The server has not found anything matching the Request-URI.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notFound" - } - } - } - }, - "404" : { - "description" : "Forbidden", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title" : "U bent niet geautoriseerd voor deze operatie.", - "status" : 403, - "detail" : "The server understood the request, but is refusing to fulfill it.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "autorisation" - } - } - } - }, - "406" : { - "description" : "Not Acceptable", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title" : "Gevraagde contenttype wordt niet ondersteund.", - "status" : 406, - "detail" : "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notAcceptable" - } - } - } - }, - "500" : { - "description" : "Internal Server Error", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title" : "Interne server fout.", - "status" : 500, - "detail" : "The server encountered an unexpected condition which prevented it from fulfilling the request.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "serverError" - } - } - } - }, - "501" : { - "description" : "Not Implemented", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2", - "title" : "Not Implemented", - "status" : 501, - "detail" : "The server does not support the functionality required to fulfill the request.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notImplemented" - } - } - } - }, - "503" : { - "description" : "Service Unavailable", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title" : "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status" : 503, - "detail" : "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notAvailable" - } - } - } - }, - "default" : { - "description" : "Er is een onverwachte fout opgetreden", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - } - } - } - } - }, - "deprecated" : true - } - }, - "/ingeschrevenpersonen/{burgerservicenummer}/partners/{id}" : { - "get" : { - "tags" : [ "Ingeschreven Personen" ], - "summary" : "Raadpleeg de partner van een persoon", - "description" : "Raadpleeg de partner van een persoon\n", - "operationId" : "GetPartner", - "parameters" : [ { - "name" : "burgerservicenummer", - "in" : "path", - "description" : "Uniek persoonsnummer\n", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "pattern" : "^[0-9]{9}$", - "type" : "string", - "example" : "555555021" - } - }, { - "name" : "id", - "in" : "path", - "description" : "De identificatie van de partner.\n", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Zoekactie geslaagd\n", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - }, - "warning" : { - "$ref" : "#/components/headers/warning" - } - }, - "content" : { - "application/hal+json" : { - "schema" : { - "$ref" : "#/components/schemas/PartnerHalBasis" - } - } - } - }, - "400" : { - "description" : "Bad Request", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/BadRequestFoutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title" : "Ten minste één parameter moet worden opgegeven.", - "status" : 400, - "detail" : "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "paramsRequired", - "invalidParams" : [ { - "type" : "https://www.vng.nl/realisatie/api/validaties/integer", - "name" : "verblijfplaats__huisnummer", - "code" : "integer", - "reason" : "Waarde is geen geldige integer." - } ] - } - } - } - }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title" : "Niet correct geauthenticeerd.", - "status" : 401, - "detail" : "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "authentication" - } - } - } - }, - "403" : { - "description" : "Forbidden", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title" : "U bent niet geautoriseerd voor deze operatie.", - "status" : 403, - "detail" : "The server understood the request, but is refusing to fulfill it.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "autorisation" - } - } - } - }, - "404" : { - "description" : "Not Found", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5", - "title" : "Opgevraagde resource bestaat niet.", - "status" : 404, - "detail" : "The server has not found anything matching the Request-URI.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notFound" - } - } - } - }, - "406" : { - "description" : "Not Acceptable", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title" : "Gevraagde contenttype wordt niet ondersteund.", - "status" : 406, - "detail" : "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notAcceptable" - } - } - } - }, - "500" : { - "description" : "Internal Server Error", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title" : "Interne server fout.", - "status" : 500, - "detail" : "The server encountered an unexpected condition which prevented it from fulfilling the request.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "serverError" - } - } - } - }, - "501" : { - "description" : "Not Implemented", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2", - "title" : "Not Implemented", - "status" : 501, - "detail" : "The server does not support the functionality required to fulfill the request.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notImplemented" - } - } - } - }, - "503" : { - "description" : "Service Unavailable", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title" : "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status" : 503, - "detail" : "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notAvailable" - } - } - } + "inOnderzoek" : { + "$ref" : "#/components/schemas/PersoonInOnderzoek" }, - "default" : { - "description" : "Er is een onverwachte fout opgetreden", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - } - } - } - } - }, - "deprecated" : true - } - }, - "/ingeschrevenpersonen/{burgerservicenummer}/partners" : { - "get" : { - "tags" : [ "Ingeschreven Personen" ], - "summary" : "Levert de actuele partners van een persoon", - "description" : "Levert de actuele partners van een persoon. Partners uit beëindigde huwelijken of partnerschappen worden niet geretourneerd\n", - "operationId" : "GetPartners", - "parameters" : [ { - "name" : "burgerservicenummer", - "in" : "path", - "description" : "Uniek persoonsnummer\n", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "pattern" : "^[0-9]{9}$", - "type" : "string", - "example" : "555555021" - } - } ], - "responses" : { - "200" : { - "description" : "Zoekactie geslaagd\n", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - }, - "warning" : { - "$ref" : "#/components/headers/warning" - } - }, - "content" : { - "application/hal+json" : { - "schema" : { - "$ref" : "#/components/schemas/PartnerHalCollectie" - } - } - } + "kiesrecht" : { + "$ref" : "#/components/schemas/Kiesrecht" }, - "400" : { - "description" : "Bad Request", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/BadRequestFoutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1", - "title" : "Ten minste één parameter moet worden opgegeven.", - "status" : 400, - "detail" : "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "paramsRequired", - "invalidParams" : [ { - "type" : "https://www.vng.nl/realisatie/api/validaties/integer", - "name" : "verblijfplaats__huisnummer", - "code" : "integer", - "reason" : "Waarde is geen geldige integer." - } ] - } - } - } + "leeftijd" : { + "$ref" : "#/components/schemas/Leeftijd" }, - "401" : { - "description" : "Unauthorized", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2", - "title" : "Niet correct geauthenticeerd.", - "status" : 401, - "detail" : "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "authentication" - } - } - } + "naam" : { + "$ref" : "#/components/schemas/NaamPersoon" }, - "403" : { - "description" : "Forbidden", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4", - "title" : "U bent niet geautoriseerd voor deze operatie.", - "status" : 403, - "detail" : "The server understood the request, but is refusing to fulfill it.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "autorisation" - } - } + "nationaliteiten" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Nationaliteit" } }, - "404" : { - "description" : "Not Found", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5", - "title" : "Opgevraagde resource bestaat niet.", - "status" : 404, - "detail" : "The server has not found anything matching the Request-URI.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notFound" - } - } - } + "geboorte" : { + "$ref" : "#/components/schemas/Geboorte" }, - "406" : { - "description" : "Not Acceptable", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7", - "title" : "Gevraagde contenttype wordt niet ondersteund.", - "status" : 406, - "detail" : "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notAcceptable" - } - } - } + "opschortingBijhouding" : { + "$ref" : "#/components/schemas/OpschortingBijhouding" }, - "500" : { - "description" : "Internal Server Error", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1", - "title" : "Interne server fout.", - "status" : 500, - "detail" : "The server encountered an unexpected condition which prevented it from fulfilling the request.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "serverError" - } - } + "overlijden" : { + "$ref" : "#/components/schemas/Overlijden" + }, + "verblijfplaats" : { + "$ref" : "#/components/schemas/AbstractVerblijfplaats" + }, + "gezagsverhouding" : { + "$ref" : "#/components/schemas/Gezagsverhouding" + }, + "verblijfstitel" : { + "$ref" : "#/components/schemas/Verblijfstitel" + }, + "reisdocumentnummers" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/Reisdocumentnummer" } }, - "501" : { - "description" : "Not Implemented", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2", - "title" : "Not Implemented", - "status" : 501, - "detail" : "The server does not support the functionality required to fulfill the request.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notImplemented" - } - } + "kinderen" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AbstractKind" } }, - "503" : { - "description" : "Service Unavailable", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - }, - "example" : { - "type" : "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4", - "title" : "Bronservice {bron} is tijdelijk niet beschikbaar.", - "status" : 503, - "detail" : "The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.", - "instance" : "https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde", - "code" : "notAvailable" - } - } + "ouders" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AbstractOuder" } }, - "default" : { - "description" : "Er is een onverwachte fout opgetreden", - "headers" : { - "api-version" : { - "$ref" : "#/components/headers/api_version" - } - }, - "content" : { - "application/problem+json" : { - "schema" : { - "$ref" : "#/components/schemas/Foutbericht" - } - } + "partners" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AbstractPartner" } } + } + }, + "ANummer" : { + "pattern" : "^[0-9]{10}$", + "type" : "string", + "description" : "Het A-nummer van de persoon\n" + }, + "PersoonInOnderzoek" : { + "type" : "object", + "properties" : { + "burgerservicenummer" : { + "type" : "boolean" + }, + "geslachtsaanduiding" : { + "type" : "boolean" + }, + "leeftijd" : { + "type" : "boolean" + } }, - "deprecated" : true - } - } - }, - "components" : { - "schemas" : { + "description" : "Geeft aan welke gegevens van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature).\n", + "allOf" : [ { + "$ref" : "#/components/schemas/InOnderzoek" + } ] + }, + "InOnderzoek" : { + "type" : "object", + "properties" : { + "datumIngangOnderzoek" : { + "$ref" : "#/components/schemas/AbstractDatum" + } + } + }, "Reisdocumentnummer" : { + "pattern" : "^[0-9a-zA-Z]{9}$", + "type" : "string", + "description" : "Het nummer van het verstrekte Nederlandse reisdocument.\n", + "example" : "546376728" + }, + "Fields" : { + "maxLength" : 924, + "pattern" : "^[a-zA-Z0-9\\.,_]+$", + "type" : "string", + "description" : "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven.\nBij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven.\nZie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)\n" + }, + "GemeenteVanInschrijving" : { + "pattern" : "^[0-9]{4}$", + "type" : "string", + "description" : "Een code die aangeeft in welke gemeente de persoon woont, of de laatste gemeente waar de persoon heeft gewoond, of de gemeente waar de persoon voor het eerst is ingeschreven.\n", + "example" : "0518" + }, + "GeboorteplaatsFilter" : { + "pattern" : "^[a-zA-Z0-9À-ž \\,\\.\\-\\'()]{1,80}$", + "type" : "string", + "description" : "Gemeentenaam of een buitenlandse plaats of een plaatsbepaling, die aangeeft waar de persoon is geboren. **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).**\n", + "example" : "Utrecht" + }, + "GeslachtsnaamFilter" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-\\']{1,200}$|^[a-zA-Z0-9À-ž \\.\\-\\']{3,199}\\*{1}$", + "type" : "string", + "description" : "De (geslachts)naam waarvan de eventueel aanwezige voorvoegsels zijn afgesplitst. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).**\n", + "example" : "Vries" + }, + "GeslachtsaanduidingFilter" : { + "pattern" : "^([Mm]|[Vv]|[Oo])$", + "type" : "string", + "description" : "Geeft aan dat de persoon een man of een vrouw is, of dat het geslacht (nog) onbekend is.\n", + "example" : "V" + }, + "VoorvoegselFilter" : { + "pattern" : "^[a-zA-Z \\']{1,10}$", + "type" : "string", + "description" : "Deel van de geslachtsnaam dat vooraf gaat aan de rest van de geslachtsnaam. Het zoeken op het voorvoegsel is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).**\n", + "example" : "de" + }, + "VoornamenOptioneelFilter" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-\\']{1,199}\\*{1}$", + "type" : "string", + "description" : "De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).**\n", + "example" : "Dirk" + }, + "VoornamenVerplichtFilter" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-\\']{1,200}$|^[a-zA-Z0-9À-ž \\.\\-\\']{3,199}\\*{1}$", + "type" : "string", + "description" : "De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).**\n", + "example" : "Dirk" + }, + "Huisletter" : { + "pattern" : "^[a-zA-Z]{1}$", + "type" : "string", + "description" : "Een toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven.\n", + "example" : "a" + }, + "Huisnummer" : { + "maximum" : 99999, + "minimum" : 1, + "type" : "integer", + "description" : "Een nummer dat door de gemeente aan een adresseerbaar object is gegeven.\n", + "example" : 14 + }, + "Huisnummertoevoeging" : { + "pattern" : "^[a-zA-Z0-9 \\-]{1,4}$", + "type" : "string", + "description" : "Een toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven.\n", + "example" : "bis" + }, + "Postcode" : { + "pattern" : "^[1-9]{1}[0-9]{3}[ ]?[A-Za-z]{2}$", + "type" : "string", + "description" : "De door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort.\n", + "example" : "2341SX" + }, + "StraatFilter" : { + "pattern" : "^[a-zA-Z0-9À-ž \\-\\']{1,80}$|^[a-zA-Z0-9À-ž \\-\\']{7,79}\\*{1}$|^\\*{1}[a-zA-Z0-9À-ž \\-\\']{7,79}$", + "type" : "string", + "description" : "Een naam die door de gemeente aan een openbare ruimte is gegeven. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).\n", + "example" : "Tulpstraat" + }, + "NummeraanduidingIdentificatie" : { + "pattern" : "^[0-9]{16}$", + "type" : "string", + "description" : "Unieke identificatie van een nummeraanduiding (en het bijbehorende adres) in de BAG.\n", + "example" : "0518200000366054" + }, + "GeboorteBeperkt" : { + "type" : "object", + "properties" : { + "datum" : { + "$ref" : "#/components/schemas/AbstractDatum" + } + } + }, + "Waardetabel" : { + "type" : "object", + "properties" : { + "code" : { + "pattern" : "^[a-zA-Z0-9 \\.]+$", + "type" : "string", + "example" : "6030" + }, + "omschrijving" : { + "pattern" : "^[a-zA-Z0-9À-ž \\'\\,\\(\\)\\.\\-]{1,200}$", + "type" : "string", + "example" : "Nederland" + } + } + }, + "NaamBasis" : { + "type" : "object", + "properties" : { + "voornamen" : { + "$ref" : "#/components/schemas/Voornamen" + }, + "adellijkeTitelPredicaat" : { + "$ref" : "#/components/schemas/AdellijkeTitelPredicaatType" + }, + "voorvoegsel" : { + "$ref" : "#/components/schemas/Voorvoegsel" + }, + "geslachtsnaam" : { + "$ref" : "#/components/schemas/Geslachtsnaam" + }, + "voorletters" : { + "$ref" : "#/components/schemas/Voorletters" + }, + "volledigeNaam" : { + "$ref" : "#/components/schemas/VolledigeNaam" + } + } + }, + "Voornamen" : { + "maxLength" : 200, + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-\\']{1,200}$", + "type" : "string", + "description" : "De verzameling namen voor de geslachtsnaam, gescheiden door spaties.\n" + }, + "AdellijkeTitelPredicaatType" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Waardetabel" + }, { + "properties" : { + "soort" : { + "$ref" : "#/components/schemas/AdellijkeTitelPredicaatSoort" + } + }, + "example" : { + "value" : { + "code" : "JV", + "omschrijving" : "jonkvrouw", + "soort" : "predicaat" + } + } + } ] + }, + "AdellijkeTitelPredicaatSoort" : { "type" : "string", - "description" : "Het nummer van het verstrekte Nederlandse reisdocument.\n", - "example" : "546376728" + "enum" : [ "titel", "predicaat" ] + }, + "Voorvoegsel" : { + "maxLength" : 10, + "pattern" : "^[a-zA-Z \\']{1,10}$", + "type" : "string", + "example" : "de" }, - "IngeschrevenPersoonBasis" : { + "Geslachtsnaam" : { + "maxLength" : 200, + "type" : "string", + "description" : "De achternaam van een persoon.\n", + "example" : "Vries" + }, + "Voorletters" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.]{1,40}$", + "type" : "string", + "description" : "De voorletters van de persoon, afgeleid van de voornamen.\n", + "example" : "P.J." + }, + "VolledigeNaam" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-\\']{1,450}$", + "type" : "string", + "description" : "Combinatie van predicaat, voornamen, adellijke titel, voorvoegsels en geslachtsnaam, zonder toevoeging van een eventuele partnernaam.\n", + "example" : "Pieter Jan de Vries" + }, + "OpschortingBijhoudingBasis" : { "type" : "object", "properties" : { - "burgerservicenummer" : { - "type" : "string", - "example" : "555555021" - }, - "geheimhoudingPersoonsgegevens" : { - "title" : "Indicatie geheim", - "type" : "boolean", - "description" : "Gegevens mogen niet worden verstrekt aan derden / maatschappelijke instellingen.\n" - }, - "geslachtsaanduiding" : { + "reden" : { "$ref" : "#/components/schemas/Waardetabel" - }, - "leeftijd" : { - "type" : "integer", - "description" : "Leeftijd in jaren op het moment van bevragen.\n", - "example" : 34 + } + }, + "description" : "* **reden** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'redenopschortingbijhouding' uit de Haal-Centraal-BRP-tabellen-bevragen API.\n" + }, + "OverlijdenBasis" : { + "type" : "object", + "properties" : { + "indicatieOverleden" : { + "$ref" : "#/components/schemas/IndicatieOverleden" + } + } + }, + "IndicatieOverleden" : { + "type" : "boolean", + "description" : "Geeft aan dat iemand is overleden (waarde true), ongeacht of de overlijdensdatum bekend is.\n" + }, + "AbstractVerblijfplaatsBeperkt" : { + "required" : [ "type" ], + "type" : "object", + "properties" : { + "type" : { + "type" : "string" + } + }, + "description" : "Gegevens over het verblijf of de woonlocatie van een persoon.\n", + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "VerblijfplaatsBuitenland" : "#/components/schemas/VerblijfplaatsBuitenlandBeperkt", + "Adres" : "#/components/schemas/AdresBeperkt", + "VerblijfplaatsOnbekend" : "#/components/schemas/VerblijfplaatsOnbekend", + "Locatie" : "#/components/schemas/LocatieBeperkt" } } }, - "IngeschrevenPersoonBeperkt" : { + "VerblijfplaatsBuitenlandBeperkt" : { "allOf" : [ { - "$ref" : "#/components/schemas/IngeschrevenPersoonBasis" + "$ref" : "#/components/schemas/AbstractVerblijfplaatsBeperkt" }, { "type" : "object", "properties" : { - "naam" : { - "$ref" : "#/components/schemas/NaamBasis" + "adresregel1" : { + "$ref" : "#/components/schemas/Adresregel1" }, - "geboorte" : { - "$ref" : "#/components/schemas/Geboortedatum" + "adresregel2" : { + "$ref" : "#/components/schemas/Adresregel2" + }, + "adresregel3" : { + "$ref" : "#/components/schemas/Adresregel3" + }, + "land" : { + "$ref" : "#/components/schemas/Waardetabel" + } + } + } ] + }, + "Adresregel1" : { + "maxLength" : 40, + "type" : "string", + "description" : "Het eerste deel van een adres is een combinatie van de straat en huisnummer.\n", + "example" : "Laan van de landinrichtingscommissie Duiven-Westervoort 26A-3" + }, + "Adresregel2" : { + "maxLength" : 50, + "type" : "string", + "description" : "Het tweede deel van een adres is een combinatie van woonplaats eventueel in combinatie met de postcode.\n", + "example" : "1234AA Nootdorp" + }, + "Adresregel3" : { + "maxLength" : 35, + "type" : "string", + "description" : "Het derde deel van een adres is optioneel. Het gaat om een of meer geografische gebieden van het adres in het buitenland.\n", + "example" : "Selangor" + }, + "AdresBeperkt" : { + "allOf" : [ { + "$ref" : "#/components/schemas/AbstractVerblijfplaatsBeperkt" + }, { + "type" : "object", + "properties" : { + "functieAdres" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "adresregel1" : { + "$ref" : "#/components/schemas/Adresregel1" + }, + "adresregel2" : { + "$ref" : "#/components/schemas/Adresregel2" + }, + "woonplaats" : { + "$ref" : "#/components/schemas/Woonplaats" + } + } + } ] + }, + "Woonplaats" : { + "title" : "woonplaats naam", + "pattern" : "^[a-zA-Z0-9À-ž \\(\\)\\,\\.\\-\\']{1,80}$", + "type" : "string", + "description" : "Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam.\n", + "example" : "Duiven" + }, + "VerblijfplaatsOnbekend" : { + "allOf" : [ { + "$ref" : "#/components/schemas/AbstractVerblijfplaats" + }, { + "type" : "object", + "properties" : { + "datumInschrijvingInGemeente" : { + "$ref" : "#/components/schemas/AbstractDatum" }, - "opschortingBijhouding" : { - "$ref" : "#/components/schemas/OpschortingBijhoudingBasis" + "gemeenteVanInschrijving" : { + "$ref" : "#/components/schemas/GemeenteVanInschrijving" }, - "overlijden" : { - "$ref" : "#/components/schemas/OverlijdenBasis" + "verblijfplaatsOnbekend" : { + "$ref" : "#/components/schemas/IndicatieVerblijfplaatsOnbekend" }, - "verblijfplaats" : { - "$ref" : "#/components/schemas/VerblijfplaatsBeperkt" + "inOnderzoek" : { + "$ref" : "#/components/schemas/VerblijfplaatsOnbekendInOnderzoek" } } } ] }, - "IngeschrevenPersoonBeperktLinks" : { + "AbstractVerblijfplaats" : { + "required" : [ "type" ], "type" : "object", "properties" : { - "self" : { - "$ref" : "#/components/schemas/HalLink" + "type" : { + "type" : "string" + } + }, + "description" : "Gegevens over het verblijf of de woonlocatie van een persoon.\n", + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "VerblijfplaatsBuitenland" : "#/components/schemas/VerblijfplaatsBuitenland", + "Adres" : "#/components/schemas/Adres", + "VerblijfplaatsOnbekend" : "#/components/schemas/VerblijfplaatsOnbekend", + "Locatie" : "#/components/schemas/Locatie" } } }, - "IngeschrevenPersoonBeperktHal" : { + "VerblijfplaatsBuitenland" : { "allOf" : [ { - "$ref" : "#/components/schemas/IngeschrevenPersoonBeperkt" + "$ref" : "#/components/schemas/AbstractVerblijfplaats" }, { + "type" : "object", "properties" : { - "_links" : { - "$ref" : "#/components/schemas/IngeschrevenPersoonBeperktLinks" + "adresregel1" : { + "$ref" : "#/components/schemas/Adresregel1" + }, + "adresregel2" : { + "$ref" : "#/components/schemas/Adresregel2" + }, + "adresregel3" : { + "$ref" : "#/components/schemas/Adresregel3" + }, + "datumInschrijvingInGemeente" : { + "$ref" : "#/components/schemas/AbstractDatum" + }, + "gemeenteVanInschrijving" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "land" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "datumVan" : { + "$ref" : "#/components/schemas/AbstractDatum" + }, + "datumIngangGeldigheid" : { + "$ref" : "#/components/schemas/AbstractDatum" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/VerblijfplaatsBuitenlandInOnderzoek" } } } ] }, - "IngeschrevenPersoon" : { + "VerblijfplaatsBuitenlandInOnderzoek" : { "allOf" : [ { - "$ref" : "#/components/schemas/IngeschrevenPersoonBasis" + "$ref" : "#/components/schemas/InOnderzoek" }, { "type" : "object", "properties" : { - "aNummer" : { - "type" : "string", - "description" : "Het A-nummer van de persoon\n" + "adresregel1" : { + "type" : "boolean" }, - "datumEersteInschrijvingGBA" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "adresregel2" : { + "type" : "boolean" }, - "inOnderzoek" : { - "$ref" : "#/components/schemas/PersoonInOnderzoek" + "adresregel3" : { + "type" : "boolean" }, - "kiesrecht" : { - "$ref" : "#/components/schemas/Kiesrecht" + "datumInschrijvingInGemeente" : { + "type" : "boolean" }, - "naam" : { - "$ref" : "#/components/schemas/NaamPersoon" + "gemeenteVanInschrijving" : { + "type" : "boolean" }, - "nationaliteiten" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Nationaliteit" - } + "land" : { + "type" : "boolean" }, - "geboorte" : { - "$ref" : "#/components/schemas/Geboorte" + "datumVan" : { + "type" : "boolean" }, - "opschortingBijhouding" : { - "$ref" : "#/components/schemas/OpschortingBijhouding" + "datumIngangGeldigheid" : { + "type" : "boolean" + } + } + } ] + }, + "Adres" : { + "description" : "Gegevens over het adres van een persoon.\n* **datumVan** : de datum van aangifte of ambtshalve melding van verblijf en adres.\n* **datumIngangGeldigheid** : datum waarop de gegevens over de verblijfplaats geldig zijn geworden.\n* **datumInschrijvingInGemeente**: bij inschrijving op grond van een verhuisaangifte door de burger is dit de aangiftedatum. Bij inschrijving op grond van een geboorteakte is dit de geboortedatum. Bij ambtshalve inschrijving is dit de datum waarop het voornemen van ambtshalve opneming schriftelijk aan de persoon is medegedeeld.\n* **datumVestigingInNederland** : datum van inschrijving in Nederland.\n* **landVanWaarIngeschreven** : het land waar de persoon woonde voor (her)vestiging in Nederland.\n* **gemeenteVanInschrijving** : de gemeente waar de persoon verblijft en is ingeschreven. De code kan voorloopnullen bevatten.\"\n", + "allOf" : [ { + "$ref" : "#/components/schemas/AbstractVerblijfplaats" + }, { + "type" : "object", + "properties" : { + "functieAdres" : { + "$ref" : "#/components/schemas/Waardetabel" }, - "overlijden" : { - "$ref" : "#/components/schemas/Overlijden" + "straat" : { + "$ref" : "#/components/schemas/Straat" }, - "verblijfplaats" : { - "$ref" : "#/components/schemas/Verblijfplaats" + "huisnummer" : { + "$ref" : "#/components/schemas/Huisnummer" }, - "gezagsverhouding" : { - "$ref" : "#/components/schemas/Gezagsverhouding" + "huisletter" : { + "$ref" : "#/components/schemas/Huisletter" }, - "verblijfstitel" : { - "$ref" : "#/components/schemas/Verblijfstitel" + "huisnummertoevoeging" : { + "$ref" : "#/components/schemas/Huisnummertoevoeging" }, - "reisdocumentnummers" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Reisdocumentnummer" - } + "aanduidingBijHuisnummer" : { + "$ref" : "#/components/schemas/Waardetabel" }, - "kinderen" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Kind" - } + "postcode" : { + "$ref" : "#/components/schemas/Postcode" }, - "ouders" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Ouder" - } + "adresseerbaarObjectIdentificatie" : { + "$ref" : "#/components/schemas/AdresseerbaarObjectIdentificatie" }, - "partners" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Partner" - } + "nummeraanduidingIdentificatie" : { + "$ref" : "#/components/schemas/NummeraanduidingIdentificatie" + }, + "adresregel1" : { + "$ref" : "#/components/schemas/Adresregel1" + }, + "adresregel2" : { + "$ref" : "#/components/schemas/Adresregel2" + }, + "woonplaats" : { + "$ref" : "#/components/schemas/Woonplaats" + }, + "indicatieVestigingVanuitBuitenland" : { + "$ref" : "#/components/schemas/IndicatieVestigingVanuitBuitenland" + }, + "korteNaam" : { + "$ref" : "#/components/schemas/KorteNaam" + }, + "vanuitVerblijfplaatsOnbekend" : { + "$ref" : "#/components/schemas/VanuitVerblijfplaatsOnbekend" + }, + "datumVan" : { + "$ref" : "#/components/schemas/AbstractDatum" + }, + "datumIngangGeldigheid" : { + "$ref" : "#/components/schemas/AbstractDatum" + }, + "datumInschrijvingInGemeente" : { + "$ref" : "#/components/schemas/AbstractDatum" + }, + "datumVestigingInNederland" : { + "$ref" : "#/components/schemas/AbstractDatum" + }, + "gemeenteVanInschrijving" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "landVanwaarIngeschreven" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/AdresInOnderzoek" } } } ] }, - "IngeschrevenPersoonHalCollectie" : { - "type" : "object", - "properties" : { - "_links" : { - "$ref" : "#/components/schemas/HalCollectionLinks" - }, - "_embedded" : { - "$ref" : "#/components/schemas/IngeschrevenPersoonHalCollectieEmbedded" - } - } + "Straat" : { + "maxLength" : 80, + "type" : "string", + "example" : "Tulpstraat" }, - "IngeschrevenPersoonHalCollectieEmbedded" : { - "type" : "object", - "properties" : { - "ingeschrevenpersonen" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/IngeschrevenPersoonBeperktHal" + "AdresseerbaarObjectIdentificatie" : { + "pattern" : "^[0-9]{16}$", + "type" : "string", + "description" : "De verblijfplaats van de persoon kan een ligplaats, een standplaats of een verblijfsobject zijn.\n", + "example" : "0226010000038820" + }, + "IndicatieVestigingVanuitBuitenland" : { + "type" : "boolean", + "description" : "Geeft aan dat de persoon zich vanuit het buitenland heeft ingeschreven.\n" + }, + "KorteNaam" : { + "maxLength" : 24, + "type" : "string", + "description" : "De officiële openbareruimtenaam uit de Basisregistratie Gebouwen en Adressen (BAG) of een verkorte versie.\n" + }, + "VanuitVerblijfplaatsOnbekend" : { + "type" : "boolean", + "description" : "Geeft aan dat de persoon is teruggekeerd uit een situatie van onbekende verblijfplaats\n" + }, + "AdresInOnderzoek" : { + "allOf" : [ { + "$ref" : "#/components/schemas/InOnderzoek" + }, { + "type" : "object", + "properties" : { + "aanduidingBijHuisnummer" : { + "type" : "boolean" + }, + "datumVan" : { + "type" : "boolean" + }, + "datumIngangGeldigheid" : { + "type" : "boolean" + }, + "datumInschrijvingInGemeente" : { + "type" : "boolean" + }, + "datumVestigingInNederland" : { + "type" : "boolean" + }, + "functieAdres" : { + "type" : "boolean" + }, + "gemeenteVanInschrijving" : { + "type" : "boolean" + }, + "huisletter" : { + "type" : "boolean" + }, + "huisnummer" : { + "type" : "boolean" + }, + "huisnummertoevoeging" : { + "type" : "boolean" + }, + "nummeraanduidingIdentificatie" : { + "type" : "boolean" + }, + "adresseerbaarObjectIdentificatie" : { + "type" : "boolean" + }, + "landVanwaarIngeschreven" : { + "type" : "boolean" + }, + "straat" : { + "type" : "boolean" + }, + "postcode" : { + "type" : "boolean" + }, + "korteNaam" : { + "type" : "boolean" + }, + "woonplaats" : { + "type" : "boolean" + }, + "adresregel1" : { + "type" : "boolean" + }, + "adresregel2" : { + "type" : "boolean" + }, + "indicatieVestigingVanuitBuitenland" : { + "type" : "boolean" + }, + "vanuitVerblijfplaatsOnbekend" : { + "type" : "boolean" } } - } + } ] }, - "IngeschrevenPersoonHalBasis" : { + "Locatie" : { "allOf" : [ { - "$ref" : "#/components/schemas/IngeschrevenPersoon" + "$ref" : "#/components/schemas/AbstractVerblijfplaats" }, { + "type" : "object", "properties" : { - "_links" : { - "$ref" : "#/components/schemas/IngeschrevenPersoonLinks" + "adresregel1" : { + "$ref" : "#/components/schemas/Adresregel1" + }, + "adresregel2" : { + "$ref" : "#/components/schemas/Adresregel2" + }, + "datumInschrijvingInGemeente" : { + "$ref" : "#/components/schemas/AbstractDatum" + }, + "datumVestigingInNederland" : { + "$ref" : "#/components/schemas/AbstractDatum" + }, + "functieAdres" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "gemeenteVanInschrijving" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "indicatieVestigingVanuitBuitenland" : { + "$ref" : "#/components/schemas/IndicatieVestigingVanuitBuitenland" + }, + "landVanwaarIngeschreven" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "locatiebeschrijving" : { + "$ref" : "#/components/schemas/Locatiebeschrijving" + }, + "vanuitVerblijfplaatsOnbekend" : { + "$ref" : "#/components/schemas/VanuitVerblijfplaatsOnbekend" + }, + "woonplaats" : { + "$ref" : "#/components/schemas/Woonplaats" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/LocatieInOnderzoek" } } } ] }, - "IngeschrevenPersoonHal" : { + "Locatiebeschrijving" : { + "maxLength" : 35, + "type" : "string", + "description" : "Omschrijving van de ligging van een verblijfsobject, standplaats of ligplaats.\n", + "example" : "Naast de derde brug" + }, + "LocatieInOnderzoek" : { "allOf" : [ { - "$ref" : "#/components/schemas/IngeschrevenPersoonHalBasis" + "$ref" : "#/components/schemas/InOnderzoek" }, { + "type" : "object", "properties" : { - "_embedded" : { - "$ref" : "#/components/schemas/IngeschrevenPersoonEmbedded" + "adresregel1" : { + "type" : "boolean" + }, + "adresregel2" : { + "type" : "boolean" + }, + "datumInschrijvingInGemeente" : { + "type" : "boolean" + }, + "datumVestigingInNederland" : { + "type" : "boolean" + }, + "functieAdres" : { + "type" : "boolean" + }, + "gemeenteVanInschrijving" : { + "type" : "boolean" + }, + "indicatieVestigingVanuitBuitenland" : { + "type" : "boolean" + }, + "landVanwaarIngeschreven" : { + "type" : "boolean" + }, + "locatiebeschrijving" : { + "type" : "boolean" + }, + "vanuitVerblijfplaatsOnbekend" : { + "type" : "boolean" + }, + "woonplaats" : { + "type" : "boolean" } } } ] }, - "Ouder" : { - "type" : "object", - "properties" : { - "burgerservicenummer" : { - "type" : "string", - "example" : "555555021" - }, - "geslachtsaanduiding" : { - "$ref" : "#/components/schemas/Waardetabel" - }, - "ouderAanduiding" : { - "$ref" : "#/components/schemas/Waardetabel" - }, - "datumIngangFamilierechtelijkeBetrekking" : { - "$ref" : "#/components/schemas/DatumOnvolledig" - }, - "naam" : { - "$ref" : "#/components/schemas/Naam" - }, - "inOnderzoek" : { - "$ref" : "#/components/schemas/OuderInOnderzoek" - }, - "geboorte" : { - "$ref" : "#/components/schemas/Geboorte" - } - }, - "description" : "Gegevens over de ouder van de persoon.\n* **datumIngangFamilierechtelijkeBetrekking** - De datum waarop de familierechtelijke betrekking is ontstaan.\n" - }, - "OuderHalCollectie" : { - "type" : "object", - "properties" : { - "_links" : { - "$ref" : "#/components/schemas/HalCollectionLinks" - }, - "_embedded" : { - "$ref" : "#/components/schemas/OuderHalCollectieEmbedded" - } - }, - "deprecated" : true - }, - "OuderHalCollectieEmbedded" : { - "type" : "object", - "properties" : { - "ouders" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/OuderHalBasis" - } - } - }, - "deprecated" : true + "IndicatieVerblijfplaatsOnbekend" : { + "type" : "boolean", + "description" : "Indicatie dat de verblijfplaats van de persoon onbekend is. Er is niet bekend in welk land de persoon verblijft.\n" }, - "OuderHalBasis" : { - "deprecated" : true, + "VerblijfplaatsOnbekendInOnderzoek" : { "allOf" : [ { - "$ref" : "#/components/schemas/Ouder" + "$ref" : "#/components/schemas/InOnderzoek" }, { + "type" : "object", "properties" : { - "geheimhoudingPersoonsgegevens" : { - "title" : "Indicatie geheim", - "type" : "boolean", - "description" : "Gegevens mogen niet worden verstrekt aan derden / maarschappelijke instellingen.\n" + "datumInschrijvingInGemeente" : { + "type" : "boolean" + }, + "gemeenteVanInschrijving" : { + "type" : "boolean" }, - "_links" : { - "$ref" : "#/components/schemas/OuderLinks" + "verblijfplaatsOnbekend" : { + "type" : "boolean" } } } ] }, - "Kind" : { - "type" : "object", - "properties" : { - "burgerservicenummer" : { - "type" : "string", - "example" : "555555021" - }, - "leeftijd" : { - "type" : "integer", - "description" : "Leeftijd op het moment van bevragen\n", - "example" : 12 - }, - "inOnderzoek" : { - "$ref" : "#/components/schemas/KindInOnderzoek" - }, - "naam" : { - "$ref" : "#/components/schemas/Naam" - }, - "geboorte" : { - "$ref" : "#/components/schemas/Geboorte" - } - }, - "description" : "Gegevens over een kind van de persoon.\n" - }, - "KindHalCollectie" : { - "type" : "object", - "properties" : { - "_links" : { - "$ref" : "#/components/schemas/HalCollectionLinks" - }, - "_embedded" : { - "$ref" : "#/components/schemas/KindHalCollectieEmbedded" - } - }, - "deprecated" : true - }, - "KindHalCollectieEmbedded" : { - "type" : "object", - "properties" : { - "kinderen" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/KindHalBasis" - } - } - }, - "deprecated" : true - }, - "KindHalBasis" : { - "deprecated" : true, + "LocatieBeperkt" : { "allOf" : [ { - "$ref" : "#/components/schemas/Kind" + "$ref" : "#/components/schemas/AbstractVerblijfplaatsBeperkt" }, { + "type" : "object", "properties" : { - "geheimhoudingPersoonsgegevens" : { - "title" : "Indicatie geheim", - "type" : "boolean", - "description" : "Gegevens mogen niet worden verstrekt aan derden/ maatschappelijke instellingen.\n" + "adresregel1" : { + "$ref" : "#/components/schemas/Adresregel1" + }, + "adresregel2" : { + "$ref" : "#/components/schemas/Adresregel2" + }, + "functieAdres" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "locatiebeschrijving" : { + "$ref" : "#/components/schemas/Locatiebeschrijving" }, - "_links" : { - "$ref" : "#/components/schemas/KindLinks" + "woonplaats" : { + "$ref" : "#/components/schemas/Woonplaats" } } } ] }, - "Partner" : { + "AbstractDatum" : { + "required" : [ "type" ], "type" : "object", "properties" : { - "burgerservicenummer" : { - "type" : "string", - "example" : "555555021" - }, - "geslachtsaanduiding" : { - "$ref" : "#/components/schemas/Waardetabel" - }, - "soortVerbintenis" : { - "$ref" : "#/components/schemas/Waardetabel" - }, - "naam" : { - "$ref" : "#/components/schemas/Naam" - }, - "geboorte" : { - "$ref" : "#/components/schemas/Geboorte" - }, - "inOnderzoek" : { - "$ref" : "#/components/schemas/PartnerInOnderzoek" - }, - "aangaanHuwelijkPartnerschap" : { - "$ref" : "#/components/schemas/AangaanHuwelijkPartnerschap" + "type" : { + "type" : "string" } }, - "description" : "Gegevens over een gesloten huwelijk/geregistreerd partnerschap van de persoon.\n" - }, - "PartnerHalCollectie" : { - "type" : "object", - "properties" : { - "_links" : { - "$ref" : "#/components/schemas/HalCollectionLinks" - }, - "_embedded" : { - "$ref" : "#/components/schemas/PartnerHalCollectieEmbedded" + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "Datum" : "#/components/schemas/VolledigeDatum", + "OnbekendDatum" : "#/components/schemas/OnbekendDatum", + "JaarDatum" : "#/components/schemas/JaarDatum", + "JaarMaandDatum" : "#/components/schemas/JaarMaandDatum" } - }, - "deprecated" : true + } }, - "PartnerHalCollectieEmbedded" : { - "type" : "object", - "properties" : { - "partners" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PartnerHalBasis" - } + "VolledigeDatum" : { + "required" : [ "datum" ], + "description" : "Datum conform iso8601", + "example" : { + "value" : { + "type" : "Datum", + "datum" : "2018-07-01" } }, - "deprecated" : true - }, - "PartnerHalBasis" : { - "deprecated" : true, - "allOf" : [ { - "$ref" : "#/components/schemas/Partner" - }, { - "properties" : { - "geheimhoudingPersoonsgegevens" : { - "title" : "Indicatie geheim", - "type" : "boolean", - "description" : "Gegevens mogen niet worden verstrekt aan derden/ maatschappelijke instellingen.\n" - }, - "_links" : { - "$ref" : "#/components/schemas/PartnerLinks" - } - } - } ] - }, - "Naam" : { "allOf" : [ { - "$ref" : "#/components/schemas/NaamBasis" + "$ref" : "#/components/schemas/AbstractDatum" }, { + "type" : "object", "properties" : { - "inOnderzoek" : { - "$ref" : "#/components/schemas/NaamInOnderzoek" + "datum" : { + "type" : "string", + "format" : "date" } } } ] }, - "NaamBasis" : { - "type" : "object", - "properties" : { - "geslachtsnaam" : { - "type" : "string", - "description" : "De achternaam van een persoon.\n", - "example" : "Vries" - }, - "voorletters" : { - "type" : "string", - "description" : "De voorletters van de persoon, afgeleid van de voornamen.\n", - "example" : "P.J." - }, - "voornamen" : { - "type" : "string", - "description" : "De verzameling namen voor de geslachtsnaam, gescheiden door spaties.\n", - "example" : "Pieter Jan" - }, - "voorvoegsel" : { - "type" : "string", - "example" : "de" - }, - "adellijkeTitelPredikaat" : { - "$ref" : "#/components/schemas/WaardetabelMetSoort" - }, - "volledigeNaam" : { - "type" : "string", - "example" : "Pieter Jan de Vries" + "OnbekendDatum" : { + "required" : [ "onbekend" ], + "description" : "representatie voor een volledig onbekend datum", + "example" : { + "value" : { + "type" : "OnbekendDatum", + "onbekend" : true } - } - }, - "WaardetabelMetSoort" : { + }, "allOf" : [ { - "$ref" : "#/components/schemas/Waardetabel" + "$ref" : "#/components/schemas/AbstractDatum" }, { + "type" : "object", "properties" : { - "soort" : { - "type" : "string" + "onbekend" : { + "type" : "boolean", + "default" : true } - }, - "example" : { - "code" : "JV", - "omschrijving" : "jonkvrouw", - "soort" : "predikaat" } } ] }, - "NaamInOnderzoek" : { - "type" : "object", - "properties" : { - "geslachtsnaam" : { - "type" : "boolean" - }, - "voornamen" : { - "type" : "boolean" - }, - "voorvoegsel" : { - "type" : "boolean" - }, - "adellijkeTitel" : { - "type" : "boolean" - }, - "predikaat" : { - "type" : "boolean" - }, - "datumIngangOnderzoek" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "JaarDatum" : { + "required" : [ "jaar" ], + "description" : "representatie voor een datum waarvan maand en dag onbekend zijn", + "example" : { + "value" : { + "type" : "JaarDatum", + "jaar" : 2018 } }, - "description" : "Geeft aan welke gegevens over de naam in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n" - }, - "NaamPersoonInOnderzoek" : { "allOf" : [ { - "$ref" : "#/components/schemas/NaamInOnderzoek" + "$ref" : "#/components/schemas/AbstractDatum" }, { + "type" : "object", "properties" : { - "aanduidingNaamgebruik" : { - "type" : "boolean" + "jaar" : { + "$ref" : "#/components/schemas/Jaar" } } } ] - }, - "OuderInOnderzoek" : { - "type" : "object", - "properties" : { - "burgerservicenummer" : { - "type" : "boolean" - }, - "datumIngangFamilierechtelijkeBetrekking" : { - "type" : "boolean" - }, - "geslachtsaanduiding" : { - "type" : "boolean" - }, - "datumIngangOnderzoek" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + }, + "Jaar" : { + "maximum" : 9999, + "minimum" : 1, + "type" : "integer", + "format" : "int32" + }, + "JaarMaandDatum" : { + "required" : [ "jaar", "maand" ], + "description" : "representatie voor een datum waarvan de dag onbekend is", + "example" : { + "value" : { + "type" : "JaarMaandDatum", + "jaar" : 2018, + "maand" : 7 } }, - "description" : "Geeft aan welke gegevens van de de ouder in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n" - }, - "Geboorte" : { "allOf" : [ { - "$ref" : "#/components/schemas/Geboortedatum" + "$ref" : "#/components/schemas/AbstractDatum" }, { + "type" : "object", "properties" : { - "land" : { - "$ref" : "#/components/schemas/Waardetabel" - }, - "plaats" : { - "$ref" : "#/components/schemas/Waardetabel" + "jaar" : { + "$ref" : "#/components/schemas/Jaar" }, - "inOnderzoek" : { - "$ref" : "#/components/schemas/GeboorteInOnderzoek" + "maand" : { + "$ref" : "#/components/schemas/Maand" } - }, - "description" : "Gegevens over de geboorte.\n* **datum** : datum waarop de persoon is geboren.\n* **land** : land waar de persoon is geboren\n* **plaats** : gemeente waar de persoon is geboren. Is de persoon geboren buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding.\n" + } } ] }, - "GeboorteInOnderzoek" : { - "type" : "object", - "properties" : { - "datum" : { - "type" : "boolean" - }, - "land" : { - "type" : "boolean" - }, - "plaats" : { - "type" : "boolean" - }, - "datumIngangOnderzoek" : { - "$ref" : "#/components/schemas/DatumOnvolledig" - } - }, - "description" : "Geeft aan welke gegevens over de geboorte van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n" + "Maand" : { + "maximum" : 12, + "minimum" : 1, + "type" : "integer", + "format" : "int32" }, "Kiesrecht" : { "type" : "object", @@ -2762,10 +1647,10 @@ "example" : true }, "einddatumUitsluitingEuropeesKiesrecht" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "$ref" : "#/components/schemas/AbstractDatum" }, "einddatumUitsluitingKiesrecht" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "$ref" : "#/components/schemas/AbstractDatum" } } }, @@ -2774,28 +1659,17 @@ "$ref" : "#/components/schemas/NaamBasis" }, { "properties" : { + "aanduidingNaamgebruik" : { + "$ref" : "#/components/schemas/Waardetabel" + }, "aanhef" : { - "type" : "string", - "description" : "Kun je gebruiken als aanhef in een brief gericht aan persoon.\n", - "example" : "Hoogwelgeboren heer" + "$ref" : "#/components/schemas/Aanhef" }, "aanschrijfwijze" : { - "type" : "string", - "description" : "Samengestelde naam die je kunt gebruiken in de communicatie met de persoon.\n", - "example" : "H.W. baron van den Aedel" - }, - "regelVoorafgaandAanAanschrijfwijze" : { - "type" : "string", - "description" : "Deze regel moet als aparte regel boven de aanschrijfwijze worden geplaatst. Komt alleen voor bij personen met een adellijke titel of predicaat.\n", - "example" : "De hoogwelgeboren heer" + "$ref" : "#/components/schemas/Aanschrijfwijze" }, "gebruikInLopendeTekst" : { - "type" : "string", - "description" : "Naam van persoon die je kunt gebruiken als je in lopende tekst (bijvoorbeeld in een brief) aan persoon refereert.\n", - "example" : "baron Van den Aedel" - }, - "aanduidingNaamgebruik" : { - "$ref" : "#/components/schemas/Waardetabel" + "$ref" : "#/components/schemas/GebruikInLopendeTekst" }, "inOnderzoek" : { "$ref" : "#/components/schemas/NaamPersoonInOnderzoek" @@ -2803,387 +1677,291 @@ } } ] }, - "PersoonInOnderzoek" : { - "type" : "object", - "properties" : { - "burgerservicenummer" : { - "type" : "boolean" - }, - "geslachtsaanduiding" : { - "type" : "boolean" - }, - "datumIngangOnderzoek" : { - "$ref" : "#/components/schemas/DatumOnvolledig" - } - }, - "description" : "Geeft aan welke gegevens van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature).\n" - }, - "Nationaliteit" : { - "type" : "object", - "properties" : { - "aanduidingBijzonderNederlanderschap" : { - "$ref" : "#/components/schemas/AanduidingBijzonderNederlanderschap" - }, - "datumIngangGeldigheid" : { - "$ref" : "#/components/schemas/DatumOnvolledig" - }, - "nationaliteit" : { - "$ref" : "#/components/schemas/Waardetabel" - }, - "redenOpname" : { - "$ref" : "#/components/schemas/Waardetabel" - }, - "inOnderzoek" : { - "$ref" : "#/components/schemas/NationaliteitInOnderzoek" - } - }, - "description" : "* **redenOpname** : De reden op grond waarvan de persoon de nationaliteit gekregen heeft.\n" + "Aanhef" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-\\']{1,650}$", + "type" : "string", + "description" : "Kun je gebruiken als aanhef in een brief gericht aan persoon.\n", + "example" : "Hoogwelgeboren heer" }, - "NationaliteitInOnderzoek" : { + "Aanschrijfwijze" : { "type" : "object", "properties" : { - "aanduidingBijzonderNederlanderschap" : { - "type" : "boolean" - }, - "nationaliteit" : { - "type" : "boolean" - }, - "redenOpname" : { - "type" : "boolean" + "naam" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-\\']{1,650}$", + "type" : "string", + "example" : "H.W. baron van den Aedel" }, - "datumIngangOnderzoek" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "aanspreekvorm" : { + "pattern" : "^[a-zA-Z ]{1,25}$", + "type" : "string", + "description" : "Deze regel moet als aparte regel boven de samengestelde naam worden geplaatst. Komt alleen voor bij personen met een adellijke titel of predicaat.\n", + "example" : "De hoogwelgeboren heer" } }, - "description" : "Geeft aan welke gegevens over de nationaliteit in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n" + "description" : "Samengestelde naam en aanspreekvorm die je kunt gebruiken in de communicatie met de persoon.\n" }, - "OpschortingBijhoudingBasis" : { - "type" : "object", - "properties" : { - "reden" : { - "$ref" : "#/components/schemas/Waardetabel" - } - } + "GebruikInLopendeTekst" : { + "pattern" : "^[a-zA-Z0-9À-ž \\.\\-\\']{1,650}$", + "type" : "string", + "description" : "Naam van persoon die je kunt gebruiken als je in lopende tekst (bijvoorbeeld in een brief) aan persoon refereert.\n", + "example" : "baron Van den Aedel" }, - "OpschortingBijhouding" : { + "NaamPersoonInOnderzoek" : { "allOf" : [ { - "$ref" : "#/components/schemas/OpschortingBijhoudingBasis" + "$ref" : "#/components/schemas/NaamInOnderzoek" }, { "type" : "object", "properties" : { - "datum" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "volledigeNaam" : { + "type" : "boolean" + }, + "aanduidingNaamgebruik" : { + "type" : "boolean" + }, + "aanhef" : { + "type" : "boolean" + }, + "aanschrijfwijze" : { + "type" : "boolean" + }, + "gebruikInLopendeTekst" : { + "type" : "boolean" } - }, - "description" : "* **datum**: de datum waarop de bijhouding van de persoonsgegevens is gestaakt.\n" + } } ] }, - "OverlijdenBasis" : { - "type" : "object", - "properties" : { - "indicatieOverleden" : { - "type" : "boolean", - "description" : "Geeft aan dat iemand is overleden (waarde true), ongeacht of de overlijdensdatum bekend is.\n" + "NaamInOnderzoek" : { + "description" : "Geeft aan welke gegevens over de naam in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n", + "allOf" : [ { + "$ref" : "#/components/schemas/InOnderzoek" + }, { + "type" : "object", + "properties" : { + "voornamen" : { + "type" : "boolean" + }, + "adellijkeTitelPredicaat" : { + "type" : "boolean" + }, + "voorvoegsel" : { + "type" : "boolean" + }, + "geslachtsnaam" : { + "type" : "boolean" + }, + "voorletters" : { + "type" : "boolean" + } } - }, - "description" : "Gegevens over het overlijden van de persoon.\n" + } ] }, - "Overlijden" : { + "Nationaliteit" : { + "description" : "* **redenOpname** : De reden op grond waarvan de persoon de nationaliteit gekregen heeft.\n", "allOf" : [ { - "$ref" : "#/components/schemas/OverlijdenBasis" + "$ref" : "#/components/schemas/AbstractNationaliteit" }, { "type" : "object", "properties" : { - "datum" : { - "$ref" : "#/components/schemas/DatumOnvolledig" - }, - "land" : { - "$ref" : "#/components/schemas/Waardetabel" + "datumIngangGeldigheid" : { + "$ref" : "#/components/schemas/AbstractDatum" }, - "plaats" : { + "nationaliteit" : { "$ref" : "#/components/schemas/Waardetabel" }, "inOnderzoek" : { - "$ref" : "#/components/schemas/OverlijdenInOnderzoek" + "$ref" : "#/components/schemas/NationaliteitInOnderzoek" } - }, - "description" : "Gegevens over het overlijden van de persoon.\n* **datum** : datum waarop de persoon is overleden.\n* **land** : land waar de persoon is overleden.\n* **plaats** : gemeente waar de persoon is overleden. Is de persoon overleden buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding.\n" + } } ] }, - "OverlijdenInOnderzoek" : { + "AbstractNationaliteit" : { + "required" : [ "type" ], "type" : "object", "properties" : { - "datum" : { - "type" : "boolean" - }, - "land" : { - "type" : "boolean" - }, - "plaats" : { - "type" : "boolean" + "type" : { + "type" : "string" }, - "datumIngangOnderzoek" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "redenOpname" : { + "$ref" : "#/components/schemas/Waardetabel" } }, - "description" : "Geeft aan welke gegevens over het overlijden van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n" - }, - "KindInOnderzoek" : { - "type" : "object", - "properties" : { - "burgerservicenummer" : { - "type" : "boolean" - }, - "datumIngangOnderzoek" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "Nationaliteit" : "#/components/schemas/Nationaliteit", + "BehandeldAlsNederlander" : "#/components/schemas/BehandeldAlsNederlander", + "VastgesteldNietNederlander" : "#/components/schemas/VastgesteldNietNederlander" } - }, - "description" : "Geeft aan of de gegevens over het kind van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n" + } }, - "PartnerInOnderzoek" : { - "type" : "object", - "properties" : { - "burgerservicenummer" : { - "type" : "boolean" - }, - "geslachtsaanduiding" : { - "type" : "boolean" - }, - "soortVerbintenis" : { - "type" : "boolean" - }, - "datumIngangOnderzoek" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "BehandeldAlsNederlander" : { + "allOf" : [ { + "$ref" : "#/components/schemas/AbstractNationaliteit" + }, { + "type" : "object", + "properties" : { + "datumIngangGeldigheid" : { + "$ref" : "#/components/schemas/AbstractDatum" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/BijzonderNederlanderschapInOnderzoek" + } } - }, - "description" : "Geeft aan welke gegevens over het huwelijk of het partnerschap in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n" + } ] }, - "AangaanHuwelijkPartnerschap" : { - "type" : "object", - "properties" : { - "datum" : { - "$ref" : "#/components/schemas/DatumOnvolledig" - }, - "land" : { - "$ref" : "#/components/schemas/Waardetabel" - }, - "plaats" : { - "$ref" : "#/components/schemas/Waardetabel" - }, - "inOnderzoek" : { - "$ref" : "#/components/schemas/AangaanHuwelijkPartnerschapInOnderzoek" + "BijzonderNederlanderschapInOnderzoek" : { + "allOf" : [ { + "$ref" : "#/components/schemas/InOnderzoek" + }, { + "type" : "object", + "properties" : { + "type" : { + "type" : "boolean" + }, + "redenOpname" : { + "type" : "boolean" + } } - }, - "description" : "Gegevens over de voltrekking van het huwelijk of het aangaan van het geregistreerd partnerschap.\n* **datum** : De datum waarop het huwelijk is voltrokken of het partnerschap is aangegaan.\n* **land** : Het land waar het huwelijk is voltrokken of het partnerschap is aangegaan.\n* **plaats** : De gemeente waar het huwelijk is voltrokken of het partnerschap is aangegaan. Voor een plaats buiten Nederland bevat het antwoord een buitenlandse plaatsnaam of aanduiding.\n" + } ] }, - "AangaanHuwelijkPartnerschapInOnderzoek" : { - "type" : "object", - "properties" : { - "datum" : { - "type" : "boolean" - }, - "land" : { - "type" : "boolean" - }, - "plaats" : { - "type" : "boolean" - }, - "datumIngangOnderzoek" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "VastgesteldNietNederlander" : { + "allOf" : [ { + "$ref" : "#/components/schemas/AbstractNationaliteit" + }, { + "type" : "object", + "properties" : { + "datumIngangGeldigheid" : { + "$ref" : "#/components/schemas/AbstractDatum" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/BijzonderNederlanderschapInOnderzoek" + } } - }, - "description" : "Geeft aan welke gegevens over het voltrekken van het huwelijk of aangaan van het partnerschap in onderzoek zijn. Zie de functionele specificaties. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n" + } ] }, - "VerblijfplaatsBeperkt" : { - "type" : "object", - "properties" : { - "functieAdres" : { - "$ref" : "#/components/schemas/Waardetabel" - }, - "adresregel1" : { - "type" : "string", - "description" : "Het eerste deel van een adres is een combinatie van de straat en huisnummer.\n", - "example" : "Laan van de landinrichtingscommissie Duiven-Westervoort 26A-3" - }, - "adresregel2" : { - "type" : "string", - "description" : "Het tweede deel van een adres is een combinatie van woonplaats eventueel in combinatie met de postcode.\n", - "example" : "1234AA Nootdorp" - }, - "adresregel3" : { - "type" : "string", - "description" : "Het derde deel van een adres is optioneel. Het gaat om een of meer geografische gebieden van het adres in het buitenland.\n", - "example" : "Selangor" - }, - "woonplaats" : { - "title" : "woonplaats naam", - "type" : "string", - "description" : "Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam.", - "example" : "Duiven" - }, - "land" : { - "$ref" : "#/components/schemas/Waardetabel" - }, - "vertrokkenOnbekendWaarheen" : { - "type" : "boolean", - "description" : "Indicatie dat de ingeschreven persoon is vertrokken naar het buitenland, maar dat niet bekend is waar naartoe.\n" + "NationaliteitInOnderzoek" : { + "description" : "Geeft aan welke gegevens over de nationaliteit in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n", + "allOf" : [ { + "$ref" : "#/components/schemas/InOnderzoek" + }, { + "type" : "object", + "properties" : { + "nationaliteit" : { + "type" : "boolean" + }, + "redenOpname" : { + "type" : "boolean" + } } - }, - "description" : "Gegevens over het verblijf of de woonlocatie van een persoon.\n" + } ] }, - "Verblijfplaats" : { + "Geboorte" : { + "description" : "Gegevens over de geboorte.\n* **datum** : datum waarop de persoon is geboren.\n* **land** : land waar de persoon is geboren\n* **plaats** : gemeente waar de persoon is geboren. Is de persoon geboren buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding.\n", "allOf" : [ { - "$ref" : "#/components/schemas/Adres" + "$ref" : "#/components/schemas/GeboorteBeperkt" }, { + "type" : "object", "properties" : { - "adresseerbaarObjectIdentificatie" : { - "type" : "string", - "description" : "De verblijfplaats van de persoon kan een ligplaats, een standplaats of een verblijfsobject zijn.\n", - "example" : "0226010000038820" - }, - "aanduidingBijHuisnummer" : { + "land" : { "$ref" : "#/components/schemas/Waardetabel" }, - "nummeraanduidingIdentificatie" : { - "type" : "string", - "description" : "Unieke identificatie van een nummeraanduiding (en het bijbehorende adres) in de BAG.\n", - "example" : "0518200000366054" - }, - "functieAdres" : { + "plaats" : { "$ref" : "#/components/schemas/Waardetabel" }, - "indicatieVestigingVanuitBuitenland" : { - "type" : "boolean", - "description" : "Geeft aan dat de ingeschreven persoon zich vanuit het buitenland heeft ingeschreven.\n" - }, - "locatiebeschrijving" : { - "type" : "string", - "description" : "Omschrijving van de ligging van een verblijfsobject, standplaats of ligplaats.\n", - "example" : "Naast de derde brug" - }, - "korteNaam" : { - "type" : "string", - "description" : "De officiële openbareruimtenaam uit de Basisregistratie Gebouwen en Adressen (BAG) of een verkorte versie.\n" - }, - "vanuitVertrokkenOnbekendWaarheen" : { - "type" : "boolean", - "description" : "Geeft aan dat de persoon is teruggekeerd uit een situatie van 'vertrokken onbekend waarheen.'\n", - "example" : true - }, - "datumAanvangAdreshouding" : { - "$ref" : "#/components/schemas/DatumOnvolledig" - }, - "datumIngangGeldigheid" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "inOnderzoek" : { + "$ref" : "#/components/schemas/GeboorteInOnderzoek" + } + } + } ] + }, + "GeboorteInOnderzoek" : { + "allOf" : [ { + "$ref" : "#/components/schemas/InOnderzoek" + }, { + "type" : "object", + "properties" : { + "datum" : { + "type" : "boolean" }, - "datumInschrijvingInGemeente" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "land" : { + "type" : "boolean" }, - "datumVestigingInNederland" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "plaats" : { + "type" : "boolean" + } + } + } ] + }, + "OpschortingBijhouding" : { + "allOf" : [ { + "$ref" : "#/components/schemas/OpschortingBijhoudingBasis" + }, { + "type" : "object", + "properties" : { + "datum" : { + "$ref" : "#/components/schemas/AbstractDatum" + } + }, + "description" : "* **datum**: de datum waarop de bijhouding van de persoonsgegevens is gestaakt.\n" + } ] + }, + "Overlijden" : { + "description" : "Gegevens over het overlijden van de persoon.\n* **datum** : datum waarop de persoon is overleden.\n* **land** : land waar de persoon is overleden.\n* **plaats** : gemeente waar de persoon is overleden. Is de persoon overleden buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding.\n", + "allOf" : [ { + "$ref" : "#/components/schemas/OverlijdenBasis" + }, { + "type" : "object", + "properties" : { + "datum" : { + "$ref" : "#/components/schemas/AbstractDatum" }, - "gemeenteVanInschrijving" : { + "land" : { "$ref" : "#/components/schemas/Waardetabel" }, - "landVanwaarIngeschreven" : { + "plaats" : { "$ref" : "#/components/schemas/Waardetabel" }, - "adresregel1" : { - "type" : "string", - "description" : "Het eerste deel van een adres is een combinatie van de straat en huisnummer.\n", - "example" : "Laan van de landinrichtingscommissie Duiven-Westervoort 26A-3" - }, - "adresregel2" : { - "type" : "string", - "description" : "Het tweede deel van een adres is een combinatie van woonplaats eventueel in combinatie met de postcode.\n", - "example" : "1234AA Nootdorp" - }, - "adresregel3" : { - "type" : "string", - "description" : "Het derde deel van een adres is optioneel. Het gaat om een of meer geografische gebieden van het adres in het buitenland.\n", - "example" : "Selangor" + "inOnderzoek" : { + "$ref" : "#/components/schemas/OverlijdenInOnderzoek" + } + } + } ] + }, + "OverlijdenInOnderzoek" : { + "description" : "Geeft aan welke gegevens over het overlijden van de persoon in onderzoek zijn.\nZie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n", + "allOf" : [ { + "$ref" : "#/components/schemas/InOnderzoek" + }, { + "type" : "object", + "properties" : { + "indicatieOverleden" : { + "type" : "boolean" }, - "vertrokkenOnbekendWaarheen" : { - "type" : "boolean", - "description" : "Indicatie dat de ingeschreven persoon is vertrokken naar het buitenland, maar dat niet bekend is waar naar toe.\n" + "datum" : { + "type" : "boolean" }, "land" : { - "$ref" : "#/components/schemas/Waardetabel" + "type" : "boolean" }, - "inOnderzoek" : { - "$ref" : "#/components/schemas/VerblijfplaatsInOnderzoek" + "plaats" : { + "type" : "boolean" } - }, - "description" : "Gegevens over het verblijf of de woonlocatie van een persoon.\n* **datumAanvangAdreshuishouding** : de datum van aangifte of ambtshalve melding van verblijf en adres.\n* **datumIngangGeldigheid** : datum waarop de gegevens over de verblijfplaats geldig zijn geworden.\n* **datumInschrijvingInGemeente**: bij inschrijving op grond van een verhuisaangifte door de burger is dit de aangiftedatum. Bij inschrijving op grond van een geboorteakte is dit de geboortedatum. Bij ambtshalve inschrijving is dit de datum waarop het voornemen van ambtshalve opneming schriftelijk aan de persoon is medegedeeld.\n* **datumVestigingInNederland** : datum van inschrijving in Nederland.\n* **landVanWaarIngeschreven** : het land waar de persoon woonde voor (her)vestiging in Nederland.\n* **gemeenteVanInschrijving** : de gemeente waar de persoon verblijft en is ingeschreven. De code kan voorloopnullen bevatten.\"\n" + } } ] }, - "VerblijfplaatsInOnderzoek" : { - "type" : "object", - "properties" : { - "aanduidingBijHuisnummer" : { - "type" : "boolean" - }, - "datumAanvangAdreshouding" : { - "type" : "boolean" - }, - "datumIngangGeldigheid" : { - "type" : "boolean" - }, - "datumInschrijvingInGemeente" : { - "type" : "boolean" - }, - "datumVestigingInNederland" : { - "type" : "boolean" - }, - "functieAdres" : { - "type" : "boolean" - }, - "gemeenteVanInschrijving" : { - "type" : "boolean" - }, - "huisletter" : { - "type" : "boolean" - }, - "huisnummer" : { - "type" : "boolean" - }, - "huisnummertoevoeging" : { - "type" : "boolean" - }, - "nummeraanduidingIdentificatie" : { - "type" : "boolean" - }, - "adresseerbaarObjectIdentificatie" : { - "type" : "boolean" - }, - "landVanwaarIngeschreven" : { - "type" : "boolean" - }, - "locatiebeschrijving" : { - "type" : "boolean" - }, - "straat" : { - "type" : "boolean" - }, - "postcode" : { - "type" : "boolean" - }, - "korteNaam" : { - "type" : "boolean" - }, - "verblijfBuitenland" : { - "type" : "boolean" - }, - "woonplaats" : { - "type" : "boolean" - }, - "datumIngangOnderzoek" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "Gezagsverhouding" : { + "allOf" : [ { + "$ref" : "#/components/schemas/GezagsverhoudingBasis" + }, { + "type" : "object", + "properties" : { + "inOnderzoek" : { + "$ref" : "#/components/schemas/GezagsverhoudingInOnderzoek" + } } - }, - "description" : "Geeft aan welke gegevens over het verblijf en adres van de persoon in onderzoek zijn. Elementen van het GBA-adres zelf (Dat zou eigenlijk een BAG-adres moeten zijn) kunnen niet in onderzoek zijn. Wel de relatie naar de nummeraanduiding. Dat wordt gedaan door de identificatiecodeNummeraanduiding in onderzoek te zetten. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n" + } ] }, - "Gezagsverhouding" : { + "GezagsverhoudingBasis" : { "type" : "object", "properties" : { "indicatieCurateleRegister" : { @@ -3193,27 +1971,25 @@ }, "indicatieGezagMinderjarige" : { "$ref" : "#/components/schemas/Waardetabel" - }, - "inOnderzoek" : { - "$ref" : "#/components/schemas/GezagsverhoudingInOnderzoek" } }, "description" : "Gegevens over het gezag over de persoon.\n" }, "GezagsverhoudingInOnderzoek" : { - "type" : "object", - "properties" : { - "indicatieCurateleRegister" : { - "type" : "boolean" - }, - "indicatieGezagMinderjarige" : { - "type" : "boolean" - }, - "datumIngangOnderzoek" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "description" : "Geeft aan welke gegevens van de gezagsverhouding in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n", + "allOf" : [ { + "$ref" : "#/components/schemas/InOnderzoek" + }, { + "type" : "object", + "properties" : { + "indicatieCurateleRegister" : { + "type" : "boolean" + }, + "indicatieGezagMinderjarige" : { + "type" : "boolean" + } } - }, - "description" : "Geeft aan welke gegevens van de gezagsverhouding in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n" + } ] }, "Verblijfstitel" : { "type" : "object", @@ -3222,10 +1998,10 @@ "$ref" : "#/components/schemas/Waardetabel" }, "datumEinde" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "$ref" : "#/components/schemas/AbstractDatum" }, "datumIngang" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "$ref" : "#/components/schemas/AbstractDatum" }, "inOnderzoek" : { "$ref" : "#/components/schemas/VerblijfstitelInOnderzoek" @@ -3234,364 +2010,318 @@ "description" : "Gegevens over de verblijfsrechtelijke status van de persoon.\n* **datumEinde**: Datum waarop de geldigheid van de gegevens over de verblijfstitel is beëindigd.\n* **datumIngang**: Datum waarop de gegevens over de verblijfstitel geldig zijn geworden.\n* **aanduiding** : Verblijfstiteltabel die aangeeft over welke verblijfsrechtelijke status de persoon beschikt.\n" }, "VerblijfstitelInOnderzoek" : { - "type" : "object", - "properties" : { - "aanduiding" : { - "type" : "boolean" - }, - "datumEinde" : { - "type" : "boolean" - }, - "datumIngang" : { - "type" : "boolean" - }, - "datumIngangOnderzoek" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "description" : "Geeft aan welke gegevens over de verblijfstitel in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n", + "allOf" : [ { + "$ref" : "#/components/schemas/InOnderzoek" + }, { + "type" : "object", + "properties" : { + "aanduiding" : { + "type" : "boolean" + }, + "datumEinde" : { + "type" : "boolean" + }, + "datumIngang" : { + "type" : "boolean" + } } - }, - "description" : "Geeft aan welke gegevens over de verblijfstitel in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n" + } ] }, - "IngeschrevenPersoonLinks" : { + "AbstractKind" : { + "required" : [ "type" ], "type" : "object", "properties" : { - "self" : { - "$ref" : "#/components/schemas/HalLink" - }, - "ouders" : { - "type" : "array", - "description" : "De ouders van de persoon.\n", - "items" : { - "$ref" : "#/components/schemas/HalLink" - } - }, - "reisdocumenten" : { - "type" : "array", - "description" : "De reisdocumenten die aan de persoon zijn verstrekt.\n", - "items" : { - "$ref" : "#/components/schemas/HalLink" - } - }, - "kinderen" : { - "type" : "array", - "description" : "De kinderen van de persoon.\n", - "items" : { - "$ref" : "#/components/schemas/HalLink" - } - }, - "partners" : { - "type" : "array", - "description" : "De actuele bij de ingeschreven persoon geregistreerde huwelijken en geregistreerd partnerschappen. Een beëindigd huwelijk of geregistreerd partnerschap wordt niet teruggegeven.\n", - "items" : { - "$ref" : "#/components/schemas/HalLink" - } - }, - "partnerhistorie" : { - "$ref" : "#/components/schemas/HalLink" - }, - "verblijfplaatshistorie" : { - "$ref" : "#/components/schemas/HalLink" - }, - "verblijfstitelhistorie" : { - "$ref" : "#/components/schemas/HalLink" - }, - "nationaliteitHistorie" : { - "$ref" : "#/components/schemas/HalLink" - }, - "adres" : { - "$ref" : "#/components/schemas/HalLink" + "type" : { + "type" : "string" + } + }, + "description" : "Gegevens over een kind van de persoon.\n", + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "Kind" : "#/components/schemas/Kind", + "OnbekendKind" : "#/components/schemas/OnbekendKind" } } }, - "OuderLinks" : { - "type" : "object", - "properties" : { - "self" : { - "$ref" : "#/components/schemas/HalLink" - }, - "ingeschrevenPersoon" : { - "$ref" : "#/components/schemas/HalLink" + "Kind" : { + "allOf" : [ { + "$ref" : "#/components/schemas/AbstractKind" + }, { + "type" : "object", + "properties" : { + "burgerservicenummer" : { + "$ref" : "#/components/schemas/Burgerservicenummer" + }, + "leeftijd" : { + "$ref" : "#/components/schemas/Leeftijd" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/KindInOnderzoek" + }, + "naam" : { + "$ref" : "#/components/schemas/NaamGerelateerde" + }, + "geboorte" : { + "$ref" : "#/components/schemas/Geboorte" + } } - }, - "deprecated" : true + } ] }, - "KindLinks" : { - "type" : "object", - "properties" : { - "self" : { - "$ref" : "#/components/schemas/HalLink" - }, - "ingeschrevenPersoon" : { - "$ref" : "#/components/schemas/HalLink" + "KindInOnderzoek" : { + "description" : "Geeft aan of de gegevens over het kind van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n", + "allOf" : [ { + "$ref" : "#/components/schemas/InOnderzoek" + }, { + "type" : "object", + "properties" : { + "burgerservicenummer" : { + "type" : "boolean" + }, + "leeftijd" : { + "type" : "boolean" + } } - }, - "deprecated" : true + } ] }, - "PartnerLinks" : { - "type" : "object", - "properties" : { - "self" : { - "$ref" : "#/components/schemas/HalLink" - }, - "ingeschrevenPersoon" : { - "$ref" : "#/components/schemas/HalLink" + "OnbekendKind" : { + "allOf" : [ { + "$ref" : "#/components/schemas/AbstractKind" + }, { + "type" : "object", + "properties" : { + "indicatieOnbekend" : { + "type" : "boolean", + "default" : false + } } - }, - "deprecated" : true + } ] }, - "IngeschrevenPersoonEmbedded" : { + "AbstractOuder" : { + "required" : [ "type" ], "type" : "object", "properties" : { - "ouders" : { - "type" : "array", - "description" : "De ouders van de persoon.\n", - "items" : { - "$ref" : "#/components/schemas/OuderHalBasis" - } - }, - "kinderen" : { - "type" : "array", - "description" : "De kinderen van de persoon.\n", - "items" : { - "$ref" : "#/components/schemas/KindHalBasis" - } - }, - "partners" : { - "type" : "array", - "description" : "De partners van de persoon. Een beëindigd huwelijk of geregistreerd partnerschap wordt niet teruggegeven.\n", - "items" : { - "$ref" : "#/components/schemas/PartnerHalBasis" - } + "type" : { + "type" : "string" } }, - "deprecated" : true - }, - "AanduidingBijzonderNederlanderschap" : { - "type" : "object", - "properties" : { - "behandeldAlsNederlander" : { - "type" : "boolean" - }, - "vastgesteldNietNederlander" : { - "type" : "boolean" + "description" : "Gegevens over de ouder van de persoon.\n", + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "Ouder" : "#/components/schemas/Ouder", + "OnbekendOuder" : "#/components/schemas/OnbekendOuder" } } }, - "Geboortedatum" : { - "type" : "object", - "properties" : { - "datum" : { - "$ref" : "#/components/schemas/DatumOnvolledig" + "Ouder" : { + "description" : "Gegevens over de ouder van de persoon.\n* **datumIngangFamilierechtelijkeBetrekking** - De datum waarop de familierechtelijke betrekking is ontstaan.\n* **geslachtsaanduiding** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'geslacht' uit de Haal-Centraal-BRP-tabellen-bevragen API.\n* **ouderaanduiding** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'ouderAanduiding' uit de Haal-Centraal-BRP-tabellen-bevragen API.\n", + "allOf" : [ { + "$ref" : "#/components/schemas/AbstractOuder" + }, { + "type" : "object", + "properties" : { + "burgerservicenummer" : { + "$ref" : "#/components/schemas/Burgerservicenummer" + }, + "geslachtsaanduiding" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "ouderAanduiding" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "datumIngangFamilierechtelijkeBetrekking" : { + "$ref" : "#/components/schemas/AbstractDatum" + }, + "naam" : { + "$ref" : "#/components/schemas/NaamGerelateerde" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/OuderInOnderzoek" + }, + "geboorte" : { + "$ref" : "#/components/schemas/Geboorte" + } } - } + } ] }, - "BadRequestFoutbericht" : { + "OuderInOnderzoek" : { + "description" : "Geeft aan welke gegevens van de de ouder in onderzoek zijn.\nZie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n", "allOf" : [ { - "$ref" : "#/components/schemas/Foutbericht" + "$ref" : "#/components/schemas/InOnderzoek" }, { "type" : "object", "properties" : { - "invalidParams" : { - "type" : "array", - "description" : "Foutmelding per fout in een parameter. Alle gevonden fouten worden één keer teruggemeld.", - "items" : { - "$ref" : "#/components/schemas/InvalidParams" - } + "burgerservicenummer" : { + "type" : "boolean" + }, + "datumIngangFamilierechtelijkeBetrekking" : { + "type" : "boolean" + }, + "geslachtsaanduiding" : { + "type" : "boolean" } } } ] }, - "Foutbericht" : { - "type" : "object", - "properties" : { - "type" : { - "type" : "string", - "description" : "Link naar meer informatie over deze fout", - "format" : "uri" - }, - "title" : { - "type" : "string", - "description" : "Beschrijving van de fout" - }, - "status" : { - "type" : "integer", - "description" : "Http status code" - }, - "detail" : { - "type" : "string", - "description" : "Details over de fout" - }, - "instance" : { - "type" : "string", - "description" : "Uri van de aanroep die de fout heeft veroorzaakt", - "format" : "uri" - }, - "code" : { - "minLength" : 1, - "type" : "string", - "description" : "Systeemcode die het type fout aangeeft" + "OnbekendOuder" : { + "allOf" : [ { + "$ref" : "#/components/schemas/AbstractOuder" + }, { + "type" : "object", + "properties" : { + "indicatieOnbekend" : { + "type" : "boolean", + "default" : false + } } - }, - "description" : "Terugmelding bij een fout. JSON representatie in lijn met [RFC7807](https://tools.ietf.org/html/rfc7807)." + } ] }, - "InvalidParams" : { + "AbstractPartner" : { + "required" : [ "type" ], "type" : "object", "properties" : { "type" : { - "type" : "string", - "format" : "uri", - "example" : "https://www.vng.nl/realisatie/api/{major-versie}/validaties/integer" - }, - "name" : { - "type" : "string", - "description" : "Naam van de parameter", - "example" : "verblijfplaats__huisnummer" - }, - "code" : { - "minLength" : 1, - "type" : "string", - "description" : "Systeemcode die het type fout aangeeft", - "example" : "integer" - }, - "reason" : { - "type" : "string", - "description" : "Beschrijving van de fout op de parameterwaarde", - "example" : "Waarde is geen geldige integer." + "type" : "string" } }, - "description" : "Details over fouten in opgegeven parameters" - }, - "Waardetabel" : { - "type" : "object", - "properties" : { - "code" : { - "type" : "string", - "example" : "6030" - }, - "omschrijving" : { - "type" : "string", - "example" : "Nederland" + "description" : "Gegevens over een gesloten huwelijk/geregistreerd partnerschap van de persoon.\n", + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "Partner" : "#/components/schemas/Partner", + "OnbekendPartner" : "#/components/schemas/OnbekendPartner" } } }, - "HalLink" : { - "required" : [ "href" ], - "type" : "object", - "properties" : { - "href" : { - "$ref" : "#/components/schemas/Href" - }, - "templated" : { - "type" : "boolean" - }, - "title" : { - "type" : "string", - "description" : "Voor mens leesbaar label bij de link" + "Partner" : { + "allOf" : [ { + "$ref" : "#/components/schemas/AbstractPartner" + }, { + "type" : "object", + "properties" : { + "burgerservicenummer" : { + "$ref" : "#/components/schemas/Burgerservicenummer" + }, + "geslachtsaanduiding" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "soortVerbintenis" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "naam" : { + "$ref" : "#/components/schemas/NaamGerelateerde" + }, + "geboorte" : { + "$ref" : "#/components/schemas/Geboorte" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/PartnerInOnderzoek" + }, + "aangaanHuwelijkPartnerschap" : { + "$ref" : "#/components/schemas/AangaanHuwelijkPartnerschap" + } } - }, - "description" : "De Link Object zoals gespecificeerd in https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5; Deze link kan als templated link worden aangeboden. [URI-templating is hier beschreven](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/uri-templating.feature)." + } ] }, - "Href" : { - "type" : "string", - "example" : "https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}" + "PartnerInOnderzoek" : { + "description" : "Geeft aan welke gegevens over het huwelijk of het partnerschap in onderzoek zijn.\nZie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n", + "allOf" : [ { + "$ref" : "#/components/schemas/InOnderzoek" + }, { + "type" : "object", + "properties" : { + "burgerservicenummer" : { + "type" : "boolean" + }, + "geslachtsaanduiding" : { + "type" : "boolean" + }, + "soortVerbintenis" : { + "type" : "boolean" + } + } + } ] }, - "DatumOnvolledig" : { + "AangaanHuwelijkPartnerschap" : { "type" : "object", "properties" : { - "dag" : { - "maximum" : 31, - "minimum" : 1, - "type" : "integer", - "description" : "Als de dag van de datum bekend is wordt dit element gevuld, ook als de volledige datum bekend is.", - "example" : 3 - }, "datum" : { - "type" : "string", - "description" : "Als de volledige datum bekend is wordt de datum gevuld die in de date definitie past.", - "format" : "date", - "example" : "1989-05-03" + "$ref" : "#/components/schemas/AbstractDatum" }, - "jaar" : { - "maximum" : 9999, - "type" : "integer", - "description" : "Als het jaar van de datum bekend is wordt dit element gevuld, ook als de volledige datum bekend is.", - "example" : 1989 + "land" : { + "$ref" : "#/components/schemas/Waardetabel" }, - "maand" : { - "maximum" : 12, - "minimum" : 1, - "type" : "integer", - "description" : "Als de maand van een datum bekend is wordt dit element gevuld, ook als de volledige datum bekend is.", - "example" : 5 + "plaats" : { + "$ref" : "#/components/schemas/Waardetabel" + }, + "inOnderzoek" : { + "$ref" : "#/components/schemas/AangaanHuwelijkPartnerschapInOnderzoek" } }, - "description" : "Gegevens over de datums die mogelijk niet volledig zijn." + "description" : "Gegevens over de voltrekking van het huwelijk of het aangaan van het geregistreerd partnerschap.\n* **datum** : De datum waarop het huwelijk is voltrokken of het partnerschap is aangegaan.\n* **land** : Het land waar het huwelijk is voltrokken of het partnerschap is aangegaan.\n* **plaats** : De gemeente waar het huwelijk is voltrokken of het partnerschap is aangegaan. Voor een plaats buiten Nederland bevat het antwoord een buitenlandse plaatsnaam of aanduiding.\n" }, - "HalCollectionLinks" : { - "type" : "object", - "properties" : { - "self" : { - "$ref" : "#/components/schemas/HalLink" + "AangaanHuwelijkPartnerschapInOnderzoek" : { + "description" : "Geeft aan welke gegevens over het voltrekken van het huwelijk of aangaan van het partnerschap in onderzoek zijn.\nZie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature)\n", + "allOf" : [ { + "$ref" : "#/components/schemas/InOnderzoek" + }, { + "type" : "object", + "properties" : { + "datum" : { + "type" : "boolean" + }, + "land" : { + "type" : "boolean" + }, + "plaats" : { + "type" : "boolean" + } } - }, - "description" : "HalCollectionLinks bevat de self link die elke HAL Resource minimaal moet hebben in zijn _links property\n" + } ] }, - "Adres" : { + "OnbekendPartner" : { + "allOf" : [ { + "$ref" : "#/components/schemas/AbstractPartner" + }, { + "type" : "object", + "properties" : { + "indicatieOnbekend" : { + "type" : "boolean", + "default" : false + } + } + } ] + }, + "NaamGerelateerde" : { "type" : "object", "properties" : { - "straat" : { - "title" : "openbareruimte naam", - "type" : "string", - "description" : "Een naam die door de gemeente aan een openbare ruimte is gegeven.", - "example" : "Laan van de landinrichtingscommissie Duiven-Westervoort" + "voornamen" : { + "$ref" : "#/components/schemas/Voornamen" }, - "huisnummer" : { - "type" : "integer", - "description" : "Een nummer dat door de gemeente aan een adresseerbaar object is gegeven.", - "example" : 1 + "adellijkeTitelPredicaat" : { + "$ref" : "#/components/schemas/AdellijkeTitelPredicaatType" }, - "huisletter" : { - "type" : "string", - "description" : "Een toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven.", - "example" : "A" + "voorvoegsel" : { + "$ref" : "#/components/schemas/Voorvoegsel" }, - "huisnummertoevoeging" : { - "type" : "string", - "description" : "Een toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven.", - "example" : "bis" + "geslachtsnaam" : { + "$ref" : "#/components/schemas/Geslachtsnaam" }, - "postcode" : { - "type" : "string", - "description" : "De door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort.", - "example" : "6922KZ" + "voorletters" : { + "$ref" : "#/components/schemas/Voorletters" }, - "woonplaats" : { - "title" : "woonplaats naam", - "type" : "string", - "description" : "Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam.", - "example" : "Duiven" + "inOnderzoek" : { + "$ref" : "#/components/schemas/NaamInOnderzoek" } - }, - "description" : "Eigenschappen van het adres die kunnen worden hergebruikt in andere API's waarin adresgegevens worden opgenomen. " - } - }, - "parameters" : { - "burgerservicenummer" : { - "name" : "burgerservicenummer", - "in" : "path", - "description" : "Uniek persoonsnummer\n", - "required" : true, - "style" : "simple", - "explode" : false, - "schema" : { - "pattern" : "^[0-9]{9}$", - "type" : "string", - "example" : "555555021" } } }, "headers" : { "api_version" : { "schema" : { + "pattern" : "^[1-9][0-9]{0,2}.[0-9]{1,3}.[0-9]{1,3}$", "type" : "string", "description" : "Geeft een specifieke API-versie aan in de context van een specifieke aanroep.", "example" : "1.0.0" @@ -3599,10 +2329,26 @@ }, "warning" : { "schema" : { + "maxLength" : 500, "type" : "string", "description" : "zie RFC 7234. In het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 (\"Miscellaneous Persistent Warning\") en het API end-point (inclusief versienummer) als de warn-agent van de warning, gevolgd door de warn-text met de human-readable waarschuwing", "example" : "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\"." } + }, + "X_Rate_Limit_Limit" : { + "schema" : { + "type" : "integer" + } + }, + "X_Rate_Limit_Remaining" : { + "schema" : { + "type" : "integer" + } + }, + "X_Rate_Limit_Reset" : { + "schema" : { + "type" : "integer" + } } } } diff --git a/specificatie/genereervariant/openapi.yaml b/specificatie/genereervariant/openapi.yaml index 996ce8cb3..e2712e82e 100644 --- a/specificatie/genereervariant/openapi.yaml +++ b/specificatie/genereervariant/openapi.yaml @@ -1,8 +1,8 @@ -openapi: 3.0.0 +openapi: 3.0.3 info: - title: Bevragen Ingeschreven Personen + title: Bevragen Personen description: | - API voor het bevragen van ingeschreven personen uit de basisregistratie personen (BRP), inclusief de registratie niet-ingezeten (RNI). Met deze API kun je personen zoeken en actuele gegevens over personen, kinderen, partners en ouders raadplegen. + API voor het bevragen van personen uit de basisregistratie personen (BRP), inclusief de registratie niet-ingezeten (RNI). Met deze API kun je personen zoeken en actuele gegevens over personen, kinderen, partners en ouders raadplegen. Gegevens die er niet zijn of niet actueel zijn krijg je niet terug. Heeft een persoon bijvoorbeeld geen geldige nationaliteit, en alleen een beëindigd partnerschap, dan krijg je geen gegevens over nationaliteit en partner. @@ -12,252 +12,63 @@ info: license: name: European Union Public License, version 1.2 (EUPL-1.2) url: https://eupl.eu/1.2/nl/ - version: 1.3.1 + version: 2.0.0 servers: - url: https://www.haalcentraal.nl/haalcentraal/api/brp description: | APILAB testserver tags: -- name: Ingeschreven Personen - description: Zoeken en raadplegen van ingeschreven personen +- name: Personen + description: Zoeken personen paths: - /ingeschrevenpersonen: - get: + /personen: + post: tags: - - Ingeschreven Personen + - Personen summary: Vindt personen description: | - Zoek personen met één van de onderstaande verplichte combinaties van parameters en vul ze evt. aan met parameters uit de andere combinaties. + Zoek personen met één van de onderstaande verplichte combinaties van parameters en vul ze evt. aan met optionele parameters. Default krijg je personen terug die nog in leven zijn, tenzij je de inclusiefoverledenpersonen=true opgeeft. - Gebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/fields_extensie.feature) + Gebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/fields_extensie.feature) - 1. Persoon - - geboorte__datum - - naam__geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature) + 1. Zoek met geslachtsnaam en geboortedatum + - geboortedatum + - geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)) - 2. Persoon - - verblijfplaats__gemeenteVanInschrijving - - naam__geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature) + 2. Zoek met geslachtsnaam, voornamen en gemeente van inschrijving + - gemeenteVanInschrijving + - geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)) - 3. Persoon - - burgerservicenummer + 3. Raadpleeg met burgerservicenummer + - burgerservicenummer - 4. Postcode - - verblijfplaats__postcode - - verblijfplaats__huisnummer + 4. Zoek met postcode en huisnummer + - postcode + - huisnummer - 5. Straat - - verblijfplaats__straat (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature) ) - - verblijfplaats__gemeenteVanInschrijving - - verblijfplaats__huisnummer + 5. Zoek met straat, huisnummer en gemeente van inschrijving + - straat (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)) + - gemeenteVanInschrijving + - huisnummer - 6. Adres - - verblijfplaats__nummeraanduidingIdentificatie - operationId: GetIngeschrevenPersonen - parameters: - - name: expand - in: query - description: Hiermee kun je opgeven welke gerelateerde resources meegeleverd - moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of - enkele properties geef je in de expand parameter kommagescheiden op. Properties - die je wil ontvangen geef je op met de resource-naam gevolgd door de property - naam, met daartussen een punt. In de definitie van het antwoord kun je bij - _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie - [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature). - required: false - deprecated: true - style: form - explode: true - schema: - type: string - - name: fields - in: query - description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen - door een door komma's gescheiden lijst van property namen op te geven. Bij - opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. - Wanneer de fields parameter niet is opgegeven, worden alle properties met - een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature) - required: false - schema: - type: string - - name: burgerservicenummer - in: query - description: | - Uniek persoonsnummer. - required: false - style: form - explode: false - schema: - type: array - items: - pattern: ^[0-9]{9}$ - type: string - example: - - "999993653" - - "999991723" - - "999995078" - - name: geboorte__datum - in: query - description: | - Je kunt alleen zoeken met een volledig geboortedatum. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/parametervalidatie.feature) - required: false - style: form - explode: true - schema: - type: string - format: date - example: 1964-09-24 - - name: geboorte__plaats - in: query - description: | - Gemeentenaam of een buitenlandse plaats of een plaatsbepaling, die aangeeft waar de persoon is geboren. **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).** - required: false - style: form - explode: true - schema: - maxLength: 40 - type: string - example: Utrecht - - name: geslachtsaanduiding - in: query - description: | - Geeft aan wat het geslacht is van persoon. - required: false - style: form - explode: true - schema: - type: string - example: V - - name: inclusiefOverledenPersonen - in: query - description: | - Als je ook overleden personen in het antwoord wilt, geef dan de parameter inclusiefOverledenPersonen op met waarde True. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/overleden_personen.feature) - required: false - style: form - explode: true - schema: - type: boolean - example: true - - name: naam__geslachtsnaam - in: query - description: | - De (geslachts)naam waarvan de eventueel aanwezige voorvoegsels zijn afgesplitst. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).** - required: false - style: form - explode: true - schema: - maxLength: 200 - type: string - example: Vries - - name: naam__voorvoegsel - in: query - description: | - Deel van de geslachtsnaam dat vooraf gaat aan de rest van de geslachtsnaam. Het zoeken op het voorvoegsel is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).** - required: false - style: form - explode: true - schema: - maxLength: 10 - type: string - example: de - - name: naam__voornamen - in: query - description: | - De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).** - required: false - style: form - explode: true - schema: - maxLength: 200 - type: string - example: Dirk - - name: verblijfplaats__gemeenteVanInschrijving - in: query - description: | - Een code die aangeeft in welke gemeente de persoon woont, of de laatste gemeente waar de persoon heeft gewoond, of de gemeente waar de persoon voor het eerst is ingeschreven. - required: false - style: form - explode: true - schema: - maxLength: 4 - type: string - example: "0518" - - name: verblijfplaats__huisletter - in: query - description: | - Een toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven. - required: false - style: form - explode: true - schema: - maxLength: 1 - type: string - example: a - - name: verblijfplaats__huisnummer - in: query - description: | - Een nummer dat door de gemeente aan een adresseerbaar object is gegeven. - required: false - style: form - explode: true - schema: - maximum: 99999 - type: integer - example: 14 - - name: verblijfplaats__huisnummertoevoeging - in: query - description: | - Een toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven. - required: false - style: form - explode: true - schema: - maxLength: 4 - type: string - example: bis - - name: verblijfplaats__nummeraanduidingIdentificatie - in: query - description: | - Unieke identificatie van een nummeraanduiding (en het bijbehorende adres) in de BAG. - required: false - style: form - explode: true - schema: - maxLength: 16 - type: string - example: "0518200000366054" - - name: verblijfplaats__straat - in: query - description: | - Een naam die door de gemeente aan een openbare ruimte is gegeven. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature). - required: false - style: form - explode: true - schema: - maxLength: 80 - type: string - example: Tulpstraat - - name: verblijfplaats__postcode - in: query - description: | - De door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort. - required: false - style: form - explode: true - schema: - pattern: ^[1-9]{1}[0-9]{3}[A-Z]{2}$ - type: string - example: 2341SX + 6. Zoek met nummeraanduiding identificatie + - nummeraanduidingIdentificatie + operationId: GetPersonen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PersonenQuery' responses: "200": description: | @@ -267,10 +78,16 @@ paths: $ref: '#/components/headers/api_version' warning: $ref: '#/components/headers/warning' + X-Rate-Limit-Limit: + $ref: '#/components/headers/X_Rate_Limit_Limit' + X-Rate-Limit-Remaining: + $ref: '#/components/headers/X_Rate_Limit_Remaining' + X-Rate-Limit-Reset: + $ref: '#/components/headers/X_Rate_Limit_Reset' content: - application/hal+json: + application/json: schema: - $ref: '#/components/schemas/IngeschrevenPersoonHalCollectie' + $ref: '#/components/schemas/PersonenQueryResponse' "400": description: Bad Request headers: @@ -346,201 +163,8 @@ paths: not acceptable according to thr accept headers sent in the request instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde code: notAcceptable - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - detail: The server encountered an unexpected condition which prevented - it from fulfilling the request. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: serverError - "501": - description: Not Implemented - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2 - title: Not Implemented - status: 501 - detail: The server does not support the functionality required to - fulfill the request. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notImplemented - "503": - description: Service Unavailable - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - detail: The service is currently unable to handle the request due - to a temporary overloading or maintenance of the server. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAvailable - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - /ingeschrevenpersonen/{burgerservicenummer}: - get: - tags: - - Ingeschreven Personen - summary: Raadpleeg een persoon - description: | - Raadpleeg een (overleden) persoon. - - Gebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/fields_extensie.feature). - operationId: GetIngeschrevenPersoon - parameters: - - name: burgerservicenummer - in: path - description: | - Uniek persoonsnummer - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{9}$ - type: string - example: "555555021" - - name: expand - in: query - description: Hiermee kun je opgeven welke gerelateerde resources meegeleverd - moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of - enkele properties geef je in de expand parameter kommagescheiden op. Properties - die je wil ontvangen geef je op met de resource-naam gevolgd door de property - naam, met daartussen een punt. In de definitie van het antwoord kun je bij - _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie - [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature). - required: false - deprecated: true - style: form - explode: true - schema: - type: string - - name: fields - in: query - description: Hiermee kun je de inhoud van de resource naar behoefte aanpassen - door een door komma's gescheiden lijst van property namen op te geven. Bij - opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. - Wanneer de fields parameter niet is opgegeven, worden alle properties met - een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature) - required: false - schema: - type: string - responses: - "200": - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/IngeschrevenPersoonHal' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - detail: The request could not be understood by the server due to malformed - syntax. The client SHOULD NOT repeat the request without modification. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: paramsRequired - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - detail: The request requires user authentication. The response MUST - include a WWW-Authenticate header field (section 14.47) containing - a challenge applicable to the requested resource. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: authentication - "403": - description: Forbidden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - detail: The server understood the request, but is refusing to fulfill - it. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: autorisation - "404": - description: Not Found - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 - title: Opgevraagde resource bestaat niet. - status: 404 - detail: The server has not found anything matching the Request-URI. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notFound - "406": - description: Not Acceptable + "429": + description: Too Many Requests headers: api-version: $ref: '#/components/headers/api_version' @@ -549,14 +173,13 @@ paths: schema: $ref: '#/components/schemas/Foutbericht' example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr accept headers sent in the request + type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html + title: Too many request + status: 429 + detail: The user has sent too many requests in a given amount of time + (rate limiting). instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAcceptable + code: tooManyRequests "500": description: Internal Server Error headers: @@ -602,7 +225,7 @@ paths: $ref: '#/components/schemas/Foutbericht' example: type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. + title: Bronservice BRP is tijdelijk niet beschikbaar. status: 503 detail: The service is currently unable to handle the request due to a temporary overloading or maintenance of the server. @@ -617,1519 +240,1018 @@ paths: application/problem+json: schema: $ref: '#/components/schemas/Foutbericht' - /ingeschrevenpersonen/{burgerservicenummer}/kinderen/{id}: - get: - tags: - - Ingeschreven Personen - summary: Raadpleeg een kind van een persoon - description: | - Raadpleeg een kind van een persoon - operationId: GetKind - parameters: - - name: burgerservicenummer - in: path - description: | - Uniek persoonsnummer - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{9}$ +components: + schemas: + PersonenQueryResponse: + required: + - type + type: object + properties: + type: type: string - example: "555555021" - - name: id - in: path - description: | - De identificatie van het kind. - required: true - style: simple - explode: false - schema: + discriminator: + propertyName: type + mapping: + ZoekMetGeslachtsnaamEnGeboortedatum: '#/components/schemas/ZoekMetGeslachtsnaamEnGeboortedatumResponse' + ZoekMetNaamEnGemeenteVanInschrijving: '#/components/schemas/ZoekMetNaamEnGemeenteVanInschrijvingResponse' + RaadpleegMetBurgerservicenummer: '#/components/schemas/RaadpleegMetBurgerservicenummerResponse' + ZoekMetPostcodeEnHuisnummer: '#/components/schemas/ZoekMetPostcodeEnHuisnummerResponse' + ZoekMetStraatHuisnummerEnGemeenteVanInschrijving: '#/components/schemas/ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse' + ZoekMetNummeraanduidingIdentificatie: '#/components/schemas/ZoekMetNummeraanduidingIdentificatieResponse' + ZoekMetGeslachtsnaamEnGeboortedatumResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: '#/components/schemas/PersoonBeperkt' + ZoekMetNaamEnGemeenteVanInschrijvingResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: '#/components/schemas/PersoonBeperkt' + RaadpleegMetBurgerservicenummerResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: '#/components/schemas/Persoon' + ZoekMetPostcodeEnHuisnummerResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: '#/components/schemas/PersoonBeperkt' + ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: '#/components/schemas/PersoonBeperkt' + ZoekMetNummeraanduidingIdentificatieResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: '#/components/schemas/PersoonBeperkt' + PersonenQuery: + required: + - fields + - type + type: object + properties: + type: type: string - responses: - "200": - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/KindHalBasis' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - detail: The request could not be understood by the server due to malformed - syntax. The client SHOULD NOT repeat the request without modification. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: paramsRequired - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - detail: The request requires user authentication. The response MUST - include a WWW-Authenticate header field (section 14.47) containing - a challenge applicable to the requested resource. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: authentication - "403": - description: Forbidden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - detail: The server understood the request, but is refusing to fulfill - it. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: autorisation - "404": - description: Not Found - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 - title: Opgevraagde resource bestaat niet. - status: 404 - detail: The server has not found anything matching the Request-URI. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notFound - "406": - description: Not Acceptable - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr accept headers sent in the request - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAcceptable - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - detail: The server encountered an unexpected condition which prevented - it from fulfilling the request. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: serverError - "501": - description: Not Implemented - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2 - title: Not Implemented - status: 501 - detail: The server does not support the functionality required to - fulfill the request. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notImplemented - "503": - description: Service Unavailable - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - detail: The service is currently unable to handle the request due - to a temporary overloading or maintenance of the server. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAvailable - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - deprecated: true - /ingeschrevenpersonen/{burgerservicenummer}/kinderen: - get: - tags: - - Ingeschreven Personen - summary: Levert de kinderen van een persoon - description: | - Levert de kinderen van een persoon - operationId: GetKinderen - parameters: - - name: burgerservicenummer - in: path - description: | - Uniek persoonsnummer - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{9}$ - type: string - example: "555555021" - responses: - "200": - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/KindHalCollectie' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - detail: The request could not be understood by the server due to malformed - syntax. The client SHOULD NOT repeat the request without modification. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: paramsRequired - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - detail: The request requires user authentication. The response MUST - include a WWW-Authenticate header field (section 14.47) containing - a challenge applicable to the requested resource. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: authentication - "403": - description: Forbidden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - detail: The server understood the request, but is refusing to fulfill - it. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: autorisation - "404": - description: Not Found - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 - title: Opgevraagde resource bestaat niet. - status: 404 - detail: The server has not found anything matching the Request-URI. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notFound - "406": - description: Not Acceptable - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr accept headers sent in the request - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAcceptable - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - detail: The server encountered an unexpected condition which prevented - it from fulfilling the request. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: serverError - "501": - description: Not Implemented - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2 - title: Not Implemented - status: 501 - detail: The server does not support the functionality required to - fulfill the request. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notImplemented - "503": - description: Service Unavailable - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - detail: The service is currently unable to handle the request due - to a temporary overloading or maintenance of the server. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAvailable - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - deprecated: true - /ingeschrevenpersonen/{burgerservicenummer}/ouders/{id}: - get: - tags: - - Ingeschreven Personen - summary: Raadpleeg een ouder van een persoon - description: | - Raadpleeg een ouder van een persoon - operationId: GetOuder - parameters: - - name: burgerservicenummer - in: path - description: | - Uniek persoonsnummer - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{9}$ - type: string - example: "555555021" - - name: id - in: path - description: | - De identificatie van de ouder. - required: true - style: simple - explode: false - schema: - type: string - responses: - "200": - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/OuderHalBasis' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - detail: The request could not be understood by the server due to malformed - syntax. The client SHOULD NOT repeat the request without modification. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: paramsRequired - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - detail: The request requires user authentication. The response MUST - include a WWW-Authenticate header field (section 14.47) containing - a challenge applicable to the requested resource. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: authentication - "403": - description: Forbidden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - detail: The server understood the request, but is refusing to fulfill - it. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: autorisation - "404": - description: Not Found - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 - title: Opgevraagde resource bestaat niet. - status: 404 - detail: The server has not found anything matching the Request-URI. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notFound - "406": - description: Not Acceptable - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr accept headers sent in the request - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAcceptable - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - detail: The server encountered an unexpected condition which prevented - it from fulfilling the request. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: serverError - "501": - description: Not Implemented - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2 - title: Not Implemented - status: 501 - detail: The server does not support the functionality required to - fulfill the request. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notImplemented - "503": - description: Service Unavailable - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - detail: The service is currently unable to handle the request due - to a temporary overloading or maintenance of the server. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAvailable - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - deprecated: true - /ingeschrevenpersonen/{burgerservicenummer}/ouders: - get: - tags: - - Ingeschreven Personen - summary: Levert de ouders van een persoon - description: | - Levert de ouders van een persoon - operationId: GetOuders - parameters: - - name: burgerservicenummer - in: path - description: | - Uniek persoonsnummer - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{9}$ - type: string - example: "555555021" - responses: - "200": - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/OuderHalCollectie' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - detail: The request could not be understood by the server due to malformed - syntax. The client SHOULD NOT repeat the request without modification. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: paramsRequired - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - detail: The request requires user authentication. The response MUST - include a WWW-Authenticate header field (section 14.47) containing - a challenge applicable to the requested resource. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: authentication - "403": - description: Not Found - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 - title: Opgevraagde resource bestaat niet. - status: 404 - detail: The server has not found anything matching the Request-URI. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notFound - "404": - description: Forbidden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - detail: The server understood the request, but is refusing to fulfill - it. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: autorisation - "406": - description: Not Acceptable - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr accept headers sent in the request - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAcceptable - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - detail: The server encountered an unexpected condition which prevented - it from fulfilling the request. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: serverError - "501": - description: Not Implemented - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2 - title: Not Implemented - status: 501 - detail: The server does not support the functionality required to - fulfill the request. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notImplemented - "503": - description: Service Unavailable - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - detail: The service is currently unable to handle the request due - to a temporary overloading or maintenance of the server. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAvailable - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - deprecated: true - /ingeschrevenpersonen/{burgerservicenummer}/partners/{id}: - get: - tags: - - Ingeschreven Personen - summary: Raadpleeg de partner van een persoon - description: | - Raadpleeg de partner van een persoon - operationId: GetPartner - parameters: - - name: burgerservicenummer - in: path - description: | - Uniek persoonsnummer - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{9}$ - type: string - example: "555555021" - - name: id - in: path - description: | - De identificatie van de partner. - required: true - style: simple - explode: false - schema: - type: string - responses: - "200": - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/PartnerHalBasis' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - detail: The request could not be understood by the server due to malformed - syntax. The client SHOULD NOT repeat the request without modification. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: paramsRequired - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - detail: The request requires user authentication. The response MUST - include a WWW-Authenticate header field (section 14.47) containing - a challenge applicable to the requested resource. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: authentication - "403": - description: Forbidden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - detail: The server understood the request, but is refusing to fulfill - it. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: autorisation - "404": - description: Not Found - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 - title: Opgevraagde resource bestaat niet. - status: 404 - detail: The server has not found anything matching the Request-URI. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notFound - "406": - description: Not Acceptable - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr accept headers sent in the request - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAcceptable - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - detail: The server encountered an unexpected condition which prevented - it from fulfilling the request. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: serverError - "501": - description: Not Implemented - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2 - title: Not Implemented - status: 501 - detail: The server does not support the functionality required to - fulfill the request. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notImplemented - "503": - description: Service Unavailable - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - detail: The service is currently unable to handle the request due - to a temporary overloading or maintenance of the server. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAvailable - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - deprecated: true - /ingeschrevenpersonen/{burgerservicenummer}/partners: - get: - tags: - - Ingeschreven Personen - summary: Levert de actuele partners van een persoon + fields: + $ref: '#/components/schemas/Fields' + gemeenteVanInschrijving: + $ref: '#/components/schemas/GemeenteVanInschrijving' + discriminator: + propertyName: type + mapping: + ZoekMetGeslachtsnaamEnGeboortedatum: '#/components/schemas/ZoekMetGeslachtsnaamEnGeboortedatum' + ZoekMetNaamEnGemeenteVanInschrijving: '#/components/schemas/ZoekMetNaamEnGemeenteVanInschrijving' + RaadpleegMetBurgerservicenummer: '#/components/schemas/RaadpleegMetBurgerservicenummer' + ZoekMetPostcodeEnHuisnummer: '#/components/schemas/ZoekMetPostcodeEnHuisnummer' + ZoekMetStraatHuisnummerEnGemeenteVanInschrijving: '#/components/schemas/ZoekMetStraatHuisnummerEnGemeenteVanInschrijving' + ZoekMetNummeraanduidingIdentificatie: '#/components/schemas/ZoekMetNummeraanduidingIdentificatie' + ZoekMetGeslachtsnaamEnGeboortedatum: + required: + - geboortedatum + - geslachtsnaam + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + geboortedatum: + type: string + description: | + Je kunt alleen zoeken met een volledig geboortedatum. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/parametervalidatie.feature) + format: date + example: 1964-09-24 + geboorteplaats: + $ref: '#/components/schemas/GeboorteplaatsFilter' + geslachtsnaam: + $ref: '#/components/schemas/GeslachtsnaamFilter' + geslachtsaanduiding: + $ref: '#/components/schemas/GeslachtsaanduidingFilter' + voorvoegsel: + $ref: '#/components/schemas/VoorvoegselFilter' + voornamen: + $ref: '#/components/schemas/VoornamenOptioneelFilter' + InclusiefOverledenPersonen: + type: boolean description: | - Levert de actuele partners van een persoon. Partners uit beëindigde huwelijken of partnerschappen worden niet geretourneerd - operationId: GetPartners - parameters: - - name: burgerservicenummer - in: path - description: | - Uniek persoonsnummer - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{9}$ + Als je ook overleden personen in het antwoord wilt, geef dan de parameter inclusiefOverledenPersonen op met waarde True. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/overleden_personen.feature) + example: true + ZoekMetNaamEnGemeenteVanInschrijving: + required: + - gemeenteVanInschrijving + - geslachtsnaam + - voornamen + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + geslachtsaanduiding: + $ref: '#/components/schemas/GeslachtsaanduidingFilter' + geslachtsnaam: + $ref: '#/components/schemas/GeslachtsnaamFilter' + voorvoegsel: + $ref: '#/components/schemas/VoorvoegselFilter' + voornamen: + $ref: '#/components/schemas/VoornamenVerplichtFilter' + RaadpleegMetBurgerservicenummer: + required: + - burgerservicenummer + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + burgerservicenummer: + maxItems: 20 + minItems: 1 + type: array + items: + $ref: '#/components/schemas/Burgerservicenummer' + ZoekMetPostcodeEnHuisnummer: + required: + - huisnummer + - postcode + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + huisletter: + $ref: '#/components/schemas/Huisletter' + huisnummer: + $ref: '#/components/schemas/Huisnummer' + huisnummertoevoeging: + $ref: '#/components/schemas/Huisnummertoevoeging' + postcode: + $ref: '#/components/schemas/Postcode' + ZoekMetStraatHuisnummerEnGemeenteVanInschrijving: + required: + - gemeenteVanInschrijving + - huisnummer + - straat + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + huisletter: + $ref: '#/components/schemas/Huisletter' + huisnummer: + $ref: '#/components/schemas/Huisnummer' + huisnummertoevoeging: + $ref: '#/components/schemas/Huisnummertoevoeging' + straat: + $ref: '#/components/schemas/StraatFilter' + ZoekMetNummeraanduidingIdentificatie: + required: + - nummeraanduidingIdentificatie + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + nummeraanduidingIdentificatie: + $ref: '#/components/schemas/NummeraanduidingIdentificatie' + BadRequestFoutbericht: + allOf: + - $ref: '#/components/schemas/Foutbericht' + - type: object + properties: + invalidParams: + type: array + description: Foutmelding per fout in een parameter. Alle gevonden fouten + worden één keer teruggemeld. + items: + $ref: '#/components/schemas/InvalidParams' + Foutbericht: + type: object + properties: + type: type: string - example: "555555021" - responses: - "200": - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: '#/components/headers/api_version' - warning: - $ref: '#/components/headers/warning' - content: - application/hal+json: - schema: - $ref: '#/components/schemas/PartnerHalCollectie' - "400": - description: Bad Request - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/BadRequestFoutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1 - title: Ten minste één parameter moet worden opgegeven. - status: 400 - detail: The request could not be understood by the server due to malformed - syntax. The client SHOULD NOT repeat the request without modification. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: paramsRequired - invalidParams: - - type: https://www.vng.nl/realisatie/api/validaties/integer - name: verblijfplaats__huisnummer - code: integer - reason: Waarde is geen geldige integer. - "401": - description: Unauthorized - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2 - title: Niet correct geauthenticeerd. - status: 401 - detail: The request requires user authentication. The response MUST - include a WWW-Authenticate header field (section 14.47) containing - a challenge applicable to the requested resource. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: authentication - "403": - description: Forbidden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4 - title: U bent niet geautoriseerd voor deze operatie. - status: 403 - detail: The server understood the request, but is refusing to fulfill - it. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: autorisation - "404": - description: Not Found - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5 - title: Opgevraagde resource bestaat niet. - status: 404 - detail: The server has not found anything matching the Request-URI. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notFound - "406": - description: Not Acceptable - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7 - title: Gevraagde contenttype wordt niet ondersteund. - status: 406 - detail: The resource identified by the request is only capable of - generating response entities which have content characteristics - not acceptable according to thr accept headers sent in the request - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAcceptable - "500": - description: Internal Server Error - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1 - title: Interne server fout. - status: 500 - detail: The server encountered an unexpected condition which prevented - it from fulfilling the request. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: serverError - "501": - description: Not Implemented - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2 - title: Not Implemented - status: 501 - detail: The server does not support the functionality required to - fulfill the request. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notImplemented - "503": - description: Service Unavailable - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - example: - type: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4 - title: Bronservice {bron} is tijdelijk niet beschikbaar. - status: 503 - detail: The service is currently unable to handle the request due - to a temporary overloading or maintenance of the server. - instance: https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde - code: notAvailable - default: - description: Er is een onverwachte fout opgetreden - headers: - api-version: - $ref: '#/components/headers/api_version' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Foutbericht' - deprecated: true -components: - schemas: - Reisdocumentnummer: + description: Link naar meer informatie over deze fout + format: uri + title: + pattern: ^[a-zA-Z0-9À-ž \.\-]{1,80}$ + type: string + description: Beschrijving van de fout + status: + maximum: 600 + minimum: 100 + type: integer + description: Http status code + detail: + pattern: ^[a-zA-Z0-9À-ž \.\-\(\)\,]{1,200}$ + type: string + description: Details over de fout + instance: + type: string + description: Uri van de aanroep die de fout heeft veroorzaakt + format: uri + code: + minLength: 1 + pattern: ^[a-zA-Z0-9]{1,25}$ + type: string + description: Systeemcode die het type fout aangeeft + description: Terugmelding bij een fout. JSON representatie in lijn met [RFC7807](https://tools.ietf.org/html/rfc7807). + InvalidParams: + type: object + properties: + type: + type: string + format: uri + example: https://www.vng.nl/realisatie/api/{major-versie}/validaties/integer + name: + pattern: ^[a-zA-Z0-9\.,_]{1,30}$ + type: string + description: Naam van de parameter + example: verblijfplaats__huisnummer + code: + minLength: 1 + pattern: ^[a-zA-Z0-9\.,_]{1,25}$ + type: string + description: Systeemcode die het type fout aangeeft + example: integer + reason: + pattern: ^[a-zA-Z0-9\.,_ ]{1,80}$ + type: string + description: Beschrijving van de fout op de parameterwaarde + example: Waarde is geen geldige integer. + description: Details over fouten in opgegeven parameters + PersoonBeperkt: + type: object + properties: + burgerservicenummer: + $ref: '#/components/schemas/Burgerservicenummer' + geboorte: + $ref: '#/components/schemas/GeboorteBeperkt' + geheimhoudingPersoonsgegevens: + $ref: '#/components/schemas/GeheimhoudingPersoonsgegevens' + geslachtsaanduiding: + $ref: '#/components/schemas/Waardetabel' + leeftijd: + $ref: '#/components/schemas/Leeftijd' + naam: + $ref: '#/components/schemas/NaamBasis' + opschortingBijhouding: + $ref: '#/components/schemas/OpschortingBijhoudingBasis' + overlijden: + $ref: '#/components/schemas/OverlijdenBasis' + verblijfplaats: + $ref: '#/components/schemas/AbstractVerblijfplaatsBeperkt' + Burgerservicenummer: + pattern: ^[0-9]{9}$ type: string + example: "555555021" + GeheimhoudingPersoonsgegevens: + type: boolean description: | - Het nummer van het verstrekte Nederlandse reisdocument. - example: "546376728" - IngeschrevenPersoonBasis: + Gegevens mogen niet worden verstrekt aan derden / maatschappelijke instellingen. + Leeftijd: + maximum: 150 + minimum: 0 + type: integer + description: | + Leeftijd in jaren op het moment van bevragen. + example: 34 + Persoon: type: object properties: + aNummer: + $ref: '#/components/schemas/ANummer' burgerservicenummer: - type: string - example: "555555021" + $ref: '#/components/schemas/Burgerservicenummer' + datumEersteInschrijvingGBA: + $ref: '#/components/schemas/AbstractDatum' geheimhoudingPersoonsgegevens: - title: Indicatie geheim - type: boolean - description: | - Gegevens mogen niet worden verstrekt aan derden / maatschappelijke instellingen. + $ref: '#/components/schemas/GeheimhoudingPersoonsgegevens' geslachtsaanduiding: $ref: '#/components/schemas/Waardetabel' + inOnderzoek: + $ref: '#/components/schemas/PersoonInOnderzoek' + kiesrecht: + $ref: '#/components/schemas/Kiesrecht' leeftijd: - type: integer - description: | - Leeftijd in jaren op het moment van bevragen. - example: 34 - IngeschrevenPersoonBeperkt: + $ref: '#/components/schemas/Leeftijd' + naam: + $ref: '#/components/schemas/NaamPersoon' + nationaliteiten: + type: array + items: + $ref: '#/components/schemas/Nationaliteit' + geboorte: + $ref: '#/components/schemas/Geboorte' + opschortingBijhouding: + $ref: '#/components/schemas/OpschortingBijhouding' + overlijden: + $ref: '#/components/schemas/Overlijden' + verblijfplaats: + $ref: '#/components/schemas/AbstractVerblijfplaats' + gezagsverhouding: + $ref: '#/components/schemas/Gezagsverhouding' + verblijfstitel: + $ref: '#/components/schemas/Verblijfstitel' + reisdocumentnummers: + type: array + items: + $ref: '#/components/schemas/Reisdocumentnummer' + kinderen: + type: array + items: + $ref: '#/components/schemas/AbstractKind' + ouders: + type: array + items: + $ref: '#/components/schemas/AbstractOuder' + partners: + type: array + items: + $ref: '#/components/schemas/AbstractPartner' + ANummer: + pattern: ^[0-9]{10}$ + type: string + description: | + Het A-nummer van de persoon + PersoonInOnderzoek: + type: object + properties: + burgerservicenummer: + type: boolean + geslachtsaanduiding: + type: boolean + leeftijd: + type: boolean + description: | + Geeft aan welke gegevens van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature). + allOf: + - $ref: '#/components/schemas/InOnderzoek' + InOnderzoek: + type: object + properties: + datumIngangOnderzoek: + $ref: '#/components/schemas/AbstractDatum' + Reisdocumentnummer: + pattern: ^[0-9a-zA-Z]{9}$ + type: string + description: | + Het nummer van het verstrekte Nederlandse reisdocument. + example: "546376728" + Fields: + maxLength: 924 + pattern: ^[a-zA-Z0-9\.,_]+$ + type: string + description: | + Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. + Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. + Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature) + GemeenteVanInschrijving: + pattern: ^[0-9]{4}$ + type: string + description: | + Een code die aangeeft in welke gemeente de persoon woont, of de laatste gemeente waar de persoon heeft gewoond, of de gemeente waar de persoon voor het eerst is ingeschreven. + example: "0518" + GeboorteplaatsFilter: + pattern: ^[a-zA-Z0-9À-ž \,\.\-\'()]{1,80}$ + type: string + description: | + Gemeentenaam of een buitenlandse plaats of een plaatsbepaling, die aangeeft waar de persoon is geboren. **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + example: Utrecht + GeslachtsnaamFilter: + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,200}$|^[a-zA-Z0-9À-ž \.\-\']{3,199}\*{1}$ + type: string + description: | + De (geslachts)naam waarvan de eventueel aanwezige voorvoegsels zijn afgesplitst. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + example: Vries + GeslachtsaanduidingFilter: + pattern: ^([Mm]|[Vv]|[Oo])$ + type: string + description: | + Geeft aan dat de persoon een man of een vrouw is, of dat het geslacht (nog) onbekend is. + example: V + VoorvoegselFilter: + pattern: ^[a-zA-Z \']{1,10}$ + type: string + description: | + Deel van de geslachtsnaam dat vooraf gaat aan de rest van de geslachtsnaam. Het zoeken op het voorvoegsel is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + example: de + VoornamenOptioneelFilter: + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,199}\*{1}$ + type: string + description: | + De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + example: Dirk + VoornamenVerplichtFilter: + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,200}$|^[a-zA-Z0-9À-ž \.\-\']{3,199}\*{1}$ + type: string + description: | + De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + example: Dirk + Huisletter: + pattern: ^[a-zA-Z]{1}$ + type: string + description: | + Een toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven. + example: a + Huisnummer: + maximum: 99999 + minimum: 1 + type: integer + description: | + Een nummer dat door de gemeente aan een adresseerbaar object is gegeven. + example: 14 + Huisnummertoevoeging: + pattern: ^[a-zA-Z0-9 \-]{1,4}$ + type: string + description: | + Een toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven. + example: bis + Postcode: + pattern: ^[1-9]{1}[0-9]{3}[ ]?[A-Za-z]{2}$ + type: string + description: | + De door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort. + example: 2341SX + StraatFilter: + pattern: ^[a-zA-Z0-9À-ž \-\']{1,80}$|^[a-zA-Z0-9À-ž \-\']{7,79}\*{1}$|^\*{1}[a-zA-Z0-9À-ž + \-\']{7,79}$ + type: string + description: | + Een naam die door de gemeente aan een openbare ruimte is gegeven. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature). + example: Tulpstraat + NummeraanduidingIdentificatie: + pattern: ^[0-9]{16}$ + type: string + description: | + Unieke identificatie van een nummeraanduiding (en het bijbehorende adres) in de BAG. + example: "0518200000366054" + GeboorteBeperkt: + type: object + properties: + datum: + $ref: '#/components/schemas/AbstractDatum' + Waardetabel: + type: object + properties: + code: + pattern: ^[a-zA-Z0-9 \.]+$ + type: string + example: "6030" + omschrijving: + pattern: ^[a-zA-Z0-9À-ž \'\,\(\)\.\-]{1,200}$ + type: string + example: Nederland + NaamBasis: + type: object + properties: + voornamen: + $ref: '#/components/schemas/Voornamen' + adellijkeTitelPredicaat: + $ref: '#/components/schemas/AdellijkeTitelPredicaatType' + voorvoegsel: + $ref: '#/components/schemas/Voorvoegsel' + geslachtsnaam: + $ref: '#/components/schemas/Geslachtsnaam' + voorletters: + $ref: '#/components/schemas/Voorletters' + volledigeNaam: + $ref: '#/components/schemas/VolledigeNaam' + Voornamen: + maxLength: 200 + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,200}$ + type: string + description: | + De verzameling namen voor de geslachtsnaam, gescheiden door spaties. + AdellijkeTitelPredicaatType: + allOf: + - $ref: '#/components/schemas/Waardetabel' + - properties: + soort: + $ref: '#/components/schemas/AdellijkeTitelPredicaatSoort' + example: + value: + code: JV + omschrijving: jonkvrouw + soort: predicaat + AdellijkeTitelPredicaatSoort: + type: string + enum: + - titel + - predicaat + Voorvoegsel: + maxLength: 10 + pattern: ^[a-zA-Z \']{1,10}$ + type: string + example: de + Geslachtsnaam: + maxLength: 200 + type: string + description: | + De achternaam van een persoon. + example: Vries + Voorletters: + pattern: ^[a-zA-Z0-9À-ž \.]{1,40}$ + type: string + description: | + De voorletters van de persoon, afgeleid van de voornamen. + example: P.J. + VolledigeNaam: + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,450}$ + type: string + description: | + Combinatie van predicaat, voornamen, adellijke titel, voorvoegsels en geslachtsnaam, zonder toevoeging van een eventuele partnernaam. + example: Pieter Jan de Vries + OpschortingBijhoudingBasis: + type: object + properties: + reden: + $ref: '#/components/schemas/Waardetabel' + description: | + * **reden** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'redenopschortingbijhouding' uit de Haal-Centraal-BRP-tabellen-bevragen API. + OverlijdenBasis: + type: object + properties: + indicatieOverleden: + $ref: '#/components/schemas/IndicatieOverleden' + IndicatieOverleden: + type: boolean + description: | + Geeft aan dat iemand is overleden (waarde true), ongeacht of de overlijdensdatum bekend is. + AbstractVerblijfplaatsBeperkt: + required: + - type + type: object + properties: + type: + type: string + description: | + Gegevens over het verblijf of de woonlocatie van een persoon. + discriminator: + propertyName: type + mapping: + VerblijfplaatsBuitenland: '#/components/schemas/VerblijfplaatsBuitenlandBeperkt' + Adres: '#/components/schemas/AdresBeperkt' + VerblijfplaatsOnbekend: '#/components/schemas/VerblijfplaatsOnbekend' + Locatie: '#/components/schemas/LocatieBeperkt' + VerblijfplaatsBuitenlandBeperkt: allOf: - - $ref: '#/components/schemas/IngeschrevenPersoonBasis' + - $ref: '#/components/schemas/AbstractVerblijfplaatsBeperkt' - type: object properties: - naam: - $ref: '#/components/schemas/NaamBasis' - geboorte: - $ref: '#/components/schemas/Geboortedatum' - opschortingBijhouding: - $ref: '#/components/schemas/OpschortingBijhoudingBasis' - overlijden: - $ref: '#/components/schemas/OverlijdenBasis' - verblijfplaats: - $ref: '#/components/schemas/VerblijfplaatsBeperkt' - IngeschrevenPersoonBeperktLinks: + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + adresregel3: + $ref: '#/components/schemas/Adresregel3' + land: + $ref: '#/components/schemas/Waardetabel' + Adresregel1: + maxLength: 40 + type: string + description: | + Het eerste deel van een adres is een combinatie van de straat en huisnummer. + example: Laan van de landinrichtingscommissie Duiven-Westervoort 26A-3 + Adresregel2: + maxLength: 50 + type: string + description: | + Het tweede deel van een adres is een combinatie van woonplaats eventueel in combinatie met de postcode. + example: 1234AA Nootdorp + Adresregel3: + maxLength: 35 + type: string + description: | + Het derde deel van een adres is optioneel. Het gaat om een of meer geografische gebieden van het adres in het buitenland. + example: Selangor + AdresBeperkt: + allOf: + - $ref: '#/components/schemas/AbstractVerblijfplaatsBeperkt' + - type: object + properties: + functieAdres: + $ref: '#/components/schemas/Waardetabel' + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + woonplaats: + $ref: '#/components/schemas/Woonplaats' + Woonplaats: + title: woonplaats naam + pattern: ^[a-zA-Z0-9À-ž \(\)\,\.\-\']{1,80}$ + type: string + description: | + Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam. + example: Duiven + VerblijfplaatsOnbekend: + allOf: + - $ref: '#/components/schemas/AbstractVerblijfplaats' + - type: object + properties: + datumInschrijvingInGemeente: + $ref: '#/components/schemas/AbstractDatum' + gemeenteVanInschrijving: + $ref: '#/components/schemas/GemeenteVanInschrijving' + verblijfplaatsOnbekend: + $ref: '#/components/schemas/IndicatieVerblijfplaatsOnbekend' + inOnderzoek: + $ref: '#/components/schemas/VerblijfplaatsOnbekendInOnderzoek' + AbstractVerblijfplaats: + required: + - type type: object properties: - self: - $ref: '#/components/schemas/HalLink' - IngeschrevenPersoonBeperktHal: + type: + type: string + description: | + Gegevens over het verblijf of de woonlocatie van een persoon. + discriminator: + propertyName: type + mapping: + VerblijfplaatsBuitenland: '#/components/schemas/VerblijfplaatsBuitenland' + Adres: '#/components/schemas/Adres' + VerblijfplaatsOnbekend: '#/components/schemas/VerblijfplaatsOnbekend' + Locatie: '#/components/schemas/Locatie' + VerblijfplaatsBuitenland: allOf: - - $ref: '#/components/schemas/IngeschrevenPersoonBeperkt' - - properties: - _links: - $ref: '#/components/schemas/IngeschrevenPersoonBeperktLinks' - IngeschrevenPersoon: + - $ref: '#/components/schemas/AbstractVerblijfplaats' + - type: object + properties: + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + adresregel3: + $ref: '#/components/schemas/Adresregel3' + datumInschrijvingInGemeente: + $ref: '#/components/schemas/AbstractDatum' + gemeenteVanInschrijving: + $ref: '#/components/schemas/Waardetabel' + land: + $ref: '#/components/schemas/Waardetabel' + datumVan: + $ref: '#/components/schemas/AbstractDatum' + datumIngangGeldigheid: + $ref: '#/components/schemas/AbstractDatum' + inOnderzoek: + $ref: '#/components/schemas/VerblijfplaatsBuitenlandInOnderzoek' + VerblijfplaatsBuitenlandInOnderzoek: + allOf: + - $ref: '#/components/schemas/InOnderzoek' + - type: object + properties: + adresregel1: + type: boolean + adresregel2: + type: boolean + adresregel3: + type: boolean + datumInschrijvingInGemeente: + type: boolean + gemeenteVanInschrijving: + type: boolean + land: + type: boolean + datumVan: + type: boolean + datumIngangGeldigheid: + type: boolean + Adres: + description: | + Gegevens over het adres van een persoon. + * **datumVan** : de datum van aangifte of ambtshalve melding van verblijf en adres. + * **datumIngangGeldigheid** : datum waarop de gegevens over de verblijfplaats geldig zijn geworden. + * **datumInschrijvingInGemeente**: bij inschrijving op grond van een verhuisaangifte door de burger is dit de aangiftedatum. Bij inschrijving op grond van een geboorteakte is dit de geboortedatum. Bij ambtshalve inschrijving is dit de datum waarop het voornemen van ambtshalve opneming schriftelijk aan de persoon is medegedeeld. + * **datumVestigingInNederland** : datum van inschrijving in Nederland. + * **landVanWaarIngeschreven** : het land waar de persoon woonde voor (her)vestiging in Nederland. + * **gemeenteVanInschrijving** : de gemeente waar de persoon verblijft en is ingeschreven. De code kan voorloopnullen bevatten." + allOf: + - $ref: '#/components/schemas/AbstractVerblijfplaats' + - type: object + properties: + functieAdres: + $ref: '#/components/schemas/Waardetabel' + straat: + $ref: '#/components/schemas/Straat' + huisnummer: + $ref: '#/components/schemas/Huisnummer' + huisletter: + $ref: '#/components/schemas/Huisletter' + huisnummertoevoeging: + $ref: '#/components/schemas/Huisnummertoevoeging' + aanduidingBijHuisnummer: + $ref: '#/components/schemas/Waardetabel' + postcode: + $ref: '#/components/schemas/Postcode' + adresseerbaarObjectIdentificatie: + $ref: '#/components/schemas/AdresseerbaarObjectIdentificatie' + nummeraanduidingIdentificatie: + $ref: '#/components/schemas/NummeraanduidingIdentificatie' + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + woonplaats: + $ref: '#/components/schemas/Woonplaats' + indicatieVestigingVanuitBuitenland: + $ref: '#/components/schemas/IndicatieVestigingVanuitBuitenland' + korteNaam: + $ref: '#/components/schemas/KorteNaam' + vanuitVerblijfplaatsOnbekend: + $ref: '#/components/schemas/VanuitVerblijfplaatsOnbekend' + datumVan: + $ref: '#/components/schemas/AbstractDatum' + datumIngangGeldigheid: + $ref: '#/components/schemas/AbstractDatum' + datumInschrijvingInGemeente: + $ref: '#/components/schemas/AbstractDatum' + datumVestigingInNederland: + $ref: '#/components/schemas/AbstractDatum' + gemeenteVanInschrijving: + $ref: '#/components/schemas/Waardetabel' + landVanwaarIngeschreven: + $ref: '#/components/schemas/Waardetabel' + inOnderzoek: + $ref: '#/components/schemas/AdresInOnderzoek' + Straat: + maxLength: 80 + type: string + example: Tulpstraat + AdresseerbaarObjectIdentificatie: + pattern: ^[0-9]{16}$ + type: string + description: | + De verblijfplaats van de persoon kan een ligplaats, een standplaats of een verblijfsobject zijn. + example: "0226010000038820" + IndicatieVestigingVanuitBuitenland: + type: boolean + description: | + Geeft aan dat de persoon zich vanuit het buitenland heeft ingeschreven. + KorteNaam: + maxLength: 24 + type: string + description: | + De officiële openbareruimtenaam uit de Basisregistratie Gebouwen en Adressen (BAG) of een verkorte versie. + VanuitVerblijfplaatsOnbekend: + type: boolean + description: | + Geeft aan dat de persoon is teruggekeerd uit een situatie van onbekende verblijfplaats + AdresInOnderzoek: + allOf: + - $ref: '#/components/schemas/InOnderzoek' + - type: object + properties: + aanduidingBijHuisnummer: + type: boolean + datumVan: + type: boolean + datumIngangGeldigheid: + type: boolean + datumInschrijvingInGemeente: + type: boolean + datumVestigingInNederland: + type: boolean + functieAdres: + type: boolean + gemeenteVanInschrijving: + type: boolean + huisletter: + type: boolean + huisnummer: + type: boolean + huisnummertoevoeging: + type: boolean + nummeraanduidingIdentificatie: + type: boolean + adresseerbaarObjectIdentificatie: + type: boolean + landVanwaarIngeschreven: + type: boolean + straat: + type: boolean + postcode: + type: boolean + korteNaam: + type: boolean + woonplaats: + type: boolean + adresregel1: + type: boolean + adresregel2: + type: boolean + indicatieVestigingVanuitBuitenland: + type: boolean + vanuitVerblijfplaatsOnbekend: + type: boolean + Locatie: allOf: - - $ref: '#/components/schemas/IngeschrevenPersoonBasis' + - $ref: '#/components/schemas/AbstractVerblijfplaats' - type: object properties: - aNummer: - type: string - description: | - Het A-nummer van de persoon - datumEersteInschrijvingGBA: - $ref: '#/components/schemas/DatumOnvolledig' + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + datumInschrijvingInGemeente: + $ref: '#/components/schemas/AbstractDatum' + datumVestigingInNederland: + $ref: '#/components/schemas/AbstractDatum' + functieAdres: + $ref: '#/components/schemas/Waardetabel' + gemeenteVanInschrijving: + $ref: '#/components/schemas/Waardetabel' + indicatieVestigingVanuitBuitenland: + $ref: '#/components/schemas/IndicatieVestigingVanuitBuitenland' + landVanwaarIngeschreven: + $ref: '#/components/schemas/Waardetabel' + locatiebeschrijving: + $ref: '#/components/schemas/Locatiebeschrijving' + vanuitVerblijfplaatsOnbekend: + $ref: '#/components/schemas/VanuitVerblijfplaatsOnbekend' + woonplaats: + $ref: '#/components/schemas/Woonplaats' inOnderzoek: - $ref: '#/components/schemas/PersoonInOnderzoek' - kiesrecht: - $ref: '#/components/schemas/Kiesrecht' - naam: - $ref: '#/components/schemas/NaamPersoon' - nationaliteiten: - type: array - items: - $ref: '#/components/schemas/Nationaliteit' - geboorte: - $ref: '#/components/schemas/Geboorte' - opschortingBijhouding: - $ref: '#/components/schemas/OpschortingBijhouding' - overlijden: - $ref: '#/components/schemas/Overlijden' - verblijfplaats: - $ref: '#/components/schemas/Verblijfplaats' - gezagsverhouding: - $ref: '#/components/schemas/Gezagsverhouding' - verblijfstitel: - $ref: '#/components/schemas/Verblijfstitel' - reisdocumentnummers: - type: array - items: - $ref: '#/components/schemas/Reisdocumentnummer' - kinderen: - type: array - items: - $ref: '#/components/schemas/Kind' - ouders: - type: array - items: - $ref: '#/components/schemas/Ouder' - partners: - type: array - items: - $ref: '#/components/schemas/Partner' - IngeschrevenPersoonHalCollectie: - type: object - properties: - _links: - $ref: '#/components/schemas/HalCollectionLinks' - _embedded: - $ref: '#/components/schemas/IngeschrevenPersoonHalCollectieEmbedded' - IngeschrevenPersoonHalCollectieEmbedded: - type: object - properties: - ingeschrevenpersonen: - type: array - items: - $ref: '#/components/schemas/IngeschrevenPersoonBeperktHal' - IngeschrevenPersoonHalBasis: - allOf: - - $ref: '#/components/schemas/IngeschrevenPersoon' - - properties: - _links: - $ref: '#/components/schemas/IngeschrevenPersoonLinks' - IngeschrevenPersoonHal: - allOf: - - $ref: '#/components/schemas/IngeschrevenPersoonHalBasis' - - properties: - _embedded: - $ref: '#/components/schemas/IngeschrevenPersoonEmbedded' - Ouder: - type: object - properties: - burgerservicenummer: - type: string - example: "555555021" - geslachtsaanduiding: - $ref: '#/components/schemas/Waardetabel' - ouderAanduiding: - $ref: '#/components/schemas/Waardetabel' - datumIngangFamilierechtelijkeBetrekking: - $ref: '#/components/schemas/DatumOnvolledig' - naam: - $ref: '#/components/schemas/Naam' - inOnderzoek: - $ref: '#/components/schemas/OuderInOnderzoek' - geboorte: - $ref: '#/components/schemas/Geboorte' + $ref: '#/components/schemas/LocatieInOnderzoek' + Locatiebeschrijving: + maxLength: 35 + type: string description: | - Gegevens over de ouder van de persoon. - * **datumIngangFamilierechtelijkeBetrekking** - De datum waarop de familierechtelijke betrekking is ontstaan. - OuderHalCollectie: - type: object - properties: - _links: - $ref: '#/components/schemas/HalCollectionLinks' - _embedded: - $ref: '#/components/schemas/OuderHalCollectieEmbedded' - deprecated: true - OuderHalCollectieEmbedded: - type: object - properties: - ouders: - type: array - items: - $ref: '#/components/schemas/OuderHalBasis' - deprecated: true - OuderHalBasis: - deprecated: true + Omschrijving van de ligging van een verblijfsobject, standplaats of ligplaats. + example: Naast de derde brug + LocatieInOnderzoek: allOf: - - $ref: '#/components/schemas/Ouder' - - properties: - geheimhoudingPersoonsgegevens: - title: Indicatie geheim + - $ref: '#/components/schemas/InOnderzoek' + - type: object + properties: + adresregel1: type: boolean - description: | - Gegevens mogen niet worden verstrekt aan derden / maarschappelijke instellingen. - _links: - $ref: '#/components/schemas/OuderLinks' - Kind: - type: object - properties: - burgerservicenummer: - type: string - example: "555555021" - leeftijd: - type: integer - description: | - Leeftijd op het moment van bevragen - example: 12 - inOnderzoek: - $ref: '#/components/schemas/KindInOnderzoek' - naam: - $ref: '#/components/schemas/Naam' - geboorte: - $ref: '#/components/schemas/Geboorte' - description: | - Gegevens over een kind van de persoon. - KindHalCollectie: - type: object - properties: - _links: - $ref: '#/components/schemas/HalCollectionLinks' - _embedded: - $ref: '#/components/schemas/KindHalCollectieEmbedded' - deprecated: true - KindHalCollectieEmbedded: - type: object - properties: - kinderen: - type: array - items: - $ref: '#/components/schemas/KindHalBasis' - deprecated: true - KindHalBasis: - deprecated: true - allOf: - - $ref: '#/components/schemas/Kind' - - properties: - geheimhoudingPersoonsgegevens: - title: Indicatie geheim + adresregel2: type: boolean - description: | - Gegevens mogen niet worden verstrekt aan derden/ maatschappelijke instellingen. - _links: - $ref: '#/components/schemas/KindLinks' - Partner: - type: object - properties: - burgerservicenummer: - type: string - example: "555555021" - geslachtsaanduiding: - $ref: '#/components/schemas/Waardetabel' - soortVerbintenis: - $ref: '#/components/schemas/Waardetabel' - naam: - $ref: '#/components/schemas/Naam' - geboorte: - $ref: '#/components/schemas/Geboorte' - inOnderzoek: - $ref: '#/components/schemas/PartnerInOnderzoek' - aangaanHuwelijkPartnerschap: - $ref: '#/components/schemas/AangaanHuwelijkPartnerschap' + datumInschrijvingInGemeente: + type: boolean + datumVestigingInNederland: + type: boolean + functieAdres: + type: boolean + gemeenteVanInschrijving: + type: boolean + indicatieVestigingVanuitBuitenland: + type: boolean + landVanwaarIngeschreven: + type: boolean + locatiebeschrijving: + type: boolean + vanuitVerblijfplaatsOnbekend: + type: boolean + woonplaats: + type: boolean + IndicatieVerblijfplaatsOnbekend: + type: boolean description: | - Gegevens over een gesloten huwelijk/geregistreerd partnerschap van de persoon. - PartnerHalCollectie: - type: object - properties: - _links: - $ref: '#/components/schemas/HalCollectionLinks' - _embedded: - $ref: '#/components/schemas/PartnerHalCollectieEmbedded' - deprecated: true - PartnerHalCollectieEmbedded: - type: object - properties: - partners: - type: array - items: - $ref: '#/components/schemas/PartnerHalBasis' - deprecated: true - PartnerHalBasis: - deprecated: true + Indicatie dat de verblijfplaats van de persoon onbekend is. Er is niet bekend in welk land de persoon verblijft. + VerblijfplaatsOnbekendInOnderzoek: allOf: - - $ref: '#/components/schemas/Partner' - - properties: - geheimhoudingPersoonsgegevens: - title: Indicatie geheim + - $ref: '#/components/schemas/InOnderzoek' + - type: object + properties: + datumInschrijvingInGemeente: type: boolean - description: | - Gegevens mogen niet worden verstrekt aan derden/ maatschappelijke instellingen. - _links: - $ref: '#/components/schemas/PartnerLinks' - Naam: + gemeenteVanInschrijving: + type: boolean + verblijfplaatsOnbekend: + type: boolean + LocatieBeperkt: allOf: - - $ref: '#/components/schemas/NaamBasis' - - properties: - inOnderzoek: - $ref: '#/components/schemas/NaamInOnderzoek' - NaamBasis: + - $ref: '#/components/schemas/AbstractVerblijfplaatsBeperkt' + - type: object + properties: + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + functieAdres: + $ref: '#/components/schemas/Waardetabel' + locatiebeschrijving: + $ref: '#/components/schemas/Locatiebeschrijving' + woonplaats: + $ref: '#/components/schemas/Woonplaats' + AbstractDatum: + required: + - type type: object properties: - geslachtsnaam: - type: string - description: | - De achternaam van een persoon. - example: Vries - voorletters: - type: string - description: | - De voorletters van de persoon, afgeleid van de voornamen. - example: P.J. - voornamen: - type: string - description: | - De verzameling namen voor de geslachtsnaam, gescheiden door spaties. - example: Pieter Jan - voorvoegsel: - type: string - example: de - adellijkeTitelPredikaat: - $ref: '#/components/schemas/WaardetabelMetSoort' - volledigeNaam: + type: type: string - example: Pieter Jan de Vries - WaardetabelMetSoort: + discriminator: + propertyName: type + mapping: + Datum: '#/components/schemas/VolledigeDatum' + OnbekendDatum: '#/components/schemas/OnbekendDatum' + JaarDatum: '#/components/schemas/JaarDatum' + JaarMaandDatum: '#/components/schemas/JaarMaandDatum' + VolledigeDatum: + required: + - datum + description: Datum conform iso8601 + example: + value: + type: Datum + datum: 2018-07-01 allOf: - - $ref: '#/components/schemas/Waardetabel' - - properties: - soort: + - $ref: '#/components/schemas/AbstractDatum' + - type: object + properties: + datum: type: string - example: - code: JV - omschrijving: jonkvrouw - soort: predikaat - NaamInOnderzoek: - type: object - properties: - geslachtsnaam: - type: boolean - voornamen: - type: boolean - voorvoegsel: - type: boolean - adellijkeTitel: - type: boolean - predikaat: - type: boolean - datumIngangOnderzoek: - $ref: '#/components/schemas/DatumOnvolledig' - description: | - Geeft aan welke gegevens over de naam in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - NaamPersoonInOnderzoek: + format: date + OnbekendDatum: + required: + - onbekend + description: representatie voor een volledig onbekend datum + example: + value: + type: OnbekendDatum + onbekend: true allOf: - - $ref: '#/components/schemas/NaamInOnderzoek' - - properties: - aanduidingNaamgebruik: + - $ref: '#/components/schemas/AbstractDatum' + - type: object + properties: + onbekend: type: boolean - OuderInOnderzoek: - type: object - properties: - burgerservicenummer: - type: boolean - datumIngangFamilierechtelijkeBetrekking: - type: boolean - geslachtsaanduiding: - type: boolean - datumIngangOnderzoek: - $ref: '#/components/schemas/DatumOnvolledig' - description: | - Geeft aan welke gegevens van de de ouder in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - Geboorte: + default: true + JaarDatum: + required: + - jaar + description: representatie voor een datum waarvan maand en dag onbekend zijn + example: + value: + type: JaarDatum + jaar: 2018 allOf: - - $ref: '#/components/schemas/Geboortedatum' - - properties: - land: - $ref: '#/components/schemas/Waardetabel' - plaats: - $ref: '#/components/schemas/Waardetabel' - inOnderzoek: - $ref: '#/components/schemas/GeboorteInOnderzoek' - description: | - Gegevens over de geboorte. - * **datum** : datum waarop de persoon is geboren. - * **land** : land waar de persoon is geboren - * **plaats** : gemeente waar de persoon is geboren. Is de persoon geboren buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding. - GeboorteInOnderzoek: - type: object - properties: - datum: - type: boolean - land: - type: boolean - plaats: - type: boolean - datumIngangOnderzoek: - $ref: '#/components/schemas/DatumOnvolledig' - description: | - Geeft aan welke gegevens over de geboorte van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + - $ref: '#/components/schemas/AbstractDatum' + - type: object + properties: + jaar: + $ref: '#/components/schemas/Jaar' + Jaar: + maximum: 9999 + minimum: 1 + type: integer + format: int32 + JaarMaandDatum: + required: + - jaar + - maand + description: representatie voor een datum waarvan de dag onbekend is + example: + value: + type: JaarMaandDatum + jaar: 2018 + maand: 7 + allOf: + - $ref: '#/components/schemas/AbstractDatum' + - type: object + properties: + jaar: + $ref: '#/components/schemas/Jaar' + maand: + $ref: '#/components/schemas/Maand' + Maand: + maximum: 12 + minimum: 1 + type: integer + format: int32 Kiesrecht: type: object properties: @@ -2142,340 +1264,226 @@ components: type: boolean example: true einddatumUitsluitingEuropeesKiesrecht: - $ref: '#/components/schemas/DatumOnvolledig' + $ref: '#/components/schemas/AbstractDatum' einddatumUitsluitingKiesrecht: - $ref: '#/components/schemas/DatumOnvolledig' + $ref: '#/components/schemas/AbstractDatum' NaamPersoon: allOf: - $ref: '#/components/schemas/NaamBasis' - properties: - aanhef: - type: string - description: | - Kun je gebruiken als aanhef in een brief gericht aan persoon. - example: Hoogwelgeboren heer - aanschrijfwijze: - type: string - description: | - Samengestelde naam die je kunt gebruiken in de communicatie met de persoon. - example: H.W. baron van den Aedel - regelVoorafgaandAanAanschrijfwijze: - type: string - description: | - Deze regel moet als aparte regel boven de aanschrijfwijze worden geplaatst. Komt alleen voor bij personen met een adellijke titel of predicaat. - example: De hoogwelgeboren heer - gebruikInLopendeTekst: - type: string - description: | - Naam van persoon die je kunt gebruiken als je in lopende tekst (bijvoorbeeld in een brief) aan persoon refereert. - example: baron Van den Aedel aanduidingNaamgebruik: $ref: '#/components/schemas/Waardetabel' + aanhef: + $ref: '#/components/schemas/Aanhef' + aanschrijfwijze: + $ref: '#/components/schemas/Aanschrijfwijze' + gebruikInLopendeTekst: + $ref: '#/components/schemas/GebruikInLopendeTekst' inOnderzoek: $ref: '#/components/schemas/NaamPersoonInOnderzoek' - PersoonInOnderzoek: + Aanhef: + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,650}$ + type: string + description: | + Kun je gebruiken als aanhef in een brief gericht aan persoon. + example: Hoogwelgeboren heer + Aanschrijfwijze: type: object properties: - burgerservicenummer: - type: boolean - geslachtsaanduiding: - type: boolean - datumIngangOnderzoek: - $ref: '#/components/schemas/DatumOnvolledig' + naam: + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,650}$ + type: string + example: H.W. baron van den Aedel + aanspreekvorm: + pattern: ^[a-zA-Z ]{1,25}$ + type: string + description: | + Deze regel moet als aparte regel boven de samengestelde naam worden geplaatst. Komt alleen voor bij personen met een adellijke titel of predicaat. + example: De hoogwelgeboren heer description: | - Geeft aan welke gegevens van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature). + Samengestelde naam en aanspreekvorm die je kunt gebruiken in de communicatie met de persoon. + GebruikInLopendeTekst: + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,650}$ + type: string + description: | + Naam van persoon die je kunt gebruiken als je in lopende tekst (bijvoorbeeld in een brief) aan persoon refereert. + example: baron Van den Aedel + NaamPersoonInOnderzoek: + allOf: + - $ref: '#/components/schemas/NaamInOnderzoek' + - type: object + properties: + volledigeNaam: + type: boolean + aanduidingNaamgebruik: + type: boolean + aanhef: + type: boolean + aanschrijfwijze: + type: boolean + gebruikInLopendeTekst: + type: boolean + NaamInOnderzoek: + description: | + Geeft aan welke gegevens over de naam in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: '#/components/schemas/InOnderzoek' + - type: object + properties: + voornamen: + type: boolean + adellijkeTitelPredicaat: + type: boolean + voorvoegsel: + type: boolean + geslachtsnaam: + type: boolean + voorletters: + type: boolean Nationaliteit: - type: object - properties: - aanduidingBijzonderNederlanderschap: - $ref: '#/components/schemas/AanduidingBijzonderNederlanderschap' - datumIngangGeldigheid: - $ref: '#/components/schemas/DatumOnvolledig' - nationaliteit: - $ref: '#/components/schemas/Waardetabel' - redenOpname: - $ref: '#/components/schemas/Waardetabel' - inOnderzoek: - $ref: '#/components/schemas/NationaliteitInOnderzoek' description: | * **redenOpname** : De reden op grond waarvan de persoon de nationaliteit gekregen heeft. - NationaliteitInOnderzoek: + allOf: + - $ref: '#/components/schemas/AbstractNationaliteit' + - type: object + properties: + datumIngangGeldigheid: + $ref: '#/components/schemas/AbstractDatum' + nationaliteit: + $ref: '#/components/schemas/Waardetabel' + inOnderzoek: + $ref: '#/components/schemas/NationaliteitInOnderzoek' + AbstractNationaliteit: + required: + - type type: object properties: - aanduidingBijzonderNederlanderschap: - type: boolean - nationaliteit: - type: boolean + type: + type: string redenOpname: - type: boolean - datumIngangOnderzoek: - $ref: '#/components/schemas/DatumOnvolledig' + $ref: '#/components/schemas/Waardetabel' + discriminator: + propertyName: type + mapping: + Nationaliteit: '#/components/schemas/Nationaliteit' + BehandeldAlsNederlander: '#/components/schemas/BehandeldAlsNederlander' + VastgesteldNietNederlander: '#/components/schemas/VastgesteldNietNederlander' + BehandeldAlsNederlander: + allOf: + - $ref: '#/components/schemas/AbstractNationaliteit' + - type: object + properties: + datumIngangGeldigheid: + $ref: '#/components/schemas/AbstractDatum' + inOnderzoek: + $ref: '#/components/schemas/BijzonderNederlanderschapInOnderzoek' + BijzonderNederlanderschapInOnderzoek: + allOf: + - $ref: '#/components/schemas/InOnderzoek' + - type: object + properties: + type: + type: boolean + redenOpname: + type: boolean + VastgesteldNietNederlander: + allOf: + - $ref: '#/components/schemas/AbstractNationaliteit' + - type: object + properties: + datumIngangGeldigheid: + $ref: '#/components/schemas/AbstractDatum' + inOnderzoek: + $ref: '#/components/schemas/BijzonderNederlanderschapInOnderzoek' + NationaliteitInOnderzoek: description: | Geeft aan welke gegevens over de nationaliteit in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - OpschortingBijhoudingBasis: - type: object - properties: - reden: - $ref: '#/components/schemas/Waardetabel' + allOf: + - $ref: '#/components/schemas/InOnderzoek' + - type: object + properties: + nationaliteit: + type: boolean + redenOpname: + type: boolean + Geboorte: + description: | + Gegevens over de geboorte. + * **datum** : datum waarop de persoon is geboren. + * **land** : land waar de persoon is geboren + * **plaats** : gemeente waar de persoon is geboren. Is de persoon geboren buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding. + allOf: + - $ref: '#/components/schemas/GeboorteBeperkt' + - type: object + properties: + land: + $ref: '#/components/schemas/Waardetabel' + plaats: + $ref: '#/components/schemas/Waardetabel' + inOnderzoek: + $ref: '#/components/schemas/GeboorteInOnderzoek' + GeboorteInOnderzoek: + allOf: + - $ref: '#/components/schemas/InOnderzoek' + - type: object + properties: + datum: + type: boolean + land: + type: boolean + plaats: + type: boolean OpschortingBijhouding: allOf: - $ref: '#/components/schemas/OpschortingBijhoudingBasis' - type: object properties: datum: - $ref: '#/components/schemas/DatumOnvolledig' + $ref: '#/components/schemas/AbstractDatum' description: | * **datum**: de datum waarop de bijhouding van de persoonsgegevens is gestaakt. - OverlijdenBasis: - type: object - properties: - indicatieOverleden: - type: boolean - description: | - Geeft aan dat iemand is overleden (waarde true), ongeacht of de overlijdensdatum bekend is. + Overlijden: description: | Gegevens over het overlijden van de persoon. - Overlijden: + * **datum** : datum waarop de persoon is overleden. + * **land** : land waar de persoon is overleden. + * **plaats** : gemeente waar de persoon is overleden. Is de persoon overleden buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding. allOf: - $ref: '#/components/schemas/OverlijdenBasis' - type: object properties: datum: - $ref: '#/components/schemas/DatumOnvolledig' + $ref: '#/components/schemas/AbstractDatum' land: $ref: '#/components/schemas/Waardetabel' plaats: $ref: '#/components/schemas/Waardetabel' inOnderzoek: $ref: '#/components/schemas/OverlijdenInOnderzoek' - description: | - Gegevens over het overlijden van de persoon. - * **datum** : datum waarop de persoon is overleden. - * **land** : land waar de persoon is overleden. - * **plaats** : gemeente waar de persoon is overleden. Is de persoon overleden buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding. OverlijdenInOnderzoek: - type: object - properties: - datum: - type: boolean - land: - type: boolean - plaats: - type: boolean - datumIngangOnderzoek: - $ref: '#/components/schemas/DatumOnvolledig' description: | - Geeft aan welke gegevens over het overlijden van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - KindInOnderzoek: - type: object - properties: - burgerservicenummer: - type: boolean - datumIngangOnderzoek: - $ref: '#/components/schemas/DatumOnvolledig' - description: | - Geeft aan of de gegevens over het kind van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - PartnerInOnderzoek: - type: object - properties: - burgerservicenummer: - type: boolean - geslachtsaanduiding: - type: boolean - soortVerbintenis: - type: boolean - datumIngangOnderzoek: - $ref: '#/components/schemas/DatumOnvolledig' - description: | - Geeft aan welke gegevens over het huwelijk of het partnerschap in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - AangaanHuwelijkPartnerschap: - type: object - properties: - datum: - $ref: '#/components/schemas/DatumOnvolledig' - land: - $ref: '#/components/schemas/Waardetabel' - plaats: - $ref: '#/components/schemas/Waardetabel' - inOnderzoek: - $ref: '#/components/schemas/AangaanHuwelijkPartnerschapInOnderzoek' - description: | - Gegevens over de voltrekking van het huwelijk of het aangaan van het geregistreerd partnerschap. - * **datum** : De datum waarop het huwelijk is voltrokken of het partnerschap is aangegaan. - * **land** : Het land waar het huwelijk is voltrokken of het partnerschap is aangegaan. - * **plaats** : De gemeente waar het huwelijk is voltrokken of het partnerschap is aangegaan. Voor een plaats buiten Nederland bevat het antwoord een buitenlandse plaatsnaam of aanduiding. - AangaanHuwelijkPartnerschapInOnderzoek: - type: object - properties: - datum: - type: boolean - land: - type: boolean - plaats: - type: boolean - datumIngangOnderzoek: - $ref: '#/components/schemas/DatumOnvolledig' - description: | - Geeft aan welke gegevens over het voltrekken van het huwelijk of aangaan van het partnerschap in onderzoek zijn. Zie de functionele specificaties. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - VerblijfplaatsBeperkt: - type: object - properties: - functieAdres: - $ref: '#/components/schemas/Waardetabel' - adresregel1: - type: string - description: | - Het eerste deel van een adres is een combinatie van de straat en huisnummer. - example: Laan van de landinrichtingscommissie Duiven-Westervoort 26A-3 - adresregel2: - type: string - description: | - Het tweede deel van een adres is een combinatie van woonplaats eventueel in combinatie met de postcode. - example: 1234AA Nootdorp - adresregel3: - type: string - description: | - Het derde deel van een adres is optioneel. Het gaat om een of meer geografische gebieden van het adres in het buitenland. - example: Selangor - woonplaats: - title: woonplaats naam - type: string - description: Een woonplaats is een gedeelte van het grondgebied van de gemeente - met een naam. - example: Duiven - land: - $ref: '#/components/schemas/Waardetabel' - vertrokkenOnbekendWaarheen: - type: boolean - description: | - Indicatie dat de ingeschreven persoon is vertrokken naar het buitenland, maar dat niet bekend is waar naartoe. - description: | - Gegevens over het verblijf of de woonlocatie van een persoon. - Verblijfplaats: + Geeft aan welke gegevens over het overlijden van de persoon in onderzoek zijn. + Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) allOf: - - $ref: '#/components/schemas/Adres' - - properties: - adresseerbaarObjectIdentificatie: - type: string - description: | - De verblijfplaats van de persoon kan een ligplaats, een standplaats of een verblijfsobject zijn. - example: "0226010000038820" - aanduidingBijHuisnummer: - $ref: '#/components/schemas/Waardetabel' - nummeraanduidingIdentificatie: - type: string - description: | - Unieke identificatie van een nummeraanduiding (en het bijbehorende adres) in de BAG. - example: "0518200000366054" - functieAdres: - $ref: '#/components/schemas/Waardetabel' - indicatieVestigingVanuitBuitenland: - type: boolean - description: | - Geeft aan dat de ingeschreven persoon zich vanuit het buitenland heeft ingeschreven. - locatiebeschrijving: - type: string - description: | - Omschrijving van de ligging van een verblijfsobject, standplaats of ligplaats. - example: Naast de derde brug - korteNaam: - type: string - description: | - De officiële openbareruimtenaam uit de Basisregistratie Gebouwen en Adressen (BAG) of een verkorte versie. - vanuitVertrokkenOnbekendWaarheen: + - $ref: '#/components/schemas/InOnderzoek' + - type: object + properties: + indicatieOverleden: type: boolean - description: | - Geeft aan dat de persoon is teruggekeerd uit een situatie van 'vertrokken onbekend waarheen.' - example: true - datumAanvangAdreshouding: - $ref: '#/components/schemas/DatumOnvolledig' - datumIngangGeldigheid: - $ref: '#/components/schemas/DatumOnvolledig' - datumInschrijvingInGemeente: - $ref: '#/components/schemas/DatumOnvolledig' - datumVestigingInNederland: - $ref: '#/components/schemas/DatumOnvolledig' - gemeenteVanInschrijving: - $ref: '#/components/schemas/Waardetabel' - landVanwaarIngeschreven: - $ref: '#/components/schemas/Waardetabel' - adresregel1: - type: string - description: | - Het eerste deel van een adres is een combinatie van de straat en huisnummer. - example: Laan van de landinrichtingscommissie Duiven-Westervoort 26A-3 - adresregel2: - type: string - description: | - Het tweede deel van een adres is een combinatie van woonplaats eventueel in combinatie met de postcode. - example: 1234AA Nootdorp - adresregel3: - type: string - description: | - Het derde deel van een adres is optioneel. Het gaat om een of meer geografische gebieden van het adres in het buitenland. - example: Selangor - vertrokkenOnbekendWaarheen: + datum: type: boolean - description: | - Indicatie dat de ingeschreven persoon is vertrokken naar het buitenland, maar dat niet bekend is waar naar toe. land: - $ref: '#/components/schemas/Waardetabel' - inOnderzoek: - $ref: '#/components/schemas/VerblijfplaatsInOnderzoek' - description: | - Gegevens over het verblijf of de woonlocatie van een persoon. - * **datumAanvangAdreshuishouding** : de datum van aangifte of ambtshalve melding van verblijf en adres. - * **datumIngangGeldigheid** : datum waarop de gegevens over de verblijfplaats geldig zijn geworden. - * **datumInschrijvingInGemeente**: bij inschrijving op grond van een verhuisaangifte door de burger is dit de aangiftedatum. Bij inschrijving op grond van een geboorteakte is dit de geboortedatum. Bij ambtshalve inschrijving is dit de datum waarop het voornemen van ambtshalve opneming schriftelijk aan de persoon is medegedeeld. - * **datumVestigingInNederland** : datum van inschrijving in Nederland. - * **landVanWaarIngeschreven** : het land waar de persoon woonde voor (her)vestiging in Nederland. - * **gemeenteVanInschrijving** : de gemeente waar de persoon verblijft en is ingeschreven. De code kan voorloopnullen bevatten." - VerblijfplaatsInOnderzoek: - type: object - properties: - aanduidingBijHuisnummer: - type: boolean - datumAanvangAdreshouding: - type: boolean - datumIngangGeldigheid: - type: boolean - datumInschrijvingInGemeente: - type: boolean - datumVestigingInNederland: - type: boolean - functieAdres: - type: boolean - gemeenteVanInschrijving: - type: boolean - huisletter: - type: boolean - huisnummer: - type: boolean - huisnummertoevoeging: - type: boolean - nummeraanduidingIdentificatie: - type: boolean - adresseerbaarObjectIdentificatie: - type: boolean - landVanwaarIngeschreven: - type: boolean - locatiebeschrijving: - type: boolean - straat: - type: boolean - postcode: - type: boolean - korteNaam: - type: boolean - verblijfBuitenland: - type: boolean - woonplaats: - type: boolean - datumIngangOnderzoek: - $ref: '#/components/schemas/DatumOnvolledig' - description: | - Geeft aan welke gegevens over het verblijf en adres van de persoon in onderzoek zijn. Elementen van het GBA-adres zelf (Dat zou eigenlijk een BAG-adres moeten zijn) kunnen niet in onderzoek zijn. Wel de relatie naar de nummeraanduiding. Dat wordt gedaan door de identificatiecodeNummeraanduiding in onderzoek te zetten. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + type: boolean + plaats: + type: boolean Gezagsverhouding: + allOf: + - $ref: '#/components/schemas/GezagsverhoudingBasis' + - type: object + properties: + inOnderzoek: + $ref: '#/components/schemas/GezagsverhoudingInOnderzoek' + GezagsverhoudingBasis: type: object properties: indicatieCurateleRegister: @@ -2485,30 +1493,28 @@ components: example: true indicatieGezagMinderjarige: $ref: '#/components/schemas/Waardetabel' - inOnderzoek: - $ref: '#/components/schemas/GezagsverhoudingInOnderzoek' description: | Gegevens over het gezag over de persoon. GezagsverhoudingInOnderzoek: - type: object - properties: - indicatieCurateleRegister: - type: boolean - indicatieGezagMinderjarige: - type: boolean - datumIngangOnderzoek: - $ref: '#/components/schemas/DatumOnvolledig' description: | Geeft aan welke gegevens van de gezagsverhouding in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: '#/components/schemas/InOnderzoek' + - type: object + properties: + indicatieCurateleRegister: + type: boolean + indicatieGezagMinderjarige: + type: boolean Verblijfstitel: type: object properties: aanduiding: $ref: '#/components/schemas/Waardetabel' datumEinde: - $ref: '#/components/schemas/DatumOnvolledig' + $ref: '#/components/schemas/AbstractDatum' datumIngang: - $ref: '#/components/schemas/DatumOnvolledig' + $ref: '#/components/schemas/AbstractDatum' inOnderzoek: $ref: '#/components/schemas/VerblijfstitelInOnderzoek' description: | @@ -2517,294 +1523,237 @@ components: * **datumIngang**: Datum waarop de gegevens over de verblijfstitel geldig zijn geworden. * **aanduiding** : Verblijfstiteltabel die aangeeft over welke verblijfsrechtelijke status de persoon beschikt. VerblijfstitelInOnderzoek: - type: object - properties: - aanduiding: - type: boolean - datumEinde: - type: boolean - datumIngang: - type: boolean - datumIngangOnderzoek: - $ref: '#/components/schemas/DatumOnvolledig' description: | Geeft aan welke gegevens over de verblijfstitel in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - IngeschrevenPersoonLinks: - type: object - properties: - self: - $ref: '#/components/schemas/HalLink' - ouders: - type: array - description: | - De ouders van de persoon. - items: - $ref: '#/components/schemas/HalLink' - reisdocumenten: - type: array - description: | - De reisdocumenten die aan de persoon zijn verstrekt. - items: - $ref: '#/components/schemas/HalLink' - kinderen: - type: array - description: | - De kinderen van de persoon. - items: - $ref: '#/components/schemas/HalLink' - partners: - type: array - description: | - De actuele bij de ingeschreven persoon geregistreerde huwelijken en geregistreerd partnerschappen. Een beëindigd huwelijk of geregistreerd partnerschap wordt niet teruggegeven. - items: - $ref: '#/components/schemas/HalLink' - partnerhistorie: - $ref: '#/components/schemas/HalLink' - verblijfplaatshistorie: - $ref: '#/components/schemas/HalLink' - verblijfstitelhistorie: - $ref: '#/components/schemas/HalLink' - nationaliteitHistorie: - $ref: '#/components/schemas/HalLink' - adres: - $ref: '#/components/schemas/HalLink' - OuderLinks: - type: object - properties: - self: - $ref: '#/components/schemas/HalLink' - ingeschrevenPersoon: - $ref: '#/components/schemas/HalLink' - deprecated: true - KindLinks: - type: object - properties: - self: - $ref: '#/components/schemas/HalLink' - ingeschrevenPersoon: - $ref: '#/components/schemas/HalLink' - deprecated: true - PartnerLinks: - type: object - properties: - self: - $ref: '#/components/schemas/HalLink' - ingeschrevenPersoon: - $ref: '#/components/schemas/HalLink' - deprecated: true - IngeschrevenPersoonEmbedded: - type: object - properties: - ouders: - type: array - description: | - De ouders van de persoon. - items: - $ref: '#/components/schemas/OuderHalBasis' - kinderen: - type: array - description: | - De kinderen van de persoon. - items: - $ref: '#/components/schemas/KindHalBasis' - partners: - type: array - description: | - De partners van de persoon. Een beëindigd huwelijk of geregistreerd partnerschap wordt niet teruggegeven. - items: - $ref: '#/components/schemas/PartnerHalBasis' - deprecated: true - AanduidingBijzonderNederlanderschap: - type: object - properties: - behandeldAlsNederlander: - type: boolean - vastgesteldNietNederlander: - type: boolean - Geboortedatum: - type: object - properties: - datum: - $ref: '#/components/schemas/DatumOnvolledig' - BadRequestFoutbericht: allOf: - - $ref: '#/components/schemas/Foutbericht' + - $ref: '#/components/schemas/InOnderzoek' - type: object properties: - invalidParams: - type: array - description: Foutmelding per fout in een parameter. Alle gevonden fouten - worden één keer teruggemeld. - items: - $ref: '#/components/schemas/InvalidParams' - Foutbericht: + aanduiding: + type: boolean + datumEinde: + type: boolean + datumIngang: + type: boolean + AbstractKind: + required: + - type type: object properties: type: type: string - description: Link naar meer informatie over deze fout - format: uri - title: - type: string - description: Beschrijving van de fout - status: - type: integer - description: Http status code - detail: - type: string - description: Details over de fout - instance: - type: string - description: Uri van de aanroep die de fout heeft veroorzaakt - format: uri - code: - minLength: 1 - type: string - description: Systeemcode die het type fout aangeeft - description: Terugmelding bij een fout. JSON representatie in lijn met [RFC7807](https://tools.ietf.org/html/rfc7807). - InvalidParams: + description: | + Gegevens over een kind van de persoon. + discriminator: + propertyName: type + mapping: + Kind: '#/components/schemas/Kind' + OnbekendKind: '#/components/schemas/OnbekendKind' + Kind: + allOf: + - $ref: '#/components/schemas/AbstractKind' + - type: object + properties: + burgerservicenummer: + $ref: '#/components/schemas/Burgerservicenummer' + leeftijd: + $ref: '#/components/schemas/Leeftijd' + inOnderzoek: + $ref: '#/components/schemas/KindInOnderzoek' + naam: + $ref: '#/components/schemas/NaamGerelateerde' + geboorte: + $ref: '#/components/schemas/Geboorte' + KindInOnderzoek: + description: | + Geeft aan of de gegevens over het kind van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: '#/components/schemas/InOnderzoek' + - type: object + properties: + burgerservicenummer: + type: boolean + leeftijd: + type: boolean + OnbekendKind: + allOf: + - $ref: '#/components/schemas/AbstractKind' + - type: object + properties: + indicatieOnbekend: + type: boolean + default: false + AbstractOuder: + required: + - type type: object properties: type: type: string - format: uri - example: https://www.vng.nl/realisatie/api/{major-versie}/validaties/integer - name: - type: string - description: Naam van de parameter - example: verblijfplaats__huisnummer - code: - minLength: 1 - type: string - description: Systeemcode die het type fout aangeeft - example: integer - reason: - type: string - description: Beschrijving van de fout op de parameterwaarde - example: Waarde is geen geldige integer. - description: Details over fouten in opgegeven parameters - Waardetabel: - type: object - properties: - code: - type: string - example: "6030" - omschrijving: - type: string - example: Nederland - HalLink: + description: | + Gegevens over de ouder van de persoon. + discriminator: + propertyName: type + mapping: + Ouder: '#/components/schemas/Ouder' + OnbekendOuder: '#/components/schemas/OnbekendOuder' + Ouder: + description: | + Gegevens over de ouder van de persoon. + * **datumIngangFamilierechtelijkeBetrekking** - De datum waarop de familierechtelijke betrekking is ontstaan. + * **geslachtsaanduiding** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'geslacht' uit de Haal-Centraal-BRP-tabellen-bevragen API. + * **ouderaanduiding** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'ouderAanduiding' uit de Haal-Centraal-BRP-tabellen-bevragen API. + allOf: + - $ref: '#/components/schemas/AbstractOuder' + - type: object + properties: + burgerservicenummer: + $ref: '#/components/schemas/Burgerservicenummer' + geslachtsaanduiding: + $ref: '#/components/schemas/Waardetabel' + ouderAanduiding: + $ref: '#/components/schemas/Waardetabel' + datumIngangFamilierechtelijkeBetrekking: + $ref: '#/components/schemas/AbstractDatum' + naam: + $ref: '#/components/schemas/NaamGerelateerde' + inOnderzoek: + $ref: '#/components/schemas/OuderInOnderzoek' + geboorte: + $ref: '#/components/schemas/Geboorte' + OuderInOnderzoek: + description: | + Geeft aan welke gegevens van de de ouder in onderzoek zijn. + Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: '#/components/schemas/InOnderzoek' + - type: object + properties: + burgerservicenummer: + type: boolean + datumIngangFamilierechtelijkeBetrekking: + type: boolean + geslachtsaanduiding: + type: boolean + OnbekendOuder: + allOf: + - $ref: '#/components/schemas/AbstractOuder' + - type: object + properties: + indicatieOnbekend: + type: boolean + default: false + AbstractPartner: required: - - href + - type type: object properties: - href: - $ref: '#/components/schemas/Href' - templated: - type: boolean - title: + type: type: string - description: Voor mens leesbaar label bij de link - description: De Link Object zoals gespecificeerd in https://tools.ietf.org/html/draft-kelly-json-hal-08#section-5; - Deze link kan als templated link worden aangeboden. [URI-templating is hier - beschreven](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/uri-templating.feature). - Href: - type: string - example: https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie} - DatumOnvolledig: + description: | + Gegevens over een gesloten huwelijk/geregistreerd partnerschap van de persoon. + discriminator: + propertyName: type + mapping: + Partner: '#/components/schemas/Partner' + OnbekendPartner: '#/components/schemas/OnbekendPartner' + Partner: + allOf: + - $ref: '#/components/schemas/AbstractPartner' + - type: object + properties: + burgerservicenummer: + $ref: '#/components/schemas/Burgerservicenummer' + geslachtsaanduiding: + $ref: '#/components/schemas/Waardetabel' + soortVerbintenis: + $ref: '#/components/schemas/Waardetabel' + naam: + $ref: '#/components/schemas/NaamGerelateerde' + geboorte: + $ref: '#/components/schemas/Geboorte' + inOnderzoek: + $ref: '#/components/schemas/PartnerInOnderzoek' + aangaanHuwelijkPartnerschap: + $ref: '#/components/schemas/AangaanHuwelijkPartnerschap' + PartnerInOnderzoek: + description: | + Geeft aan welke gegevens over het huwelijk of het partnerschap in onderzoek zijn. + Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: '#/components/schemas/InOnderzoek' + - type: object + properties: + burgerservicenummer: + type: boolean + geslachtsaanduiding: + type: boolean + soortVerbintenis: + type: boolean + AangaanHuwelijkPartnerschap: type: object properties: - dag: - maximum: 31 - minimum: 1 - type: integer - description: Als de dag van de datum bekend is wordt dit element gevuld, - ook als de volledige datum bekend is. - example: 3 datum: - type: string - description: Als de volledige datum bekend is wordt de datum gevuld die - in de date definitie past. - format: date - example: 1989-05-03 - jaar: - maximum: 9999 - type: integer - description: Als het jaar van de datum bekend is wordt dit element gevuld, - ook als de volledige datum bekend is. - example: 1989 - maand: - maximum: 12 - minimum: 1 - type: integer - description: Als de maand van een datum bekend is wordt dit element gevuld, - ook als de volledige datum bekend is. - example: 5 - description: Gegevens over de datums die mogelijk niet volledig zijn. - HalCollectionLinks: - type: object - properties: - self: - $ref: '#/components/schemas/HalLink' + $ref: '#/components/schemas/AbstractDatum' + land: + $ref: '#/components/schemas/Waardetabel' + plaats: + $ref: '#/components/schemas/Waardetabel' + inOnderzoek: + $ref: '#/components/schemas/AangaanHuwelijkPartnerschapInOnderzoek' description: | - HalCollectionLinks bevat de self link die elke HAL Resource minimaal moet hebben in zijn _links property - Adres: + Gegevens over de voltrekking van het huwelijk of het aangaan van het geregistreerd partnerschap. + * **datum** : De datum waarop het huwelijk is voltrokken of het partnerschap is aangegaan. + * **land** : Het land waar het huwelijk is voltrokken of het partnerschap is aangegaan. + * **plaats** : De gemeente waar het huwelijk is voltrokken of het partnerschap is aangegaan. Voor een plaats buiten Nederland bevat het antwoord een buitenlandse plaatsnaam of aanduiding. + AangaanHuwelijkPartnerschapInOnderzoek: + description: | + Geeft aan welke gegevens over het voltrekken van het huwelijk of aangaan van het partnerschap in onderzoek zijn. + Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: '#/components/schemas/InOnderzoek' + - type: object + properties: + datum: + type: boolean + land: + type: boolean + plaats: + type: boolean + OnbekendPartner: + allOf: + - $ref: '#/components/schemas/AbstractPartner' + - type: object + properties: + indicatieOnbekend: + type: boolean + default: false + NaamGerelateerde: type: object properties: - straat: - title: openbareruimte naam - type: string - description: Een naam die door de gemeente aan een openbare ruimte is gegeven. - example: Laan van de landinrichtingscommissie Duiven-Westervoort - huisnummer: - type: integer - description: Een nummer dat door de gemeente aan een adresseerbaar object - is gegeven. - example: 1 - huisletter: - type: string - description: Een toevoeging aan een huisnummer in de vorm van een letter - die door de gemeente aan een adresseerbaar object is gegeven. - example: A - huisnummertoevoeging: - type: string - description: Een toevoeging aan een huisnummer of een combinatie van huisnummer - en huisletter die door de gemeente aan een adresseerbaar object is gegeven. - example: bis - postcode: - type: string - description: De door PostNL vastgestelde code die bij een bepaalde combinatie - van een straatnaam en een huisnummer hoort. - example: 6922KZ - woonplaats: - title: woonplaats naam - type: string - description: Een woonplaats is een gedeelte van het grondgebied van de gemeente - met een naam. - example: Duiven - description: 'Eigenschappen van het adres die kunnen worden hergebruikt in andere - API''s waarin adresgegevens worden opgenomen. ' - parameters: - burgerservicenummer: - name: burgerservicenummer - in: path - description: | - Uniek persoonsnummer - required: true - style: simple - explode: false - schema: - pattern: ^[0-9]{9}$ - type: string - example: "555555021" + voornamen: + $ref: '#/components/schemas/Voornamen' + adellijkeTitelPredicaat: + $ref: '#/components/schemas/AdellijkeTitelPredicaatType' + voorvoegsel: + $ref: '#/components/schemas/Voorvoegsel' + geslachtsnaam: + $ref: '#/components/schemas/Geslachtsnaam' + voorletters: + $ref: '#/components/schemas/Voorletters' + inOnderzoek: + $ref: '#/components/schemas/NaamInOnderzoek' headers: api_version: schema: + pattern: ^[1-9][0-9]{0,2}.[0-9]{1,3}.[0-9]{1,3}$ type: string description: Geeft een specifieke API-versie aan in de context van een specifieke aanroep. example: 1.0.0 warning: schema: + maxLength: 500 type: string description: zie RFC 7234. In het geval een major versie wordt uitgefaseerd, gebruiken we warn-code 299 ("Miscellaneous Persistent Warning") en het API @@ -2813,3 +1762,12 @@ components: example: '299 https://service.../api/.../v1 "Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1".' + X_Rate_Limit_Limit: + schema: + type: integer + X_Rate_Limit_Remaining: + schema: + type: integer + X_Rate_Limit_Reset: + schema: + type: integer diff --git a/specificatie/gezagsverhouding.yaml b/specificatie/gezagsverhouding.yaml new file mode 100644 index 000000000..04dffd195 --- /dev/null +++ b/specificatie/gezagsverhouding.yaml @@ -0,0 +1,45 @@ +openapi: 3.0.3 +info: + title: Gezagsverhouding definities + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + GezagsverhoudingBasis: + type: object + description: | + Gegevens over het gezag over de persoon. + properties: + indicatieCurateleRegister: + type: boolean + description: | + Geeft aan dat de persoon onder curatele is gesteld. + example: true + indicatieGezagMinderjarige: + $ref: 'common.yaml#/components/schemas/Waardetabel' + GbaGezagsverhouding: + allOf: + - $ref: '#/components/schemas/GezagsverhoudingBasis' + - type: object + properties: + inOnderzoek: + $ref: 'gba-inonderzoek.yaml#/components/schemas/GbaInOnderzoek' + Gezagsverhouding: + allOf: + - $ref: '#/components/schemas/GezagsverhoudingBasis' + - type: object + properties: + inOnderzoek: + $ref: '#/components/schemas/GezagsverhoudingInOnderzoek' + GezagsverhoudingInOnderzoek: + description: | + Geeft aan welke gegevens van de gezagsverhouding in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + indicatieCurateleRegister: + type: boolean + indicatieGezagMinderjarige: + type: boolean diff --git a/specificatie/kiesrecht.yaml b/specificatie/kiesrecht.yaml new file mode 100644 index 000000000..4f64f3600 --- /dev/null +++ b/specificatie/kiesrecht.yaml @@ -0,0 +1,38 @@ +openapi: 3.0.3 +info: + title: Kiesrecht definities + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + GbaKiesrecht: + type: object + properties: + europeesKiesrecht: + type: boolean + description: | + Geeft aan of persoon een oproep moet ontvangen voor verkiezingen voor het Europees parlement. + example: true + uitgeslotenVanKiesrecht: + type: boolean + example: true + einddatumUitsluitingEuropeesKiesrecht: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + einddatumUitsluitingKiesrecht: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + Kiesrecht: + type: object + properties: + europeesKiesrecht: + type: boolean + description: | + Geeft aan of persoon een oproep moet ontvangen voor verkiezingen voor het Europees parlement. + example: true + uitgeslotenVanKiesrecht: + type: boolean + example: true + einddatumUitsluitingEuropeesKiesrecht: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + einddatumUitsluitingKiesrecht: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' diff --git a/specificatie/kind.yaml b/specificatie/kind.yaml new file mode 100644 index 000000000..bca71c817 --- /dev/null +++ b/specificatie/kind.yaml @@ -0,0 +1,67 @@ +openapi: 3.0.3 +info: + title: Kind definities + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + GbaKind: + type: object + properties: + burgerservicenummer: + $ref: 'persoon.yaml#/components/schemas/Burgerservicenummer' + inOnderzoek: + $ref: 'gba-inonderzoek.yaml#/components/schemas/GbaInOnderzoek' + naam: + $ref: 'naam.yaml#/components/schemas/GbaNaamBasis' + geboorte: + $ref: 'geboorte.yaml#/components/schemas/GbaGeboorte' + AbstractKind: + type: object + description: | + Gegevens over een kind van de persoon. + required: + - type + properties: + type: + type: string + discriminator: + propertyName: type + mapping: + Kind: '#/components/schemas/Kind' + OnbekendKind: '#/components/schemas/OnbekendKind' + Kind: + allOf: + - $ref: '#/components/schemas/AbstractKind' + - type: object + properties: + burgerservicenummer: + $ref: 'persoon.yaml#/components/schemas/Burgerservicenummer' + leeftijd: + $ref: 'persoon.yaml#/components/schemas/Leeftijd' + inOnderzoek: + $ref: '#/components/schemas/KindInOnderzoek' + naam: + $ref: 'naam.yaml#/components/schemas/NaamGerelateerde' + geboorte: + $ref: 'geboorte.yaml#/components/schemas/Geboorte' + OnbekendKind: + allOf: + - $ref: '#/components/schemas/AbstractKind' + - type: object + properties: + indicatieOnbekend: + type: boolean + default: false + KindInOnderzoek: + description: | + Geeft aan of de gegevens over het kind van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + burgerservicenummer: + type: boolean + leeftijd: + type: boolean diff --git a/specificatie/naam.yaml b/specificatie/naam.yaml new file mode 100644 index 000000000..0dc83b549 --- /dev/null +++ b/specificatie/naam.yaml @@ -0,0 +1,173 @@ +openapi: 3.0.3 +info: + title: Naam definities + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + Aanhef: + type: string + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,650}$ + description: | + Kun je gebruiken als aanhef in een brief gericht aan persoon. + example: "Hoogwelgeboren heer" + Aanschrijfwijze: + type: object + description: | + Samengestelde naam en aanspreekvorm die je kunt gebruiken in de communicatie met de persoon. + properties: + naam: + type: string + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,650}$ + example: "H.W. baron van den Aedel" + aanspreekvorm: + description: | + Deze regel moet als aparte regel boven de samengestelde naam worden geplaatst. Komt alleen voor bij personen met een adellijke titel of predicaat. + type: string + pattern: ^[a-zA-Z ]{1,25}$ + example: "De hoogwelgeboren heer" + GebruikInLopendeTekst: + type: string + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,650}$ + description: | + Naam van persoon die je kunt gebruiken als je in lopende tekst (bijvoorbeeld in een brief) aan persoon refereert. + example: "baron Van den Aedel" + Geslachtsnaam: + type: string + maxLength: 200 + description: | + De achternaam van een persoon. + example: "Vries" + VolledigeNaam: + type: string + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,450}$ + description: | + Combinatie van predicaat, voornamen, adellijke titel, voorvoegsels en geslachtsnaam, zonder toevoeging van een eventuele partnernaam. + example: "Pieter Jan de Vries" + Voorletters: + type: string + pattern: ^[a-zA-Z0-9À-ž \.]{1,40}$ + description: | + De voorletters van de persoon, afgeleid van de voornamen. + example: "P.J." + Voornamen: + type: string + pattern: ^[a-zA-Z0-9À-ž \.\-\']{1,200}$ + maxLength: 200 + description: | + De verzameling namen voor de geslachtsnaam, gescheiden door spaties. + Voorvoegsel: + type: string + pattern: ^[a-zA-Z \']{1,10}$ + maxLength: 10 + example: "de" + AdellijkeTitelPredicaatSoort: + type: string + enum: + - titel + - predicaat + AdellijkeTitelPredicaatType: + allOf: + - $ref: 'common.yaml#/components/schemas/Waardetabel' + - properties: + soort: + $ref: '#/components/schemas/AdellijkeTitelPredicaatSoort' + example: + value: + code: "JV" + omschrijving: "jonkvrouw" + soort: "predicaat" + GbaNaamBasis: + type: object + properties: + voornamen: + $ref: '#/components/schemas/Voornamen' + adellijkeTitelPredicaat: + $ref: '#/components/schemas/AdellijkeTitelPredicaatType' + voorvoegsel: + $ref: '#/components/schemas/Voorvoegsel' + geslachtsnaam: + $ref: '#/components/schemas/Geslachtsnaam' + GbaNaamPersoon: + allOf: + - $ref: '#/components/schemas/GbaNaamBasis' + - properties: + aanduidingNaamgebruik: + $ref: 'common.yaml#/components/schemas/Waardetabel' + NaamBasis: + type: object + properties: + voornamen: + $ref: '#/components/schemas/Voornamen' + adellijkeTitelPredicaat: + $ref: '#/components/schemas/AdellijkeTitelPredicaatType' + voorvoegsel: + $ref: '#/components/schemas/Voorvoegsel' + geslachtsnaam: + $ref: '#/components/schemas/Geslachtsnaam' + voorletters: + $ref: '#/components/schemas/Voorletters' + volledigeNaam: + $ref: '#/components/schemas/VolledigeNaam' + NaamGerelateerde: + type: object + properties: + voornamen: + $ref: '#/components/schemas/Voornamen' + adellijkeTitelPredicaat: + $ref: '#/components/schemas/AdellijkeTitelPredicaatType' + voorvoegsel: + $ref: '#/components/schemas/Voorvoegsel' + geslachtsnaam: + $ref: '#/components/schemas/Geslachtsnaam' + voorletters: + $ref: '#/components/schemas/Voorletters' + inOnderzoek: + $ref: '#/components/schemas/NaamInOnderzoek' + NaamInOnderzoek: + description: | + Geeft aan welke gegevens over de naam in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + voornamen: + type: boolean + adellijkeTitelPredicaat: + type: boolean + voorvoegsel: + type: boolean + geslachtsnaam: + type: boolean + voorletters: + type: boolean + NaamPersoon: + allOf: + - $ref: '#/components/schemas/NaamBasis' + - properties: + aanduidingNaamgebruik: + $ref: 'common.yaml#/components/schemas/Waardetabel' + aanhef: + $ref: '#/components/schemas/Aanhef' + aanschrijfwijze: + $ref: '#/components/schemas/Aanschrijfwijze' + gebruikInLopendeTekst: + $ref: '#/components/schemas/GebruikInLopendeTekst' + inOnderzoek: + $ref: '#/components/schemas/NaamPersoonInOnderzoek' + NaamPersoonInOnderzoek: + allOf: + - $ref: '#/components/schemas/NaamInOnderzoek' + - type: object + properties: + volledigeNaam: + type: boolean + aanduidingNaamgebruik: + type: boolean + aanhef: + type: boolean + aanschrijfwijze: + type: boolean + gebruikInLopendeTekst: + type: boolean diff --git a/specificatie/nationaliteit.yaml b/specificatie/nationaliteit.yaml new file mode 100644 index 000000000..64d9aecff --- /dev/null +++ b/specificatie/nationaliteit.yaml @@ -0,0 +1,90 @@ +openapi: 3.0.3 +info: + title: Nationaliteit definities + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + AbstractNationaliteit: + type: object + required: + - type + properties: + type: + type: string + redenOpname: + $ref: 'common.yaml#/components/schemas/Waardetabel' + discriminator: + propertyName: type + mapping: + Nationaliteit: '#/components/schemas/Nationaliteit' + BehandeldAlsNederlander: '#/components/schemas/BehandeldAlsNederlander' + VastgesteldNietNederlander: '#/components/schemas/VastgesteldNietNederlander' + Nationaliteit: + description: | + * **redenOpname** : De reden op grond waarvan de persoon de nationaliteit gekregen heeft. + allOf: + - $ref: '#/components/schemas/AbstractNationaliteit' + - type: object + properties: + datumIngangGeldigheid: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + nationaliteit: + $ref: 'common.yaml#/components/schemas/Waardetabel' + inOnderzoek: + $ref: '#/components/schemas/NationaliteitInOnderzoek' + BehandeldAlsNederlander: + allOf: + - $ref: '#/components/schemas/AbstractNationaliteit' + - type: object + properties: + datumIngangGeldigheid: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + inOnderzoek: + $ref: '#/components/schemas/BijzonderNederlanderschapInOnderzoek' + VastgesteldNietNederlander: + allOf: + - $ref: '#/components/schemas/AbstractNationaliteit' + - type: object + properties: + datumIngangGeldigheid: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + inOnderzoek: + $ref: '#/components/schemas/BijzonderNederlanderschapInOnderzoek' + GbaNationaliteit: + description: | + Bij de LO GBA versie kunnen datums, bijv datumIngangGeldigheid de LoGbaDatum refereren + Het hoeft niet van AbstractDatum af te leiden omdat het nooit een andere type kan zijn + type: object + properties: + aanduidingBijzonderNederlandschap: + $ref: 'common.yaml#/components/schemas/Waardetabel' + datumIngangGeldigheid: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + nationaliteit: + $ref: 'common.yaml#/components/schemas/Waardetabel' + redenOpname: + $ref: 'common.yaml#/components/schemas/Waardetabel' + inOnderzoek: + $ref: 'gba-inonderzoek.yaml#/components/schemas/GbaInOnderzoek' + BijzonderNederlanderschapInOnderzoek: + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + type: + type: boolean + redenOpname: + type: boolean + NationaliteitInOnderzoek: + description: | + Geeft aan welke gegevens over de nationaliteit in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + nationaliteit: + type: boolean + redenOpname: + type: boolean diff --git a/specificatie/openapi.yaml b/specificatie/openapi.yaml index dac5c09f5..5ba3c1d9a 100644 --- a/specificatie/openapi.yaml +++ b/specificatie/openapi.yaml @@ -1,4 +1,4 @@ -openapi: 3.0.0 +openapi: 3.0.3 servers: - description: | APILAB testserver @@ -11,7 +11,7 @@ info: Gegevens die er niet zijn of niet actueel zijn krijg je niet terug. Heeft een persoon bijvoorbeeld geen geldige nationaliteit, en alleen een beëindigd partnerschap, dan krijg je geen gegevens over nationaliteit en partner. Zie de [Functionele documentatie](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/tree/v1.1.0/features) voor nadere toelichting. - version: "1.3.1" + version: 2.0.0 contact: url: https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen license: @@ -19,1457 +19,7 @@ info: url: https://eupl.eu/1.2/nl/ tags: - name: Personen - description: Zoeken en raadplegen van personen + description: Zoeken personen paths: /personen: - get: - operationId: GetPersonen - summary: Vindt personen - description: | - Zoek personen met één van de onderstaande verplichte combinaties van parameters en vul ze evt. aan met parameters uit de andere combinaties. - - - Default krijg je personen terug die nog in leven zijn, tenzij je de inclusiefoverledenpersonen=true opgeeft. - - - Gebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/fields_extensie.feature) - - - 1. Persoon - - geboorte__datum - - naam__geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature) - - - 2. Persoon - - verblijfplaats__gemeenteVanInschrijving - - naam__geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature) - - - 3. Persoon - - burgerservicenummer - - - 4. Postcode - - verblijfplaats__postcode - - verblijfplaats__huisnummer - - - 5. Straat - - verblijfplaats__straat (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature) ) - - verblijfplaats__gemeenteVanInschrijving - - verblijfplaats__huisnummer - - - 6. Adres - - verblijfplaats__nummeraanduidingIdentificatie - - parameters: - - name: expand - deprecated: true - in: query - required: false - description: "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature)." - schema: - type: string - - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/parameters/fields" - - in: query - name: burgerservicenummer - required: false - description: | - Uniek persoonsnummer. - explode: false - example: ["999993653","999991723","999995078"] - schema: - type: array - items: - type: string - pattern: "^[0-9]{9}$" - - in: query - name: geboorte__datum - description: | - Je kunt alleen zoeken met een volledig geboortedatum. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/parametervalidatie.feature) - required: false - schema: - type: string - format: date - example: "1964-09-24" - - in: query - name: geboorte__plaats - description: | - Gemeentenaam of een buitenlandse plaats of een plaatsbepaling, die aangeeft waar de persoon is geboren. **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).** - required: false - schema: - type: string - maxLength: 40 - example: "Utrecht" - - in: query - name: geslachtsaanduiding - description: | - Geeft aan wat het geslacht is van persoon. - required: false - schema: - type: "string" - example: "V" - - in: query - name: inclusiefOverledenPersonen - description: | - Als je ook overleden personen in het antwoord wilt, geef dan de parameter inclusiefOverledenPersonen op met waarde True. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/overleden_personen.feature) - required: false - schema: - type: boolean - example: true - - in: query - name: naam__geslachtsnaam - description: | - De (geslachts)naam waarvan de eventueel aanwezige voorvoegsels zijn afgesplitst. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).** - required: false - schema: - type: string - maxLength: 200 - example: "Vries" - - in: query - name: naam__voorvoegsel - description: | - Deel van de geslachtsnaam dat vooraf gaat aan de rest van de geslachtsnaam. Het zoeken op het voorvoegsel is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).** - required: false - schema: - type: string - maxLength: 10 - example: "de" - - in: query - name: naam__voornamen - description: | - De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).** - required: false - schema: - type: string - maxLength: 200 - example: "Dirk" - - in: query - name: verblijfplaats__gemeenteVanInschrijving - description: | - Een code die aangeeft in welke gemeente de persoon woont, of de laatste gemeente waar de persoon heeft gewoond, of de gemeente waar de persoon voor het eerst is ingeschreven. - required: false - schema: - type: string - maxLength: 4 - example: "0518" - - in: query - name: verblijfplaats__huisletter - description: | - Een toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven. - required: false - schema: - type: string - maxLength: 1 - example: "a" - - in: query - name: verblijfplaats__huisnummer - description: | - Een nummer dat door de gemeente aan een adresseerbaar object is gegeven. - required: false - schema: - type: integer - maximum: 99999 - example: 14 - - in: query - name: verblijfplaats__huisnummertoevoeging - description: | - Een toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven. - required: false - schema: - type: string - maxLength: 4 - example: "bis" - - in: query - name: verblijfplaats__nummeraanduidingIdentificatie - description: | - Unieke identificatie van een nummeraanduiding (en het bijbehorende adres) in de BAG. - required: false - schema: - type: string - maxLength: 16 - example: "0518200000366054" - - in: query - name: verblijfplaats__straat - description: | - Een naam die door de gemeente aan een openbare ruimte is gegeven. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature). - required: false - schema: - type: string - maxLength: 80 - example: "Tulpstraat" - - in: query - name: verblijfplaats__postcode - description: | - De door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort. - required: false - schema: - type: string - pattern: ^[1-9]{1}[0-9]{3}[A-Z]{2}$ - example: "2341SX" - responses: - '200': - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/api_version" - warning: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/warning" - content: - application/hal+json: - schema: - $ref: '#/components/schemas/PersoonHalCollectie' - '400': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/400" - '401': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/401" - '403': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/403" - '406': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/406" - '500': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/500" - '501': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/501" - '503': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/503" - 'default': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/default" - tags: - - Personen - /personen/{burgerservicenummer}: - get: - operationId: GetPersoon - summary: Raadpleeg een persoon - description: | - Raadpleeg een (overleden) persoon. - - Gebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/fields_extensie.feature). - - parameters: - - $ref: '#/components/parameters/burgerservicenummer' - - name: expand - deprecated: true - in: query - required: false - description: "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature)." - schema: - type: string - - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/parameters/fields" - responses: - '200': - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/api_version" - warning: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/warning" - content: - application/hal+json: - schema: - $ref: '#/components/schemas/PersoonHal' - '400': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/400" - '401': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/401" - '403': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/403" - '404': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/404" - '406': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/406" - '500': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/500" - '501': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/501" - '503': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/503" - 'default': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/default" - tags: - - Personen - /personen/{burgerservicenummer}/kinderen/{id}: - get: - deprecated: true - operationId: GetKind - summary: "Raadpleeg een kind van een persoon" - description: | - Raadpleeg een kind van een persoon - parameters: - - $ref: '#/components/parameters/burgerservicenummer' - - in: path - name: id - description: | - De identificatie van het kind. - required: true - schema: - type: string - responses: - '200': - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/api_version" - warning: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/warning" - content: - application/hal+json: - schema: - $ref: '#/components/schemas/KindHalBasis' - '400': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/400" - '401': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/401" - '403': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/403" - '404': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/404" - '406': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/406" - '500': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/500" - '501': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/501" - '503': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/503" - 'default': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/default" - tags: - - Personen - /personen/{burgerservicenummer}/kinderen: - get: - deprecated: true - operationId: GetKinderen - summary: "Levert de kinderen van een persoon" - description: | - Levert de kinderen van een persoon - parameters: - - $ref: '#/components/parameters/burgerservicenummer' - responses: - '200': - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/api_version" - warning: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/warning" - content: - application/hal+json: - schema: - $ref: '#/components/schemas/KindHalCollectie' - '400': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/400" - '401': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/401" - '403': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/403" - '404': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/404" - '406': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/406" - '500': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/500" - '501': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/501" - '503': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/503" - 'default': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/default" - tags: - - Personen - /personen/{burgerservicenummer}/ouders/{id}: - get: - deprecated: true - operationId: GetOuder - summary: "Raadpleeg een ouder van een persoon" - description: | - Raadpleeg een ouder van een persoon - parameters: - - $ref: '#/components/parameters/burgerservicenummer' - - in: path - name: id - description: | - De identificatie van de ouder. - required: true - schema: - type: string - responses: - '200': - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/api_version" - warning: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/warning" - content: - application/hal+json: - schema: - $ref: '#/components/schemas/OuderHalBasis' - '400': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/400" - '401': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/401" - '403': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/403" - '404': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/404" - '406': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/406" - '500': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/500" - '501': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/501" - '503': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/503" - 'default': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/default" - tags: - - Personen - /personen/{burgerservicenummer}/ouders: - get: - deprecated: true - operationId: GetOuders - summary: "Levert de ouders van een persoon" - description: | - Levert de ouders van een persoon - parameters: - - $ref: '#/components/parameters/burgerservicenummer' - responses: - '200': - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/api_version" - warning: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/warning" - content: - application/hal+json: - schema: - $ref: '#/components/schemas/OuderHalCollectie' - '400': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/400" - '401': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/401" - '403': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/404" - '404': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/403" - '406': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/406" - '500': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/500" - '501': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/501" - '503': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/503" - 'default': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/default" - tags: - - Personen - /personen/{burgerservicenummer}/partners/{id}: - get: - deprecated: true - operationId: GetPartner - summary: "Raadpleeg de partner van een persoon" - description: | - Raadpleeg de partner van een persoon - parameters: - - $ref: '#/components/parameters/burgerservicenummer' - - in: path - name: id - description: | - De identificatie van de partner. - required: true - schema: - type: string - responses: - '200': - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/api_version" - warning: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/warning" - content: - application/hal+json: - schema: - $ref: '#/components/schemas/PartnerHalBasis' - '400': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/400" - '401': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/401" - '403': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/403" - '404': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/404" - '406': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/406" - '500': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/500" - '501': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/501" - '503': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/503" - 'default': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/default" - tags: - - Personen - /personen/{burgerservicenummer}/partners: - get: - deprecated: true - operationId: GetPartners - summary: "Levert de actuele partners van een persoon" - description: | - Levert de actuele partners van een persoon. Partners uit beëindigde huwelijken of partnerschappen worden niet geretourneerd - parameters: - - $ref: '#/components/parameters/burgerservicenummer' - responses: - '200': - description: | - Zoekactie geslaagd - headers: - api-version: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/api_version" - warning: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/headers/warning" - content: - application/hal+json: - schema: - $ref: '#/components/schemas/PartnerHalCollectie' - '400': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/400" - '401': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/401" - '403': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/403" - '404': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/404" - '406': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/406" - '500': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/500" - '501': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/501" - '503': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/503" - 'default': - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/responses/default" - tags: - - Personen -components: - parameters: - burgerservicenummer: - name: burgerservicenummer - in: path - description: | - Uniek persoonsnummer - required: true - schema: - type: "string" - pattern: "^[0-9]{9}$" - example: "555555021" - schemas: - Reisdocumentnummer: - type: "string" - description: | - Het nummer van het verstrekte Nederlandse reisdocument. - example: "546376728" - PersoonBasis: - type: "object" - description: | - * **geslachtsaanduiding** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'geslacht' uit de Haal-Centraal-BRP-tabellen-bevragen API. - properties: - burgerservicenummer: - type: "string" - example: "555555021" - geheimhoudingPersoonsgegevens: - type: boolean - title: "Indicatie geheim" - description: | - Gegevens mogen niet worden verstrekt aan derden / maatschappelijke instellingen. - geslachtsaanduiding: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - leeftijd: - type: integer - description: | - Leeftijd in jaren op het moment van bevragen. - example: 34 - PersoonBeperkt: - allOf: - - $ref: "#/components/schemas/PersoonBasis" - - type: "object" - properties: - naam: - $ref: "#/components/schemas/NaamBasis" - geboorte: - $ref: "#/components/schemas/Geboortedatum" - opschortingBijhouding: - $ref: "#/components/schemas/OpschortingBijhoudingBasis" - overlijden: - $ref: "#/components/schemas/OverlijdenBasis" - verblijfplaats: - $ref: "#/components/schemas/VerblijfplaatsBeperkt" - PersoonBeperktLinks: - type: "object" - properties: - self: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - PersoonBeperktHal: - allOf: - - $ref: '#/components/schemas/PersoonBeperkt' - - properties: - _links: - $ref: "#/components/schemas/PersoonBeperktLinks" - Persoon: - allOf: - - $ref: "#/components/schemas/IPersoonBasis" - - type: "object" - properties: - aNummer: - description: | - Het A-nummer van de persoon - type: "string" - datumEersteInschrijvingGBA: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - inOnderzoek: - $ref: "#/components/schemas/PersoonInOnderzoek" - kiesrecht: - $ref: "#/components/schemas/Kiesrecht" - naam: - $ref: "#/components/schemas/NaamPersoon" - nationaliteiten: - type: "array" - items: - $ref: "#/components/schemas/Nationaliteit" - geboorte: - $ref: "#/components/schemas/Geboorte" - opschortingBijhouding: - $ref: "#/components/schemas/OpschortingBijhouding" - overlijden: - $ref: "#/components/schemas/Overlijden" - verblijfplaats: - $ref: "#/components/schemas/Verblijfplaats" - gezagsverhouding: - $ref: "#/components/schemas/Gezagsverhouding" - verblijfstitel: - $ref: "#/components/schemas/Verblijfstitel" - reisdocumentnummers: - type: "array" - items: - $ref: "#/components/schemas/Reisdocumentnummer" - kinderen: - type: "array" - items: - $ref: "#/components/schemas/Kind" - ouders: - type: "array" - items: - $ref: "#/components/schemas/Ouder" - partners: - type: "array" - items: - $ref: "#/components/schemas/Partner" - PersoonHalCollectie: - type: object - properties: - _links: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalCollectionLinks" - _embedded: - $ref: "#/components/schemas/PersoonHalCollectieEmbedded" - PersoonHalCollectieEmbedded: - type: object - properties: - personen: - type: array - items: - $ref: '#/components/schemas/PersoonBeperktHal' - PersoonHalBasis: - allOf: - - $ref: '#/components/schemas/Persoon' - - properties: - _links: - $ref: "#/components/schemas/PersoonLinks" - PersoonHal: - allOf: - - $ref: '#/components/schemas/PersoonHalBasis' - - properties: - _embedded: - $ref: "#/components/schemas/PersoonEmbedded" - Ouder: - type: "object" - description: | - Gegevens over de ouder van de persoon. - * **datumIngangFamilierechtelijkeBetrekking** - De datum waarop de familierechtelijke betrekking is ontstaan. - * **geslachtsaanduiding** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'geslacht' uit de Haal-Centraal-BRP-tabellen-bevragen API. - * **ouderaanduiding** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'ouderAanduiding' uit de Haal-Centraal-BRP-tabellen-bevragen API. - properties: - burgerservicenummer: - type: "string" - example: "555555021" - geslachtsaanduiding: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - ouderAanduiding: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - datumIngangFamilierechtelijkeBetrekking: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - naam: - $ref: "#/components/schemas/Naam" - inOnderzoek: - $ref: "#/components/schemas/OuderInOnderzoek" - geboorte: - $ref: "#/components/schemas/Geboorte" - OuderHalCollectie: - deprecated: true - type: object - properties: - _links: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalCollectionLinks" - _embedded: - $ref: '#/components/schemas/OuderHalCollectieEmbedded' - OuderHalCollectieEmbedded: - deprecated: true - type: object - properties: - ouders: - type: array - items: - $ref: '#/components/schemas/OuderHalBasis' - OuderHalBasis: - deprecated: true - allOf: - - $ref: '#/components/schemas/Ouder' - - properties: - geheimhoudingPersoonsgegevens: - type: boolean - title: "Indicatie geheim" - description: | - Gegevens mogen niet worden verstrekt aan derden / maarschappelijke instellingen. - _links: - $ref: "#/components/schemas/OuderLinks" - Kind: - type: "object" - description: | - Gegevens over een kind van de persoon. - properties: - burgerservicenummer: - type: "string" - example: "555555021" - leeftijd: - type: integer - description: | - Leeftijd op het moment van bevragen - example: 12 - inOnderzoek: - $ref: "#/components/schemas/KindInOnderzoek" - naam: - $ref: "#/components/schemas/Naam" - geboorte: - $ref: "#/components/schemas/Geboorte" - KindHalCollectie: - deprecated: true - type: object - properties: - _links: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalCollectionLinks" - _embedded: - $ref: '#/components/schemas/KindHalCollectieEmbedded' - KindHalCollectieEmbedded: - deprecated: true - type: object - properties: - kinderen: - type: array - items: - $ref: '#/components/schemas/KindHalBasis' - KindHalBasis: - deprecated: true - allOf: - - $ref: '#/components/schemas/Kind' - - properties: - geheimhoudingPersoonsgegevens: - type: boolean - title: "Indicatie geheim" - description: | - Gegevens mogen niet worden verstrekt aan derden/ maatschappelijke instellingen. - _links: - $ref: "#/components/schemas/KindLinks" - Partner: - type: "object" - description: | - Gegevens over een gesloten huwelijk/geregistreerd partnerschap van de persoon. - * **geslachtsaanduiding** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'geslacht' uit de Haal-Centraal-BRP-tabellen-bevragen API. - * **soortVerbintenis** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'soort_verbintenis' uit de Haal-Centraal-BRP-tabellen-bevragen API. - properties: - burgerservicenummer: - type: "string" - example: "555555021" - geslachtsaanduiding: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - soortVerbintenis: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - naam: - $ref: "#/components/schemas/Naam" - geboorte: - $ref: "#/components/schemas/Geboorte" - inOnderzoek: - $ref: "#/components/schemas/PartnerInOnderzoek" - aangaanHuwelijkPartnerschap: - $ref: "#/components/schemas/AangaanHuwelijkPartnerschap" - PartnerHalCollectie: - deprecated: true - type: object - properties: - _links: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalCollectionLinks" - _embedded: - $ref: '#/components/schemas/PartnerHalCollectieEmbedded' - PartnerHalCollectieEmbedded: - deprecated: true - type: object - properties: - partners: - type: array - items: - $ref: '#/components/schemas/PartnerHalBasis' - PartnerHalBasis: - deprecated: true - allOf: - - $ref: '#/components/schemas/Partner' - - properties: - geheimhoudingPersoonsgegevens: - type: boolean - title: "Indicatie geheim" - description: | - Gegevens mogen niet worden verstrekt aan derden/ maatschappelijke instellingen. - _links: - $ref: "#/components/schemas/PartnerLinks" - Naam: - allOf: - - $ref: "#/components/schemas/NaamBasis" - - properties: - inOnderzoek: - $ref: "#/components/schemas/NaamInOnderzoek" - NaamBasis: - type: "object" - description: | - * **adellijkeTitel** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'adellijke_titel_predikaat' uit de Haal-Centraal-BRP-tabellen-bevragen API. - * **predikaat** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'adellijke_titel_predikaat' uit de Haal-Centraal-BRP-tabellen-bevragen API. - properties: - geslachtsnaam: - type: "string" - description: | - De achternaam van een persoon. - example: "Vries" - voorletters: - type: "string" - description: | - De voorletters van de persoon, afgeleid van de voornamen. - example: "P.J." - voornamen: - type: "string" - description: | - De verzameling namen voor de geslachtsnaam, gescheiden door spaties. - example: "Pieter Jan" - voorvoegsel: - type: "string" - example: "de" - adellijkeTitelPredikaat: - $ref: "#/components/schemas/WaardetabelMetSoort" - volledigeNaam: - type: "string" - example: "Pieter Jan de Vries" - WaardetabelMetSoort: - allOf: - - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - - properties: - soort: - type: "string" - example: - code: "JV" - omschrijving: "jonkvrouw" - soort: "predikaat" - NaamInOnderzoek: - type: "object" - description: | - Geeft aan welke gegevens over de naam in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - properties: - geslachtsnaam: - type: boolean - voornamen: - type: boolean - voorvoegsel: - type: boolean - adellijkeTitel: - type: boolean - predikaat: - type: boolean - datumIngangOnderzoek: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - NaamPersoonInOnderzoek: - allOf: - - $ref: '#/components/schemas/NaamInOnderzoek' - - properties: - aanduidingNaamgebruik: - type: boolean - OuderInOnderzoek: - type: "object" - description: | - Geeft aan welke gegevens van de de ouder in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - properties: - burgerservicenummer: - type: boolean - datumIngangFamilierechtelijkeBetrekking: - type: boolean - geslachtsaanduiding: - type: boolean - datumIngangOnderzoek: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - Geboorte: - allOf: - - $ref: '#/components/schemas/Geboortedatum' - - description: | - Gegevens over de geboorte. - * **datum** : datum waarop de persoon is geboren. - * **land** : land waar de persoon is geboren, wordt gevuld op basis van de waarden die voorkomen in de tabel 'landen' uit de Haal-Centraal-BRP-tabellen-bevragen API. - * **plaats** : gemeente waar de persoon is geboren. Is de persoon geboren buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding. Wordt gevuld op basis van de waarden die voorkomen in de tabel 'gemeenten' uit de Haal-Centraal-BRP-tabellen-bevragen API. - properties: - land: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - plaats: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - inOnderzoek: - $ref: "#/components/schemas/GeboorteInOnderzoek" - GeboorteInOnderzoek: - type: "object" - description: | - Geeft aan welke gegevens over de geboorte van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - properties: - datum: - type: boolean - land: - type: boolean - plaats: - type: boolean - datumIngangOnderzoek: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - Kiesrecht: - type: "object" - properties: - europeesKiesrecht: - type: boolean - description: | - Geeft aan of persoon een oproep moet ontvangen voor verkiezingen voor het Europees parlement. - example: true - uitgeslotenVanKiesrecht: - type: boolean - example: true - einddatumUitsluitingEuropeesKiesrecht: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - einddatumUitsluitingKiesrecht: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - NaamPersoon: - allOf: - - $ref: "#/components/schemas/NaamBasis" - - properties: - aanhef: - type: "string" - description: | - Kun je gebruiken als aanhef in een brief gericht aan persoon. - example: "Hoogwelgeboren heer" - aanschrijfwijze: - type: "string" - description: | - Samengestelde naam die je kunt gebruiken in de communicatie met de persoon. - example: "H.W. baron van den Aedel" - regelVoorafgaandAanAanschrijfwijze: - type: "string" - description: | - Deze regel moet als aparte regel boven de aanschrijfwijze worden geplaatst. Komt alleen voor bij personen met een adellijke titel of predicaat. - example: "De hoogwelgeboren heer" - gebruikInLopendeTekst: - type: "string" - description: | - Naam van persoon die je kunt gebruiken als je in lopende tekst (bijvoorbeeld in een brief) aan persoon refereert. - example: "baron Van den Aedel" - aanduidingNaamgebruik: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - inOnderzoek: - $ref: "#/components/schemas/NaamPersoonInOnderzoek" - description: | - * **aanduidingNaamgebruik** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'naamgebruik' uit de Haal-Centraal-BRP-tabellen-bevragen API. - PersoonInOnderzoek: - type: "object" - description: | - Geeft aan welke gegevens van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature). - properties: - burgerservicenummer: - type: boolean - geslachtsaanduiding: - type: boolean - datumIngangOnderzoek: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - Nationaliteit: - type: "object" - description: | - * **redenOpname** : De reden op grond waarvan de persoon de nationaliteit gekregen heeft. Wordt gevuld op basis van de waarden die voorkomen in de tabel 'reden_opnemen_beeindigen_nationaliteit' uit de Haal-Centraal-BRP-tabellen-bevragen API. - * **nationaliteit** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'nationaliteiten' uit de Haal-Centraal-BRP-tabellen-bevragen API. - properties: - aanduidingBijzonderNederlanderschap: - $ref: "#/components/schemas/AanduidingBijzonderNederlanderschap" - datumIngangGeldigheid: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - nationaliteit: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - redenOpname: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - inOnderzoek: - $ref: "#/components/schemas/NationaliteitInOnderzoek" - NationaliteitInOnderzoek: - type: "object" - description: | - Geeft aan welke gegevens over de nationaliteit in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - properties: - aanduidingBijzonderNederlanderschap: - type: boolean - nationaliteit: - type: boolean - redenOpname: - type: boolean - datumIngangOnderzoek: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - OpschortingBijhoudingBasis: - type: "object" - description: | - * **reden** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'redenopschortingbijhouding' uit de Haal-Centraal-BRP-tabellen-bevragen API. - - properties: - reden: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - OpschortingBijhouding: - allOf: - - $ref: "#/components/schemas/OpschortingBijhoudingBasis" - - type: "object" - description: | - * **datum**: de datum waarop de bijhouding van de persoonsgegevens is gestaakt. - properties: - datum: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - OverlijdenBasis: - type: "object" - description: | - Gegevens over het overlijden van de persoon. - properties: - indicatieOverleden: - type: boolean - description: | - Geeft aan dat iemand is overleden (waarde true), ongeacht of de overlijdensdatum bekend is. - Overlijden: - allOf: - - $ref: "#/components/schemas/OverlijdenBasis" - - type: "object" - description: | - Gegevens over het overlijden van de persoon. - * **datum** : datum waarop de persoon is overleden. - * **land** : land waar de persoon is overleden, wordt gevuld op basis van de waarden die voorkomen in de tabel 'landen' uit de Haal-Centraal-BRP-tabellen-bevragen API. - * **plaats** : gemeente waar de persoon is overleden. Is de persoon overleden buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding. Wordt gevuld op basis van de waarden die voorkomen in de tabel 'gemeenten' uit de Haal-Centraal-BRP-tabellen-bevragen API. - properties: - datum: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - land: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - plaats: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - inOnderzoek: - $ref: "#/components/schemas/OverlijdenInOnderzoek" - OverlijdenInOnderzoek: - type: "object" - description: | - Geeft aan welke gegevens over het overlijden van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - properties: - datum: - type: boolean - land: - type: boolean - plaats: - type: boolean - datumIngangOnderzoek: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - KindInOnderzoek: - type: "object" - description: | - Geeft aan of de gegevens over het kind van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - properties: - burgerservicenummer: - type: boolean - datumIngangOnderzoek: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - PartnerInOnderzoek: - type: "object" - description: | - Geeft aan welke gegevens over het huwelijk of het partnerschap in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - properties: - burgerservicenummer: - type: boolean - geslachtsaanduiding: - type: boolean - soortVerbintenis: - type: boolean - datumIngangOnderzoek: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - AangaanHuwelijkPartnerschap: - type: "object" - description: | - Gegevens over de voltrekking van het huwelijk of het aangaan van het geregistreerd partnerschap. - * **datum** : De datum waarop het huwelijk is voltrokken of het partnerschap is aangegaan. - * **land** : Het land waar het huwelijk is voltrokken of het partnerschap is aangegaan, wordt gevuld op basis van de waarden die voorkomen in de tabel 'landen' uit de Haal-Centraal-BRP-tabellen-bevragen API. - * **plaats** : De gemeente waar het huwelijk is voltrokken of het partnerschap is aangegaan. Wordt gevuld op basis van de waarden die voorkomen in de tabel 'gemeenten' uit de Haal-Centraal-BRP-tabellen-bevragen API. Voor een plaats buiten Nederland bevat het antwoord een buitenlandse plaatsnaam of aanduiding. - properties: - datum: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - land: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - plaats: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - inOnderzoek: - $ref: "#/components/schemas/AangaanHuwelijkPartnerschapInOnderzoek" - AangaanHuwelijkPartnerschapInOnderzoek: - type: "object" - description: | - Geeft aan welke gegevens over het voltrekken van het huwelijk of aangaan van het partnerschap in onderzoek zijn. Zie de functionele specificaties. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - properties: - datum: - type: boolean - land: - type: boolean - plaats: - type: boolean - datumIngangOnderzoek: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - VerblijfplaatsBeperkt: - type: object - description: | - Gegevens over het verblijf of de woonlocatie van een persoon. - * **functieAdres: wordt gevuld op basis van de waarden die voorkomen in de tabel 'soort_adres' uit de Haal-Centraal-BRP-tabellen-bevragen API. - * **land** wordt gevuld op basis van de waarden die voorkomen in de tabel 'landen' uit de Haal-Centraal-BRP-tabellen-bevragen API. - - - properties: - - functieAdres: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - adresregel1: - type: "string" - description: | - Het eerste deel van een adres is een combinatie van de straat en huisnummer. - # example: "1600 Pennsylvania Avenue NW" - example: "Laan van de landinrichtingscommissie Duiven-Westervoort 26A-3" - adresregel2: - type: "string" - description: | - Het tweede deel van een adres is een combinatie van woonplaats eventueel in combinatie met de postcode. - # example: "Washington, DC 20500" - example: "1234AA Nootdorp" - adresregel3: - type: "string" - description: | - Het derde deel van een adres is optioneel. Het gaat om een of meer geografische gebieden van het adres in het buitenland. - example: "Selangor" - woonplaats: - description: "Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam." - title: woonplaats naam - type: string - example: 'Duiven' - land: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - vertrokkenOnbekendWaarheen: - type: boolean - description: | - Indicatie dat de ingeschreven persoon is vertrokken naar het buitenland, maar dat niet bekend is waar naartoe. - Verblijfplaats: - allOf: - - $ref : "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-BAG-bevragen/v1.1.0/specificatie/openapi.yaml#/components/schemas/Adres" - - description: | - Gegevens over het verblijf of de woonlocatie van een persoon. - * **datumAanvangAdreshuishouding** : de datum van aangifte of ambtshalve melding van verblijf en adres. - * **datumIngangGeldigheid** : datum waarop de gegevens over de verblijfplaats geldig zijn geworden. - * **datumInschrijvingInGemeente**: bij inschrijving op grond van een verhuisaangifte door de burger is dit de aangiftedatum. Bij inschrijving op grond van een geboorteakte is dit de geboortedatum. Bij ambtshalve inschrijving is dit de datum waarop het voornemen van ambtshalve opneming schriftelijk aan de persoon is medegedeeld. - * **datumVestigingInNederland** : datum van inschrijving in Nederland. - * **landVanWaarIngeschreven** : het land waar de persoon woonde voor (her)vestiging in Nederland. Wordt gevuld op basis van de waarden die voorkomen in de tabel 'landen' uit de Haal-Centraal-BRP-tabellen-bevragen API. - * **gemeenteVanInschrijving** wordt gevuld op basis van de waarden die voorkomen in de tabel 'gemeenten' uit de Haal-Centraal-BRP-tabellen-bevragen API. De code kan voorloopnullen bevatten. - * **land** wordt gevuld op basis van de waarden die voorkomen in de tabel 'landen' uit de Haal-Centraal-BRP-tabellen-bevragen API. - properties: - adresseerbaarObjectIdentificatie: - type: "string" - description: | - De verblijfplaats van de persoon kan een ligplaats, een standplaats of een verblijfsobject zijn. - example: "0226010000038820" - aanduidingBijHuisnummer: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - nummeraanduidingIdentificatie: - type: "string" - description: | - Unieke identificatie van een nummeraanduiding (en het bijbehorende adres) in de BAG. - example: "0518200000366054" - functieAdres: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - indicatieVestigingVanuitBuitenland: - type: boolean - description: | - Geeft aan dat de ingeschreven persoon zich vanuit het buitenland heeft ingeschreven. - locatiebeschrijving: - type: "string" - description: | - Omschrijving van de ligging van een verblijfsobject, standplaats of ligplaats. - example: "Naast de derde brug" - korteNaam: - description: | - De officiële openbareruimtenaam uit de Basisregistratie Gebouwen en Adressen (BAG) of een verkorte versie. - type: string - vanuitVertrokkenOnbekendWaarheen: - type: boolean - description: | - Geeft aan dat de persoon is teruggekeerd uit een situatie van 'vertrokken onbekend waarheen.' - example: true - datumAanvangAdreshouding: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - datumIngangGeldigheid: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - datumInschrijvingInGemeente: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - datumVestigingInNederland: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - gemeenteVanInschrijving: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - landVanwaarIngeschreven: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - adresregel1: - type: "string" - description: | - Het eerste deel van een adres is een combinatie van de straat en huisnummer. - # example: "1600 Pennsylvania Avenue NW" - example: "Laan van de landinrichtingscommissie Duiven-Westervoort 26A-3" - adresregel2: - type: "string" - description: | - Het tweede deel van een adres is een combinatie van woonplaats eventueel in combinatie met de postcode. - # example: "Washington, DC 20500" - example: "1234AA Nootdorp" - adresregel3: - type: "string" - description: | - Het derde deel van een adres is optioneel. Het gaat om een of meer geografische gebieden van het adres in het buitenland. - example: "Selangor" - vertrokkenOnbekendWaarheen: - type: boolean - description: | - Indicatie dat de ingeschreven persoon is vertrokken naar het buitenland, maar dat niet bekend is waar naar toe. - land: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - inOnderzoek: - $ref: "#/components/schemas/VerblijfplaatsInOnderzoek" - VerblijfplaatsInOnderzoek: - type: "object" - description: | - Geeft aan welke gegevens over het verblijf en adres van de persoon in onderzoek zijn. Elementen van het GBA-adres zelf (Dat zou eigenlijk een BAG-adres moeten zijn) kunnen niet in onderzoek zijn. Wel de relatie naar de nummeraanduiding. Dat wordt gedaan door de identificatiecodeNummeraanduiding in onderzoek te zetten. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - properties: - aanduidingBijHuisnummer: - type: boolean - datumAanvangAdreshouding: - type: boolean - datumIngangGeldigheid: - type: boolean - datumInschrijvingInGemeente: - type: boolean - datumVestigingInNederland: - type: boolean - functieAdres: - type: boolean - gemeenteVanInschrijving: - type: boolean - huisletter: - type: boolean - huisnummer: - type: boolean - huisnummertoevoeging: - type: boolean - nummeraanduidingIdentificatie: - type: boolean - adresseerbaarObjectIdentificatie: - type: boolean - landVanwaarIngeschreven: - type: boolean - locatiebeschrijving: - type: boolean - straat: - type: boolean - postcode: - type: boolean - korteNaam: - type: boolean - verblijfBuitenland: - type: boolean - woonplaats: - type: boolean - datumIngangOnderzoek: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - Gezagsverhouding: - type: "object" - description: | - Gegevens over het gezag over de persoon. - * *indicatieGezagMinderjarige** wordt gevuld op basis van de waarden die voorkomen in de tabel 'indicatiegezagminderjarige' uit de Haal-Centraal-BRP-tabellen-bevragen API. - - properties: - indicatieCurateleRegister: - type: boolean - description: | - Geeft aan dat de persoon onder curatele is gesteld. - example: true - indicatieGezagMinderjarige: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - inOnderzoek: - $ref: "#/components/schemas/GezagsverhoudingInOnderzoek" - GezagsverhoudingInOnderzoek: - type: "object" - description: | - Geeft aan welke gegevens van de gezagsverhouding in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - properties: - indicatieCurateleRegister: - type: boolean - indicatieGezagMinderjarige: - type: boolean - datumIngangOnderzoek: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - Verblijfstitel: - type: "object" - description: | - Gegevens over de verblijfsrechtelijke status van de persoon. - * **datumEinde**: Datum waarop de geldigheid van de gegevens over de verblijfstitel is beëindigd. - * **datumIngang**: Datum waarop de gegevens over de verblijfstitel geldig zijn geworden. - * **aanduiding** : Verblijfstiteltabel die aangeeft over welke verblijfsrechtelijke status de persoon beschikt. - properties: - aanduiding: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/Waardetabel" - datumEinde: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - datumIngang: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - inOnderzoek: - $ref: "#/components/schemas/VerblijfstitelInOnderzoek" - VerblijfstitelInOnderzoek: - type: "object" - description: | - Geeft aan welke gegevens over de verblijfstitel in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) - properties: - aanduiding: - type: boolean - datumEinde: - type: boolean - datumIngang: - type: boolean - datumIngangOnderzoek: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" - PersoonLinks: - type: "object" - properties: - self: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - ouders: - type: "array" - description: | - De ouders van de persoon. - items: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - reisdocumenten: - type: "array" - description: | - De reisdocumenten die aan de persoon zijn verstrekt. - items: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - kinderen: - type: "array" - description: | - De kinderen van de persoon. - items: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - partners: - type: "array" - description: | - De actuele bij de ingeschreven persoon geregistreerde huwelijken en geregistreerd partnerschappen. Een beëindigd huwelijk of geregistreerd partnerschap wordt niet teruggegeven. - items: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - partnerhistorie: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - verblijfplaatshistorie: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - verblijfstitelhistorie: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - nationaliteitHistorie: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - adres: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - OuderLinks: - deprecated: true - type: "object" - properties: - self: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - Persoon: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - KindLinks: - deprecated: true - type: "object" - properties: - self: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - Persoon: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - PartnerLinks: - deprecated: true - type: "object" - properties: - self: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - Persoon: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/HalLink" - PersoonEmbedded: - type: "object" - deprecated: true - properties: - ouders: - type: "array" - description: | - De ouders van de persoon. - items: - $ref: "#/components/schemas/OuderHalBasis" - kinderen: - type: "array" - description: | - De kinderen van de persoon. - items: - $ref: "#/components/schemas/KindHalBasis" - partners: - type: "array" - description: | - De partners van de persoon. Een beëindigd huwelijk of geregistreerd partnerschap wordt niet teruggegeven. - items: - $ref: "#/components/schemas/PartnerHalBasis" - AanduidingBijzonderNederlanderschap: - type: object - properties: - behandeldAlsNederlander: - type: boolean - vastgesteldNietNederlander: - type: boolean - Geboortedatum: - type: "object" - properties: - datum: - $ref: "https://raw.githubusercontent.com/VNG-Realisatie/Haal-Centraal-common/v1.2.0/api-specificatie/common.yaml#/components/schemas/DatumOnvolledig" + $ref: 'zoek-personen.yaml#/paths/~1personen' diff --git a/specificatie/opschortingbijhouding.yaml b/specificatie/opschortingbijhouding.yaml new file mode 100644 index 000000000..83e5c673f --- /dev/null +++ b/specificatie/opschortingbijhouding.yaml @@ -0,0 +1,33 @@ +openapi: 3.0.3 +info: + title: OpschortingBijhouding definities + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + OpschortingBijhoudingBasis: + type: object + description: | + * **reden** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'redenopschortingbijhouding' uit de Haal-Centraal-BRP-tabellen-bevragen API. + properties: + reden: + $ref: 'common.yaml#/components/schemas/Waardetabel' + GbaOpschortingBijhouding: + allOf: + - $ref: '#/components/schemas/OpschortingBijhoudingBasis' + - type: object + description: | + * **datum**: de datum waarop de bijhouding van de persoonsgegevens is gestaakt. + properties: + datum: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + OpschortingBijhouding: + allOf: + - $ref: '#/components/schemas/OpschortingBijhoudingBasis' + - type: object + description: | + * **datum**: de datum waarop de bijhouding van de persoonsgegevens is gestaakt. + properties: + datum: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' diff --git a/specificatie/ouder.yaml b/specificatie/ouder.yaml new file mode 100644 index 000000000..0022997d7 --- /dev/null +++ b/specificatie/ouder.yaml @@ -0,0 +1,88 @@ +openapi: 3.0.3 +info: + title: Ouder definities + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + AbstractOuder: + type: object + description: | + Gegevens over de ouder van de persoon. + required: + - type + properties: + type: + type: string + discriminator: + propertyName: type + mapping: + Ouder: '#/components/schemas/Ouder' + OnbekendOuder: '#/components/schemas/OnbekendOuder' + GbaOuder: + type: object + description: | + Gegevens over de ouder van de persoon. + * **datumIngangFamilierechtelijkeBetrekking** - De datum waarop de familierechtelijke betrekking is ontstaan. + properties: + burgerservicenummer: + $ref: 'persoon.yaml#/components/schemas/Burgerservicenummer' + geslachtsaanduiding: + $ref: 'common.yaml#/components/schemas/Waardetabel' + ouderAanduiding: + $ref: 'common.yaml#/components/schemas/Waardetabel' + datumIngangFamilierechtelijkeBetrekking: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + naam: + $ref: 'naam.yaml#/components/schemas/GbaNaamBasis' + inOnderzoek: + $ref: 'gba-inonderzoek.yaml#/components/schemas/GbaInOnderzoek' + geboorte: + $ref: 'geboorte.yaml#/components/schemas/GbaGeboorte' + Ouder: + description: | + Gegevens over de ouder van de persoon. + * **datumIngangFamilierechtelijkeBetrekking** - De datum waarop de familierechtelijke betrekking is ontstaan. + * **geslachtsaanduiding** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'geslacht' uit de Haal-Centraal-BRP-tabellen-bevragen API. + * **ouderaanduiding** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'ouderAanduiding' uit de Haal-Centraal-BRP-tabellen-bevragen API. + allOf: + - $ref: '#/components/schemas/AbstractOuder' + - type: object + properties: + burgerservicenummer: + $ref: 'persoon.yaml#/components/schemas/Burgerservicenummer' + geslachtsaanduiding: + $ref: 'common.yaml#/components/schemas/Waardetabel' + ouderAanduiding: + $ref: 'common.yaml#/components/schemas/Waardetabel' + datumIngangFamilierechtelijkeBetrekking: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + naam: + $ref: 'naam.yaml#/components/schemas/NaamGerelateerde' + inOnderzoek: + $ref: '#/components/schemas/OuderInOnderzoek' + geboorte: + $ref: 'geboorte.yaml#/components/schemas/Geboorte' + OnbekendOuder: + allOf: + - $ref: '#/components/schemas/AbstractOuder' + - type: object + properties: + indicatieOnbekend: + type: boolean + default: false + OuderInOnderzoek: + description: | + Geeft aan welke gegevens van de de ouder in onderzoek zijn. + Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + burgerservicenummer: + type: boolean + datumIngangFamilierechtelijkeBetrekking: + type: boolean + geslachtsaanduiding: + type: boolean diff --git a/specificatie/overlijden.yaml b/specificatie/overlijden.yaml new file mode 100644 index 000000000..e45f8b6ed --- /dev/null +++ b/specificatie/overlijden.yaml @@ -0,0 +1,67 @@ +openapi: 3.0.3 +info: + title: Overlijden definities + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + IndicatieOverleden: + type: boolean + description: | + Geeft aan dat iemand is overleden (waarde true), ongeacht of de overlijdensdatum bekend is. + GbaOverlijdenBasis: + type: object + properties: + datum: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + GbaOverlijden: + allOf: + - $ref: '#/components/schemas/GbaOverlijdenBasis' + - type: object + properties: + land: + $ref: 'common.yaml#/components/schemas/Waardetabel' + plaats: + $ref: 'common.yaml#/components/schemas/Waardetabel' + inOnderzoek: + $ref: 'gba-inonderzoek.yaml#/components/schemas/GbaInOnderzoek' + OverlijdenBasis: + type: object + properties: + indicatieOverleden: + $ref: '#/components/schemas/IndicatieOverleden' + Overlijden: + description: | + Gegevens over het overlijden van de persoon. + * **datum** : datum waarop de persoon is overleden. + * **land** : land waar de persoon is overleden. + * **plaats** : gemeente waar de persoon is overleden. Is de persoon overleden buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding. + allOf: + - $ref: '#/components/schemas/OverlijdenBasis' + - type: object + properties: + datum: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + land: + $ref: 'common.yaml#/components/schemas/Waardetabel' + plaats: + $ref: 'common.yaml#/components/schemas/Waardetabel' + inOnderzoek: + $ref: '#/components/schemas/OverlijdenInOnderzoek' + OverlijdenInOnderzoek: + description: | + Geeft aan welke gegevens over het overlijden van de persoon in onderzoek zijn. + Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + indicatieOverleden: + type: boolean + datum: + type: boolean + land: + type: boolean + plaats: + type: boolean diff --git a/specificatie/partner.yaml b/specificatie/partner.yaml new file mode 100644 index 000000000..93e076370 --- /dev/null +++ b/specificatie/partner.yaml @@ -0,0 +1,133 @@ +openapi: 3.0.3 +info: + title: Ouder definities + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + AbstractPartner: + type: object + description: | + Gegevens over een gesloten huwelijk/geregistreerd partnerschap van de persoon. + required: + - type + properties: + type: + type: string + discriminator: + propertyName: type + mapping: + Partner: '#/components/schemas/Partner' + OnbekendPartner: '#/components/schemas/OnbekendPartner' + GbaPartner: + type: object + properties: + burgerservicenummer: + $ref: 'persoon.yaml#/components/schemas/Burgerservicenummer' + geslachtsaanduiding: + $ref: 'common.yaml#/components/schemas/Waardetabel' + soortVerbintenis: + $ref: 'common.yaml#/components/schemas/Waardetabel' + naam: + $ref: 'naam.yaml#/components/schemas/GbaNaamBasis' + geboorte: + $ref: 'geboorte.yaml#/components/schemas/GbaGeboorte' + inOnderzoek: + $ref: 'gba-inonderzoek.yaml#/components/schemas/GbaInOnderzoek' + aangaanHuwelijkPartnerschap: + $ref: '#/components/schemas/GbaAangaanHuwelijkPartnerschap' + ontbindingHuwelijkPartnerschap: + $ref: "#/components/schemas/GbaOntbindingHuwelijkPartnerschap" + Partner: + allOf: + - $ref: '#/components/schemas/AbstractPartner' + - type: object + properties: + burgerservicenummer: + $ref: 'persoon.yaml#/components/schemas/Burgerservicenummer' + geslachtsaanduiding: + $ref: 'common.yaml#/components/schemas/Waardetabel' + soortVerbintenis: + $ref: 'common.yaml#/components/schemas/Waardetabel' + naam: + $ref: 'naam.yaml#/components/schemas/NaamGerelateerde' + geboorte: + $ref: 'geboorte.yaml#/components/schemas/Geboorte' + inOnderzoek: + $ref: '#/components/schemas/PartnerInOnderzoek' + aangaanHuwelijkPartnerschap: + $ref: '#/components/schemas/AangaanHuwelijkPartnerschap' + OnbekendPartner: + allOf: + - $ref: '#/components/schemas/AbstractPartner' + - type: object + properties: + indicatieOnbekend: + type: boolean + default: false + PartnerInOnderzoek: + description: | + Geeft aan welke gegevens over het huwelijk of het partnerschap in onderzoek zijn. + Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + burgerservicenummer: + type: boolean + geslachtsaanduiding: + type: boolean + soortVerbintenis: + type: boolean + GbaAangaanHuwelijkPartnerschap: + type: object + description: | + Gegevens over de voltrekking van het huwelijk of het aangaan van het geregistreerd partnerschap. + * **datum** : De datum waarop het huwelijk is voltrokken of het partnerschap is aangegaan. + * **land** : Het land waar het huwelijk is voltrokken of het partnerschap is aangegaan. + * **plaats** : De gemeente waar het huwelijk is voltrokken of het partnerschap is aangegaan. Voor een plaats buiten Nederland bevat het antwoord een buitenlandse plaatsnaam of aanduiding. + properties: + datum: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + land: + $ref: 'common.yaml#/components/schemas/Waardetabel' + plaats: + $ref: 'common.yaml#/components/schemas/Waardetabel' + inOnderzoek: + $ref: 'gba-inonderzoek.yaml#/components/schemas/GbaInOnderzoek' + AangaanHuwelijkPartnerschap: + type: object + description: | + Gegevens over de voltrekking van het huwelijk of het aangaan van het geregistreerd partnerschap. + * **datum** : De datum waarop het huwelijk is voltrokken of het partnerschap is aangegaan. + * **land** : Het land waar het huwelijk is voltrokken of het partnerschap is aangegaan. + * **plaats** : De gemeente waar het huwelijk is voltrokken of het partnerschap is aangegaan. Voor een plaats buiten Nederland bevat het antwoord een buitenlandse plaatsnaam of aanduiding. + properties: + datum: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + land: + $ref: 'common.yaml#/components/schemas/Waardetabel' + plaats: + $ref: 'common.yaml#/components/schemas/Waardetabel' + inOnderzoek: + $ref: '#/components/schemas/AangaanHuwelijkPartnerschapInOnderzoek' + AangaanHuwelijkPartnerschapInOnderzoek: + description: | + Geeft aan welke gegevens over het voltrekken van het huwelijk of aangaan van het partnerschap in onderzoek zijn. + Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + datum: + type: boolean + land: + type: boolean + plaats: + type: boolean + GbaOntbindingHuwelijkPartnerschap: + type: object + properties: + datum: + $ref: 'datum.yaml#/components/schemas/GbaDatum' diff --git a/specificatie/persoon.yaml b/specificatie/persoon.yaml new file mode 100644 index 000000000..c303e1527 --- /dev/null +++ b/specificatie/persoon.yaml @@ -0,0 +1,198 @@ +openapi: 3.0.3 +info: + title: Persoon definities + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + ANummer: + description: | + Het A-nummer van de persoon + type: string + pattern: ^[0-9]{10}$ + Burgerservicenummer: + type: string + pattern: ^[0-9]{9}$ + example: "555555021" + GbaGeheimhoudingPersoonsgegevens: + type: integer + GeheimhoudingPersoonsgegevens: + description: | + Gegevens mogen niet worden verstrekt aan derden / maatschappelijke instellingen. + type: boolean + Leeftijd: + type: integer + description: | + Leeftijd in jaren op het moment van bevragen. + example: 34 + minimum: 0 + maximum: 150 + Reisdocumentnummer: + type: string + pattern: ^[0-9a-zA-Z]{9}$ + description: | + Het nummer van het verstrekte Nederlandse reisdocument. + example: "546376728" + GbaPersoonBeperkt: + type: object + properties: + burgerservicenummer: + $ref: '#/components/schemas/Burgerservicenummer' + geboorte: + $ref: 'geboorte.yaml#/components/schemas/GbaGeboorteBeperkt' + geheimhoudingPersoonsgegevens: + $ref: '#/components/schemas/GbaGeheimhoudingPersoonsgegevens' + geslachtsaanduiding: + $ref: 'common.yaml#/components/schemas/Waardetabel' + naam: + $ref: 'naam.yaml#/components/schemas/GbaNaamBasis' + opschortingBijhouding: + $ref: 'opschortingbijhouding.yaml#/components/schemas/OpschortingBijhoudingBasis' + overlijden: + $ref: 'overlijden.yaml#/components/schemas/GbaOverlijdenBasis' + verblijfplaats: + $ref: 'verblijfplaats.yaml#/components/schemas/GbaVerblijfplaatsBeperkt' + PersoonBeperkt: + type: object + properties: + burgerservicenummer: + $ref: '#/components/schemas/Burgerservicenummer' + geboorte: + $ref: 'geboorte.yaml#/components/schemas/GeboorteBeperkt' + geheimhoudingPersoonsgegevens: + $ref: '#/components/schemas/GeheimhoudingPersoonsgegevens' + geslachtsaanduiding: + $ref: 'common.yaml#/components/schemas/Waardetabel' + leeftijd: + $ref: '#/components/schemas/Leeftijd' + naam: + $ref: 'naam.yaml#/components/schemas/NaamBasis' + opschortingBijhouding: + $ref: 'opschortingbijhouding.yaml#/components/schemas/OpschortingBijhoudingBasis' + overlijden: + $ref: 'overlijden.yaml#/components/schemas/OverlijdenBasis' + verblijfplaats: + $ref: 'verblijfplaats.yaml#/components/schemas/AbstractVerblijfplaatsBeperkt' + GbaPersoon: + type: object + properties: + aNummer: + $ref: '#/components/schemas/ANummer' + burgerservicenummer: + $ref: '#/components/schemas/Burgerservicenummer' + datumEersteInschrijvingGBA: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + geheimhoudingPersoonsgegevens: + $ref: '#/components/schemas/GbaGeheimhoudingPersoonsgegevens' + geslachtsaanduiding: + $ref: 'common.yaml#/components/schemas/Waardetabel' + inOnderzoek: + $ref: 'gba-inonderzoek.yaml#/components/schemas/GbaInOnderzoek' + kiesrecht: + $ref: 'kiesrecht.yaml#/components/schemas/GbaKiesrecht' + naam: + $ref: 'naam.yaml#/components/schemas/GbaNaamPersoon' + nationaliteiten: + type: array + items: + $ref: 'nationaliteit.yaml#/components/schemas/GbaNationaliteit' + geboorte: + $ref: 'geboorte.yaml#/components/schemas/GbaGeboorte' + opschortingBijhouding: + $ref: 'opschortingbijhouding.yaml#/components/schemas/GbaOpschortingBijhouding' + overlijden: + $ref: 'overlijden.yaml#/components/schemas/GbaOverlijden' + verblijfplaats: + $ref: 'verblijfplaats.yaml#/components/schemas/GbaVerblijfplaats' + gezagsverhouding: + $ref: 'gezagsverhouding.yaml#/components/schemas/GbaGezagsverhouding' + verblijfstitel: + $ref: 'verblijfstitel.yaml#/components/schemas/GbaVerblijfstitel' + reisdocumentnummers: + type: array + items: + $ref: '#/components/schemas/Reisdocumentnummer' + kinderen: + type: array + items: + $ref: 'kind.yaml#/components/schemas/GbaKind' + ouders: + type: array + items: + $ref: 'ouder.yaml#/components/schemas/GbaOuder' + partners: + type: array + items: + $ref: 'partner.yaml#/components/schemas/GbaPartner' + Persoon: + type: object + properties: + aNummer: + $ref: '#/components/schemas/ANummer' + burgerservicenummer: + $ref: '#/components/schemas/Burgerservicenummer' + datumEersteInschrijvingGBA: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + geheimhoudingPersoonsgegevens: + $ref: '#/components/schemas/GeheimhoudingPersoonsgegevens' + geslachtsaanduiding: + $ref: 'common.yaml#/components/schemas/Waardetabel' + inOnderzoek: + $ref: '#/components/schemas/PersoonInOnderzoek' + kiesrecht: + $ref: 'kiesrecht.yaml#/components/schemas/Kiesrecht' + leeftijd: + $ref: '#/components/schemas/Leeftijd' + naam: + $ref: 'naam.yaml#/components/schemas/NaamPersoon' + nationaliteiten: + type: array + items: + $ref: 'nationaliteit.yaml#/components/schemas/Nationaliteit' + geboorte: + $ref: 'geboorte.yaml#/components/schemas/Geboorte' + opschortingBijhouding: + $ref: 'opschortingbijhouding.yaml#/components/schemas/OpschortingBijhouding' + overlijden: + $ref: 'overlijden.yaml#/components/schemas/Overlijden' + verblijfplaats: + $ref: 'verblijfplaats.yaml#/components/schemas/AbstractVerblijfplaats' + gezagsverhouding: + $ref: 'gezagsverhouding.yaml#/components/schemas/Gezagsverhouding' + verblijfstitel: + $ref: 'verblijfstitel.yaml#/components/schemas/Verblijfstitel' + reisdocumentnummers: + type: array + items: + $ref: '#/components/schemas/Reisdocumentnummer' + kinderen: + type: array + items: + $ref: 'kind.yaml#/components/schemas/AbstractKind' + ouders: + type: array + items: + $ref: 'ouder.yaml#/components/schemas/AbstractOuder' + partners: + type: array + items: + $ref: 'partner.yaml#/components/schemas/AbstractPartner' + PersoonInOnderzoek: + description: | + Geeft aan welke gegevens van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature). + allOf: + - $ref: '#/components/schemas/InOnderzoek' + type: object + properties: + burgerservicenummer: + type: boolean + geslachtsaanduiding: + type: boolean + leeftijd: + type: boolean + InOnderzoek: + type: object + properties: + datumIngangOnderzoek: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' diff --git a/specificatie/verblijfplaats.yaml b/specificatie/verblijfplaats.yaml new file mode 100644 index 000000000..d35befc3c --- /dev/null +++ b/specificatie/verblijfplaats.yaml @@ -0,0 +1,498 @@ +openapi: 3.0.3 +info: + title: Verblijfplaats definities + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + Adresregel1: + type: string + maxLength: 40 + description: | + Het eerste deel van een adres is een combinatie van de straat en huisnummer. + # example: "1600 Pennsylvania Avenue NW" + example: "Laan van de landinrichtingscommissie Duiven-Westervoort 26A-3" + Adresregel2: + type: string + maxLength: 50 + description: | + Het tweede deel van een adres is een combinatie van woonplaats eventueel in combinatie met de postcode. + # example: "Washington, DC 20500" + example: "1234AA Nootdorp" + Adresregel3: + type: string + maxLength: 35 + description: | + Het derde deel van een adres is optioneel. Het gaat om een of meer geografische gebieden van het adres in het buitenland. + example: "Selangor" + AdresseerbaarObjectIdentificatie: + type: string + pattern: ^[0-9]{16}$ + description: | + De verblijfplaats van de persoon kan een ligplaats, een standplaats of een verblijfsobject zijn. + example: "0226010000038820" + GemeenteVanInschrijving: + description: | + Een code die aangeeft in welke gemeente de persoon woont, of de laatste gemeente waar de persoon heeft gewoond, of de gemeente waar de persoon voor het eerst is ingeschreven. + type: string + pattern: ^[0-9]{4}$ + example: "0518" + Huisletter: + description: | + Een toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven. + type: string + pattern: ^[a-zA-Z]{1}$ + example: "a" + Huisnummer: + description: | + Een nummer dat door de gemeente aan een adresseerbaar object is gegeven. + type: integer + minimum: 1 + maximum: 99999 + example: 14 + Huisnummertoevoeging: + description: | + Een toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven. + type: string + pattern: ^[a-zA-Z0-9 \-]{1,4}$ + example: "bis" + IndicatieVestigingVanuitBuitenland: + type: boolean + description: | + Geeft aan dat de persoon zich vanuit het buitenland heeft ingeschreven. + KorteNaam: + description: | + De officiële openbareruimtenaam uit de Basisregistratie Gebouwen en Adressen (BAG) of een verkorte versie. + type: string + maxLength: 24 + Locatiebeschrijving: + type: string + maxLength: 35 + description: | + Omschrijving van de ligging van een verblijfsobject, standplaats of ligplaats. + example: "Naast de derde brug" + NaamOpenbareRuimte: + type: string + maxLength: 80 + NummeraanduidingIdentificatie: + description: | + Unieke identificatie van een nummeraanduiding (en het bijbehorende adres) in de BAG. + type: string + pattern: ^[0-9]{16}$ + example: "0518200000366054" + Postcode: + description: | + De door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort. + type: string + pattern: ^[1-9]{1}[0-9]{3}[ ]?[A-Za-z]{2}$ + example: "2341SX" + Straat: + type: string + maxLength: 80 + example: "Tulpstraat" + VanuitVerblijfplaatsOnbekend: + type: boolean + description: | + Geeft aan dat de persoon is teruggekeerd uit een situatie van onbekende verblijfplaats + IndicatieVerblijfplaatsOnbekend: + type: boolean + description: | + Indicatie dat de verblijfplaats van de persoon onbekend is. Er is niet bekend in welk land de persoon verblijft. + Woonplaats: + description: | + Een woonplaats is een gedeelte van het grondgebied van de gemeente met een naam. + title: woonplaats naam + type: string + pattern: ^[a-zA-Z0-9À-ž \(\)\,\.\-\']{1,80}$ + example: "Duiven" + AbstractVerblijfplaatsBeperkt: + type: object + description: | + Gegevens over het verblijf of de woonlocatie van een persoon. + required: + - type + properties: + type: + type: string + discriminator: + propertyName: type + mapping: + VerblijfplaatsBuitenland: '#/components/schemas/VerblijfplaatsBuitenlandBeperkt' + Adres: '#/components/schemas/AdresBeperkt' + VerblijfplaatsOnbekend: '#/components/schemas/VerblijfplaatsOnbekend' + Locatie: '#/components/schemas/LocatieBeperkt' + AdresBeperkt: + allOf: + - $ref: '#/components/schemas/AbstractVerblijfplaatsBeperkt' + - type: object + properties: + functieAdres: + $ref: 'common.yaml#/components/schemas/Waardetabel' + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + woonplaats: + $ref: '#/components/schemas/Woonplaats' + VerblijfplaatsBuitenlandBeperkt: + allOf: + - $ref: '#/components/schemas/AbstractVerblijfplaatsBeperkt' + - type: object + properties: + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + adresregel3: + $ref: '#/components/schemas/Adresregel3' + land: + $ref: 'common.yaml#/components/schemas/Waardetabel' + VerblijfplaatsOnbekendBeperkt: + allOf: + - $ref: '#/components/schemas/AbstractVerblijfplaatsBeperkt' + - type: object + properties: + verblijfplaatsOnbekend: + $ref: '#/components/schemas/IndicatieVerblijfplaatsOnbekend' + LocatieBeperkt: + allOf: + - $ref: '#/components/schemas/AbstractVerblijfplaatsBeperkt' + - type: object + properties: + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + functieAdres: + $ref: 'common.yaml#/components/schemas/Waardetabel' + locatiebeschrijving: + $ref: '#/components/schemas/Locatiebeschrijving' + woonplaats: + $ref: '#/components/schemas/Woonplaats' + GbaVerblijfplaatsBeperkt: + type: object + properties: + functieAdres: + $ref: 'common.yaml#/components/schemas/Waardetabel' + woonplaats: + $ref: '#/components/schemas/Woonplaats' + straat: + $ref: '#/components/schemas/Straat' + huisnummer: + $ref: '#/components/schemas/Huisnummer' + huisletter: + $ref: '#/components/schemas/Huisletter' + huisnummertoevoeging: + $ref: '#/components/schemas/Huisnummertoevoeging' + aanduidingBijHuisnummer: + $ref: 'common.yaml#/components/schemas/Waardetabel' + postcode: + $ref: '#/components/schemas/Postcode' + locatiebeschrijving: + $ref: '#/components/schemas/Locatiebeschrijving' + land: + $ref: 'common.yaml#/components/schemas/Waardetabel' + gemeenteVanInschrijving: + $ref: 'common.yaml#/components/schemas/Waardetabel' + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + adresregel3: + $ref: '#/components/schemas/Adresregel3' + AbstractVerblijfplaats: + type: object + description: | + Gegevens over het verblijf of de woonlocatie van een persoon. + required: + - type + properties: + type: + type: string + discriminator: + propertyName: type + mapping: + VerblijfplaatsBuitenland: '#/components/schemas/VerblijfplaatsBuitenland' + Adres: '#/components/schemas/Adres' + VerblijfplaatsOnbekend: '#/components/schemas/VerblijfplaatsOnbekend' + Locatie: '#/components/schemas/Locatie' + VerblijfplaatsBuitenland: + allOf: + - $ref : '#/components/schemas/AbstractVerblijfplaats' + - type: object + properties: + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + adresregel3: + $ref: '#/components/schemas/Adresregel3' + datumInschrijvingInGemeente: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + gemeenteVanInschrijving: + $ref: 'common.yaml#/components/schemas/Waardetabel' + land: + $ref: 'common.yaml#/components/schemas/Waardetabel' + datumVan: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + datumIngangGeldigheid: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + inOnderzoek: + $ref: '#/components/schemas/VerblijfplaatsBuitenlandInOnderzoek' + Adres: + description: | + Gegevens over het adres van een persoon. + * **datumVan** : de datum van aangifte of ambtshalve melding van verblijf en adres. + * **datumIngangGeldigheid** : datum waarop de gegevens over de verblijfplaats geldig zijn geworden. + * **datumInschrijvingInGemeente**: bij inschrijving op grond van een verhuisaangifte door de burger is dit de aangiftedatum. Bij inschrijving op grond van een geboorteakte is dit de geboortedatum. Bij ambtshalve inschrijving is dit de datum waarop het voornemen van ambtshalve opneming schriftelijk aan de persoon is medegedeeld. + * **datumVestigingInNederland** : datum van inschrijving in Nederland. + * **landVanWaarIngeschreven** : het land waar de persoon woonde voor (her)vestiging in Nederland. + * **gemeenteVanInschrijving** : de gemeente waar de persoon verblijft en is ingeschreven. De code kan voorloopnullen bevatten." + allOf: + - $ref : '#/components/schemas/AbstractVerblijfplaats' + - type: object + properties: + functieAdres: + $ref: 'common.yaml#/components/schemas/Waardetabel' + straat: + $ref: '#/components/schemas/Straat' + huisnummer: + $ref: '#/components/schemas/Huisnummer' + huisletter: + $ref: '#/components/schemas/Huisletter' + huisnummertoevoeging: + $ref: '#/components/schemas/Huisnummertoevoeging' + aanduidingBijHuisnummer: + $ref: 'common.yaml#/components/schemas/Waardetabel' + postcode: + $ref: '#/components/schemas/Postcode' + adresseerbaarObjectIdentificatie: + $ref: '#/components/schemas/AdresseerbaarObjectIdentificatie' + nummeraanduidingIdentificatie: + $ref: '#/components/schemas/NummeraanduidingIdentificatie' + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + woonplaats: + $ref: '#/components/schemas/Woonplaats' + indicatieVestigingVanuitBuitenland: + $ref: '#/components/schemas/IndicatieVestigingVanuitBuitenland' + korteNaam: + $ref: '#/components/schemas/KorteNaam' + vanuitVerblijfplaatsOnbekend: + $ref: '#/components/schemas/VanuitVerblijfplaatsOnbekend' + datumVan: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + datumIngangGeldigheid: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + datumInschrijvingInGemeente: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + datumVestigingInNederland: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + gemeenteVanInschrijving: + $ref: "common.yaml#/components/schemas/Waardetabel" + landVanwaarIngeschreven: + $ref: 'common.yaml#/components/schemas/Waardetabel' + inOnderzoek: + $ref: "#/components/schemas/AdresInOnderzoek" + Locatie: + allOf: + - $ref: '#/components/schemas/AbstractVerblijfplaats' + - type: object + properties: + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + datumInschrijvingInGemeente: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + datumVestigingInNederland: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + functieAdres: + $ref: 'common.yaml#/components/schemas/Waardetabel' + gemeenteVanInschrijving: + $ref: "common.yaml#/components/schemas/Waardetabel" + indicatieVestigingVanuitBuitenland: + $ref: '#/components/schemas/IndicatieVestigingVanuitBuitenland' + landVanwaarIngeschreven: + $ref: 'common.yaml#/components/schemas/Waardetabel' + locatiebeschrijving: + $ref: '#/components/schemas/Locatiebeschrijving' + vanuitVerblijfplaatsOnbekend: + $ref: '#/components/schemas/VanuitVerblijfplaatsOnbekend' + woonplaats: + $ref: '#/components/schemas/Woonplaats' + inOnderzoek: + $ref: '#/components/schemas/LocatieInOnderzoek' + VerblijfplaatsOnbekend: + allOf: + - $ref: '#/components/schemas/AbstractVerblijfplaats' + - type: object + properties: + datumInschrijvingInGemeente: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + gemeenteVanInschrijving: + $ref: '#/components/schemas/GemeenteVanInschrijving' + verblijfplaatsOnbekend: + $ref: '#/components/schemas/IndicatieVerblijfplaatsOnbekend' + inOnderzoek: + $ref: '#/components/schemas/VerblijfplaatsOnbekendInOnderzoek' + GbaVerblijfplaats: + type: object + properties: + adresregel1: + $ref: '#/components/schemas/Adresregel1' + adresregel2: + $ref: '#/components/schemas/Adresregel2' + adresregel3: + $ref: '#/components/schemas/Adresregel3' + adresseerbaarObjectIdentificatie: + $ref: '#/components/schemas/AdresseerbaarObjectIdentificatie' + nummeraanduidingIdentificatie: + $ref: '#/components/schemas/NummeraanduidingIdentificatie' + functieAdres: + $ref: 'common.yaml#/components/schemas/Waardetabel' + woonplaats: + $ref: '#/components/schemas/Woonplaats' + landVanwaarIngeschreven: + $ref: 'common.yaml#/components/schemas/Waardetabel' + straat: + $ref: '#/components/schemas/Straat' + huisnummer: + $ref: '#/components/schemas/Huisnummer' + huisletter: + $ref: '#/components/schemas/Huisletter' + huisnummertoevoeging: + $ref: '#/components/schemas/Huisnummertoevoeging' + aanduidingBijHuisnummer: + $ref: 'common.yaml#/components/schemas/Waardetabel' + postcode: + $ref: '#/components/schemas/Postcode' + locatiebeschrijving: + $ref: '#/components/schemas/Locatiebeschrijving' + land: + $ref: 'common.yaml#/components/schemas/Waardetabel' + datumAanvangAdreshouding: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + datumAanvangAdresBuitenland: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + datumIngangGeldigheid: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + datumInschrijvingInGemeente: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + datumVestigingInNederland: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + gemeenteVanInschrijving: + $ref: 'common.yaml#/components/schemas/Waardetabel' + naamOpenbareRuimte: + $ref: '#/components/schemas/NaamOpenbareRuimte' + inOnderzoek: + $ref: 'gba-inonderzoek.yaml#/components/schemas/GbaInOnderzoek' + VerblijfplaatsBuitenlandInOnderzoek: + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + adresregel1: + type: boolean + adresregel2: + type: boolean + adresregel3: + type: boolean + datumInschrijvingInGemeente: + type: boolean + gemeenteVanInschrijving: + type: boolean + land: + type: boolean + datumVan: + type: boolean + datumIngangGeldigheid: + type: boolean + AdresInOnderzoek: + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + aanduidingBijHuisnummer: + type: boolean + datumVan: + type: boolean + datumIngangGeldigheid: + type: boolean + datumInschrijvingInGemeente: + type: boolean + datumVestigingInNederland: + type: boolean + functieAdres: + type: boolean + gemeenteVanInschrijving: + type: boolean + huisletter: + type: boolean + huisnummer: + type: boolean + huisnummertoevoeging: + type: boolean + nummeraanduidingIdentificatie: + type: boolean + adresseerbaarObjectIdentificatie: + type: boolean + landVanwaarIngeschreven: + type: boolean + straat: + type: boolean + postcode: + type: boolean + korteNaam: + type: boolean + woonplaats: + type: boolean + adresregel1: + type: boolean + adresregel2: + type: boolean + indicatieVestigingVanuitBuitenland: + type: boolean + vanuitVerblijfplaatsOnbekend: + type: boolean + VerblijfplaatsOnbekendInOnderzoek: + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + datumInschrijvingInGemeente: + type: boolean + gemeenteVanInschrijving: + type: boolean + verblijfplaatsOnbekend: + type: boolean + LocatieInOnderzoek: + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + adresregel1: + type: boolean + adresregel2: + type: boolean + datumInschrijvingInGemeente: + type: boolean + datumVestigingInNederland: + type: boolean + functieAdres: + type: boolean + gemeenteVanInschrijving: + type: boolean + indicatieVestigingVanuitBuitenland: + type: boolean + landVanwaarIngeschreven: + type: boolean + locatiebeschrijving: + type: boolean + vanuitVerblijfplaatsOnbekend: + type: boolean + woonplaats: + type: boolean diff --git a/specificatie/verblijfstitel.yaml b/specificatie/verblijfstitel.yaml new file mode 100644 index 000000000..7dadb6e3f --- /dev/null +++ b/specificatie/verblijfstitel.yaml @@ -0,0 +1,53 @@ +openapi: 3.0.3 +info: + title: Verblijfstitel definities + version: 2.0.0 + contact: {} +paths: {} +components: + schemas: + GbaVerblijfstitel: + type: object + description: | + Gegevens over de verblijfsrechtelijke status van de persoon. + * **datumEinde**: Datum waarop de geldigheid van de gegevens over de verblijfstitel is beëindigd. + * **datumIngang**: Datum waarop de gegevens over de verblijfstitel geldig zijn geworden. + * **aanduiding** : Verblijfstiteltabel die aangeeft over welke verblijfsrechtelijke status de persoon beschikt. + properties: + aanduiding: + $ref: 'common.yaml#/components/schemas/Waardetabel' + datumEinde: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + datumIngang: + $ref: 'datum.yaml#/components/schemas/GbaDatum' + inOnderzoek: + $ref: 'gba-inonderzoek.yaml#/components/schemas/GbaInOnderzoek' + Verblijfstitel: + type: object + description: | + Gegevens over de verblijfsrechtelijke status van de persoon. + * **datumEinde**: Datum waarop de geldigheid van de gegevens over de verblijfstitel is beëindigd. + * **datumIngang**: Datum waarop de gegevens over de verblijfstitel geldig zijn geworden. + * **aanduiding** : Verblijfstiteltabel die aangeeft over welke verblijfsrechtelijke status de persoon beschikt. + properties: + aanduiding: + $ref: 'common.yaml#/components/schemas/Waardetabel' + datumEinde: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + datumIngang: + $ref: 'datum.yaml#/components/schemas/AbstractDatum' + inOnderzoek: + $ref: '#/components/schemas/VerblijfstitelInOnderzoek' + VerblijfstitelInOnderzoek: + description: | + Geeft aan welke gegevens over de verblijfstitel in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + allOf: + - $ref: 'persoon.yaml#/components/schemas/InOnderzoek' + - type: object + properties: + aanduiding: + type: boolean + datumEinde: + type: boolean + datumIngang: + type: boolean diff --git a/specificatie/zoek-gba-personen.yaml b/specificatie/zoek-gba-personen.yaml new file mode 100644 index 000000000..75258704d --- /dev/null +++ b/specificatie/zoek-gba-personen.yaml @@ -0,0 +1,164 @@ +openapi: 3.0.3 +info: + title: Zoek Personen endpoint definitie + version: 2.0.0 + contact: {} +paths: + /personen: + post: + operationId: GetPersonen + summary: Vindt personen + description: | + Zoek personen met één van de onderstaande verplichte combinaties van parameters en vul ze evt. aan met optionele parameters. + + + Default krijg je personen terug die nog in leven zijn, tenzij je de inclusiefoverledenpersonen=true opgeeft. + + + Gebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/fields_extensie.feature) + + + 1. Zoek met geslachtsnaam en geboortedatum + - geboortedatum + - geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)) + + + 2. Zoek met geslachtsnaam, voornamen en gemeente van inschrijving + - gemeenteVanInschrijving + - geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)) + + + 3. Raadpleeg met burgerservicenummer + - burgerservicenummer + + + 4. Zoek met postcode en huisnummer + - postcode + - huisnummer + + + 5. Zoek met straat, huisnummer en gemeente van inschrijving + - straat (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)) + - gemeenteVanInschrijving + - huisnummer + + + 6. Zoek met nummeraanduiding identificatie + - nummeraanduidingIdentificatie + + requestBody: + content: + application/json: + schema: + $ref: 'zoek-personen.yaml#/components/schemas/PersonenQuery' + responses: + '200': + description: | + Zoekactie geslaagd + headers: + api-version: + $ref: 'common.yaml#/components/headers/api_version' + warning: + $ref: 'common.yaml#/components/headers/warning' + X-Rate-Limit-Limit: + $ref: 'common.yaml#/components/headers/X_Rate_Limit_Limit' + X-Rate-Limit-Remaining: + $ref: 'common.yaml#/components/headers/X_Rate_Limit_Remaining' + X-Rate-Limit-Reset: + $ref: 'common.yaml#/components/headers/X_Rate_Limit_Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/PersonenQueryResponse' + '400': + $ref: 'common.yaml#/components/responses/400' + '401': + $ref: 'common.yaml#/components/responses/401' + '403': + $ref: 'common.yaml#/components/responses/403' + '406': + $ref: 'common.yaml#/components/responses/406' + '429': + $ref: 'common.yaml#/components/responses/429' + '500': + $ref: 'common.yaml#/components/responses/500' + '501': + $ref: 'common.yaml#/components/responses/501' + '503': + $ref: 'common.yaml#/components/responses/503' + 'default': + $ref: 'common.yaml#/components/responses/default' + tags: + - Personen +components: + schemas: + PersonenQueryResponse: + type: object + required: + - type + discriminator: + propertyName: type + mapping: + ZoekMetGeslachtsnaamEnGeboortedatum: '#/components/schemas/ZoekMetGeslachtsnaamEnGeboortedatumResponse' + ZoekMetNaamEnGemeenteVanInschrijving: '#/components/schemas/ZoekMetNaamEnGemeenteVanInschrijvingResponse' + RaadpleegMetBurgerservicenummer: '#/components/schemas/RaadpleegMetBurgerservicenummerResponse' + ZoekMetPostcodeEnHuisnummer: '#/components/schemas/ZoekMetPostcodeEnHuisnummerResponse' + ZoekMetStraatHuisnummerEnGemeenteVanInschrijving: '#/components/schemas/ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse' + ZoekMetNummeraanduidingIdentificatie: '#/components/schemas/ZoekMetNummeraanduidingIdentificatieResponse' + properties: + type: + type: string + RaadpleegMetBurgerservicenummerResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: 'persoon.yaml#/components/schemas/GbaPersoon' + ZoekMetGeslachtsnaamEnGeboortedatumResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: 'persoon.yaml#/components/schemas/GbaPersoonBeperkt' + ZoekMetNaamEnGemeenteVanInschrijvingResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: 'persoon.yaml#/components/schemas/GbaPersoonBeperkt' + ZoekMetPostcodeEnHuisnummerResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: 'persoon.yaml#/components/schemas/GbaPersoonBeperkt' + ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: 'persoon.yaml#/components/schemas/GbaPersoonBeperkt' + ZoekMetNummeraanduidingIdentificatieResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: 'persoon.yaml#/components/schemas/GbaPersoonBeperkt' diff --git a/specificatie/zoek-personen.yaml b/specificatie/zoek-personen.yaml new file mode 100644 index 000000000..9823c86cd --- /dev/null +++ b/specificatie/zoek-personen.yaml @@ -0,0 +1,296 @@ +openapi: 3.0.3 +info: + title: Zoek Personen endpoint definitie + version: 2.0.0 + contact: {} +paths: + /personen: + post: + operationId: GetPersonen + summary: Vindt personen + description: | + Zoek personen met één van de onderstaande verplichte combinaties van parameters en vul ze evt. aan met optionele parameters. + + + Default krijg je personen terug die nog in leven zijn, tenzij je de inclusiefoverledenpersonen=true opgeeft. + + + Gebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/fields_extensie.feature) + + + 1. Zoek met geslachtsnaam en geboortedatum + - geboortedatum + - geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)) + + + 2. Zoek met geslachtsnaam, voornamen en gemeente van inschrijving + - gemeenteVanInschrijving + - geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)) + + + 3. Raadpleeg met burgerservicenummer + - burgerservicenummer + + + 4. Zoek met postcode en huisnummer + - postcode + - huisnummer + + + 5. Zoek met straat, huisnummer en gemeente van inschrijving + - straat (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)) + - gemeenteVanInschrijving + - huisnummer + + + 6. Zoek met nummeraanduiding identificatie + - nummeraanduidingIdentificatie + + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PersonenQuery' + responses: + '200': + description: | + Zoekactie geslaagd + headers: + api-version: + $ref: 'common.yaml#/components/headers/api_version' + warning: + $ref: 'common.yaml#/components/headers/warning' + X-Rate-Limit-Limit: + $ref: 'common.yaml#/components/headers/X_Rate_Limit_Limit' + X-Rate-Limit-Remaining: + $ref: 'common.yaml#/components/headers/X_Rate_Limit_Remaining' + X-Rate-Limit-Reset: + $ref: 'common.yaml#/components/headers/X_Rate_Limit_Reset' + content: + application/json: + schema: + $ref: '#/components/schemas/PersonenQueryResponse' + '400': + $ref: 'common.yaml#/components/responses/400' + '401': + $ref: 'common.yaml#/components/responses/401' + '403': + $ref: 'common.yaml#/components/responses/403' + '406': + $ref: 'common.yaml#/components/responses/406' + '429': + $ref: 'common.yaml#/components/responses/429' + '500': + $ref: 'common.yaml#/components/responses/500' + '501': + $ref: 'common.yaml#/components/responses/501' + '503': + $ref: 'common.yaml#/components/responses/503' + 'default': + $ref: 'common.yaml#/components/responses/default' + tags: + - Personen +components: + schemas: + InclusiefOverledenPersonen: + description: | + Als je ook overleden personen in het antwoord wilt, geef dan de parameter inclusiefOverledenPersonen op met waarde True. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/overleden_personen.feature) + type: boolean + example: true + PersonenQuery: + type: object + required: + - type + - fields + discriminator: + propertyName: type + mapping: + ZoekMetGeslachtsnaamEnGeboortedatum: '#/components/schemas/ZoekMetGeslachtsnaamEnGeboortedatum' + ZoekMetNaamEnGemeenteVanInschrijving: '#/components/schemas/ZoekMetNaamEnGemeenteVanInschrijving' + RaadpleegMetBurgerservicenummer: '#/components/schemas/RaadpleegMetBurgerservicenummer' + ZoekMetPostcodeEnHuisnummer: '#/components/schemas/ZoekMetPostcodeEnHuisnummer' + ZoekMetStraatHuisnummerEnGemeenteVanInschrijving: '#/components/schemas/ZoekMetStraatHuisnummerEnGemeenteVanInschrijving' + ZoekMetNummeraanduidingIdentificatie: '#/components/schemas/ZoekMetNummeraanduidingIdentificatie' + properties: + type: + type: string + fields: + $ref: 'filter.yaml#/components/schemas/Fields' + gemeenteVanInschrijving: + $ref: 'verblijfplaats.yaml#/components/schemas/GemeenteVanInschrijving' + RaadpleegMetBurgerservicenummer: + required: + - burgerservicenummer + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + burgerservicenummer: + type: array + items: + $ref: 'persoon.yaml#/components/schemas/Burgerservicenummer' + minItems: 1 + maxItems: 20 + ZoekMetGeslachtsnaamEnGeboortedatum: + required: + - geslachtsnaam + - geboortedatum + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + geboortedatum: + description: | + Je kunt alleen zoeken met een volledig geboortedatum. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/parametervalidatie.feature) + type: string + format: date + example: "1964-09-24" + geboorteplaats: + $ref: 'filter.yaml#/components/schemas/GeboorteplaatsFilter' + geslachtsnaam: + $ref: 'filter.yaml#/components/schemas/GeslachtsnaamFilter' + geslachtsaanduiding: + $ref: 'filter.yaml#/components/schemas/GeslachtsaanduidingFilter' + voorvoegsel: + $ref: 'filter.yaml#/components/schemas/VoorvoegselFilter' + voornamen: + $ref: 'filter.yaml#/components/schemas/VoornamenOptioneelFilter' + ZoekMetNaamEnGemeenteVanInschrijving: + required: + - geslachtsnaam + - gemeenteVanInschrijving + - voornamen + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + geslachtsaanduiding: + $ref: 'filter.yaml#/components/schemas/GeslachtsaanduidingFilter' + geslachtsnaam: + $ref: 'filter.yaml#/components/schemas/GeslachtsnaamFilter' + voorvoegsel: + $ref: 'filter.yaml#/components/schemas/VoorvoegselFilter' + voornamen: + $ref: 'filter.yaml#/components/schemas/VoornamenVerplichtFilter' + ZoekMetPostcodeEnHuisnummer: + required: + - postcode + - huisnummer + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + huisletter: + $ref: 'verblijfplaats.yaml#/components/schemas/Huisletter' + huisnummer: + $ref: 'verblijfplaats.yaml#/components/schemas/Huisnummer' + huisnummertoevoeging: + $ref: 'verblijfplaats.yaml#/components/schemas/Huisnummertoevoeging' + postcode: + $ref: 'verblijfplaats.yaml#/components/schemas/Postcode' + ZoekMetStraatHuisnummerEnGemeenteVanInschrijving: + required: + - straat + - huisnummer + - gemeenteVanInschrijving + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + huisletter: + $ref: 'verblijfplaats.yaml#/components/schemas/Huisletter' + huisnummer: + $ref: 'verblijfplaats.yaml#/components/schemas/Huisnummer' + huisnummertoevoeging: + $ref: 'verblijfplaats.yaml#/components/schemas/Huisnummertoevoeging' + straat: + $ref: 'filter.yaml#/components/schemas/StraatFilter' + ZoekMetNummeraanduidingIdentificatie: + required: + - nummeraanduidingIdentificatie + allOf: + - $ref: '#/components/schemas/PersonenQuery' + - type: object + properties: + inclusiefOverledenPersonen: + $ref: '#/components/schemas/InclusiefOverledenPersonen' + nummeraanduidingIdentificatie: + $ref: 'verblijfplaats.yaml#/components/schemas/NummeraanduidingIdentificatie' + PersonenQueryResponse: + type: object + required: + - type + discriminator: + propertyName: type + mapping: + ZoekMetGeslachtsnaamEnGeboortedatum: '#/components/schemas/ZoekMetGeslachtsnaamEnGeboortedatumResponse' + ZoekMetNaamEnGemeenteVanInschrijving: '#/components/schemas/ZoekMetNaamEnGemeenteVanInschrijvingResponse' + RaadpleegMetBurgerservicenummer: '#/components/schemas/RaadpleegMetBurgerservicenummerResponse' + ZoekMetPostcodeEnHuisnummer: '#/components/schemas/ZoekMetPostcodeEnHuisnummerResponse' + ZoekMetStraatHuisnummerEnGemeenteVanInschrijving: '#/components/schemas/ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse' + ZoekMetNummeraanduidingIdentificatie: '#/components/schemas/ZoekMetNummeraanduidingIdentificatieResponse' + properties: + type: + type: string + RaadpleegMetBurgerservicenummerResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: 'persoon.yaml#/components/schemas/Persoon' + ZoekMetGeslachtsnaamEnGeboortedatumResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: 'persoon.yaml#/components/schemas/PersoonBeperkt' + ZoekMetNaamEnGemeenteVanInschrijvingResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: 'persoon.yaml#/components/schemas/PersoonBeperkt' + ZoekMetPostcodeEnHuisnummerResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: 'persoon.yaml#/components/schemas/PersoonBeperkt' + ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: 'persoon.yaml#/components/schemas/PersoonBeperkt' + ZoekMetNummeraanduidingIdentificatieResponse: + allOf: + - $ref: '#/components/schemas/PersonenQueryResponse' + - type: object + properties: + personen: + type: array + items: + $ref: 'persoon.yaml#/components/schemas/PersoonBeperkt' diff --git a/src/BrpProxy/BrpProxy.csproj b/src/BrpProxy/BrpProxy.csproj new file mode 100644 index 000000000..c7c845a99 --- /dev/null +++ b/src/BrpProxy/BrpProxy.csproj @@ -0,0 +1,21 @@ + + + + net6.0 + enable + enable + cc46c4af-2126-40a9-a6cc-c3d7d53f86f3 + Linux + ..\.. + + + + + + + + + + + + diff --git a/src/BrpProxy/DataTransferObjects.cs b/src/BrpProxy/DataTransferObjects.cs new file mode 100644 index 000000000..0e48ce81e --- /dev/null +++ b/src/BrpProxy/DataTransferObjects.cs @@ -0,0 +1,2594 @@ +//---------------------- +// +// Generated using the NSwag toolchain v13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0)) (http://NSwag.org) +// +//---------------------- + +#pragma warning disable 108 // Disable "CS0108 '{derivedDto}.ToJson()' hides inherited member '{dtoBase}.ToJson()'. Use the new keyword if hiding was intended." +#pragma warning disable 114 // Disable "CS0114 '{derivedDto}.RaisePropertyChanged(String)' hides inherited member 'dtoBase.RaisePropertyChanged(String)'. To make the current member override that implementation, add the override keyword. Otherwise add the new keyword." +#pragma warning disable 472 // Disable "CS0472 The result of the expression is always 'false' since a value of type 'Int32' is never equal to 'null' of type 'Int32?' +#pragma warning disable 1573 // Disable "CS1573 Parameter '...' has no matching param tag in the XML comment for ... +#pragma warning disable 1591 // Disable "CS1591 Missing XML comment for publicly visible type or member ..." +#pragma warning disable 8073 // Disable "CS8073 The result of the expression is always 'false' since a value of type 'T' is never equal to 'null' of type 'T?'" +#pragma warning disable 3016 // Disable "CS3016 Arrays as attribute arguments is not CLS-compliant" +#pragma warning disable 8603 // Disable "CS8603 Possible null reference return" + +namespace HaalCentraal.BrpProxy.Generated +{ + using System = global::System; + + + + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("ZoekMetGeslachtsnaamEnGeboortedatum", typeof(ZoekMetGeslachtsnaamEnGeboortedatumResponse))] + [JsonInheritanceAttribute("ZoekMetGeslachtsnaamEnGemeenteVanInschrijving", typeof(ZoekMetGeslachtsnaamEnGemeenteVanInschrijvingResponse))] + [JsonInheritanceAttribute("RaadpleegMetBurgerservicenummer", typeof(RaadpleegMetBurgerservicenummerResponse))] + [JsonInheritanceAttribute("ZoekMetPostcodeEnHuisnummer", typeof(ZoekMetPostcodeEnHuisnummerResponse))] + [JsonInheritanceAttribute("ZoekMetStraatHuisnummerEnGemeenteVanInschrijving", typeof(ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse))] + [JsonInheritanceAttribute("ZoekMetNummeraanduidingIdentificatie", typeof(ZoekMetNummeraanduidingIdentificatieResponse))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class PersonenQueryResponse + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetGeslachtsnaamEnGeboortedatumResponse : PersonenQueryResponse + { + [Newtonsoft.Json.JsonProperty("personen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.ICollection Personen { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetGeslachtsnaamEnGemeenteVanInschrijvingResponse : PersonenQueryResponse + { + [Newtonsoft.Json.JsonProperty("personen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.ICollection Personen { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class RaadpleegMetBurgerservicenummerResponse : PersonenQueryResponse + { + [Newtonsoft.Json.JsonProperty("personen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.ICollection Personen { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetPostcodeEnHuisnummerResponse : PersonenQueryResponse + { + [Newtonsoft.Json.JsonProperty("personen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.ICollection Personen { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse : PersonenQueryResponse + { + [Newtonsoft.Json.JsonProperty("personen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.ICollection Personen { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetNummeraanduidingIdentificatieResponse : PersonenQueryResponse + { + [Newtonsoft.Json.JsonProperty("personen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.ICollection Personen { get; set; } + + } + + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("ZoekMetGeslachtsnaamEnGeboortedatum", typeof(ZoekMetGeslachtsnaamEnGeboortedatum))] + [JsonInheritanceAttribute("ZoekMetGeslachtsnaamEnGemeenteVanInschrijving", typeof(ZoekMetGeslachtsnaamEnGemeenteVanInschrijving))] + [JsonInheritanceAttribute("RaadpleegMetBurgerservicenummer", typeof(RaadpleegMetBurgerservicenummer))] + [JsonInheritanceAttribute("ZoekMetPostcodeEnHuisnummer", typeof(ZoekMetPostcodeEnHuisnummer))] + [JsonInheritanceAttribute("ZoekMetStraatHuisnummerEnGemeenteVanInschrijving", typeof(ZoekMetStraatHuisnummerEnGemeenteVanInschrijving))] + [JsonInheritanceAttribute("ZoekMetNummeraanduidingIdentificatie", typeof(ZoekMetNummeraanduidingIdentificatie))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class PersonenQuery + { + [Newtonsoft.Json.JsonProperty("fields", Required = Newtonsoft.Json.Required.Always)] + public string Fields { get; set; } + + [Newtonsoft.Json.JsonProperty("gemeenteVanInschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string GemeenteVanInschrijving { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetGeslachtsnaamEnGeboortedatum : PersonenQuery + { + [Newtonsoft.Json.JsonProperty("inclusiefOverledenPersonen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool InclusiefOverledenPersonen { get; set; } + + /// + /// Je kunt alleen zoeken met een volledig geboortedatum. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/parametervalidatie.feature) + ///
+ /// + [Newtonsoft.Json.JsonProperty("geboortedatum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [Newtonsoft.Json.JsonConverter(typeof(DateFormatConverter))] + public System.DateTimeOffset? Geboortedatum { get; set; } + + /// + /// Gemeentenaam of een buitenlandse plaats of een plaatsbepaling, die aangeeft waar de persoon is geboren. **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + ///
+ /// + [Newtonsoft.Json.JsonProperty("geboorteplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Geboorteplaats { get; set; } + + /// + /// De (geslachts)naam waarvan de eventueel aanwezige voorvoegsels zijn afgesplitst. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + ///
+ /// + [Newtonsoft.Json.JsonProperty("geslachtsnaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Geslachtsnaam { get; set; } + + /// + /// Geeft aan dat de persoon een man of een vrouw is, of dat het geslacht (nog) onbekend is. + ///
+ /// + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Geslachtsaanduiding { get; set; } + + /// + /// Deel van de geslachtsnaam dat vooraf gaat aan de rest van de geslachtsnaam. Het zoeken op het voorvoegsel is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + ///
+ /// + [Newtonsoft.Json.JsonProperty("voorvoegsel", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Voorvoegsel { get; set; } + + /// + /// De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + ///
+ /// + [Newtonsoft.Json.JsonProperty("voornamen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Voornamen { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetGeslachtsnaamEnGemeenteVanInschrijving : PersonenQuery + { + [Newtonsoft.Json.JsonProperty("inclusiefOverledenPersonen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool InclusiefOverledenPersonen { get; set; } + + /// + /// Geeft aan dat de persoon een man of een vrouw is, of dat het geslacht (nog) onbekend is. + ///
+ /// + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Geslachtsaanduiding { get; set; } + + /// + /// De (geslachts)naam waarvan de eventueel aanwezige voorvoegsels zijn afgesplitst. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + ///
+ /// + [Newtonsoft.Json.JsonProperty("geslachtsnaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Geslachtsnaam { get; set; } + + /// + /// Deel van de geslachtsnaam dat vooraf gaat aan de rest van de geslachtsnaam. Het zoeken op het voorvoegsel is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + ///
+ /// + [Newtonsoft.Json.JsonProperty("voorvoegsel", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Voorvoegsel { get; set; } + + /// + /// De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + ///
+ /// + [Newtonsoft.Json.JsonProperty("voornamen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Voornamen { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class RaadpleegMetBurgerservicenummer : PersonenQuery + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.ICollection Burgerservicenummer { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetPostcodeEnHuisnummer : PersonenQuery + { + [Newtonsoft.Json.JsonProperty("inclusiefOverledenPersonen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool InclusiefOverledenPersonen { get; set; } + + [Newtonsoft.Json.JsonProperty("huisletter", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Huisletter { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int Huisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummertoevoeging", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Huisnummertoevoeging { get; set; } + + [Newtonsoft.Json.JsonProperty("postcode", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Postcode { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetStraatHuisnummerEnGemeenteVanInschrijving : PersonenQuery + { + [Newtonsoft.Json.JsonProperty("inclusiefOverledenPersonen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool InclusiefOverledenPersonen { get; set; } + + [Newtonsoft.Json.JsonProperty("huisletter", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Huisletter { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int Huisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummertoevoeging", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Huisnummertoevoeging { get; set; } + + [Newtonsoft.Json.JsonProperty("straat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Straat { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetNummeraanduidingIdentificatie : PersonenQuery + { + [Newtonsoft.Json.JsonProperty("inclusiefOverledenPersonen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool InclusiefOverledenPersonen { get; set; } + + [Newtonsoft.Json.JsonProperty("nummeraanduidingIdentificatie", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string NummeraanduidingIdentificatie { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class BadRequestFoutbericht : Foutbericht + { + /// + /// Foutmelding per fout in een parameter. Alle gevonden fouten worden ��n keer teruggemeld. + /// + [Newtonsoft.Json.JsonProperty("invalidParams", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.ICollection InvalidParams { get; set; } + + } + + /// + /// Terugmelding bij een fout. JSON representatie in lijn met [RFC7807](https://tools.ietf.org/html/rfc7807). + /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Foutbericht + { + /// + /// Link naar meer informatie over deze fout + /// + [Newtonsoft.Json.JsonProperty("type", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Uri Type { get; set; } + + /// + /// Beschrijving van de fout + /// + [Newtonsoft.Json.JsonProperty("title", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Title { get; set; } + + /// + /// Http status code + /// + [Newtonsoft.Json.JsonProperty("status", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int? Status { get; set; } + + /// + /// Details over de fout + /// + [Newtonsoft.Json.JsonProperty("detail", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Detail { get; set; } + + /// + /// Uri van de aanroep die de fout heeft veroorzaakt + /// + [Newtonsoft.Json.JsonProperty("instance", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Uri Instance { get; set; } + + /// + /// Systeemcode die het type fout aangeeft + /// + [Newtonsoft.Json.JsonProperty("code", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Code { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Details over fouten in opgegeven parameters + /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class InvalidParams + { + [Newtonsoft.Json.JsonProperty("type", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Uri Type { get; set; } + + /// + /// Naam van de parameter + /// + [Newtonsoft.Json.JsonProperty("name", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Name { get; set; } + + /// + /// Systeemcode die het type fout aangeeft + /// + [Newtonsoft.Json.JsonProperty("code", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Code { get; set; } + + /// + /// Beschrijving van de fout op de parameterwaarde + /// + [Newtonsoft.Json.JsonProperty("reason", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Reason { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class PersoonBeperkt + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("geboorte", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GeboorteBeperkt Geboorte { get; set; } + + [Newtonsoft.Json.JsonProperty("geheimhoudingPersoonsgegevens", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractGeheimhoudingPersoonsgegevens GeheimhoudingPersoonsgegevens { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Geslachtsaanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("leeftijd", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int Leeftijd { get; set; } + + [Newtonsoft.Json.JsonProperty("naam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public NaamBasis Naam { get; set; } + + [Newtonsoft.Json.JsonProperty("opschortingBijhouding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public OpschortingBijhoudingBasis OpschortingBijhouding { get; set; } + + [Newtonsoft.Json.JsonProperty("overlijden", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractOverlijdenBasis Overlijden { get; set; } + + [Newtonsoft.Json.JsonProperty("verblijfplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractVerblijfplaatsBeperkt Verblijfplaats { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Waardetabel + { + [Newtonsoft.Json.JsonProperty("code", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Code { get; set; } + + [Newtonsoft.Json.JsonProperty("omschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Omschrijving { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Persoon + { + /// + /// Het A-nummer van de persoon + ///
+ /// + [Newtonsoft.Json.JsonProperty("aNummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string ANummer { get; set; } + + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("datumEersteInschrijvingGBA", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumEersteInschrijvingGBA { get; set; } + + [Newtonsoft.Json.JsonProperty("geheimhoudingPersoonsgegevens", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractGeheimhoudingPersoonsgegevens GeheimhoudingPersoonsgegevens { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Geslachtsaanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractPersoonInOnderzoek InOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("kiesrecht", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Kiesrecht Kiesrecht { get; set; } + + [Newtonsoft.Json.JsonProperty("leeftijd", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int Leeftijd { get; set; } + + [Newtonsoft.Json.JsonProperty("naam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public NaamPersoon Naam { get; set; } + + [Newtonsoft.Json.JsonProperty("nationaliteiten", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.ICollection Nationaliteiten { get; set; } + + [Newtonsoft.Json.JsonProperty("geboorte", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Geboorte Geboorte { get; set; } + + [Newtonsoft.Json.JsonProperty("opschortingBijhouding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public OpschortingBijhouding OpschortingBijhouding { get; set; } + + [Newtonsoft.Json.JsonProperty("overlijden", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Overlijden Overlijden { get; set; } + + [Newtonsoft.Json.JsonProperty("verblijfplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractVerblijfplaats Verblijfplaats { get; set; } + + [Newtonsoft.Json.JsonProperty("gezagsverhouding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Gezagsverhouding Gezagsverhouding { get; set; } + + [Newtonsoft.Json.JsonProperty("verblijfstitel", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Verblijfstitel Verblijfstitel { get; set; } + + [Newtonsoft.Json.JsonProperty("reisdocumentnummers", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.ICollection Reisdocumentnummers { get; set; } + + [Newtonsoft.Json.JsonProperty("kinderen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.ICollection Kinderen { get; set; } + + [Newtonsoft.Json.JsonProperty("ouders", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.ICollection Ouders { get; set; } + + [Newtonsoft.Json.JsonProperty("partners", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.ICollection Partners { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Geeft aan welke gegevens van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature). + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaPersoonInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(PersoonInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractPersoonInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaPersoonInOnderzoek : AbstractPersoonInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class PersoonInOnderzoek : AbstractPersoonInOnderzoek + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Geslachtsaanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GeboorteBeperkt + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum Datum { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Gegevens mogen niet worden verstrekt aan derden / maatschappelijke instellingen. + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaGeheimhouding", typeof(GbaGeheimhoudingPersoonsgegevens))] + [JsonInheritanceAttribute("Geheimhouding", typeof(GeheimhoudingPersoonsgegevens))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractGeheimhoudingPersoonsgegevens + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaGeheimhoudingPersoonsgegevens : AbstractGeheimhoudingPersoonsgegevens + { + [Newtonsoft.Json.JsonProperty("waarde", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int? Waarde { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GeheimhoudingPersoonsgegevens : AbstractGeheimhoudingPersoonsgegevens + { + [Newtonsoft.Json.JsonProperty("geheimhouding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Geheimhouding { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class NaamBasis : GbaNaamBasis + { + [Newtonsoft.Json.JsonProperty("voorletters", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Voorletters { get; set; } + + [Newtonsoft.Json.JsonProperty("volledigeNaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string VolledigeNaam { get; set; } + + [Newtonsoft.Json.JsonProperty("adellijkeTitelPredikaat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public WaardetabelMetSoort AdellijkeTitelPredikaat { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaNaamBasis + { + [Newtonsoft.Json.JsonProperty("voornamen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Voornamen { get; set; } + + [Newtonsoft.Json.JsonProperty("voorvoegsel", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Voorvoegsel { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsnaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Geslachtsnaam { get; set; } + + [Newtonsoft.Json.JsonProperty("adellijkeTitelPredikaat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel AdellijkeTitelPredikaat { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class WaardetabelMetSoort : Waardetabel + { + [Newtonsoft.Json.JsonProperty("soort", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Soort { get; set; } + + } + + /// + /// * **reden** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'redenopschortingbijhouding' uit de Haal-Centraal-BRP-tabellen-bevragen API. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OpschortingBijhoudingBasis + { + [Newtonsoft.Json.JsonProperty("reden", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Reden { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Gegevens over het overlijden van de persoon. + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaOverlijden", typeof(GbaOverlijdenBasis))] + [JsonInheritanceAttribute("Overlijden", typeof(OverlijdenBasis))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractOverlijdenBasis + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaOverlijdenBasis : AbstractOverlijdenBasis + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis Datum { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OverlijdenBasis : AbstractOverlijdenBasis + { + [Newtonsoft.Json.JsonProperty("indicatieOverleden", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool IndicatieOverleden { get; set; } + + } + + /// + /// Gegevens over het verblijf of de woonlocatie van een persoon. + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaVerblijfplaats", typeof(GbaVerblijfplaatsBeperkt))] + [JsonInheritanceAttribute("VerblijfplaatsBuitenland", typeof(VerblijfplaatsBuitenlandBeperkt))] + [JsonInheritanceAttribute("Adres", typeof(AdresBeperkt))] + [JsonInheritanceAttribute("Locatie", typeof(LocatieBeperkt))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractVerblijfplaatsBeperkt + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaVerblijfplaatsBeperkt : AbstractVerblijfplaatsBeperkt + { + [Newtonsoft.Json.JsonProperty("straat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Straat { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int Huisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("huisletter", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Huisletter { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummertoevoeging", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Huisnummertoevoeging { get; set; } + + [Newtonsoft.Json.JsonProperty("aanduidingBijHuisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel AanduidingBijHuisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("postcode", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Postcode { get; set; } + + [Newtonsoft.Json.JsonProperty("locatiebeschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Locatiebeschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Land { get; set; } + + [Newtonsoft.Json.JsonProperty("gemeenteVanInschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string GemeenteVanInschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel1 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel2 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel3", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel3 { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VerblijfplaatsBuitenlandBeperkt : AbstractVerblijfplaatsBeperkt + { + [Newtonsoft.Json.JsonProperty("adresregel1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel1 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel2 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel3", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel3 { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Land { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AdresBeperkt : AbstractVerblijfplaatsBeperkt + { + [Newtonsoft.Json.JsonProperty("functieAdres", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel FunctieAdres { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel1 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel2 { get; set; } + + [Newtonsoft.Json.JsonProperty("woonplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Woonplaats { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VerblijfplaatsOnbekend : AbstractVerblijfplaats + { + [Newtonsoft.Json.JsonProperty("vertrokkenOnbekendWaarheen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool VertrokkenOnbekendWaarheen { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public VerblijfplaatsOnbekendInOnderzoek InOnderzoek { get; set; } + + } + + /// + /// Gegevens over het verblijf of de woonlocatie van een persoon. + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("VerblijfplaatsOnbekend", typeof(VerblijfplaatsOnbekend))] + [JsonInheritanceAttribute("GbaVerblijfplaats", typeof(GbaVerblijfplaats))] + [JsonInheritanceAttribute("VerblijfplaatsBuitenland", typeof(VerblijfplaatsBuitenland))] + [JsonInheritanceAttribute("Adres", typeof(Adres))] + [JsonInheritanceAttribute("Locatie", typeof(Locatie))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractVerblijfplaats + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaVerblijfplaats : AbstractVerblijfplaats + { + [Newtonsoft.Json.JsonProperty("straat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Straat { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int Huisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("huisletter", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Huisletter { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummertoevoeging", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Huisnummertoevoeging { get; set; } + + [Newtonsoft.Json.JsonProperty("aanduidingBijHuisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel AanduidingBijHuisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("postcode", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Postcode { get; set; } + + [Newtonsoft.Json.JsonProperty("locatiebeschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Locatiebeschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Land { get; set; } + + [Newtonsoft.Json.JsonProperty("datumAanvangAdreshouding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatum DatumAanvangAdreshouding { get; set; } + + [Newtonsoft.Json.JsonProperty("datumAanvangAdresBuitenland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatum DatumAanvangAdresBuitenland { get; set; } + + [Newtonsoft.Json.JsonProperty("gemeenteVanInschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string GemeenteVanInschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("naamOpenbareRuimte", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string NaamOpenbareRuimte { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaInOnderzoek InOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VerblijfplaatsBuitenland : AbstractVerblijfplaats + { + [Newtonsoft.Json.JsonProperty("adresregel1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel1 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel2 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel3", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel3 { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Land { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVan", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumVan { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public VerblijfplaatsBuitenlandInOnderzoek InOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VerblijfplaatsBuitenlandInOnderzoek + { + [Newtonsoft.Json.JsonProperty("verblijfBuitenland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? VerblijfBuitenland { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVan", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumVan { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Gegevens over het adres van een persoon. + ///
* **datumVan** : de datum van aangifte of ambtshalve melding van verblijf en adres. + ///
* **datumIngangGeldigheid** : datum waarop de gegevens over de verblijfplaats geldig zijn geworden. + ///
* **datumInschrijvingInGemeente**: bij inschrijving op grond van een verhuisaangifte door de burger is dit de aangiftedatum. Bij inschrijving op grond van een geboorteakte is dit de geboortedatum. Bij ambtshalve inschrijving is dit de datum waarop het voornemen van ambtshalve opneming schriftelijk aan de persoon is medegedeeld. + ///
* **datumVestigingInNederland** : datum van inschrijving in Nederland. + ///
* **landVanWaarIngeschreven** : het land waar de persoon woonde voor (her)vestiging in Nederland. + ///
* **gemeenteVanInschrijving** : de gemeente waar de persoon verblijft en is ingeschreven. De code kan voorloopnullen bevatten." + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Adres : AbstractVerblijfplaats + { + [Newtonsoft.Json.JsonProperty("functieAdres", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel FunctieAdres { get; set; } + + [Newtonsoft.Json.JsonProperty("straat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Straat { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int Huisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("huisletter", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Huisletter { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummertoevoeging", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Huisnummertoevoeging { get; set; } + + [Newtonsoft.Json.JsonProperty("aanduidingBijHuisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel AanduidingBijHuisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("postcode", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Postcode { get; set; } + + [Newtonsoft.Json.JsonProperty("adresseerbaarObjectIdentificatie", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string AdresseerbaarObjectIdentificatie { get; set; } + + [Newtonsoft.Json.JsonProperty("nummeraanduidingIdentificatie", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string NummeraanduidingIdentificatie { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel1 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel2 { get; set; } + + [Newtonsoft.Json.JsonProperty("woonplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Woonplaats { get; set; } + + [Newtonsoft.Json.JsonProperty("indicatieVestigingVanuitBuitenland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool IndicatieVestigingVanuitBuitenland { get; set; } + + [Newtonsoft.Json.JsonProperty("korteNaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string KorteNaam { get; set; } + + [Newtonsoft.Json.JsonProperty("vanuitVertrokkenOnbekendWaarheen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool VanuitVertrokkenOnbekendWaarheen { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVan", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumVan { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("datumInschrijvingInGemeente", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumInschrijvingInGemeente { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVestigingInNederland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumVestigingInNederland { get; set; } + + [Newtonsoft.Json.JsonProperty("gemeenteVanInschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel GemeenteVanInschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("landVanwaarIngeschreven", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel LandVanwaarIngeschreven { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public VerblijfplaatsInOnderzoek InOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VerblijfplaatsInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingBijHuisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? AanduidingBijHuisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVan", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumVan { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("datumInschrijvingInGemeente", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumInschrijvingInGemeente { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVestigingInNederland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumVestigingInNederland { get; set; } + + [Newtonsoft.Json.JsonProperty("functieAdres", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? FunctieAdres { get; set; } + + [Newtonsoft.Json.JsonProperty("gemeenteVanInschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? GemeenteVanInschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("huisletter", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Huisletter { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Huisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummertoevoeging", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Huisnummertoevoeging { get; set; } + + [Newtonsoft.Json.JsonProperty("nummeraanduidingIdentificatie", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? NummeraanduidingIdentificatie { get; set; } + + [Newtonsoft.Json.JsonProperty("adresseerbaarObjectIdentificatie", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? AdresseerbaarObjectIdentificatie { get; set; } + + [Newtonsoft.Json.JsonProperty("landVanwaarIngeschreven", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? LandVanwaarIngeschreven { get; set; } + + [Newtonsoft.Json.JsonProperty("straat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Straat { get; set; } + + [Newtonsoft.Json.JsonProperty("postcode", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Postcode { get; set; } + + [Newtonsoft.Json.JsonProperty("korteNaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? KorteNaam { get; set; } + + [Newtonsoft.Json.JsonProperty("woonplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Woonplaats { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Locatie : AbstractVerblijfplaats + { + [Newtonsoft.Json.JsonProperty("adresregel1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel1 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel2 { get; set; } + + [Newtonsoft.Json.JsonProperty("datumInschrijvingInGemeente", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumInschrijvingInGemeente { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVestigingInNederland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumVestigingInNederland { get; set; } + + [Newtonsoft.Json.JsonProperty("functieAdres", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel FunctieAdres { get; set; } + + [Newtonsoft.Json.JsonProperty("gemeenteVanInschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel GemeenteVanInschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("indicatieVestigingVanuitBuitenland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool IndicatieVestigingVanuitBuitenland { get; set; } + + [Newtonsoft.Json.JsonProperty("landVanwaarIngeschreven", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel LandVanwaarIngeschreven { get; set; } + + [Newtonsoft.Json.JsonProperty("locatiebeschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Locatiebeschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("vanuitVertrokkenOnbekendWaarheen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool VanuitVertrokkenOnbekendWaarheen { get; set; } + + [Newtonsoft.Json.JsonProperty("woonplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Woonplaats { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public LocatieInOnderzoek InOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class LocatieInOnderzoek + { + [Newtonsoft.Json.JsonProperty("datumInschrijvingInGemeente", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumInschrijvingInGemeente { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVestigingInNederland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumVestigingInNederland { get; set; } + + [Newtonsoft.Json.JsonProperty("functieAdres", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? FunctieAdres { get; set; } + + [Newtonsoft.Json.JsonProperty("gemeenteVanInschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? GemeenteVanInschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("landVanwaarIngeschreven", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? LandVanwaarIngeschreven { get; set; } + + [Newtonsoft.Json.JsonProperty("locatiebeschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Locatiebeschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("woonplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Woonplaats { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VerblijfplaatsOnbekendInOnderzoek + { + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Land { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class LocatieBeperkt : AbstractVerblijfplaatsBeperkt + { + [Newtonsoft.Json.JsonProperty("adresregel1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel1 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel2 { get; set; } + + [Newtonsoft.Json.JsonProperty("functieAdres", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel FunctieAdres { get; set; } + + [Newtonsoft.Json.JsonProperty("locatiebeschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Locatiebeschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("woonplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Woonplaats { get; set; } + + } + + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaDatum", typeof(GbaDatum))] + [JsonInheritanceAttribute("Datum", typeof(VolledigDatum))] + [JsonInheritanceAttribute("OnbekendDatum", typeof(OnbekendDatum))] + [JsonInheritanceAttribute("JaarDatum", typeof(JaarDatum))] + [JsonInheritanceAttribute("JaarMaandDatum", typeof(JaarMaandDatum))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractDatum + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Datum conform LO GBA + /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaDatum : AbstractDatum + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Datum { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaDatumBasis + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Datum { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Datum conform iso8601 + /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VolledigDatum : AbstractDatum + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [Newtonsoft.Json.JsonConverter(typeof(DateFormatConverter))] + public System.DateTimeOffset? Datum { get; set; } + + } + + /// + /// representatie voor een volledig onbekend datum + /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OnbekendDatum : AbstractDatum + { + [Newtonsoft.Json.JsonProperty("onbekend", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Onbekend { get; set; } = true; + + } + + /// + /// representatie voor een datum waarvan maand en dag onbekend zijn + /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class JaarDatum : AbstractDatum + { + [Newtonsoft.Json.JsonProperty("jaar", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int Jaar { get; set; } + + } + + /// + /// representatie voor een datum waarvan de dag onbekend is + /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class JaarMaandDatum : AbstractDatum + { + [Newtonsoft.Json.JsonProperty("jaar", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int Jaar { get; set; } + + [Newtonsoft.Json.JsonProperty("maand", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int Maand { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Kiesrecht + { + /// + /// Geeft aan of persoon een oproep moet ontvangen voor verkiezingen voor het Europees parlement. + ///
+ /// + [Newtonsoft.Json.JsonProperty("europeesKiesrecht", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? EuropeesKiesrecht { get; set; } + + [Newtonsoft.Json.JsonProperty("uitgeslotenVanKiesrecht", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? UitgeslotenVanKiesrecht { get; set; } + + [Newtonsoft.Json.JsonProperty("einddatumUitsluitingEuropeesKiesrecht", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum EinddatumUitsluitingEuropeesKiesrecht { get; set; } + + [Newtonsoft.Json.JsonProperty("einddatumUitsluitingKiesrecht", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum EinddatumUitsluitingKiesrecht { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class NaamPersoon : NaamBasis + { + [Newtonsoft.Json.JsonProperty("aanhef", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Aanhef { get; set; } + + [Newtonsoft.Json.JsonProperty("aanschrijfwijze", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Aanschrijfwijze { get; set; } + + [Newtonsoft.Json.JsonProperty("regelVoorafgaandAanAanschrijfwijze", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string RegelVoorafgaandAanAanschrijfwijze { get; set; } + + [Newtonsoft.Json.JsonProperty("gebruikInLopendeTekst", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string GebruikInLopendeTekst { get; set; } + + [Newtonsoft.Json.JsonProperty("aanduidingNaamgebruik", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel AanduidingNaamgebruik { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractNaamPersoonInOnderzoek InOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Geeft aan welke gegevens over de naam in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaNaamPersoonInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(NaamPersoonInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractNaamPersoonInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaNaamPersoonInOnderzoek : AbstractNaamPersoonInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class NaamPersoonInOnderzoek : AbstractNaamPersoonInOnderzoek + { + [Newtonsoft.Json.JsonProperty("geslachtsnaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Geslachtsnaam { get; set; } + + [Newtonsoft.Json.JsonProperty("voornamen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Voornamen { get; set; } + + [Newtonsoft.Json.JsonProperty("voorvoegsel", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Voorvoegsel { get; set; } + + [Newtonsoft.Json.JsonProperty("adellijkeTitelPredikaat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? AdellijkeTitelPredikaat { get; set; } + + [Newtonsoft.Json.JsonProperty("aanduidingNaamgebruik", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? AanduidingNaamgebruik { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + /// + /// * **redenOpname** : De reden op grond waarvan de persoon de nationaliteit gekregen heeft. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Nationaliteit : AbstractNationaliteit + { + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("nationaliteit", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Nationaliteit1 { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public NationaliteitInOnderzoek InOnderzoek { get; set; } + + } + + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("Nationaliteit", typeof(Nationaliteit))] + [JsonInheritanceAttribute("GbaNationaliteit", typeof(GbaNationaliteit))] + [JsonInheritanceAttribute("BehandeldAlsNederlander", typeof(BehandeldAlsNederlander))] + [JsonInheritanceAttribute("VastgesteldNietNederlander", typeof(VastgesteldNietNederlander))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractNationaliteit + { + [Newtonsoft.Json.JsonProperty("redenOpname", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel RedenOpname { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Bij de LO GBA versie kunnen datums, bijv datumIngangGeldigheid de LoGbaDatum refereren + ///
Het hoeft niet van AbstractDatum af te leiden omdat het nooit een andere type kan zijn + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaNationaliteit : AbstractNationaliteit + { + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("nationaliteit", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Nationaliteit { get; set; } + + [Newtonsoft.Json.JsonProperty("aanduidingBijzonderNederlandschap", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel AanduidingBijzonderNederlandschap { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaInOnderzoek InOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class BehandeldAlsNederlander : AbstractNationaliteit + { + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public BijzonderNederlanderschapInOnderzoek InOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class BijzonderNederlanderschapInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingBijzonderNederlanderschap", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? AanduidingBijzonderNederlanderschap { get; set; } + + [Newtonsoft.Json.JsonProperty("redenOpname", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? RedenOpname { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VastgesteldNietNederlander : AbstractNationaliteit + { + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public BijzonderNederlanderschapInOnderzoek InOnderzoek { get; set; } + + } + + /// + /// Geeft aan welke gegevens over de nationaliteit in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class NationaliteitInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingBijzonderNederlanderschap", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? AanduidingBijzonderNederlanderschap { get; set; } + + [Newtonsoft.Json.JsonProperty("nationaliteit", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Nationaliteit { get; set; } + + [Newtonsoft.Json.JsonProperty("redenOpname", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? RedenOpname { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Gegevens over de geboorte. + ///
* **datum** : datum waarop de persoon is geboren. + ///
* **land** : land waar de persoon is geboren + ///
* **plaats** : gemeente waar de persoon is geboren. Is de persoon geboren buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Geboorte + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum Datum { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Land { get; set; } + + [Newtonsoft.Json.JsonProperty("plaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Plaats { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractGeboorteInOnderzoek InOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Geeft aan welke gegevens over de geboorte van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaGeboorteInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(GeboorteInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractGeboorteInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaGeboorteInOnderzoek : AbstractGeboorteInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GeboorteInOnderzoek : AbstractGeboorteInOnderzoek + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Datum { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Land { get; set; } + + [Newtonsoft.Json.JsonProperty("plaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Plaats { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + /// + /// * **datum**: de datum waarop de bijhouding van de persoonsgegevens is gestaakt. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OpschortingBijhouding : OpschortingBijhoudingBasis + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum Datum { get; set; } + + } + + /// + /// Gegevens over het overlijden van de persoon. + ///
* **datum** : datum waarop de persoon is overleden. + ///
* **land** : land waar de persoon is overleden. + ///
* **plaats** : gemeente waar de persoon is overleden. Is de persoon overleden buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Overlijden + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum Datum { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Land { get; set; } + + [Newtonsoft.Json.JsonProperty("plaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Plaats { get; set; } + + [Newtonsoft.Json.JsonProperty("indicatieOverleden", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool IndicatieOverleden { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractOverlijdenInOnderzoek InOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Geeft aan welke gegevens over het overlijden van de persoon in onderzoek zijn. + ///
Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaOverlijdenInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(OverlijdenInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractOverlijdenInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaOverlijdenInOnderzoek : AbstractOverlijdenInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OverlijdenInOnderzoek : AbstractOverlijdenInOnderzoek + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Datum { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Land { get; set; } + + [Newtonsoft.Json.JsonProperty("plaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Plaats { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + /// + /// Gegevens over het gezag over de persoon. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Gezagsverhouding + { + /// + /// Geeft aan dat de persoon onder curatele is gesteld. + ///
+ /// + [Newtonsoft.Json.JsonProperty("indicatieCurateleRegister", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? IndicatieCurateleRegister { get; set; } + + [Newtonsoft.Json.JsonProperty("indicatieGezagMinderjarige", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel IndicatieGezagMinderjarige { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractGezagsverhoudingInOnderzoek InOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Geeft aan welke gegevens van de gezagsverhouding in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaGezagsverhoudingInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(GezagsverhoudingInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractGezagsverhoudingInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaGezagsverhoudingInOnderzoek : AbstractGezagsverhoudingInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GezagsverhoudingInOnderzoek : AbstractGezagsverhoudingInOnderzoek + { + [Newtonsoft.Json.JsonProperty("indicatieCurateleRegister", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? IndicatieCurateleRegister { get; set; } + + [Newtonsoft.Json.JsonProperty("indicatieGezagMinderjarige", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? IndicatieGezagMinderjarige { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + /// + /// Gegevens over de verblijfsrechtelijke status van de persoon. + ///
* **datumEinde**: Datum waarop de geldigheid van de gegevens over de verblijfstitel is be�indigd. + ///
* **datumIngang**: Datum waarop de gegevens over de verblijfstitel geldig zijn geworden. + ///
* **aanduiding** : Verblijfstiteltabel die aangeeft over welke verblijfsrechtelijke status de persoon beschikt. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Verblijfstitel + { + [Newtonsoft.Json.JsonProperty("aanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Aanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("datumEinde", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumEinde { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngang", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngang { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractVerblijfstitelInOnderzoek InOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Geeft aan welke gegevens over de verblijfstitel in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaVerblijfstitelInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(VerblijfstitelInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractVerblijfstitelInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaVerblijfstitelInOnderzoek : AbstractVerblijfstitelInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VerblijfstitelInOnderzoek : AbstractVerblijfstitelInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Aanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("datumEinde", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumEinde { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngang", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumIngang { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + /// + /// Gegevens over een kind van de persoon. + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("Kind", typeof(Kind))] + [JsonInheritanceAttribute("OnbekendKind", typeof(OnbekendKind))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractKind + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Kind : AbstractKind + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Burgerservicenummer { get; set; } + + /// + /// Leeftijd op het moment van bevragen + ///
+ /// + [Newtonsoft.Json.JsonProperty("leeftijd", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int? Leeftijd { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractKindInOnderzoek InOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("naam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public NaamGerelateerde Naam { get; set; } + + [Newtonsoft.Json.JsonProperty("geboorte", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Geboorte Geboorte { get; set; } + + } + + /// + /// Geeft aan of de gegevens over het kind van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaKindInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(KindInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractKindInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaKindInOnderzoek : AbstractKindInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class KindInOnderzoek : AbstractKindInOnderzoek + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OnbekendKind : AbstractKind + { + [Newtonsoft.Json.JsonProperty("indicatieOnbekend", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? IndicatieOnbekend { get; set; } = false; + + } + + /// + /// Gegevens over de ouder van de persoon. + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("Ouder", typeof(Ouder))] + [JsonInheritanceAttribute("OnbekendOuder", typeof(OnbekendOuder))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractOuder + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Gegevens over de ouder van de persoon. + ///
* **datumIngangFamilierechtelijkeBetrekking** - De datum waarop de familierechtelijke betrekking is ontstaan. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Ouder : AbstractOuder + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Geslachtsaanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("ouderAanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel OuderAanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangFamilierechtelijkeBetrekking", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangFamilierechtelijkeBetrekking { get; set; } + + [Newtonsoft.Json.JsonProperty("naam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public NaamGerelateerde Naam { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractOuderInOnderzoek InOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("geboorte", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Geboorte Geboorte { get; set; } + + } + + /// + /// Geeft aan welke gegevens van de de ouder in onderzoek zijn. + ///
Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaOuderInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(OuderInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractOuderInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaOuderInOnderzoek : AbstractOuderInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OuderInOnderzoek : AbstractOuderInOnderzoek + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangFamilierechtelijkeBetrekking", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumIngangFamilierechtelijkeBetrekking { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Geslachtsaanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OnbekendOuder : AbstractOuder + { + [Newtonsoft.Json.JsonProperty("indicatieOnbekend", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? IndicatieOnbekend { get; set; } = false; + + } + + /// + /// Gegevens over een gesloten huwelijk/geregistreerd partnerschap van de persoon. + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("Partner", typeof(Partner))] + [JsonInheritanceAttribute("OnbekendPartner", typeof(OnbekendPartner))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractPartner + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Partner : AbstractPartner + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Geslachtsaanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("soortVerbintenis", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel SoortVerbintenis { get; set; } + + [Newtonsoft.Json.JsonProperty("naam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public NaamGerelateerde Naam { get; set; } + + [Newtonsoft.Json.JsonProperty("geboorte", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Geboorte Geboorte { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractPartnerInOnderzoek InOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("aangaanHuwelijkPartnerschap", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AangaanHuwelijkPartnerschap AangaanHuwelijkPartnerschap { get; set; } + + } + + /// + /// Geeft aan welke gegevens over het huwelijk of het partnerschap in onderzoek zijn. + ///
Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaPartnerInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(PartnerInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractPartnerInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaPartnerInOnderzoek : AbstractPartnerInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class PartnerInOnderzoek : AbstractPartnerInOnderzoek + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Geslachtsaanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("soortVerbintenis", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? SoortVerbintenis { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + /// + /// Gegevens over de voltrekking van het huwelijk of het aangaan van het geregistreerd partnerschap. + ///
* **datum** : De datum waarop het huwelijk is voltrokken of het partnerschap is aangegaan. + ///
* **land** : Het land waar het huwelijk is voltrokken of het partnerschap is aangegaan. + ///
* **plaats** : De gemeente waar het huwelijk is voltrokken of het partnerschap is aangegaan. Voor een plaats buiten Nederland bevat het antwoord een buitenlandse plaatsnaam of aanduiding. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AangaanHuwelijkPartnerschap + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum Datum { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Land { get; set; } + + [Newtonsoft.Json.JsonProperty("plaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Plaats { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractAangaanHuwelijkPartnerschapInOnderzoek InOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Geeft aan welke gegevens over het voltrekken van het huwelijk of aangaan van het partnerschap in onderzoek zijn. + ///
Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaAangaanHuwelijkPartnerschapInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(AangaanHuwelijkPartnerschapInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractAangaanHuwelijkPartnerschapInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaAangaanHuwelijkPartnerschapInOnderzoek : AbstractAangaanHuwelijkPartnerschapInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AangaanHuwelijkPartnerschapInOnderzoek : AbstractAangaanHuwelijkPartnerschapInOnderzoek + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Datum { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Land { get; set; } + + [Newtonsoft.Json.JsonProperty("plaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Plaats { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OnbekendPartner : AbstractPartner + { + [Newtonsoft.Json.JsonProperty("indicatieOnbekend", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? IndicatieOnbekend { get; set; } = false; + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class NaamGerelateerde : GbaNaamBasis + { + [Newtonsoft.Json.JsonProperty("voorletters", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Voorletters { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractNaamInOnderzoek InOnderzoek { get; set; } + + } + + /// + /// Geeft aan welke gegevens over de naam van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaNaamInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractNaamInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaNaamInOnderzoek : AbstractNaamInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + /// + /// Geeft aan welke gegevens over de naam in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class NaamInOnderzoek + { + [Newtonsoft.Json.JsonProperty("geslachtsnaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Geslachtsnaam { get; set; } + + [Newtonsoft.Json.JsonProperty("voornamen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Voornamen { get; set; } + + [Newtonsoft.Json.JsonProperty("voorvoegsel", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Voorvoegsel { get; set; } + + [Newtonsoft.Json.JsonProperty("adellijkeTitelPredikaat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? AdellijkeTitelPredikaat { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + [System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface, AllowMultiple = true)] + internal class JsonInheritanceAttribute : System.Attribute + { + public JsonInheritanceAttribute(string key, System.Type type) + { + Key = key; + Type = type; + } + + public string Key { get; } + + public System.Type Type { get; } + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + internal class JsonInheritanceConverter : Newtonsoft.Json.JsonConverter + { + internal static readonly string DefaultDiscriminatorName = "discriminator"; + + private readonly string _discriminatorName; + + [System.ThreadStatic] + private static bool _isReading; + + [System.ThreadStatic] + private static bool _isWriting; + + public JsonInheritanceConverter() + { + _discriminatorName = DefaultDiscriminatorName; + } + + public JsonInheritanceConverter(string discriminatorName) + { + _discriminatorName = discriminatorName; + } + + public string DiscriminatorName { get { return _discriminatorName; } } + + public override void WriteJson(Newtonsoft.Json.JsonWriter writer, object value, Newtonsoft.Json.JsonSerializer serializer) + { + try + { + _isWriting = true; + + var jObject = Newtonsoft.Json.Linq.JObject.FromObject(value, serializer); + jObject.AddFirst(new Newtonsoft.Json.Linq.JProperty(_discriminatorName, GetSubtypeDiscriminator(value.GetType()))); + writer.WriteToken(jObject.CreateReader()); + } + finally + { + _isWriting = false; + } + } + + public override bool CanWrite + { + get + { + if (_isWriting) + { + _isWriting = false; + return false; + } + return true; + } + } + + public override bool CanRead + { + get + { + if (_isReading) + { + _isReading = false; + return false; + } + return true; + } + } + + public override bool CanConvert(System.Type objectType) + { + return true; + } + + public override object ReadJson(Newtonsoft.Json.JsonReader reader, System.Type objectType, object existingValue, Newtonsoft.Json.JsonSerializer serializer) + { + var jObject = serializer.Deserialize(reader); + if (jObject == null) + return null; + + var discriminatorValue = jObject.GetValue(_discriminatorName); + var discriminator = discriminatorValue != null ? Newtonsoft.Json.Linq.Extensions.Value(discriminatorValue) : null; + var subtype = GetObjectSubtype(objectType, discriminator); + + var objectContract = serializer.ContractResolver.ResolveContract(subtype) as Newtonsoft.Json.Serialization.JsonObjectContract; + if (objectContract == null || System.Linq.Enumerable.All(objectContract.Properties, p => p.PropertyName != _discriminatorName)) + { + jObject.Remove(_discriminatorName); + } + + try + { + _isReading = true; + return serializer.Deserialize(jObject.CreateReader(), subtype); + } + finally + { + _isReading = false; + } + } + + private System.Type GetObjectSubtype(System.Type objectType, string discriminator) + { + foreach (var attribute in System.Reflection.CustomAttributeExtensions.GetCustomAttributes(System.Reflection.IntrospectionExtensions.GetTypeInfo(objectType), true)) + { + if (attribute.Key == discriminator) + return attribute.Type; + } + + return objectType; + } + + private string GetSubtypeDiscriminator(System.Type objectType) + { + foreach (var attribute in System.Reflection.CustomAttributeExtensions.GetCustomAttributes(System.Reflection.IntrospectionExtensions.GetTypeInfo(objectType), true)) + { + if (attribute.Type == objectType) + return attribute.Key; + } + + return objectType.Name; + } + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + internal class DateFormatConverter : Newtonsoft.Json.Converters.IsoDateTimeConverter + { + public DateFormatConverter() + { + DateTimeFormat = "yyyy-MM-dd"; + } + } + + + + [System.CodeDom.Compiler.GeneratedCode("NSwag", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ApiException : System.Exception + { + public int StatusCode { get; private set; } + + public string Response { get; private set; } + + public System.Collections.Generic.IReadOnlyDictionary> Headers { get; private set; } + + public ApiException(string message, int statusCode, string response, System.Collections.Generic.IReadOnlyDictionary> headers, System.Exception innerException) + : base(message + "\n\nStatus: " + statusCode + "\nResponse: \n" + ((response == null) ? "(null)" : response.Substring(0, response.Length >= 512 ? 512 : response.Length)), innerException) + { + StatusCode = statusCode; + Response = response; + Headers = headers; + } + + public override string ToString() + { + return string.Format("HTTP Response: \n\n{0}\n\n{1}", Response, base.ToString()); + } + } + + [System.CodeDom.Compiler.GeneratedCode("NSwag", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ApiException : ApiException + { + public TResult Result { get; private set; } + + public ApiException(string message, int statusCode, string response, System.Collections.Generic.IReadOnlyDictionary> headers, TResult result, System.Exception innerException) + : base(message, statusCode, response, headers, innerException) + { + Result = result; + } + } + +} + +#pragma warning restore 1591 +#pragma warning restore 1573 +#pragma warning restore 472 +#pragma warning restore 114 +#pragma warning restore 108 +#pragma warning restore 3016 +#pragma warning restore 8603 \ No newline at end of file diff --git a/src/BrpProxy/DataTransferObjects.nswag b/src/BrpProxy/DataTransferObjects.nswag new file mode 100644 index 000000000..ec3237883 --- /dev/null +++ b/src/BrpProxy/DataTransferObjects.nswag @@ -0,0 +1,99 @@ +{ + "runtime": "Net60", + "defaultVariables": null, + "documentGenerator": { + "fromDocument": { + "url": "../../specificatie/genereervariant/openapi.yaml", + "output": null, + "newLineBehavior": "Auto" + } + }, + "codeGenerators": { + "openApiToCSharpClient": { + "clientBaseClass": null, + "configurationClass": null, + "generateClientClasses": false, + "generateClientInterfaces": false, + "clientBaseInterface": null, + "injectHttpClient": true, + "disposeHttpClient": true, + "protectedMethods": [], + "generateExceptionClasses": true, + "exceptionClass": "ApiException", + "wrapDtoExceptions": true, + "useHttpClientCreationMethod": false, + "httpClientType": "System.Net.Http.HttpClient", + "useHttpRequestMessageCreationMethod": false, + "useBaseUrl": true, + "generateBaseUrlProperty": true, + "generateSyncMethods": false, + "generatePrepareRequestAndProcessResponseAsAsyncMethods": false, + "exposeJsonSerializerSettings": false, + "clientClassAccessModifier": "public", + "typeAccessModifier": "public", + "generateContractsOutput": false, + "contractsNamespace": null, + "contractsOutputFilePath": null, + "parameterDateTimeFormat": "s", + "parameterDateFormat": "yyyy-MM-dd", + "generateUpdateJsonSerializerSettingsMethod": true, + "useRequestAndResponseSerializationSettings": false, + "serializeTypeInformation": false, + "queryNullValue": "", + "className": "{controller}Client", + "operationGenerationMode": "MultipleClientsFromOperationId", + "additionalNamespaceUsages": [], + "additionalContractNamespaceUsages": [], + "generateOptionalParameters": false, + "generateJsonMethods": false, + "enforceFlagEnums": false, + "parameterArrayType": "System.Collections.Generic.IEnumerable", + "parameterDictionaryType": "System.Collections.Generic.IDictionary", + "responseArrayType": "System.Collections.Generic.ICollection", + "responseDictionaryType": "System.Collections.Generic.IDictionary", + "wrapResponses": false, + "wrapResponseMethods": [], + "generateResponseClasses": true, + "responseClass": "SwaggerResponse", + "namespace": "HaalCentraal.BrpProxy.Generated", + "requiredPropertiesMustBeDefined": true, + "dateType": "System.DateTimeOffset", + "jsonConverters": null, + "anyType": "object", + "dateTimeType": "System.DateTimeOffset", + "timeType": "System.TimeSpan", + "timeSpanType": "System.TimeSpan", + "arrayType": "System.Collections.Generic.ICollection", + "arrayInstanceType": "System.Collections.ObjectModel.Collection", + "dictionaryType": "System.Collections.Generic.IDictionary", + "dictionaryInstanceType": "System.Collections.Generic.Dictionary", + "arrayBaseType": "System.Collections.ObjectModel.Collection", + "dictionaryBaseType": "System.Collections.Generic.Dictionary", + "classStyle": "Poco", + "jsonLibrary": "NewtonsoftJson", + "generateDefaultValues": true, + "generateDataAnnotations": false, + "excludedTypeNames": [], + "excludedParameterNames": [], + "handleReferences": false, + "generateImmutableArrayProperties": false, + "generateImmutableDictionaryProperties": false, + "jsonSerializerSettingsTransformationMethod": null, + "inlineNamedArrays": false, + "inlineNamedDictionaries": false, + "inlineNamedTuples": true, + "inlineNamedAny": false, + "generateDtoTypes": true, + "generateOptionalPropertiesAsNullable": true, + "generateNullableReferenceTypes": false, + "templateDirectory": null, + "typeNameGeneratorType": null, + "propertyNameGeneratorType": null, + "enumNameGeneratorType": null, + "serviceHost": null, + "serviceSchemes": null, + "output": "DataTransferObjects.cs", + "newLineBehavior": "Auto" + } + } +} \ No newline at end of file diff --git a/src/BrpProxy/Dockerfile b/src/BrpProxy/Dockerfile new file mode 100644 index 000000000..b3d40ecdd --- /dev/null +++ b/src/BrpProxy/Dockerfile @@ -0,0 +1,22 @@ +#See https://aka.ms/containerfastmode to understand how Visual Studio uses this Dockerfile to build your images for faster debugging. + +FROM mcr.microsoft.com/dotnet/aspnet:6.0 AS base +WORKDIR /app +EXPOSE 80 +EXPOSE 443 + +FROM mcr.microsoft.com/dotnet/sdk:6.0 AS build +WORKDIR /src +COPY ["src/BrpProxy/BrpProxy.csproj", "src/BrpProxy/"] +RUN dotnet restore "src/BrpProxy/BrpProxy.csproj" +COPY . . +WORKDIR "/src/src/BrpProxy" +RUN dotnet build "BrpProxy.csproj" -c Release -o /app/build + +FROM build AS publish +RUN dotnet publish "BrpProxy.csproj" -c Release -o /app/publish + +FROM base AS final +WORKDIR /app +COPY --from=publish /app/publish . +ENTRYPOINT ["dotnet", "BrpProxy.dll"] \ No newline at end of file diff --git a/src/BrpProxy/Mappers/GbaDatumMapper.cs b/src/BrpProxy/Mappers/GbaDatumMapper.cs new file mode 100644 index 000000000..fd5024388 --- /dev/null +++ b/src/BrpProxy/Mappers/GbaDatumMapper.cs @@ -0,0 +1,39 @@ +using HaalCentraal.BrpProxy.Generated; +using System.Globalization; +using System.Text.RegularExpressions; + +namespace BrpProxy.Mappers; + +public static class GbaDatumMapper +{ + private static Regex GbaDatumRegex = new Regex("^(?[0-9]{4})(?[0-9]{2})(?[0-9]{2})$"); + + public static AbstractDatum Map(this GbaDatum datum) + { + if (GbaDatumRegex.IsMatch(datum.Datum)) + { + var match = GbaDatumRegex.Match(datum.Datum); + var jaar = int.Parse(match.Groups["jaar"].Value, CultureInfo.InvariantCulture); + var maand = int.Parse(match.Groups["maand"].Value, CultureInfo.InvariantCulture); + var dag = int.Parse(match.Groups["dag"].Value, CultureInfo.InvariantCulture); + + if (jaar != 0 && maand != 0 && dag != 0) + { + return new VolledigDatum { Datum = new DateTime(jaar, maand, dag) }; + } + if (jaar == 0 && maand == 0 && dag == 0) + { + return new OnbekendDatum(); + } + if (jaar != 0 && maand != 0 && dag == 0) + { + return new JaarMaandDatum { Jaar = jaar, Maand = maand }; + } + if (jaar != 0 && maand == 0 && dag == 0) + { + return new JaarDatum { Jaar = jaar }; + } + } + return datum; + } +} diff --git a/src/BrpProxy/Mappers/GeboorteMapper.cs b/src/BrpProxy/Mappers/GeboorteMapper.cs new file mode 100644 index 000000000..ec0bff702 --- /dev/null +++ b/src/BrpProxy/Mappers/GeboorteMapper.cs @@ -0,0 +1,26 @@ +using HaalCentraal.BrpProxy.Generated; + +namespace BrpProxy.Mappers; + +public static class GeboorteMapper +{ + public static void Map(this GeboorteBeperkt geboorte) + { + if (geboorte == null) return; + + if (geboorte?.Datum is GbaDatum datum) + { + geboorte.Datum = datum.Map(); + } + } + + public static void Map(this Geboorte geboorte) + { + if (geboorte == null) return; + + if (geboorte?.Datum is GbaDatum datum) + { + geboorte.Datum = datum.Map(); + } + } +} diff --git a/src/BrpProxy/Mappers/NaamMapper.cs b/src/BrpProxy/Mappers/NaamMapper.cs new file mode 100644 index 000000000..2fc1f86de --- /dev/null +++ b/src/BrpProxy/Mappers/NaamMapper.cs @@ -0,0 +1,68 @@ +using HaalCentraal.BrpProxy.Generated; +using System.Text.RegularExpressions; + +namespace BrpProxy.Mappers; + +public static class NaamMapper +{ + public static void Map(this NaamBasis naam) + { + if (naam == null) return; + + naam.VolledigeNaam = MapNaarVolledigeNaam(naam.Voornamen, naam.Voorvoegsel, naam.Geslachtsnaam, naam.AdellijkeTitelPredikaat); + naam.Voorletters = naam.Voornamen.MapNaarVoorletters(); + } + + public static string MapNaarVolledigeNaam(string voornamen, string voorvoegsel, string geslachtsnaam, Waardetabel adellijkeTitelPredikaat) + { + var adellijkeTitel = adellijkeTitelPredikaat.MapNaarAdellijkeTitel(); + var predikaat = adellijkeTitelPredikaat.MapNaarPredikaat(); + + var retval = Regex.Replace($"{predikaat} {voornamen} {adellijkeTitel} {voorvoegsel} {geslachtsnaam}", @"\s+", " ").Trim(); + + return retval; + } + + public static string MapNaarAdellijkeTitel(this Waardetabel waardetabel) + { + if (waardetabel == null) return string.Empty; + + switch (waardetabel.Code) + { + case "BS": + return "barones"; + case "R": + return "ridder"; + default: + return string.Empty; + } + } + + public static string MapNaarPredikaat(this Waardetabel waardetabel) + { + if (waardetabel == null) return string.Empty; + + switch (waardetabel.Code) + { + case "JV": + return "jonkvrouw"; + default: + return string.Empty; + } + } + + public static string MapNaarVoorletters(this string voornamen) + { + if (string.IsNullOrWhiteSpace(voornamen) || + voornamen == ".") + { + return voornamen; + } + + var voorletters = from voornaam in voornamen.Split(" ") + select voornaam.Trim().Length > 1 + ? voornaam[..1] + "." + : voornaam + " "; + return string.Join("", voorletters).Trim(); + } +} diff --git a/src/BrpProxy/Mappers/VerblijfplaatsMapper.cs b/src/BrpProxy/Mappers/VerblijfplaatsMapper.cs new file mode 100644 index 000000000..0af1353fb --- /dev/null +++ b/src/BrpProxy/Mappers/VerblijfplaatsMapper.cs @@ -0,0 +1,29 @@ +using HaalCentraal.BrpProxy.Generated; + +namespace BrpProxy.Mappers +{ + public static class VerblijfplaatsMapper + { + public static AbstractVerblijfplaats Map(this AbstractVerblijfplaats verblijfplaats) + { + if (verblijfplaats is GbaVerblijfplaats gba) + { + var retval = new Adres(); + + retval.Straat = gba.MapStraat(); + retval.KorteNaam = gba.Straat; + + return retval; + } + + return verblijfplaats; + } + + private static string MapStraat(this GbaVerblijfplaats gba) + { + return !string.IsNullOrEmpty(gba.NaamOpenbareRuimte) + ? gba.NaamOpenbareRuimte + : gba.Straat; + } + } +} diff --git a/src/BrpProxy/Middlewares/OverwriteResponseBodyMiddleware.cs b/src/BrpProxy/Middlewares/OverwriteResponseBodyMiddleware.cs new file mode 100644 index 000000000..b413366e7 --- /dev/null +++ b/src/BrpProxy/Middlewares/OverwriteResponseBodyMiddleware.cs @@ -0,0 +1,121 @@ +using BrpProxy.Mappers; +using HaalCentraal.BrpProxy.Generated; +using Newtonsoft.Json; +using System.IO.Compression; + +namespace BrpProxy.Middlewares +{ + public class OverwriteResponseBodyMiddleware + { + private readonly RequestDelegate _next; + private readonly ILogger _logger; + + public OverwriteResponseBodyMiddleware(RequestDelegate next, ILogger logger) + { + _next = next; + _logger = logger; + } + + public async Task Invoke(HttpContext context) + { + var orgBodyStream = context.Response.Body; + + using var newBodyStream = new MemoryStream(); + context.Response.Body = newBodyStream; + + await _next(context); + + var body = await context.Response.ReadBodyAsync(); + + _logger.LogInformation($"original: {body}"); + + var modifiedBody = body.Transform(); + + using var bodyStream = modifiedBody.ToMemoryStream(); + + context.Response.ContentLength = bodyStream.Length; + await bodyStream.CopyToAsync(orgBodyStream); + } + } + + public static class BrpHelpers + { + public static string Transform(this string payload) + { + var personen = JsonConvert.DeserializeObject(payload); + + switch (personen) + { + case RaadpleegMetBurgerservicenummerResponse p: + p.Personen.Map(); + break; + case ZoekMetGeslachtsnaamEnGeboortedatumResponse pb: + pb.Personen.Map(); + break; + case ZoekMetGeslachtsnaamEnGemeenteVanInschrijvingResponse pb: + pb.Personen.Map(); + break; + case ZoekMetPostcodeEnHuisnummerResponse pb: + pb.Personen.Map(); + break; + } + + return JsonConvert.SerializeObject(personen); + } + + private static void Map(this ICollection personen) + { + foreach (var persoon in personen) + { + persoon?.Geboorte.Map(); + persoon?.Naam.Map(); + } + } + + private static void Map(this ICollection personen) + { + foreach (var persoon in personen) + { + persoon?.Geboorte.Map(); + persoon?.Naam.Map(); + } + } + } + + public static class HttpResponseHelpers + { + public static async Task ReadBodyAsync(this HttpResponse response) + { + response.Body.Seek(0, SeekOrigin.Begin); + + //var gzipStream = new GZipStream(response.Body, CompressionMode.Decompress); + //var streamReader = new StreamReader(gzipStream); + var streamReader = new StreamReader(response.Body); + + var retval = await streamReader.ReadToEndAsync(); + + response.Body.Seek(0, SeekOrigin.Begin); + + return retval; + } + } + + public static class MemoryStreamHelpers + { + public static MemoryStream ToMemoryStream(this string data) + { + var retval = new MemoryStream(); + + //var gzipStream = new GZipStream(retval, CompressionMode.Compress); + //var streamWriter = new StreamWriter(gzipStream); + var streamWriter = new StreamWriter(retval); + + streamWriter.Write(data); + streamWriter.Flush(); + + retval.Seek(0, SeekOrigin.Begin); + + return retval; + } + } +} diff --git a/src/BrpProxy/Program.cs b/src/BrpProxy/Program.cs new file mode 100644 index 000000000..ad38b8907 --- /dev/null +++ b/src/BrpProxy/Program.cs @@ -0,0 +1,28 @@ +using BrpProxy.Middlewares; +using Ocelot.DependencyInjection; +using Ocelot.Middleware; + +var builder = WebApplication.CreateBuilder(args); + +var a = Path.Combine("configuration", "ocelot.json"); +builder.Configuration.AddJsonFile(Path.Combine("configuration", "ocelot.json")); + +// Add services to the container. +builder.Services.AddOcelot(); + +//builder.Services.AddControllers(); + +var app = builder.Build(); + +// Configure the HTTP request pipeline. + +//app.UseHttpsRedirection(); + +//app.UseAuthorization(); + +//app.MapControllers(); + +app.UseMiddleware(); +app.UseOcelot().Wait(); + +app.Run(); diff --git a/src/BrpProxy/Properties/launchSettings.json b/src/BrpProxy/Properties/launchSettings.json new file mode 100644 index 000000000..eecd9deb3 --- /dev/null +++ b/src/BrpProxy/Properties/launchSettings.json @@ -0,0 +1,38 @@ +{ + "$schema": "https://json.schemastore.org/launchsettings.json", + "iisSettings": { + "windowsAuthentication": false, + "anonymousAuthentication": true, + "iisExpress": { + "applicationUrl": "http://localhost:16982", + "sslPort": 44324 + } + }, + "profiles": { + "BrpProxy": { + "commandName": "Project", + "launchBrowser": true, + "launchUrl": "weatherforecast", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + }, + "applicationUrl": "https://localhost:7074;http://localhost:5074", + "dotnetRunMessages": true + }, + "IIS Express": { + "commandName": "IISExpress", + "launchBrowser": true, + "launchUrl": "weatherforecast", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "Docker": { + "commandName": "Docker", + "launchBrowser": true, + "launchUrl": "{Scheme}://{ServiceHost}:{ServicePort}/weatherforecast", + "publishAllPorts": true, + "useSSL": true + } + } +} \ No newline at end of file diff --git a/src/BrpProxy/appsettings.Development.json b/src/BrpProxy/appsettings.Development.json new file mode 100644 index 000000000..0c208ae91 --- /dev/null +++ b/src/BrpProxy/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/src/BrpProxy/appsettings.json b/src/BrpProxy/appsettings.json new file mode 100644 index 000000000..10f68b8c8 --- /dev/null +++ b/src/BrpProxy/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*" +} diff --git a/src/BrpProxy/configuration/ocelot.json b/src/BrpProxy/configuration/ocelot.json new file mode 100644 index 000000000..b3a556122 --- /dev/null +++ b/src/BrpProxy/configuration/ocelot.json @@ -0,0 +1,15 @@ +{ + "Routes": [ + { + "UpstreamPathTemplate": "/{everything}", + "DownstreamPathTemplate": "/haalcentraal/api/brp/{everything}", + "DownstreamScheme": "https", + "DownstreamHostAndPorts": [ + { + "Host": "localhost", + "Port": "7098" + } + ] + } + ] +} \ No newline at end of file diff --git a/src/BrpService/BrpService.csproj b/src/BrpService/BrpService.csproj new file mode 100644 index 000000000..d33210646 --- /dev/null +++ b/src/BrpService/BrpService.csproj @@ -0,0 +1,20 @@ + + + + net6.0 + + enable + HaalCentraal.BrpService + HaalCentraal.BrpService + + + + + + + + + + + + diff --git a/src/BrpService/Controllers/PersoonController.cs b/src/BrpService/Controllers/PersoonController.cs new file mode 100644 index 000000000..2c877cb52 --- /dev/null +++ b/src/BrpService/Controllers/PersoonController.cs @@ -0,0 +1,83 @@ +using HaalCentraal.BrpService.Generated; +using Microsoft.AspNetCore.Mvc; + +namespace HaalCentraal.BrpService.Controllers +{ + [ApiController] + public class PersoonController : Generated.ControllerBase + { + private readonly ILogger _logger; + private readonly IWebHostEnvironment _environment; + + public PersoonController(ILogger logger, IWebHostEnvironment environment) + { + _logger = logger; + _environment = environment; + } + + public override async Task> GetPersonen([FromBody] PersonenQuery body) + { + if (body is RaadpleegMetBurgerservicenummer) + { + return await Handle(body as RaadpleegMetBurgerservicenummer); + } + if(body is ZoekMetGeslachtsnaamEnGeboortedatum) + { + return await Handle(body as ZoekMetGeslachtsnaamEnGeboortedatum); + } + if(body is ZoekMetGeslachtsnaamEnGemeenteVanInschrijving) + { + return await Handle(body as ZoekMetGeslachtsnaamEnGemeenteVanInschrijving); + } + if(body is ZoekMetPostcodeEnHuisnummer) + { + return await Handle(body as ZoekMetPostcodeEnHuisnummer); + } + throw new InvalidOperationException($"Onbekend type query: {body}"); + } + + private async Task> Handle(ZoekMetPostcodeEnHuisnummer query) + { + _logger.LogInformation("ZoekMetPostcodeEnHuisnummer"); + + var path = Path.Combine(_environment.ContentRootPath, $"Data/postcode-huisnummer-{query.Postcode}-{query.Huisnummer}.json"); + var data = await System.IO.File.ReadAllTextAsync(path); + var retval = Newtonsoft.Json.JsonConvert.DeserializeObject(data); + + return Ok(retval); + } + + private async Task> Handle(ZoekMetGeslachtsnaamEnGemeenteVanInschrijving query) + { + _logger.LogInformation("ZoekMetGeslachtsnaamEnGemeenteVanInschrijving"); + + var path = Path.Combine(_environment.ContentRootPath, $"Data/geslachtsnaam-gemeente-{query.Geslachtsnaam}-{query.GemeenteVanInschrijving}.json"); + var data = await System.IO.File.ReadAllTextAsync(path); + var retval = Newtonsoft.Json.JsonConvert.DeserializeObject(data); + + return Ok(retval); + } + + private async Task> Handle(ZoekMetGeslachtsnaamEnGeboortedatum query) + { + _logger.LogInformation("ZoekMetGeslachtsnaamEnGeboortedatum"); + + var path = Path.Combine(_environment.ContentRootPath, $"Data/geslachtsnaam-geboortedatum-{query.Geslachtsnaam}-{query.Geboortedatum.Value.ToString("yyyy-MM-dd")}.json"); + var data = await System.IO.File.ReadAllTextAsync(path); + var retval = Newtonsoft.Json.JsonConvert.DeserializeObject(data); + + return Ok(retval); + } + + private async Task> Handle(RaadpleegMetBurgerservicenummer query) + { + _logger.LogInformation("ZoekMetBurgerservicenummer"); + + var path = Path.Combine(_environment.ContentRootPath, $"Data/bsn-{string.Join("-", query.Burgerservicenummer)}.json"); + var data = await System.IO.File.ReadAllTextAsync(path); + var retval = Newtonsoft.Json.JsonConvert.DeserializeObject(data); + + return Ok(retval); + } + } +} diff --git a/src/BrpService/Generated.cs b/src/BrpService/Generated.cs new file mode 100644 index 000000000..46416d7c7 --- /dev/null +++ b/src/BrpService/Generated.cs @@ -0,0 +1,2658 @@ +//---------------------- +// +// Generated using the NSwag toolchain v13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0)) (http://NSwag.org) +// +//---------------------- + +#pragma warning disable 108 // Disable "CS0108 '{derivedDto}.ToJson()' hides inherited member '{dtoBase}.ToJson()'. Use the new keyword if hiding was intended." +#pragma warning disable 114 // Disable "CS0114 '{derivedDto}.RaisePropertyChanged(String)' hides inherited member 'dtoBase.RaisePropertyChanged(String)'. To make the current member override that implementation, add the override keyword. Otherwise add the new keyword." +#pragma warning disable 472 // Disable "CS0472 The result of the expression is always 'false' since a value of type 'Int32' is never equal to 'null' of type 'Int32?' +#pragma warning disable 1573 // Disable "CS1573 Parameter '...' has no matching param tag in the XML comment for ... +#pragma warning disable 1591 // Disable "CS1591 Missing XML comment for publicly visible type or member ..." +#pragma warning disable 8073 // Disable "CS8073 The result of the expression is always 'false' since a value of type 'T' is never equal to 'null' of type 'T?'" +#pragma warning disable 3016 // Disable "CS3016 Arrays as attribute arguments is not CLS-compliant" +#pragma warning disable 8603 // Disable "CS8603 Possible null reference return" + +namespace HaalCentraal.BrpService.Generated +{ + using System = global::System; + + [System.CodeDom.Compiler.GeneratedCode("NSwag", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + [Microsoft.AspNetCore.Mvc.Route("haalcentraal/api/brp")] + + public abstract class ControllerBase : Microsoft.AspNetCore.Mvc.ControllerBase + { + /// + /// Vindt personen + /// + /// Zoekactie geslaagd + [Microsoft.AspNetCore.Mvc.HttpPost, Microsoft.AspNetCore.Mvc.Route("personen")] + public abstract System.Threading.Tasks.Task> GetPersonen([Microsoft.AspNetCore.Mvc.FromBody] PersonenQuery body); + + } + + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("ZoekMetGeslachtsnaamEnGeboortedatum", typeof(ZoekMetGeslachtsnaamEnGeboortedatumResponse))] + [JsonInheritanceAttribute("ZoekMetGeslachtsnaamEnGemeenteVanInschrijving", typeof(ZoekMetGeslachtsnaamEnGemeenteVanInschrijvingResponse))] + [JsonInheritanceAttribute("RaadpleegMetBurgerservicenummer", typeof(RaadpleegMetBurgerservicenummerResponse))] + [JsonInheritanceAttribute("ZoekMetPostcodeEnHuisnummer", typeof(ZoekMetPostcodeEnHuisnummerResponse))] + [JsonInheritanceAttribute("ZoekMetStraatHuisnummerEnGemeenteVanInschrijving", typeof(ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse))] + [JsonInheritanceAttribute("ZoekMetNummeraanduidingIdentificatie", typeof(ZoekMetNummeraanduidingIdentificatieResponse))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class PersonenQueryResponse + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetGeslachtsnaamEnGeboortedatumResponse : PersonenQueryResponse + { + [Newtonsoft.Json.JsonProperty("personen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.List Personen { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetGeslachtsnaamEnGemeenteVanInschrijvingResponse : PersonenQueryResponse + { + [Newtonsoft.Json.JsonProperty("personen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.List Personen { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class RaadpleegMetBurgerservicenummerResponse : PersonenQueryResponse + { + [Newtonsoft.Json.JsonProperty("personen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.List Personen { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetPostcodeEnHuisnummerResponse : PersonenQueryResponse + { + [Newtonsoft.Json.JsonProperty("personen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.List Personen { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetStraatHuisnummerEnGemeenteVanInschrijvingResponse : PersonenQueryResponse + { + [Newtonsoft.Json.JsonProperty("personen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.List Personen { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetNummeraanduidingIdentificatieResponse : PersonenQueryResponse + { + [Newtonsoft.Json.JsonProperty("personen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.List Personen { get; set; } + + } + + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("ZoekMetGeslachtsnaamEnGeboortedatum", typeof(ZoekMetGeslachtsnaamEnGeboortedatum))] + [JsonInheritanceAttribute("ZoekMetGeslachtsnaamEnGemeenteVanInschrijving", typeof(ZoekMetGeslachtsnaamEnGemeenteVanInschrijving))] + [JsonInheritanceAttribute("RaadpleegMetBurgerservicenummer", typeof(RaadpleegMetBurgerservicenummer))] + [JsonInheritanceAttribute("ZoekMetPostcodeEnHuisnummer", typeof(ZoekMetPostcodeEnHuisnummer))] + [JsonInheritanceAttribute("ZoekMetStraatHuisnummerEnGemeenteVanInschrijving", typeof(ZoekMetStraatHuisnummerEnGemeenteVanInschrijving))] + [JsonInheritanceAttribute("ZoekMetNummeraanduidingIdentificatie", typeof(ZoekMetNummeraanduidingIdentificatie))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class PersonenQuery + { + [Newtonsoft.Json.JsonProperty("fields", Required = Newtonsoft.Json.Required.Always)] + [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)] + [System.ComponentModel.DataAnnotations.StringLength(924)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9\.,_]+$")] + public string Fields { get; set; } + + [Newtonsoft.Json.JsonProperty("gemeenteVanInschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{4}$")] + public string GemeenteVanInschrijving { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetGeslachtsnaamEnGeboortedatum : PersonenQuery + { + [Newtonsoft.Json.JsonProperty("inclusiefOverledenPersonen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool InclusiefOverledenPersonen { get; set; } + + /// + /// Je kunt alleen zoeken met een volledig geboortedatum. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/parametervalidatie.feature) + ///
+ /// + [Newtonsoft.Json.JsonProperty("geboortedatum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [Newtonsoft.Json.JsonConverter(typeof(DateFormatConverter))] + public System.DateTimeOffset? Geboortedatum { get; set; } + + /// + /// Gemeentenaam of een buitenlandse plaats of een plaatsbepaling, die aangeeft waar de persoon is geboren. **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + ///
+ /// + [Newtonsoft.Json.JsonProperty("geboorteplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.StringLength(40)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^(\?+|\*)?[a-zA-Z0-9�-� '\-\']{1,40}(\?+|\*)?$")] + public string Geboorteplaats { get; set; } + + /// + /// De (geslachts)naam waarvan de eventueel aanwezige voorvoegsels zijn afgesplitst. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + ///
+ /// + [Newtonsoft.Json.JsonProperty("geslachtsnaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^(\?+|\*)?[a-zA-Z0-9�-� '\-\']{1,200}(\?+|\*)?$")] + public string Geslachtsnaam { get; set; } + + /// + /// Geeft aan dat de persoon een man of een vrouw is, of dat het geslacht (nog) onbekend is. + ///
+ /// + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^([Mm]|[Vv]|[Oo])$")] + public string Geslachtsaanduiding { get; set; } + + /// + /// Deel van de geslachtsnaam dat vooraf gaat aan de rest van de geslachtsnaam. Het zoeken op het voorvoegsel is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + ///
+ /// + [Newtonsoft.Json.JsonProperty("voorvoegsel", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9�-�' '\-\']{1,10}$")] + public string Voorvoegsel { get; set; } + + /// + /// De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + ///
+ /// + [Newtonsoft.Json.JsonProperty("voornamen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^(\?+|\*)?[a-zA-Z0-9�-�' '\-\']{1,200}(\?+|\*)?$")] + public string Voornamen { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetGeslachtsnaamEnGemeenteVanInschrijving : PersonenQuery + { + [Newtonsoft.Json.JsonProperty("inclusiefOverledenPersonen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool InclusiefOverledenPersonen { get; set; } + + /// + /// Geeft aan dat de persoon een man of een vrouw is, of dat het geslacht (nog) onbekend is. + ///
+ /// + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^([Mm]|[Vv]|[Oo])$")] + public string Geslachtsaanduiding { get; set; } + + /// + /// De (geslachts)naam waarvan de eventueel aanwezige voorvoegsels zijn afgesplitst. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + ///
+ /// + [Newtonsoft.Json.JsonProperty("geslachtsnaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^(\?+|\*)?[a-zA-Z0-9�-� '\-\']{1,200}(\?+|\*)?$")] + public string Geslachtsnaam { get; set; } + + /// + /// Deel van de geslachtsnaam dat vooraf gaat aan de rest van de geslachtsnaam. Het zoeken op het voorvoegsel is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + ///
+ /// + [Newtonsoft.Json.JsonProperty("voorvoegsel", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9�-�' '\-\']{1,10}$")] + public string Voorvoegsel { get; set; } + + /// + /// De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/case_insensitive.feature).** + ///
+ /// + [Newtonsoft.Json.JsonProperty("voornamen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^(\?+|\*)?[a-zA-Z0-9�-�' '\-\']{1,200}(\?+|\*)?$")] + public string Voornamen { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class RaadpleegMetBurgerservicenummer : PersonenQuery + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.MinLength(1)] + [System.ComponentModel.DataAnnotations.MaxLength(20)] + public System.Collections.Generic.List Burgerservicenummer { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetPostcodeEnHuisnummer : PersonenQuery + { + [Newtonsoft.Json.JsonProperty("inclusiefOverledenPersonen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool InclusiefOverledenPersonen { get; set; } + + [Newtonsoft.Json.JsonProperty("huisletter", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z]{1}$")] + public string Huisletter { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.Range(1, 99999)] + public int Huisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummertoevoeging", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9]{1,4}$")] + public string Huisnummertoevoeging { get; set; } + + [Newtonsoft.Json.JsonProperty("postcode", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[1-9]{1}[0-9]{3}[ ]?[A-Za-z]{2}$")] + public string Postcode { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetStraatHuisnummerEnGemeenteVanInschrijving : PersonenQuery + { + [Newtonsoft.Json.JsonProperty("inclusiefOverledenPersonen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool InclusiefOverledenPersonen { get; set; } + + [Newtonsoft.Json.JsonProperty("huisletter", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z]{1}$")] + public string Huisletter { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.Range(1, 99999)] + public int Huisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummertoevoeging", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9]{1,4}$")] + public string Huisnummertoevoeging { get; set; } + + [Newtonsoft.Json.JsonProperty("straat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^(\?+|\*)?[a-zA-Z0-9�-� '\-\']{1,80}(\?+|\*)?$")] + public string Straat { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class ZoekMetNummeraanduidingIdentificatie : PersonenQuery + { + [Newtonsoft.Json.JsonProperty("inclusiefOverledenPersonen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool InclusiefOverledenPersonen { get; set; } + + [Newtonsoft.Json.JsonProperty("nummeraanduidingIdentificatie", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{16}$")] + public string NummeraanduidingIdentificatie { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class BadRequestFoutbericht : Foutbericht + { + /// + /// Foutmelding per fout in een parameter. Alle gevonden fouten worden ��n keer teruggemeld. + /// + [Newtonsoft.Json.JsonProperty("invalidParams", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.List InvalidParams { get; set; } + + } + + /// + /// Terugmelding bij een fout. JSON representatie in lijn met [RFC7807](https://tools.ietf.org/html/rfc7807). + /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Foutbericht + { + /// + /// Link naar meer informatie over deze fout + /// + [Newtonsoft.Json.JsonProperty("type", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Uri Type { get; set; } + + /// + /// Beschrijving van de fout + /// + [Newtonsoft.Json.JsonProperty("title", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Title { get; set; } + + /// + /// Http status code + /// + [Newtonsoft.Json.JsonProperty("status", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int? Status { get; set; } + + /// + /// Details over de fout + /// + [Newtonsoft.Json.JsonProperty("detail", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Detail { get; set; } + + /// + /// Uri van de aanroep die de fout heeft veroorzaakt + /// + [Newtonsoft.Json.JsonProperty("instance", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Uri Instance { get; set; } + + /// + /// Systeemcode die het type fout aangeeft + /// + [Newtonsoft.Json.JsonProperty("code", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.StringLength(int.MaxValue, MinimumLength = 1)] + public string Code { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Details over fouten in opgegeven parameters + /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class InvalidParams + { + [Newtonsoft.Json.JsonProperty("type", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Uri Type { get; set; } + + /// + /// Naam van de parameter + /// + [Newtonsoft.Json.JsonProperty("name", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Name { get; set; } + + /// + /// Systeemcode die het type fout aangeeft + /// + [Newtonsoft.Json.JsonProperty("code", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.StringLength(int.MaxValue, MinimumLength = 1)] + public string Code { get; set; } + + /// + /// Beschrijving van de fout op de parameterwaarde + /// + [Newtonsoft.Json.JsonProperty("reason", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Reason { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class PersoonBeperkt + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{9}$")] + public string Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("geboorte", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GeboorteBeperkt Geboorte { get; set; } + + [Newtonsoft.Json.JsonProperty("geheimhoudingPersoonsgegevens", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractGeheimhoudingPersoonsgegevens GeheimhoudingPersoonsgegevens { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Geslachtsaanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("leeftijd", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.Range(0, 150)] + public int Leeftijd { get; set; } + + [Newtonsoft.Json.JsonProperty("naam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public NaamBasis Naam { get; set; } + + [Newtonsoft.Json.JsonProperty("opschortingBijhouding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public OpschortingBijhoudingBasis OpschortingBijhouding { get; set; } + + [Newtonsoft.Json.JsonProperty("overlijden", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractOverlijdenBasis Overlijden { get; set; } + + [Newtonsoft.Json.JsonProperty("verblijfplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractVerblijfplaatsBeperkt Verblijfplaats { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Waardetabel + { + [Newtonsoft.Json.JsonProperty("code", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Code { get; set; } + + [Newtonsoft.Json.JsonProperty("omschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Omschrijving { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Persoon + { + /// + /// Het A-nummer van de persoon + ///
+ /// + [Newtonsoft.Json.JsonProperty("aNummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string ANummer { get; set; } + + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{9}$")] + public string Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("datumEersteInschrijvingGBA", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumEersteInschrijvingGBA { get; set; } + + [Newtonsoft.Json.JsonProperty("geheimhoudingPersoonsgegevens", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractGeheimhoudingPersoonsgegevens GeheimhoudingPersoonsgegevens { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Geslachtsaanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractPersoonInOnderzoek InOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("kiesrecht", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Kiesrecht Kiesrecht { get; set; } + + [Newtonsoft.Json.JsonProperty("leeftijd", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.Range(0, 150)] + public int Leeftijd { get; set; } + + [Newtonsoft.Json.JsonProperty("naam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public NaamPersoon Naam { get; set; } + + [Newtonsoft.Json.JsonProperty("nationaliteiten", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.List Nationaliteiten { get; set; } + + [Newtonsoft.Json.JsonProperty("geboorte", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Geboorte Geboorte { get; set; } + + [Newtonsoft.Json.JsonProperty("opschortingBijhouding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public OpschortingBijhouding OpschortingBijhouding { get; set; } + + [Newtonsoft.Json.JsonProperty("overlijden", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Overlijden Overlijden { get; set; } + + [Newtonsoft.Json.JsonProperty("verblijfplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractVerblijfplaats Verblijfplaats { get; set; } + + [Newtonsoft.Json.JsonProperty("gezagsverhouding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Gezagsverhouding Gezagsverhouding { get; set; } + + [Newtonsoft.Json.JsonProperty("verblijfstitel", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Verblijfstitel Verblijfstitel { get; set; } + + [Newtonsoft.Json.JsonProperty("reisdocumentnummers", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.List Reisdocumentnummers { get; set; } + + [Newtonsoft.Json.JsonProperty("kinderen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.List Kinderen { get; set; } + + [Newtonsoft.Json.JsonProperty("ouders", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.List Ouders { get; set; } + + [Newtonsoft.Json.JsonProperty("partners", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public System.Collections.Generic.List Partners { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Geeft aan welke gegevens van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature). + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaPersoonInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(PersoonInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractPersoonInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaPersoonInOnderzoek : AbstractPersoonInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{6}$")] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class PersoonInOnderzoek : AbstractPersoonInOnderzoek + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Geslachtsaanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GeboorteBeperkt + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum Datum { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Gegevens mogen niet worden verstrekt aan derden / maatschappelijke instellingen. + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaGeheimhouding", typeof(GbaGeheimhoudingPersoonsgegevens))] + [JsonInheritanceAttribute("Geheimhouding", typeof(GeheimhoudingPersoonsgegevens))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractGeheimhoudingPersoonsgegevens + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaGeheimhoudingPersoonsgegevens : AbstractGeheimhoudingPersoonsgegevens + { + [Newtonsoft.Json.JsonProperty("waarde", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int? Waarde { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GeheimhoudingPersoonsgegevens : AbstractGeheimhoudingPersoonsgegevens + { + [Newtonsoft.Json.JsonProperty("geheimhouding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Geheimhouding { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class NaamBasis : GbaNaamBasis + { + [Newtonsoft.Json.JsonProperty("voorletters", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Voorletters { get; set; } + + [Newtonsoft.Json.JsonProperty("volledigeNaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string VolledigeNaam { get; set; } + + [Newtonsoft.Json.JsonProperty("adellijkeTitelPredikaat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public WaardetabelMetSoort AdellijkeTitelPredikaat { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaNaamBasis + { + [Newtonsoft.Json.JsonProperty("voornamen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.StringLength(200)] + public string Voornamen { get; set; } + + [Newtonsoft.Json.JsonProperty("voorvoegsel", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.StringLength(10)] + public string Voorvoegsel { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsnaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.StringLength(200)] + public string Geslachtsnaam { get; set; } + + [Newtonsoft.Json.JsonProperty("adellijkeTitelPredikaat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel AdellijkeTitelPredikaat { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class WaardetabelMetSoort : Waardetabel + { + [Newtonsoft.Json.JsonProperty("soort", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Soort { get; set; } + + } + + /// + /// * **reden** - wordt gevuld op basis van de waarden die voorkomen in de tabel 'redenopschortingbijhouding' uit de Haal-Centraal-BRP-tabellen-bevragen API. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OpschortingBijhoudingBasis + { + [Newtonsoft.Json.JsonProperty("reden", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Reden { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Gegevens over het overlijden van de persoon. + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaOverlijden", typeof(GbaOverlijdenBasis))] + [JsonInheritanceAttribute("Overlijden", typeof(OverlijdenBasis))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractOverlijdenBasis + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaOverlijdenBasis : AbstractOverlijdenBasis + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis Datum { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OverlijdenBasis : AbstractOverlijdenBasis + { + [Newtonsoft.Json.JsonProperty("indicatieOverleden", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool IndicatieOverleden { get; set; } + + } + + /// + /// Gegevens over het verblijf of de woonlocatie van een persoon. + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaVerblijfplaats", typeof(GbaVerblijfplaatsBeperkt))] + [JsonInheritanceAttribute("VerblijfplaatsBuitenland", typeof(VerblijfplaatsBuitenlandBeperkt))] + [JsonInheritanceAttribute("Adres", typeof(AdresBeperkt))] + [JsonInheritanceAttribute("Locatie", typeof(LocatieBeperkt))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractVerblijfplaatsBeperkt + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaVerblijfplaatsBeperkt : AbstractVerblijfplaatsBeperkt + { + [Newtonsoft.Json.JsonProperty("straat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9�-� '\-\']{1,80}$")] + public string Straat { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.Range(1, 99999)] + public int Huisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("huisletter", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z]{1}$")] + public string Huisletter { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummertoevoeging", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9]{1,4}$")] + public string Huisnummertoevoeging { get; set; } + + [Newtonsoft.Json.JsonProperty("aanduidingBijHuisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel AanduidingBijHuisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("postcode", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[1-9]{1}[0-9]{3}[ ]?[A-Za-z]{2}$")] + public string Postcode { get; set; } + + [Newtonsoft.Json.JsonProperty("locatiebeschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Locatiebeschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Land { get; set; } + + [Newtonsoft.Json.JsonProperty("gemeenteVanInschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{4}$")] + public string GemeenteVanInschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel1 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel2 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel3", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel3 { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VerblijfplaatsBuitenlandBeperkt : AbstractVerblijfplaatsBeperkt + { + [Newtonsoft.Json.JsonProperty("adresregel1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel1 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel2 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel3", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel3 { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Land { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AdresBeperkt : AbstractVerblijfplaatsBeperkt + { + [Newtonsoft.Json.JsonProperty("functieAdres", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel FunctieAdres { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel1 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel2 { get; set; } + + [Newtonsoft.Json.JsonProperty("woonplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9�-� '\-\']{1,80}$")] + public string Woonplaats { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VerblijfplaatsOnbekend : AbstractVerblijfplaats + { + [Newtonsoft.Json.JsonProperty("vertrokkenOnbekendWaarheen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool VertrokkenOnbekendWaarheen { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public VerblijfplaatsOnbekendInOnderzoek InOnderzoek { get; set; } + + } + + /// + /// Gegevens over het verblijf of de woonlocatie van een persoon. + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("VerblijfplaatsOnbekend", typeof(VerblijfplaatsOnbekend))] + [JsonInheritanceAttribute("GbaVerblijfplaats", typeof(GbaVerblijfplaats))] + [JsonInheritanceAttribute("VerblijfplaatsBuitenland", typeof(VerblijfplaatsBuitenland))] + [JsonInheritanceAttribute("Adres", typeof(Adres))] + [JsonInheritanceAttribute("Locatie", typeof(Locatie))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractVerblijfplaats + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaVerblijfplaats : AbstractVerblijfplaats + { + [Newtonsoft.Json.JsonProperty("straat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9�-� '\-\']{1,80}$")] + public string Straat { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.Range(1, 99999)] + public int Huisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("huisletter", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z]{1}$")] + public string Huisletter { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummertoevoeging", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9]{1,4}$")] + public string Huisnummertoevoeging { get; set; } + + [Newtonsoft.Json.JsonProperty("aanduidingBijHuisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel AanduidingBijHuisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("postcode", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[1-9]{1}[0-9]{3}[ ]?[A-Za-z]{2}$")] + public string Postcode { get; set; } + + [Newtonsoft.Json.JsonProperty("locatiebeschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Locatiebeschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Land { get; set; } + + [Newtonsoft.Json.JsonProperty("datumAanvangAdreshouding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatum DatumAanvangAdreshouding { get; set; } + + [Newtonsoft.Json.JsonProperty("datumAanvangAdresBuitenland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatum DatumAanvangAdresBuitenland { get; set; } + + [Newtonsoft.Json.JsonProperty("gemeenteVanInschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{4}$")] + public string GemeenteVanInschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("naamOpenbareRuimte", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string NaamOpenbareRuimte { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaInOnderzoek InOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VerblijfplaatsBuitenland : AbstractVerblijfplaats + { + [Newtonsoft.Json.JsonProperty("adresregel1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel1 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel2 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel3", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel3 { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Land { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVan", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumVan { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public VerblijfplaatsBuitenlandInOnderzoek InOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VerblijfplaatsBuitenlandInOnderzoek + { + [Newtonsoft.Json.JsonProperty("verblijfBuitenland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? VerblijfBuitenland { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVan", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumVan { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Gegevens over het adres van een persoon. + ///
* **datumVan** : de datum van aangifte of ambtshalve melding van verblijf en adres. + ///
* **datumIngangGeldigheid** : datum waarop de gegevens over de verblijfplaats geldig zijn geworden. + ///
* **datumInschrijvingInGemeente**: bij inschrijving op grond van een verhuisaangifte door de burger is dit de aangiftedatum. Bij inschrijving op grond van een geboorteakte is dit de geboortedatum. Bij ambtshalve inschrijving is dit de datum waarop het voornemen van ambtshalve opneming schriftelijk aan de persoon is medegedeeld. + ///
* **datumVestigingInNederland** : datum van inschrijving in Nederland. + ///
* **landVanWaarIngeschreven** : het land waar de persoon woonde voor (her)vestiging in Nederland. + ///
* **gemeenteVanInschrijving** : de gemeente waar de persoon verblijft en is ingeschreven. De code kan voorloopnullen bevatten." + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Adres : AbstractVerblijfplaats + { + [Newtonsoft.Json.JsonProperty("functieAdres", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel FunctieAdres { get; set; } + + [Newtonsoft.Json.JsonProperty("straat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9�-� '\-\']{1,80}$")] + public string Straat { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.Range(1, 99999)] + public int Huisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("huisletter", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z]{1}$")] + public string Huisletter { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummertoevoeging", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9]{1,4}$")] + public string Huisnummertoevoeging { get; set; } + + [Newtonsoft.Json.JsonProperty("aanduidingBijHuisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel AanduidingBijHuisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("postcode", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[1-9]{1}[0-9]{3}[ ]?[A-Za-z]{2}$")] + public string Postcode { get; set; } + + [Newtonsoft.Json.JsonProperty("adresseerbaarObjectIdentificatie", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string AdresseerbaarObjectIdentificatie { get; set; } + + [Newtonsoft.Json.JsonProperty("nummeraanduidingIdentificatie", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{16}$")] + public string NummeraanduidingIdentificatie { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel1 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel2 { get; set; } + + [Newtonsoft.Json.JsonProperty("woonplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9�-� '\-\']{1,80}$")] + public string Woonplaats { get; set; } + + [Newtonsoft.Json.JsonProperty("indicatieVestigingVanuitBuitenland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool IndicatieVestigingVanuitBuitenland { get; set; } + + [Newtonsoft.Json.JsonProperty("korteNaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string KorteNaam { get; set; } + + [Newtonsoft.Json.JsonProperty("vanuitVertrokkenOnbekendWaarheen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool VanuitVertrokkenOnbekendWaarheen { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVan", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumVan { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("datumInschrijvingInGemeente", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumInschrijvingInGemeente { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVestigingInNederland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumVestigingInNederland { get; set; } + + [Newtonsoft.Json.JsonProperty("gemeenteVanInschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel GemeenteVanInschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("landVanwaarIngeschreven", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel LandVanwaarIngeschreven { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public VerblijfplaatsInOnderzoek InOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VerblijfplaatsInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingBijHuisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? AanduidingBijHuisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVan", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumVan { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("datumInschrijvingInGemeente", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumInschrijvingInGemeente { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVestigingInNederland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumVestigingInNederland { get; set; } + + [Newtonsoft.Json.JsonProperty("functieAdres", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? FunctieAdres { get; set; } + + [Newtonsoft.Json.JsonProperty("gemeenteVanInschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? GemeenteVanInschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("huisletter", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Huisletter { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Huisnummer { get; set; } + + [Newtonsoft.Json.JsonProperty("huisnummertoevoeging", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Huisnummertoevoeging { get; set; } + + [Newtonsoft.Json.JsonProperty("nummeraanduidingIdentificatie", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? NummeraanduidingIdentificatie { get; set; } + + [Newtonsoft.Json.JsonProperty("adresseerbaarObjectIdentificatie", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? AdresseerbaarObjectIdentificatie { get; set; } + + [Newtonsoft.Json.JsonProperty("landVanwaarIngeschreven", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? LandVanwaarIngeschreven { get; set; } + + [Newtonsoft.Json.JsonProperty("straat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Straat { get; set; } + + [Newtonsoft.Json.JsonProperty("postcode", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Postcode { get; set; } + + [Newtonsoft.Json.JsonProperty("korteNaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? KorteNaam { get; set; } + + [Newtonsoft.Json.JsonProperty("woonplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Woonplaats { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Locatie : AbstractVerblijfplaats + { + [Newtonsoft.Json.JsonProperty("adresregel1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel1 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel2 { get; set; } + + [Newtonsoft.Json.JsonProperty("datumInschrijvingInGemeente", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumInschrijvingInGemeente { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVestigingInNederland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumVestigingInNederland { get; set; } + + [Newtonsoft.Json.JsonProperty("functieAdres", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel FunctieAdres { get; set; } + + [Newtonsoft.Json.JsonProperty("gemeenteVanInschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel GemeenteVanInschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("indicatieVestigingVanuitBuitenland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool IndicatieVestigingVanuitBuitenland { get; set; } + + [Newtonsoft.Json.JsonProperty("landVanwaarIngeschreven", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel LandVanwaarIngeschreven { get; set; } + + [Newtonsoft.Json.JsonProperty("locatiebeschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Locatiebeschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("vanuitVertrokkenOnbekendWaarheen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool VanuitVertrokkenOnbekendWaarheen { get; set; } + + [Newtonsoft.Json.JsonProperty("woonplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9�-� '\-\']{1,80}$")] + public string Woonplaats { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public LocatieInOnderzoek InOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class LocatieInOnderzoek + { + [Newtonsoft.Json.JsonProperty("datumInschrijvingInGemeente", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumInschrijvingInGemeente { get; set; } + + [Newtonsoft.Json.JsonProperty("datumVestigingInNederland", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumVestigingInNederland { get; set; } + + [Newtonsoft.Json.JsonProperty("functieAdres", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? FunctieAdres { get; set; } + + [Newtonsoft.Json.JsonProperty("gemeenteVanInschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? GemeenteVanInschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("landVanwaarIngeschreven", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? LandVanwaarIngeschreven { get; set; } + + [Newtonsoft.Json.JsonProperty("locatiebeschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Locatiebeschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("woonplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Woonplaats { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VerblijfplaatsOnbekendInOnderzoek + { + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Land { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class LocatieBeperkt : AbstractVerblijfplaatsBeperkt + { + [Newtonsoft.Json.JsonProperty("adresregel1", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel1 { get; set; } + + [Newtonsoft.Json.JsonProperty("adresregel2", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Adresregel2 { get; set; } + + [Newtonsoft.Json.JsonProperty("functieAdres", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel FunctieAdres { get; set; } + + [Newtonsoft.Json.JsonProperty("locatiebeschrijving", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Locatiebeschrijving { get; set; } + + [Newtonsoft.Json.JsonProperty("woonplaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[a-zA-Z0-9�-� '\-\']{1,80}$")] + public string Woonplaats { get; set; } + + } + + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaDatum", typeof(GbaDatum))] + [JsonInheritanceAttribute("Datum", typeof(VolledigDatum))] + [JsonInheritanceAttribute("OnbekendDatum", typeof(OnbekendDatum))] + [JsonInheritanceAttribute("JaarDatum", typeof(JaarDatum))] + [JsonInheritanceAttribute("JaarMaandDatum", typeof(JaarMaandDatum))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractDatum + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Datum conform LO GBA + /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaDatum : AbstractDatum + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{8}$")] + public string Datum { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaDatumBasis + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{8}$")] + public string Datum { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Datum conform iso8601 + /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VolledigDatum : AbstractDatum + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [Newtonsoft.Json.JsonConverter(typeof(DateFormatConverter))] + public System.DateTimeOffset? Datum { get; set; } + + } + + /// + /// representatie voor een volledig onbekend datum + /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OnbekendDatum : AbstractDatum + { + [Newtonsoft.Json.JsonProperty("onbekend", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Onbekend { get; set; } = true; + + } + + /// + /// representatie voor een datum waarvan maand en dag onbekend zijn + /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class JaarDatum : AbstractDatum + { + [Newtonsoft.Json.JsonProperty("jaar", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.Range(1, 9999)] + public int Jaar { get; set; } + + } + + /// + /// representatie voor een datum waarvan de dag onbekend is + /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class JaarMaandDatum : AbstractDatum + { + [Newtonsoft.Json.JsonProperty("jaar", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.Range(1, 9999)] + public int Jaar { get; set; } + + [Newtonsoft.Json.JsonProperty("maand", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.Range(1, 12)] + public int Maand { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Kiesrecht + { + /// + /// Geeft aan of persoon een oproep moet ontvangen voor verkiezingen voor het Europees parlement. + ///
+ /// + [Newtonsoft.Json.JsonProperty("europeesKiesrecht", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? EuropeesKiesrecht { get; set; } + + [Newtonsoft.Json.JsonProperty("uitgeslotenVanKiesrecht", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? UitgeslotenVanKiesrecht { get; set; } + + [Newtonsoft.Json.JsonProperty("einddatumUitsluitingEuropeesKiesrecht", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum EinddatumUitsluitingEuropeesKiesrecht { get; set; } + + [Newtonsoft.Json.JsonProperty("einddatumUitsluitingKiesrecht", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum EinddatumUitsluitingKiesrecht { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class NaamPersoon : NaamBasis + { + [Newtonsoft.Json.JsonProperty("aanhef", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Aanhef { get; set; } + + [Newtonsoft.Json.JsonProperty("aanschrijfwijze", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Aanschrijfwijze { get; set; } + + [Newtonsoft.Json.JsonProperty("regelVoorafgaandAanAanschrijfwijze", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string RegelVoorafgaandAanAanschrijfwijze { get; set; } + + [Newtonsoft.Json.JsonProperty("gebruikInLopendeTekst", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string GebruikInLopendeTekst { get; set; } + + [Newtonsoft.Json.JsonProperty("aanduidingNaamgebruik", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel AanduidingNaamgebruik { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractNaamPersoonInOnderzoek InOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Geeft aan welke gegevens over de naam in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaNaamPersoonInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(NaamPersoonInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractNaamPersoonInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaNaamPersoonInOnderzoek : AbstractNaamPersoonInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{6}$")] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class NaamPersoonInOnderzoek : AbstractNaamPersoonInOnderzoek + { + [Newtonsoft.Json.JsonProperty("geslachtsnaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Geslachtsnaam { get; set; } + + [Newtonsoft.Json.JsonProperty("voornamen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Voornamen { get; set; } + + [Newtonsoft.Json.JsonProperty("voorvoegsel", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Voorvoegsel { get; set; } + + [Newtonsoft.Json.JsonProperty("adellijkeTitelPredikaat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? AdellijkeTitelPredikaat { get; set; } + + [Newtonsoft.Json.JsonProperty("aanduidingNaamgebruik", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? AanduidingNaamgebruik { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + /// + /// * **redenOpname** : De reden op grond waarvan de persoon de nationaliteit gekregen heeft. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Nationaliteit : AbstractNationaliteit + { + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("nationaliteit", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Nationaliteit1 { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public NationaliteitInOnderzoek InOnderzoek { get; set; } + + } + + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("Nationaliteit", typeof(Nationaliteit))] + [JsonInheritanceAttribute("GbaNationaliteit", typeof(GbaNationaliteit))] + [JsonInheritanceAttribute("BehandeldAlsNederlander", typeof(BehandeldAlsNederlander))] + [JsonInheritanceAttribute("VastgesteldNietNederlander", typeof(VastgesteldNietNederlander))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractNationaliteit + { + [Newtonsoft.Json.JsonProperty("redenOpname", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel RedenOpname { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Bij de LO GBA versie kunnen datums, bijv datumIngangGeldigheid de LoGbaDatum refereren + ///
Het hoeft niet van AbstractDatum af te leiden omdat het nooit een andere type kan zijn + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaNationaliteit : AbstractNationaliteit + { + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("nationaliteit", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Nationaliteit { get; set; } + + [Newtonsoft.Json.JsonProperty("aanduidingBijzonderNederlandschap", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel AanduidingBijzonderNederlandschap { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaInOnderzoek InOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class BehandeldAlsNederlander : AbstractNationaliteit + { + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public BijzonderNederlanderschapInOnderzoek InOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class BijzonderNederlanderschapInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingBijzonderNederlanderschap", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? AanduidingBijzonderNederlanderschap { get; set; } + + [Newtonsoft.Json.JsonProperty("redenOpname", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? RedenOpname { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VastgesteldNietNederlander : AbstractNationaliteit + { + [Newtonsoft.Json.JsonProperty("datumIngangGeldigheid", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangGeldigheid { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public BijzonderNederlanderschapInOnderzoek InOnderzoek { get; set; } + + } + + /// + /// Geeft aan welke gegevens over de nationaliteit in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class NationaliteitInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingBijzonderNederlanderschap", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? AanduidingBijzonderNederlanderschap { get; set; } + + [Newtonsoft.Json.JsonProperty("nationaliteit", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Nationaliteit { get; set; } + + [Newtonsoft.Json.JsonProperty("redenOpname", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? RedenOpname { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Gegevens over de geboorte. + ///
* **datum** : datum waarop de persoon is geboren. + ///
* **land** : land waar de persoon is geboren + ///
* **plaats** : gemeente waar de persoon is geboren. Is de persoon geboren buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Geboorte + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum Datum { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Land { get; set; } + + [Newtonsoft.Json.JsonProperty("plaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Plaats { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractGeboorteInOnderzoek InOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Geeft aan welke gegevens over de geboorte van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaGeboorteInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(GeboorteInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractGeboorteInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaGeboorteInOnderzoek : AbstractGeboorteInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{6}$")] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GeboorteInOnderzoek : AbstractGeboorteInOnderzoek + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Datum { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Land { get; set; } + + [Newtonsoft.Json.JsonProperty("plaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Plaats { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + /// + /// * **datum**: de datum waarop de bijhouding van de persoonsgegevens is gestaakt. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OpschortingBijhouding : OpschortingBijhoudingBasis + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum Datum { get; set; } + + } + + /// + /// Gegevens over het overlijden van de persoon. + ///
* **datum** : datum waarop de persoon is overleden. + ///
* **land** : land waar de persoon is overleden. + ///
* **plaats** : gemeente waar de persoon is overleden. Is de persoon overleden buiten Nederland, dan bevat het antwoord alleen een buitenlandse plaatsnaam of aanduiding. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Overlijden + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum Datum { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Land { get; set; } + + [Newtonsoft.Json.JsonProperty("plaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Plaats { get; set; } + + [Newtonsoft.Json.JsonProperty("indicatieOverleden", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool IndicatieOverleden { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractOverlijdenInOnderzoek InOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Geeft aan welke gegevens over het overlijden van de persoon in onderzoek zijn. + ///
Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaOverlijdenInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(OverlijdenInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractOverlijdenInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaOverlijdenInOnderzoek : AbstractOverlijdenInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{6}$")] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OverlijdenInOnderzoek : AbstractOverlijdenInOnderzoek + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Datum { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Land { get; set; } + + [Newtonsoft.Json.JsonProperty("plaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Plaats { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + /// + /// Gegevens over het gezag over de persoon. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Gezagsverhouding + { + /// + /// Geeft aan dat de persoon onder curatele is gesteld. + ///
+ /// + [Newtonsoft.Json.JsonProperty("indicatieCurateleRegister", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? IndicatieCurateleRegister { get; set; } + + [Newtonsoft.Json.JsonProperty("indicatieGezagMinderjarige", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel IndicatieGezagMinderjarige { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractGezagsverhoudingInOnderzoek InOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Geeft aan welke gegevens van de gezagsverhouding in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaGezagsverhoudingInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(GezagsverhoudingInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractGezagsverhoudingInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaGezagsverhoudingInOnderzoek : AbstractGezagsverhoudingInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{6}$")] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GezagsverhoudingInOnderzoek : AbstractGezagsverhoudingInOnderzoek + { + [Newtonsoft.Json.JsonProperty("indicatieCurateleRegister", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? IndicatieCurateleRegister { get; set; } + + [Newtonsoft.Json.JsonProperty("indicatieGezagMinderjarige", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? IndicatieGezagMinderjarige { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + /// + /// Gegevens over de verblijfsrechtelijke status van de persoon. + ///
* **datumEinde**: Datum waarop de geldigheid van de gegevens over de verblijfstitel is be�indigd. + ///
* **datumIngang**: Datum waarop de gegevens over de verblijfstitel geldig zijn geworden. + ///
* **aanduiding** : Verblijfstiteltabel die aangeeft over welke verblijfsrechtelijke status de persoon beschikt. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Verblijfstitel + { + [Newtonsoft.Json.JsonProperty("aanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Aanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("datumEinde", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumEinde { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngang", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngang { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractVerblijfstitelInOnderzoek InOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Geeft aan welke gegevens over de verblijfstitel in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaVerblijfstitelInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(VerblijfstitelInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractVerblijfstitelInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaVerblijfstitelInOnderzoek : AbstractVerblijfstitelInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{6}$")] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class VerblijfstitelInOnderzoek : AbstractVerblijfstitelInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Aanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("datumEinde", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumEinde { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngang", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumIngang { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + /// + /// Gegevens over een kind van de persoon. + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("Kind", typeof(Kind))] + [JsonInheritanceAttribute("OnbekendKind", typeof(OnbekendKind))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractKind + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Kind : AbstractKind + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{9}$")] + public string Burgerservicenummer { get; set; } + + /// + /// Leeftijd op het moment van bevragen + ///
+ /// + [Newtonsoft.Json.JsonProperty("leeftijd", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public int? Leeftijd { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractKindInOnderzoek InOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("naam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public NaamGerelateerde Naam { get; set; } + + [Newtonsoft.Json.JsonProperty("geboorte", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Geboorte Geboorte { get; set; } + + } + + /// + /// Geeft aan of de gegevens over het kind van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaKindInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(KindInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractKindInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaKindInOnderzoek : AbstractKindInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{6}$")] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class KindInOnderzoek : AbstractKindInOnderzoek + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OnbekendKind : AbstractKind + { + [Newtonsoft.Json.JsonProperty("indicatieOnbekend", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? IndicatieOnbekend { get; set; } = false; + + } + + /// + /// Gegevens over de ouder van de persoon. + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("Ouder", typeof(Ouder))] + [JsonInheritanceAttribute("OnbekendOuder", typeof(OnbekendOuder))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractOuder + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Gegevens over de ouder van de persoon. + ///
* **datumIngangFamilierechtelijkeBetrekking** - De datum waarop de familierechtelijke betrekking is ontstaan. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Ouder : AbstractOuder + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{9}$")] + public string Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Geslachtsaanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("ouderAanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel OuderAanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangFamilierechtelijkeBetrekking", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangFamilierechtelijkeBetrekking { get; set; } + + [Newtonsoft.Json.JsonProperty("naam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public NaamGerelateerde Naam { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractOuderInOnderzoek InOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("geboorte", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Geboorte Geboorte { get; set; } + + } + + /// + /// Geeft aan welke gegevens van de de ouder in onderzoek zijn. + ///
Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaOuderInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(OuderInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractOuderInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaOuderInOnderzoek : AbstractOuderInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{6}$")] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OuderInOnderzoek : AbstractOuderInOnderzoek + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangFamilierechtelijkeBetrekking", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? DatumIngangFamilierechtelijkeBetrekking { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Geslachtsaanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OnbekendOuder : AbstractOuder + { + [Newtonsoft.Json.JsonProperty("indicatieOnbekend", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? IndicatieOnbekend { get; set; } = false; + + } + + /// + /// Gegevens over een gesloten huwelijk/geregistreerd partnerschap van de persoon. + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("Partner", typeof(Partner))] + [JsonInheritanceAttribute("OnbekendPartner", typeof(OnbekendPartner))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractPartner + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class Partner : AbstractPartner + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{9}$")] + public string Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Geslachtsaanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("soortVerbintenis", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel SoortVerbintenis { get; set; } + + [Newtonsoft.Json.JsonProperty("naam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public NaamGerelateerde Naam { get; set; } + + [Newtonsoft.Json.JsonProperty("geboorte", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Geboorte Geboorte { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractPartnerInOnderzoek InOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("aangaanHuwelijkPartnerschap", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AangaanHuwelijkPartnerschap AangaanHuwelijkPartnerschap { get; set; } + + } + + /// + /// Geeft aan welke gegevens over het huwelijk of het partnerschap in onderzoek zijn. + ///
Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaPartnerInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(PartnerInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractPartnerInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaPartnerInOnderzoek : AbstractPartnerInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{6}$")] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class PartnerInOnderzoek : AbstractPartnerInOnderzoek + { + [Newtonsoft.Json.JsonProperty("burgerservicenummer", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Burgerservicenummer { get; set; } + + [Newtonsoft.Json.JsonProperty("geslachtsaanduiding", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Geslachtsaanduiding { get; set; } + + [Newtonsoft.Json.JsonProperty("soortVerbintenis", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? SoortVerbintenis { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + /// + /// Gegevens over de voltrekking van het huwelijk of het aangaan van het geregistreerd partnerschap. + ///
* **datum** : De datum waarop het huwelijk is voltrokken of het partnerschap is aangegaan. + ///
* **land** : Het land waar het huwelijk is voltrokken of het partnerschap is aangegaan. + ///
* **plaats** : De gemeente waar het huwelijk is voltrokken of het partnerschap is aangegaan. Voor een plaats buiten Nederland bevat het antwoord een buitenlandse plaatsnaam of aanduiding. + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AangaanHuwelijkPartnerschap + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum Datum { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Land { get; set; } + + [Newtonsoft.Json.JsonProperty("plaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public Waardetabel Plaats { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractAangaanHuwelijkPartnerschapInOnderzoek InOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + /// + /// Geeft aan welke gegevens over het voltrekken van het huwelijk of aangaan van het partnerschap in onderzoek zijn. + ///
Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaAangaanHuwelijkPartnerschapInOnderzoek))] + [JsonInheritanceAttribute("InOnderzoek", typeof(AangaanHuwelijkPartnerschapInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractAangaanHuwelijkPartnerschapInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaAangaanHuwelijkPartnerschapInOnderzoek : AbstractAangaanHuwelijkPartnerschapInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{6}$")] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AangaanHuwelijkPartnerschapInOnderzoek : AbstractAangaanHuwelijkPartnerschapInOnderzoek + { + [Newtonsoft.Json.JsonProperty("datum", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Datum { get; set; } + + [Newtonsoft.Json.JsonProperty("land", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Land { get; set; } + + [Newtonsoft.Json.JsonProperty("plaats", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Plaats { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class OnbekendPartner : AbstractPartner + { + [Newtonsoft.Json.JsonProperty("indicatieOnbekend", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? IndicatieOnbekend { get; set; } = false; + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{6}$")] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class NaamGerelateerde : GbaNaamBasis + { + [Newtonsoft.Json.JsonProperty("voorletters", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public string Voorletters { get; set; } + + [Newtonsoft.Json.JsonProperty("inOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractNaamInOnderzoek InOnderzoek { get; set; } + + } + + /// + /// Geeft aan welke gegevens over de naam van de persoon in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [Newtonsoft.Json.JsonConverter(typeof(JsonInheritanceConverter), "type")] + [JsonInheritanceAttribute("GbaInOnderzoek", typeof(GbaNaamInOnderzoek))] + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class AbstractNaamInOnderzoek + { + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class GbaNaamInOnderzoek : AbstractNaamInOnderzoek + { + [Newtonsoft.Json.JsonProperty("aanduidingGegevensInOnderzoek", Required = Newtonsoft.Json.Required.Always)] + [System.ComponentModel.DataAnnotations.Required(AllowEmptyStrings = true)] + [System.ComponentModel.DataAnnotations.RegularExpression(@"^[0-9]{6}$")] + public string AanduidingGegevensInOnderzoek { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public GbaDatumBasis DatumIngangOnderzoek { get; set; } + + } + + /// + /// Geeft aan welke gegevens over de naam in onderzoek zijn. Zie de [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/in_onderzoek.feature) + ///
+ /// + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + public partial class NaamInOnderzoek + { + [Newtonsoft.Json.JsonProperty("geslachtsnaam", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Geslachtsnaam { get; set; } + + [Newtonsoft.Json.JsonProperty("voornamen", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Voornamen { get; set; } + + [Newtonsoft.Json.JsonProperty("voorvoegsel", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? Voorvoegsel { get; set; } + + [Newtonsoft.Json.JsonProperty("adellijkeTitelPredikaat", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public bool? AdellijkeTitelPredikaat { get; set; } + + [Newtonsoft.Json.JsonProperty("datumIngangOnderzoek", Required = Newtonsoft.Json.Required.DisallowNull, NullValueHandling = Newtonsoft.Json.NullValueHandling.Ignore)] + public AbstractDatum DatumIngangOnderzoek { get; set; } + + private System.Collections.Generic.IDictionary _additionalProperties = new System.Collections.Generic.Dictionary(); + + [Newtonsoft.Json.JsonExtensionData] + public System.Collections.Generic.IDictionary AdditionalProperties + { + get { return _additionalProperties; } + set { _additionalProperties = value; } + } + + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + [System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface, AllowMultiple = true)] + internal class JsonInheritanceAttribute : System.Attribute + { + public JsonInheritanceAttribute(string key, System.Type type) + { + Key = key; + Type = type; + } + + public string Key { get; } + + public System.Type Type { get; } + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + internal class JsonInheritanceConverter : Newtonsoft.Json.JsonConverter + { + internal static readonly string DefaultDiscriminatorName = "discriminator"; + + private readonly string _discriminatorName; + + [System.ThreadStatic] + private static bool _isReading; + + [System.ThreadStatic] + private static bool _isWriting; + + public JsonInheritanceConverter() + { + _discriminatorName = DefaultDiscriminatorName; + } + + public JsonInheritanceConverter(string discriminatorName) + { + _discriminatorName = discriminatorName; + } + + public string DiscriminatorName { get { return _discriminatorName; } } + + public override void WriteJson(Newtonsoft.Json.JsonWriter writer, object value, Newtonsoft.Json.JsonSerializer serializer) + { + try + { + _isWriting = true; + + var jObject = Newtonsoft.Json.Linq.JObject.FromObject(value, serializer); + jObject.AddFirst(new Newtonsoft.Json.Linq.JProperty(_discriminatorName, GetSubtypeDiscriminator(value.GetType()))); + writer.WriteToken(jObject.CreateReader()); + } + finally + { + _isWriting = false; + } + } + + public override bool CanWrite + { + get + { + if (_isWriting) + { + _isWriting = false; + return false; + } + return true; + } + } + + public override bool CanRead + { + get + { + if (_isReading) + { + _isReading = false; + return false; + } + return true; + } + } + + public override bool CanConvert(System.Type objectType) + { + return true; + } + + public override object ReadJson(Newtonsoft.Json.JsonReader reader, System.Type objectType, object existingValue, Newtonsoft.Json.JsonSerializer serializer) + { + var jObject = serializer.Deserialize(reader); + if (jObject == null) + return null; + + var discriminatorValue = jObject.GetValue(_discriminatorName); + var discriminator = discriminatorValue != null ? Newtonsoft.Json.Linq.Extensions.Value(discriminatorValue) : null; + var subtype = GetObjectSubtype(objectType, discriminator); + + var objectContract = serializer.ContractResolver.ResolveContract(subtype) as Newtonsoft.Json.Serialization.JsonObjectContract; + if (objectContract == null || System.Linq.Enumerable.All(objectContract.Properties, p => p.PropertyName != _discriminatorName)) + { + jObject.Remove(_discriminatorName); + } + + try + { + _isReading = true; + return serializer.Deserialize(jObject.CreateReader(), subtype); + } + finally + { + _isReading = false; + } + } + + private System.Type GetObjectSubtype(System.Type objectType, string discriminator) + { + foreach (var attribute in System.Reflection.CustomAttributeExtensions.GetCustomAttributes(System.Reflection.IntrospectionExtensions.GetTypeInfo(objectType), true)) + { + if (attribute.Key == discriminator) + return attribute.Type; + } + + return objectType; + } + + private string GetSubtypeDiscriminator(System.Type objectType) + { + foreach (var attribute in System.Reflection.CustomAttributeExtensions.GetCustomAttributes(System.Reflection.IntrospectionExtensions.GetTypeInfo(objectType), true)) + { + if (attribute.Type == objectType) + return attribute.Key; + } + + return objectType.Name; + } + } + + [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "13.15.7.0 (NJsonSchema v10.6.7.0 (Newtonsoft.Json v13.0.0.0))")] + internal class DateFormatConverter : Newtonsoft.Json.Converters.IsoDateTimeConverter + { + public DateFormatConverter() + { + DateTimeFormat = "yyyy-MM-dd"; + } + } + + +} + +#pragma warning restore 1591 +#pragma warning restore 1573 +#pragma warning restore 472 +#pragma warning restore 114 +#pragma warning restore 108 +#pragma warning restore 3016 +#pragma warning restore 8603 \ No newline at end of file diff --git a/src/BrpService/Program.cs b/src/BrpService/Program.cs new file mode 100644 index 000000000..d6e6602b7 --- /dev/null +++ b/src/BrpService/Program.cs @@ -0,0 +1,25 @@ +var builder = WebApplication.CreateBuilder(args); + +// Add services to the container. + +builder.Services.AddControllers().AddNewtonsoftJson(); +// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle +builder.Services.AddEndpointsApiExplorer(); +builder.Services.AddSwaggerGen(); + +var app = builder.Build(); + +// Configure the HTTP request pipeline. +if (app.Environment.IsDevelopment()) +{ + app.UseSwagger(); + app.UseSwaggerUI(); +} + +app.UseHttpsRedirection(); + +app.UseAuthorization(); + +app.MapControllers(); + +app.Run(); diff --git a/src/BrpService/Properties/launchSettings.json b/src/BrpService/Properties/launchSettings.json new file mode 100644 index 000000000..ee8cbe34a --- /dev/null +++ b/src/BrpService/Properties/launchSettings.json @@ -0,0 +1,31 @@ +{ + "$schema": "https://json.schemastore.org/launchsettings.json", + "iisSettings": { + "windowsAuthentication": false, + "anonymousAuthentication": true, + "iisExpress": { + "applicationUrl": "http://localhost:22192", + "sslPort": 44332 + } + }, + "profiles": { + "BrpService": { + "commandName": "Project", + "dotnetRunMessages": true, + "launchBrowser": true, + "launchUrl": "swagger", + "applicationUrl": "https://localhost:7098;http://localhost:5098", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + }, + "IIS Express": { + "commandName": "IISExpress", + "launchBrowser": true, + "launchUrl": "swagger", + "environmentVariables": { + "ASPNETCORE_ENVIRONMENT": "Development" + } + } + } +} diff --git a/src/BrpService/Server.nswag b/src/BrpService/Server.nswag new file mode 100644 index 000000000..3e46a833d --- /dev/null +++ b/src/BrpService/Server.nswag @@ -0,0 +1,77 @@ +{ + "runtime": "Net60", + "defaultVariables": null, + "documentGenerator": { + "fromDocument": { + "url": "../../specificatie/genereervariant/openapi.yaml", + "output": null, + "newLineBehavior": "Auto" + } + }, + "codeGenerators": { + "openApiToCSharpController": { + "controllerBaseClass": null, + "controllerStyle": "Abstract", + "controllerTarget": "AspNetCore", + "useCancellationToken": false, + "useActionResultType": true, + "generateModelValidationAttributes": false, + "routeNamingStrategy": "None", + "basePath": null, + "className": "{controller}", + "operationGenerationMode": "MultipleClientsFromOperationId", + "additionalNamespaceUsages": [], + "additionalContractNamespaceUsages": [], + "generateOptionalParameters": false, + "generateJsonMethods": false, + "enforceFlagEnums": false, + "parameterArrayType": "System.Collections.Generic.IEnumerable", + "parameterDictionaryType": "System.Collections.Generic.IDictionary", + "responseArrayType": "System.Collections.Generic.ICollection", + "responseDictionaryType": "System.Collections.Generic.IDictionary", + "wrapResponses": false, + "wrapResponseMethods": [], + "generateResponseClasses": true, + "responseClass": "SwaggerResponse", + "namespace": "HaalCentraal.BrpService.Generated", + "requiredPropertiesMustBeDefined": true, + "dateType": "System.DateTimeOffset", + "jsonConverters": null, + "anyType": "object", + "dateTimeType": "System.DateTimeOffset", + "timeType": "System.TimeSpan", + "timeSpanType": "System.TimeSpan", + "arrayType": "System.Collections.Generic.List", + "arrayInstanceType": "System.Collections.Generic.List", + "dictionaryType": "System.Collections.Generic.IDictionary", + "dictionaryInstanceType": "System.Collections.Generic.Dictionary", + "arrayBaseType": "System.Collections.ObjectModel.Collection", + "dictionaryBaseType": "System.Collections.Generic.Dictionary", + "classStyle": "Poco", + "jsonLibrary": "NewtonsoftJson", + "generateDefaultValues": true, + "generateDataAnnotations": true, + "excludedTypeNames": [], + "excludedParameterNames": [], + "handleReferences": false, + "generateImmutableArrayProperties": false, + "generateImmutableDictionaryProperties": false, + "jsonSerializerSettingsTransformationMethod": null, + "inlineNamedArrays": false, + "inlineNamedDictionaries": false, + "inlineNamedTuples": true, + "inlineNamedAny": false, + "generateDtoTypes": true, + "generateOptionalPropertiesAsNullable": true, + "generateNullableReferenceTypes": false, + "templateDirectory": null, + "typeNameGeneratorType": null, + "propertyNameGeneratorType": null, + "enumNameGeneratorType": null, + "serviceHost": null, + "serviceSchemes": null, + "output": "Generated.cs", + "newLineBehavior": "Auto" + } + } +} \ No newline at end of file diff --git a/src/BrpService/appsettings.Development.json b/src/BrpService/appsettings.Development.json new file mode 100644 index 000000000..0c208ae91 --- /dev/null +++ b/src/BrpService/appsettings.Development.json @@ -0,0 +1,8 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + } +} diff --git a/src/BrpService/appsettings.json b/src/BrpService/appsettings.json new file mode 100644 index 000000000..10f68b8c8 --- /dev/null +++ b/src/BrpService/appsettings.json @@ -0,0 +1,9 @@ +{ + "Logging": { + "LogLevel": { + "Default": "Information", + "Microsoft.AspNetCore": "Warning" + } + }, + "AllowedHosts": "*" +} diff --git a/test/BRP-Bevragen-postman-collection.json b/test/BRP-Bevragen-postman-collection.json index df35ac21d..7a7a48bdf 100644 --- a/test/BRP-Bevragen-postman-collection.json +++ b/test/BRP-Bevragen-postman-collection.json @@ -1,4907 +1,496 @@ { "item": [ { - "id": "1403897f-7511-4f98-82ab-c555322c0e77", - "name": "ingeschrevenpersonen", - "item": [ + "id": "1b8d9fda-9ce6-4414-809c-a2847d2b148a", + "name": "Vindt personen", + "request": { + "name": "Vindt personen", + "description": { + "content": "Zoek personen met één van de onderstaande verplichte combinaties van parameters en vul ze evt. aan met optionele parameters.\n\n\nDefault krijg je personen terug die nog in leven zijn, tenzij je de inclusiefoverledenpersonen=true opgeeft.\n\n\nGebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.3.0/features/fields_extensie.feature)\n\n\n1. Zoek met geslachtsnaam en geboortedatum\n - geboortedatum\n - geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature))\n\n\n2. Zoek met geslachtsnaam, voornamen en gemeente van inschrijving\n - gemeenteVanInschrijving\n - geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature))\n\n\n3. Raadpleeg met burgerservicenummer\n - burgerservicenummer\n\n\n4. Zoek met postcode en huisnummer\n - postcode\n - huisnummer\n\n\n5. Zoek met straat, huisnummer en gemeente van inschrijving\n - straat (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.3.0/features/wildcard.feature))\n - gemeenteVanInschrijving\n - huisnummer\n\n\n6. Zoek met nummeraanduiding identificatie\n - nummeraanduidingIdentificatie\n", + "type": "text/plain" + }, + "url": { + "path": [ + "personen" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "method": "POST", + "auth": null, + "body": { + "mode": "raw", + "raw": "{\n \"fields\": \"\",\n \"type\": \"\",\n \"gemeenteVanInschrijving\": \"\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "response": [ { - "id": "0ee97840-9365-478c-88ef-ca208c172fe3", - "name": "Vindt personen", - "request": { - "name": "Vindt personen", - "description": { - "content": "Zoek personen met één van de onderstaande verplichte combinaties van parameters en vul ze evt. aan met parameters uit de andere combinaties.\n\n\nDefault krijg je personen terug die nog in leven zijn, tenzij je de inclusiefoverledenpersonen=true opgeeft.\n\n\nGebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/fields_extensie.feature)\n\n\n1. Persoon\n - geboorte__datum\n - naam__geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature)\n\n\n2. Persoon\n - verblijfplaats__gemeenteVanInschrijving\n - naam__geslachtsnaam (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature)\n\n\n3. Persoon\n - burgerservicenummer\n\n\n4. Postcode\n - verblijfplaats__postcode\n - verblijfplaats__huisnummer\n\n\n5. Straat\n - verblijfplaats__straat (minimaal 2 karakters, [wildcard toegestaan](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature) )\n - verblijfplaats__gemeenteVanInschrijving\n - verblijfplaats__huisnummer\n\n\n6. Adres\n - verblijfplaats__nummeraanduidingIdentificatie\n", - "type": "text/plain" - }, + "id": "6d340073-280a-44c2-a92d-ce99a6668eab", + "name": "Zoekactie geslaagd\n", + "originalRequest": { "url": { "path": [ - "ingeschrevenpersonen" + "personen" ], "host": [ "{{baseUrl}}" ], - "query": [ - { - "disabled": false, - "key": "expand", - "value": "", - "description": "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature)." - }, - { - "disabled": false, - "key": "fields", - "value": "", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)" - }, - { - "disabled": false, - "key": "burgerservicenummer", - "value": ",", - "description": "Uniek persoonsnummer.\n" - }, - { - "disabled": false, - "key": "geboorte__datum", - "value": "", - "description": "Je kunt alleen zoeken met een volledig geboortedatum. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/parametervalidatie.feature)\n" - }, - { - "disabled": false, - "key": "geboorte__plaats", - "value": "", - "description": "Gemeentenaam of een buitenlandse plaats of een plaatsbepaling, die aangeeft waar de persoon is geboren. **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).**\n" - }, - { - "disabled": false, - "key": "geslachtsaanduiding", - "value": "", - "description": "Geeft aan wat het geslacht is van persoon.\n" - }, - { - "disabled": false, - "key": "inclusiefOverledenPersonen", - "value": "", - "description": "Als je ook overleden personen in het antwoord wilt, geef dan de parameter inclusiefOverledenPersonen op met waarde True. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/overleden_personen.feature)\n" - }, - { - "disabled": false, - "key": "naam__geslachtsnaam", - "value": "", - "description": "De (geslachts)naam waarvan de eventueel aanwezige voorvoegsels zijn afgesplitst. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).**\n" - }, - { - "disabled": false, - "key": "naam__voorvoegsel", - "value": "", - "description": "Deel van de geslachtsnaam dat vooraf gaat aan de rest van de geslachtsnaam. Het zoeken op het voorvoegsel is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).**\n" - }, - { - "disabled": false, - "key": "naam__voornamen", - "value": "", - "description": "De verzameling namen die, gescheiden door spaties, aan de geslachtsnaam voorafgaat. ** Bij deze query-parameter is het gebruik van een [wildcard](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature) toegestaan in combinatie met minimaal 2 karakters.** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).**\n" - }, - { - "disabled": false, - "key": "verblijfplaats__gemeenteVanInschrijving", - "value": "", - "description": "Een code die aangeeft in welke gemeente de persoon woont, of de laatste gemeente waar de persoon heeft gewoond, of de gemeente waar de persoon voor het eerst is ingeschreven.\n" - }, - { - "disabled": false, - "key": "verblijfplaats__huisletter", - "value": "", - "description": "Een toevoeging aan een huisnummer in de vorm van een letter die door de gemeente aan een adresseerbaar object is gegeven.\n" - }, - { - "disabled": false, - "key": "verblijfplaats__huisnummer", - "value": "", - "description": "Een nummer dat door de gemeente aan een adresseerbaar object is gegeven.\n" - }, - { - "disabled": false, - "key": "verblijfplaats__huisnummertoevoeging", - "value": "", - "description": "Een toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter die door de gemeente aan een adresseerbaar object is gegeven.\n" - }, - { - "disabled": false, - "key": "verblijfplaats__nummeraanduidingIdentificatie", - "value": "", - "description": "Unieke identificatie van een nummeraanduiding (en het bijbehorende adres) in de BAG.\n" - }, - { - "disabled": false, - "key": "verblijfplaats__straat", - "value": "", - "description": "Een naam die door de gemeente aan een openbare ruimte is gegeven. **Gebruik van de wildcard is toegestaan. Zie [feature-beschrijving](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/wildcard.feature)** **Zoeken met tekstvelden is [case-Insensitive](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/case_insensitive.feature).\n" - }, - { - "disabled": false, - "key": "verblijfplaats__postcode", - "value": "", - "description": "De door PostNL vastgestelde code die bij een bepaalde combinatie van een straatnaam en een huisnummer hoort.\n" + "query": [], + "variable": [] + }, + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"fields\": \"\",\n \"type\": \"\",\n \"gemeenteVanInschrijving\": \"0518\"\n}", + "options": { + "raw": { + "language": "json" } + } + } + }, + "status": "OK", + "code": 200, + "header": [ + { + "disabled": false, + "key": "api-version", + "value": "1.0.0", + "description": "" + }, + { + "disabled": false, + "key": "warning", + "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", + "description": "" + }, + { + "disabled": false, + "key": "X-Rate-Limit-Limit", + "value": "21757456", + "description": "" + }, + { + "disabled": false, + "key": "X-Rate-Limit-Remaining", + "value": "21757456", + "description": "" + }, + { + "disabled": false, + "key": "X-Rate-Limit-Reset", + "value": "21757456", + "description": "" + }, + { + "key": "Content-Type", + "value": "application/json" + } + ], + "body": "{\n \"type\": \"ut\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "f35bd95d-93ad-4d93-a0f6-967419eff72b", + "name": "Bad Request", + "originalRequest": { + "url": { + "path": [ + "personen" + ], + "host": [ + "{{baseUrl}}" ], + "query": [], "variable": [] }, - "method": "GET", - "auth": null + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"fields\": \"\",\n \"type\": \"\",\n \"gemeenteVanInschrijving\": \"0518\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } }, - "response": [ + "status": "Bad Request", + "code": 400, + "header": [ { - "id": "84c79b7e-7f88-42df-9a38-bdad40756d43", - "name": "Zoekactie geslaagd\n", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "burgerservicenummer", - "value": "999993653,999991723,999995078" - }, - { - "key": "geboorte__datum", - "value": "" - }, - { - "key": "geboorte__plaats", - "value": "Utrecht" - }, - { - "key": "geslachtsaanduiding", - "value": "V" - }, - { - "key": "inclusiefOverledenPersonen", - "value": "true" - }, - { - "key": "naam__geslachtsnaam", - "value": "Vries" - }, - { - "key": "naam__voorvoegsel", - "value": "de" - }, - { - "key": "naam__voornamen", - "value": "Dirk" - }, - { - "key": "verblijfplaats__gemeenteVanInschrijving", - "value": "0518" - }, - { - "key": "verblijfplaats__huisletter", - "value": "a" - }, - { - "key": "verblijfplaats__huisnummer", - "value": "14" - }, - { - "key": "verblijfplaats__huisnummertoevoeging", - "value": "bis" - }, - { - "key": "verblijfplaats__nummeraanduidingIdentificatie", - "value": "0518200000366054" - }, - { - "key": "verblijfplaats__straat", - "value": "Tulpstraat" - }, - { - "key": "verblijfplaats__postcode", - "value": "2341SX" - } - ], - "variable": [] - }, - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"Duis magna fug\"\n }\n },\n \"_embedded\": {\n \"ingeschrevenpersonen\": [\n {\n \"burgerservicenummer\": {\n \"value\": \"\"\n },\n \"geheimhoudingPersoonsgegevens\": {\n \"value\": \"\"\n },\n \"geslachtsaanduiding\": {\n \"value\": \"\"\n },\n \"leeftijd\": {\n \"value\": \"\"\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"value\": \"\"\n },\n \"opschortingBijhouding\": {\n \"value\": \"\"\n },\n \"overlijden\": {\n \"value\": \"\"\n },\n \"verblijfplaats\": {\n \"value\": \"\"\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"labore occaecat laborum sint Ut\"\n }\n }\n },\n {\n \"burgerservicenummer\": {\n \"value\": \"\"\n },\n \"geheimhoudingPersoonsgegevens\": {\n \"value\": \"\"\n },\n \"geslachtsaanduiding\": {\n \"value\": \"\"\n },\n \"leeftijd\": {\n \"value\": \"\"\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"value\": \"\"\n },\n \"opschortingBijhouding\": {\n \"value\": \"\"\n },\n \"overlijden\": {\n \"value\": \"\"\n },\n \"verblijfplaats\": {\n \"value\": \"\"\n },\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"tempor ex qui reprehen\"\n }\n }\n }\n ]\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" + "disabled": false, + "key": "api-version", + "value": "1.0.0", + "description": "" }, { - "id": "3ca4954e-d255-4f1d-8ec4-6b9620b64b68", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "burgerservicenummer", - "value": "999993653,999991723,999995078" - }, - { - "key": "geboorte__datum", - "value": "" - }, - { - "key": "geboorte__plaats", - "value": "Utrecht" - }, - { - "key": "geslachtsaanduiding", - "value": "V" - }, - { - "key": "inclusiefOverledenPersonen", - "value": "true" - }, - { - "key": "naam__geslachtsnaam", - "value": "Vries" - }, - { - "key": "naam__voorvoegsel", - "value": "de" - }, - { - "key": "naam__voornamen", - "value": "Dirk" - }, - { - "key": "verblijfplaats__gemeenteVanInschrijving", - "value": "0518" - }, - { - "key": "verblijfplaats__huisletter", - "value": "a" - }, - { - "key": "verblijfplaats__huisnummer", - "value": "14" - }, - { - "key": "verblijfplaats__huisnummertoevoeging", - "value": "bis" - }, - { - "key": "verblijfplaats__nummeraanduidingIdentificatie", - "value": "0518200000366054" - }, - { - "key": "verblijfplaats__straat", - "value": "Tulpstraat" - }, - { - "key": "verblijfplaats__postcode", - "value": "2341SX" - } - ], - "variable": [] - }, - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } + "key": "Content-Type", + "value": "application/problem+json" + } + ], + "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "4a0c0df5-1338-4725-a38e-63bd1e83d9c5", + "name": "Unauthorized", + "originalRequest": { + "url": { + "path": [ + "personen" + ], + "host": [ + "{{baseUrl}}" ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" + "query": [], + "variable": [] }, - { - "id": "01ef757e-e64b-44fa-94a9-a3cedc6b7038", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "burgerservicenummer", - "value": "999993653,999991723,999995078" - }, - { - "key": "geboorte__datum", - "value": "" - }, - { - "key": "geboorte__plaats", - "value": "Utrecht" - }, - { - "key": "geslachtsaanduiding", - "value": "V" - }, - { - "key": "inclusiefOverledenPersonen", - "value": "true" - }, - { - "key": "naam__geslachtsnaam", - "value": "Vries" - }, - { - "key": "naam__voorvoegsel", - "value": "de" - }, - { - "key": "naam__voornamen", - "value": "Dirk" - }, - { - "key": "verblijfplaats__gemeenteVanInschrijving", - "value": "0518" - }, - { - "key": "verblijfplaats__huisletter", - "value": "a" - }, - { - "key": "verblijfplaats__huisnummer", - "value": "14" - }, - { - "key": "verblijfplaats__huisnummertoevoeging", - "value": "bis" - }, - { - "key": "verblijfplaats__nummeraanduidingIdentificatie", - "value": "0518200000366054" - }, - { - "key": "verblijfplaats__straat", - "value": "Tulpstraat" - }, - { - "key": "verblijfplaats__postcode", - "value": "2341SX" - } - ], - "variable": [] - }, - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"fields\": \"\",\n \"type\": \"\",\n \"gemeenteVanInschrijving\": \"0518\"\n}", + "options": { + "raw": { + "language": "json" } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"detail\": \"The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" + } + } + }, + "status": "Unauthorized", + "code": 401, + "header": [ + { + "disabled": false, + "key": "api-version", + "value": "1.0.0", + "description": "" }, { - "id": "519c2d75-1661-4995-8d43-ca4324f746d6", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "burgerservicenummer", - "value": "999993653,999991723,999995078" - }, - { - "key": "geboorte__datum", - "value": "" - }, - { - "key": "geboorte__plaats", - "value": "Utrecht" - }, - { - "key": "geslachtsaanduiding", - "value": "V" - }, - { - "key": "inclusiefOverledenPersonen", - "value": "true" - }, - { - "key": "naam__geslachtsnaam", - "value": "Vries" - }, - { - "key": "naam__voorvoegsel", - "value": "de" - }, - { - "key": "naam__voornamen", - "value": "Dirk" - }, - { - "key": "verblijfplaats__gemeenteVanInschrijving", - "value": "0518" - }, - { - "key": "verblijfplaats__huisletter", - "value": "a" - }, - { - "key": "verblijfplaats__huisnummer", - "value": "14" - }, - { - "key": "verblijfplaats__huisnummertoevoeging", - "value": "bis" - }, - { - "key": "verblijfplaats__nummeraanduidingIdentificatie", - "value": "0518200000366054" - }, - { - "key": "verblijfplaats__straat", - "value": "Tulpstraat" - }, - { - "key": "verblijfplaats__postcode", - "value": "2341SX" - } - ], - "variable": [] - }, - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } + "key": "Content-Type", + "value": "application/problem+json" + } + ], + "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"detail\": \"The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "48c223fc-c977-4f7d-b0dd-f68b91e22662", + "name": "Forbidden", + "originalRequest": { + "url": { + "path": [ + "personen" ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] }, - { - "id": "55923696-8277-46c0-b947-48784fc3c5b5", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "burgerservicenummer", - "value": "999993653,999991723,999995078" - }, - { - "key": "geboorte__datum", - "value": "" - }, - { - "key": "geboorte__plaats", - "value": "Utrecht" - }, - { - "key": "geslachtsaanduiding", - "value": "V" - }, - { - "key": "inclusiefOverledenPersonen", - "value": "true" - }, - { - "key": "naam__geslachtsnaam", - "value": "Vries" - }, - { - "key": "naam__voorvoegsel", - "value": "de" - }, - { - "key": "naam__voornamen", - "value": "Dirk" - }, - { - "key": "verblijfplaats__gemeenteVanInschrijving", - "value": "0518" - }, - { - "key": "verblijfplaats__huisletter", - "value": "a" - }, - { - "key": "verblijfplaats__huisnummer", - "value": "14" - }, - { - "key": "verblijfplaats__huisnummertoevoeging", - "value": "bis" - }, - { - "key": "verblijfplaats__nummeraanduidingIdentificatie", - "value": "0518200000366054" - }, - { - "key": "verblijfplaats__straat", - "value": "Tulpstraat" - }, - { - "key": "verblijfplaats__postcode", - "value": "2341SX" - } - ], - "variable": [] - }, - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"fields\": \"\",\n \"type\": \"\",\n \"gemeenteVanInschrijving\": \"0518\"\n}", + "options": { + "raw": { + "language": "json" } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" + } + } + }, + "status": "Forbidden", + "code": 403, + "header": [ + { + "disabled": false, + "key": "api-version", + "value": "1.0.0", + "description": "" }, { - "id": "79742a65-6bef-4a4c-95d9-519c4dada9a4", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "burgerservicenummer", - "value": "999993653,999991723,999995078" - }, - { - "key": "geboorte__datum", - "value": "" - }, - { - "key": "geboorte__plaats", - "value": "Utrecht" - }, - { - "key": "geslachtsaanduiding", - "value": "V" - }, - { - "key": "inclusiefOverledenPersonen", - "value": "true" - }, - { - "key": "naam__geslachtsnaam", - "value": "Vries" - }, - { - "key": "naam__voorvoegsel", - "value": "de" - }, - { - "key": "naam__voornamen", - "value": "Dirk" - }, - { - "key": "verblijfplaats__gemeenteVanInschrijving", - "value": "0518" - }, - { - "key": "verblijfplaats__huisletter", - "value": "a" - }, - { - "key": "verblijfplaats__huisnummer", - "value": "14" - }, - { - "key": "verblijfplaats__huisnummertoevoeging", - "value": "bis" - }, - { - "key": "verblijfplaats__nummeraanduidingIdentificatie", - "value": "0518200000366054" - }, - { - "key": "verblijfplaats__straat", - "value": "Tulpstraat" - }, - { - "key": "verblijfplaats__postcode", - "value": "2341SX" - } - ], - "variable": [] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } + "key": "Content-Type", + "value": "application/problem+json" + } + ], + "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "35b349c1-bd80-4233-aeed-581462298370", + "name": "Not Acceptable", + "originalRequest": { + "url": { + "path": [ + "personen" + ], + "host": [ + "{{baseUrl}}" ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" + "query": [], + "variable": [] }, - { - "id": "8e1c0c85-e83e-4e66-8426-58ce5a1246c4", - "name": "Not Implemented", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "burgerservicenummer", - "value": "999993653,999991723,999995078" - }, - { - "key": "geboorte__datum", - "value": "" - }, - { - "key": "geboorte__plaats", - "value": "Utrecht" - }, - { - "key": "geslachtsaanduiding", - "value": "V" - }, - { - "key": "inclusiefOverledenPersonen", - "value": "true" - }, - { - "key": "naam__geslachtsnaam", - "value": "Vries" - }, - { - "key": "naam__voorvoegsel", - "value": "de" - }, - { - "key": "naam__voornamen", - "value": "Dirk" - }, - { - "key": "verblijfplaats__gemeenteVanInschrijving", - "value": "0518" - }, - { - "key": "verblijfplaats__huisletter", - "value": "a" - }, - { - "key": "verblijfplaats__huisnummer", - "value": "14" - }, - { - "key": "verblijfplaats__huisnummertoevoeging", - "value": "bis" - }, - { - "key": "verblijfplaats__nummeraanduidingIdentificatie", - "value": "0518200000366054" - }, - { - "key": "verblijfplaats__straat", - "value": "Tulpstraat" - }, - { - "key": "verblijfplaats__postcode", - "value": "2341SX" - } - ], - "variable": [] - }, - "method": "GET", - "body": {} - }, - "status": "Not Implemented", - "code": 501, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"fields\": \"\",\n \"type\": \"\",\n \"gemeenteVanInschrijving\": \"0518\"\n}", + "options": { + "raw": { + "language": "json" } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2\",\n \"title\": \"Not Implemented\",\n \"status\": 501,\n \"detail\": \"The server does not support the functionality required to fulfill the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notImplemented\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" + } + } + }, + "status": "Not Acceptable", + "code": 406, + "header": [ + { + "disabled": false, + "key": "api-version", + "value": "1.0.0", + "description": "" }, { - "id": "d0d3f09c-5536-49df-bc02-23ae33fe6ec2", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "burgerservicenummer", - "value": "999993653,999991723,999995078" - }, - { - "key": "geboorte__datum", - "value": "" - }, - { - "key": "geboorte__plaats", - "value": "Utrecht" - }, - { - "key": "geslachtsaanduiding", - "value": "V" - }, - { - "key": "inclusiefOverledenPersonen", - "value": "true" - }, - { - "key": "naam__geslachtsnaam", - "value": "Vries" - }, - { - "key": "naam__voorvoegsel", - "value": "de" - }, - { - "key": "naam__voornamen", - "value": "Dirk" - }, - { - "key": "verblijfplaats__gemeenteVanInschrijving", - "value": "0518" - }, - { - "key": "verblijfplaats__huisletter", - "value": "a" - }, - { - "key": "verblijfplaats__huisnummer", - "value": "14" - }, - { - "key": "verblijfplaats__huisnummertoevoeging", - "value": "bis" - }, - { - "key": "verblijfplaats__nummeraanduidingIdentificatie", - "value": "0518200000366054" - }, - { - "key": "verblijfplaats__straat", - "value": "Tulpstraat" - }, - { - "key": "verblijfplaats__postcode", - "value": "2341SX" - } - ], - "variable": [] - }, - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } + "key": "Content-Type", + "value": "application/problem+json" + } + ], + "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "3fb5903e-e4bc-42ff-ab0b-74df340dc37a", + "name": "Too Many Requests", + "originalRequest": { + "url": { + "path": [ + "personen" + ], + "host": [ + "{{baseUrl}}" ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" + "query": [], + "variable": [] }, - { - "id": "b3494a74-1fe6-4878-82d7-b4e7b3981b2e", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - }, - { - "key": "burgerservicenummer", - "value": "999993653,999991723,999995078" - }, - { - "key": "geboorte__datum", - "value": "" - }, - { - "key": "geboorte__plaats", - "value": "Utrecht" - }, - { - "key": "geslachtsaanduiding", - "value": "V" - }, - { - "key": "inclusiefOverledenPersonen", - "value": "true" - }, - { - "key": "naam__geslachtsnaam", - "value": "Vries" - }, - { - "key": "naam__voorvoegsel", - "value": "de" - }, - { - "key": "naam__voornamen", - "value": "Dirk" - }, - { - "key": "verblijfplaats__gemeenteVanInschrijving", - "value": "0518" - }, - { - "key": "verblijfplaats__huisletter", - "value": "a" - }, - { - "key": "verblijfplaats__huisnummer", - "value": "14" - }, - { - "key": "verblijfplaats__huisnummertoevoeging", - "value": "bis" - }, - { - "key": "verblijfplaats__nummeraanduidingIdentificatie", - "value": "0518200000366054" - }, - { - "key": "verblijfplaats__straat", - "value": "Tulpstraat" - }, - { - "key": "verblijfplaats__postcode", - "value": "2341SX" - } - ], - "variable": [] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"fields\": \"\",\n \"type\": \"\",\n \"gemeenteVanInschrijving\": \"0518\"\n}", + "options": { + "raw": { + "language": "json" } - ], - "body": "{\n \"type\": \"https://JDrdRUpHk.dqDkSCockv6z+84lgYpQdt\",\n \"title\": \"consequat laborum\",\n \"status\": -92650013,\n \"detail\": \"aute consectetur dolor ea\",\n \"instance\": \"https://zVDETLBZkBgrhcMh.ciyYhvnAotrHGZJ0pk,-aOXJjBEcKtQc\",\n \"code\": \"eu veniam commodo sint\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" + } + } + }, + "status": "Too Many Requests", + "code": 429, + "header": [ + { + "disabled": false, + "key": "api-version", + "value": "1.0.0", + "description": "" + }, + { + "key": "Content-Type", + "value": "application/problem+json" } ], - "event": [] + "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html\",\n \"title\": \"Too many request\",\n \"status\": 429,\n \"detail\": \"The user has sent too many requests in a given amount of time (rate limiting).\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"tooManyRequests\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" }, { - "id": "1bbf5fc0-6cca-40fb-a5bc-fea21a88e898", - "name": "{burgerservicenummer}", - "item": [ - { - "id": "f1f8e4b8-6e4c-495e-8e29-f81da9e1b90d", - "name": "Raadpleeg een persoon", - "request": { - "name": "Raadpleeg een persoon", - "description": { - "content": "Raadpleeg een (overleden) persoon.\n\nGebruik de fields parameter als je alleen specifieke velden in het antwoord wil zien, [zie functionele specificaties fields-parameter](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/blob/v1.1.0/features/fields_extensie.feature).\n", - "type": "text/plain" - }, - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "disabled": false, - "key": "expand", - "value": "", - "description": "Hiermee kun je opgeven welke gerelateerde resources meegeleverd moeten worden, en hun inhoud naar behoefte aanpassen. Hele resources of enkele properties geef je in de expand parameter kommagescheiden op. Properties die je wil ontvangen geef je op met de resource-naam gevolgd door de property naam, met daartussen een punt. In de definitie van het antwoord kun je bij _embedded zien welke gerelateerde resources meegeleverd kunnen worden. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/expand.feature)." - }, - { - "disabled": false, - "key": "fields", - "value": "", - "description": "Hiermee kun je de inhoud van de resource naar behoefte aanpassen door een door komma's gescheiden lijst van property namen op te geven. Bij opgave van niet-bestaande properties wordt een 400 Bad Request teruggegeven. Wanneer de fields parameter niet is opgegeven, worden alle properties met een waarde teruggegeven. Zie [functionele specificaties](https://github.com/VNG-Realisatie/Haal-Centraal-common/blob/v1.2.0/features/fields.feature)" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "auth": null - }, - "response": [ - { - "id": "64a92bec-8f75-4fdd-9b41-5349cd6d17f6", - "name": "Zoekactie geslaagd\n", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"burgerservicenummer\": \"555555021\",\n \"geheimhoudingPersoonsgegevens\": true,\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"leeftijd\": 34,\n \"aNummer\": \"elit dolore esse\",\n \"datumEersteInschrijvingGBA\": {\n \"dag\": 3,\n \"datum\": \"1966-07-08\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"inOnderzoek\": {\n \"burgerservicenummer\": true,\n \"geslachtsaanduiding\": false,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"2009-09-11\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n },\n \"kiesrecht\": {\n \"europeesKiesrecht\": true,\n \"uitgeslotenVanKiesrecht\": true,\n \"einddatumUitsluitingEuropeesKiesrecht\": {\n \"dag\": 3,\n \"datum\": \"1994-07-02\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"einddatumUitsluitingKiesrecht\": {\n \"dag\": 3,\n \"datum\": \"1967-01-14\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n },\n \"naam\": {\n \"geslachtsnaam\": {\n \"value\": \"\"\n },\n \"voorletters\": {\n \"value\": \"\"\n },\n \"voornamen\": {\n \"value\": \"\"\n },\n \"voorvoegsel\": {\n \"value\": \"\"\n },\n \"adellijkeTitelPredikaat\": {\n \"value\": \"\"\n },\n \"volledigeNaam\": {\n \"value\": \"\"\n },\n \"aanhef\": \"Hoogwelgeboren heer\",\n \"aanschrijfwijze\": \"H.W. baron van den Aedel\",\n \"regelVoorafgaandAanAanschrijfwijze\": \"De hoogwelgeboren heer\",\n \"gebruikInLopendeTekst\": \"baron Van den Aedel\",\n \"aanduidingNaamgebruik\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"nationaliteiten\": [\n {\n \"aanduidingBijzonderNederlanderschap\": {\n \"value\": \"\"\n },\n \"datumIngangGeldigheid\": {\n \"dag\": 3,\n \"datum\": \"1949-06-25\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"nationaliteit\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"redenOpname\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n {\n \"aanduidingBijzonderNederlanderschap\": {\n \"value\": \"\"\n },\n \"datumIngangGeldigheid\": {\n \"dag\": 3,\n \"datum\": \"2022-01-12\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"nationaliteit\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"redenOpname\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n }\n ],\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"opschortingBijhouding\": {\n \"reden\": {\n \"value\": \"\"\n },\n \"datum\": {\n \"dag\": 3,\n \"datum\": \"1947-03-20\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n },\n \"overlijden\": {\n \"indicatieOverleden\": {\n \"value\": \"\"\n },\n \"datum\": {\n \"dag\": 3,\n \"datum\": \"1963-02-16\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"verblijfplaats\": {\n \"straat\": {\n \"value\": \"\"\n },\n \"huisnummer\": {\n \"value\": \"\"\n },\n \"huisletter\": {\n \"value\": \"\"\n },\n \"huisnummertoevoeging\": {\n \"value\": \"\"\n },\n \"postcode\": {\n \"value\": \"\"\n },\n \"woonplaats\": {\n \"value\": \"\"\n },\n \"adresseerbaarObjectIdentificatie\": \"0226010000038820\",\n \"aanduidingBijHuisnummer\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"nummeraanduidingIdentificatie\": \"0518200000366054\",\n \"functieAdres\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"indicatieVestigingVanuitBuitenland\": false,\n \"locatiebeschrijving\": \"Naast de derde brug\",\n \"korteNaam\": \"aute eu proident est\",\n \"vanuitVertrokkenOnbekendWaarheen\": true,\n \"datumAanvangAdreshouding\": {\n \"dag\": 3,\n \"datum\": \"2019-09-13\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"datumIngangGeldigheid\": {\n \"dag\": 3,\n \"datum\": \"2001-07-13\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"datumInschrijvingInGemeente\": {\n \"dag\": 3,\n \"datum\": \"2008-08-25\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"datumVestigingInNederland\": {\n \"dag\": 3,\n \"datum\": \"1998-02-04\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"gemeenteVanInschrijving\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"landVanwaarIngeschreven\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"adresregel1\": \"Laan van de landinrichtingscommissie Duiven-Westervoort 26A-3\",\n \"adresregel2\": \"1234AA Nootdorp\",\n \"adresregel3\": \"Selangor\",\n \"vertrokkenOnbekendWaarheen\": false,\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"gezagsverhouding\": {\n \"indicatieCurateleRegister\": true,\n \"indicatieGezagMinderjarige\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"indicatieCurateleRegister\": {\n \"value\": \"\"\n },\n \"indicatieGezagMinderjarige\": {\n \"value\": \"\"\n },\n \"datumIngangOnderzoek\": {\n \"value\": \"\"\n }\n }\n },\n \"verblijfstitel\": {\n \"aanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"datumEinde\": {\n \"dag\": 3,\n \"datum\": \"1996-06-04\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"datumIngang\": {\n \"dag\": 3,\n \"datum\": \"1944-07-20\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"inOnderzoek\": {\n \"aanduiding\": {\n \"value\": \"\"\n },\n \"datumEinde\": {\n \"value\": \"\"\n },\n \"datumIngang\": {\n \"value\": \"\"\n },\n \"datumIngangOnderzoek\": {\n \"value\": \"\"\n }\n }\n },\n \"reisdocumentnummers\": [\n \"546376728\",\n \"546376728\"\n ],\n \"kinderen\": [\n {\n \"burgerservicenummer\": \"555555021\",\n \"leeftijd\": 12,\n \"inOnderzoek\": {\n \"value\": \"\"\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"burgerservicenummer\": \"555555021\",\n \"leeftijd\": 12,\n \"inOnderzoek\": {\n \"value\": \"\"\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"ouders\": [\n {\n \"burgerservicenummer\": \"555555021\",\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"ouderAanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"datumIngangFamilierechtelijkeBetrekking\": {\n \"dag\": 3,\n \"datum\": \"1989-07-18\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"burgerservicenummer\": \"555555021\",\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"ouderAanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"datumIngangFamilierechtelijkeBetrekking\": {\n \"dag\": 3,\n \"datum\": \"1996-08-13\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"partners\": [\n {\n \"burgerservicenummer\": \"555555021\",\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"soortVerbintenis\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n },\n \"aangaanHuwelijkPartnerschap\": {\n \"value\": \"\"\n }\n },\n {\n \"burgerservicenummer\": \"555555021\",\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"soortVerbintenis\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n },\n \"aangaanHuwelijkPartnerschap\": {\n \"value\": \"\"\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"aliqua ad culpa consectetur enim\"\n },\n \"ouders\": [\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"cillum proident\"\n },\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"consequat velit nostrud\"\n }\n ],\n \"reisdocumenten\": [\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"veniam labore ullamco\"\n },\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"ad proident\"\n }\n ],\n \"kinderen\": [\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"elit exercitation incididunt laboris\"\n },\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"sit nisi exercitation anim\"\n }\n ],\n \"partners\": [\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"occaecat minim\"\n },\n {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"sunt elit aute\"\n }\n ],\n \"partnerhistorie\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"qui aute in\"\n },\n \"verblijfplaatshistorie\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"et amet eu officia id\"\n },\n \"verblijfstitelhistorie\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"sunt velit\"\n },\n \"nationaliteitHistorie\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"proident est sunt\"\n },\n \"adres\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"cupidatat dolore occaecat\"\n }\n },\n \"_embedded\": {\n \"ouders\": [\n {\n \"burgerservicenummer\": \"555555021\",\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"ouderAanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"datumIngangFamilierechtelijkeBetrekking\": {\n \"dag\": 3,\n \"datum\": \"1991-10-06\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"geheimhoudingPersoonsgegevens\": false,\n \"_links\": {\n \"self\": {\n \"value\": \"\"\n },\n \"ingeschrevenPersoon\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"burgerservicenummer\": \"555555021\",\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"ouderAanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"datumIngangFamilierechtelijkeBetrekking\": {\n \"dag\": 3,\n \"datum\": \"1943-01-02\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"geheimhoudingPersoonsgegevens\": false,\n \"_links\": {\n \"self\": {\n \"value\": \"\"\n },\n \"ingeschrevenPersoon\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"kinderen\": [\n {\n \"burgerservicenummer\": \"555555021\",\n \"leeftijd\": 12,\n \"inOnderzoek\": {\n \"value\": \"\"\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"geheimhoudingPersoonsgegevens\": false,\n \"_links\": {\n \"self\": {\n \"value\": \"\"\n },\n \"ingeschrevenPersoon\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"burgerservicenummer\": \"555555021\",\n \"leeftijd\": 12,\n \"inOnderzoek\": {\n \"value\": \"\"\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"geheimhoudingPersoonsgegevens\": false,\n \"_links\": {\n \"self\": {\n \"value\": \"\"\n },\n \"ingeschrevenPersoon\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"partners\": [\n {\n \"burgerservicenummer\": \"555555021\",\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"soortVerbintenis\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n },\n \"aangaanHuwelijkPartnerschap\": {\n \"value\": \"\"\n },\n \"geheimhoudingPersoonsgegevens\": false,\n \"_links\": {\n \"self\": {\n \"value\": \"\"\n },\n \"ingeschrevenPersoon\": {\n \"value\": \"\"\n }\n }\n },\n {\n \"burgerservicenummer\": \"555555021\",\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"soortVerbintenis\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n },\n \"aangaanHuwelijkPartnerschap\": {\n \"value\": \"\"\n },\n \"geheimhoudingPersoonsgegevens\": false,\n \"_links\": {\n \"self\": {\n \"value\": \"\"\n },\n \"ingeschrevenPersoon\": {\n \"value\": \"\"\n }\n }\n }\n ]\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "b2e12933-d0d9-40e2-8380-ec837a38b421", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "651c4767-b884-499d-8a51-bfcf93468b5e", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"detail\": \"The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "e43bea7e-641e-4f31-be02-b7126d87a3f8", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "026a685f-a46c-4063-8591-1f8ec5447dba", - "name": "Not Found", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5\",\n \"title\": \"Opgevraagde resource bestaat niet.\",\n \"status\": 404,\n \"detail\": \"The server has not found anything matching the Request-URI.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notFound\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "e5b9b67e-d39e-4a36-95a6-836cac65bf9b", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "2eb8ea1c-371c-4513-b908-7d4931c70087", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "15163194-2077-433d-a71c-ac0def949afa", - "name": "Not Implemented", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Implemented", - "code": 501, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2\",\n \"title\": \"Not Implemented\",\n \"status\": 501,\n \"detail\": \"The server does not support the functionality required to fulfill the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notImplemented\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "eaca6acf-d8fc-4dca-85b0-cfbd5db169d6", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "77b3190c-3179-4dde-b50a-8d763536c63a", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [ - { - "key": "expand", - "value": "" - }, - { - "key": "fields", - "value": "" - } - ], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://JDrdRUpHk.dqDkSCockv6z+84lgYpQdt\",\n \"title\": \"consequat laborum\",\n \"status\": -92650013,\n \"detail\": \"aute consectetur dolor ea\",\n \"instance\": \"https://zVDETLBZkBgrhcMh.ciyYhvnAotrHGZJ0pk,-aOXJjBEcKtQc\",\n \"code\": \"eu veniam commodo sint\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } + "id": "90355de9-1164-4ad9-a754-a91a4b27d1aa", + "name": "Internal Server Error", + "originalRequest": { + "url": { + "path": [ + "personen" + ], + "host": [ + "{{baseUrl}}" ], - "event": [] + "query": [], + "variable": [] }, - { - "id": "1a3c9b66-5181-4564-bcd8-9e7ea484a469", - "name": "kinderen", - "item": [ - { - "id": "8648ceff-82ea-4d11-aa9a-d381691f0331", - "name": "Levert de kinderen van een persoon", - "request": { - "name": "Levert de kinderen van een persoon", - "description": { - "content": "Levert de kinderen van een persoon\n", - "type": "text/plain" - }, - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "auth": null - }, - "response": [ - { - "id": "571d1693-f7cd-464a-93cc-ff205c2d5c53", - "name": "Zoekactie geslaagd\n", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"adipisicing Duis\"\n }\n },\n \"_embedded\": {\n \"kinderen\": [\n {\n \"burgerservicenummer\": \"555555021\",\n \"leeftijd\": 12,\n \"inOnderzoek\": {\n \"burgerservicenummer\": {\n \"value\": \"\"\n },\n \"datumIngangOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"geheimhoudingPersoonsgegevens\": true,\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"cillum voluptate laboris officia occaecat\"\n },\n \"ingeschrevenPersoon\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"Ut reprehenderit\"\n }\n }\n },\n {\n \"burgerservicenummer\": \"555555021\",\n \"leeftijd\": 12,\n \"inOnderzoek\": {\n \"burgerservicenummer\": {\n \"value\": \"\"\n },\n \"datumIngangOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"naam\": {\n \"value\": \"\"\n },\n \"geboorte\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"geheimhoudingPersoonsgegevens\": false,\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"laborum id exercitation amet\"\n },\n \"ingeschrevenPersoon\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"Ut Lorem sed proident id\"\n }\n }\n }\n ]\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "891c686a-4003-4135-a3ba-b304288b96af", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "b20b061d-158a-429f-89e2-e04d8a3fbeeb", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"detail\": \"The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "d750f11f-1115-4912-bd0d-e174dd70047b", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "8bd8a002-86dc-43ec-9a28-4e94293336f2", - "name": "Not Found", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5\",\n \"title\": \"Opgevraagde resource bestaat niet.\",\n \"status\": 404,\n \"detail\": \"The server has not found anything matching the Request-URI.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notFound\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "fe6d0f50-8d0f-4a3c-affa-5516bc1be141", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "40607db4-7314-45c1-bf77-e9a9a1acc8f4", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "be846c23-7d49-46e0-bf20-d8303c0a0680", - "name": "Not Implemented", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Implemented", - "code": 501, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2\",\n \"title\": \"Not Implemented\",\n \"status\": 501,\n \"detail\": \"The server does not support the functionality required to fulfill the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notImplemented\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "ae93c0c2-fd7c-4584-98bf-461dc2a17522", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "eed6dd24-171e-49d3-afbc-d58c918a3d3e", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://JDrdRUpHk.dqDkSCockv6z+84lgYpQdt\",\n \"title\": \"consequat laborum\",\n \"status\": -92650013,\n \"detail\": \"aute consectetur dolor ea\",\n \"instance\": \"https://zVDETLBZkBgrhcMh.ciyYhvnAotrHGZJ0pk,-aOXJjBEcKtQc\",\n \"code\": \"eu veniam commodo sint\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] - }, - { - "id": "84131c5e-0ac1-426a-bd86-59ea42260a6f", - "name": "Raadpleeg een kind van een persoon", - "request": { - "name": "Raadpleeg een kind van een persoon", - "description": { - "content": "Raadpleeg een kind van een persoon\n", - "type": "text/plain" - }, - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van het kind.\n" - } - ] - }, - "method": "GET", - "auth": null - }, - "response": [ - { - "id": "9eec6378-ac06-4147-8926-866786a3ab9c", - "name": "Zoekactie geslaagd\n", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van het kind.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"burgerservicenummer\": \"555555021\",\n \"leeftijd\": 12,\n \"inOnderzoek\": {\n \"burgerservicenummer\": true,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"1975-08-03\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n },\n \"naam\": {\n \"geslachtsnaam\": \"Vries\",\n \"voorletters\": \"P.J.\",\n \"voornamen\": \"Pieter Jan\",\n \"voorvoegsel\": \"de\",\n \"adellijkeTitelPredikaat\": {\n \"code\": \"JV\",\n \"omschrijving\": \"jonkvrouw\",\n \"soort\": \"predikaat\"\n },\n \"volledigeNaam\": \"Pieter Jan de Vries\",\n \"inOnderzoek\": {\n \"geslachtsnaam\": true,\n \"voornamen\": true,\n \"voorvoegsel\": true,\n \"adellijkeTitel\": false,\n \"predikaat\": false,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"2006-08-29\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"geboorte\": {\n \"datum\": {\n \"dag\": 3,\n \"datum\": \"2017-11-21\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"datum\": true,\n \"land\": false,\n \"plaats\": true,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"2015-10-06\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"geheimhoudingPersoonsgegevens\": false,\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"do id dolor\"\n },\n \"ingeschrevenPersoon\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"n\"\n }\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "1528fa70-0b47-4913-b8de-bbbf07124a2b", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van het kind.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "25de2c09-5891-4767-aaaa-543daad171bb", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van het kind.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"detail\": \"The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "1b72b86d-20e9-48ea-a8ff-effc24775657", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van het kind.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "45101e99-f5d0-4a21-9570-d882d20f461f", - "name": "Not Found", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van het kind.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5\",\n \"title\": \"Opgevraagde resource bestaat niet.\",\n \"status\": 404,\n \"detail\": \"The server has not found anything matching the Request-URI.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notFound\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "68e48d49-f651-4c98-b56e-69e038a87922", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van het kind.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "9a71674a-e729-4008-9511-0b4c01c6739a", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van het kind.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "0b28c008-dd41-4e49-af21-ab63f754a384", - "name": "Not Implemented", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van het kind.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Implemented", - "code": 501, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2\",\n \"title\": \"Not Implemented\",\n \"status\": 501,\n \"detail\": \"The server does not support the functionality required to fulfill the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notImplemented\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "62b35808-30e1-4143-9c13-a31389f1bc74", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van het kind.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "77160993-cd87-4766-a3ed-d0b376fa9fea", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "kinderen", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van het kind.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://JDrdRUpHk.dqDkSCockv6z+84lgYpQdt\",\n \"title\": \"consequat laborum\",\n \"status\": -92650013,\n \"detail\": \"aute consectetur dolor ea\",\n \"instance\": \"https://zVDETLBZkBgrhcMh.ciyYhvnAotrHGZJ0pk,-aOXJjBEcKtQc\",\n \"code\": \"eu veniam commodo sint\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"fields\": \"\",\n \"type\": \"\",\n \"gemeenteVanInschrijving\": \"0518\"\n}", + "options": { + "raw": { + "language": "json" } - ], - "event": [] + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "disabled": false, + "key": "api-version", + "value": "1.0.0", + "description": "" }, { - "id": "8c5285b3-206f-498a-8e48-df40d79bd39b", - "name": "ouders", - "item": [ - { - "id": "15f5178f-edb7-4600-825d-84ef901a3368", - "name": "Levert de ouders van een persoon", - "request": { - "name": "Levert de ouders van een persoon", - "description": { - "content": "Levert de ouders van een persoon\n", - "type": "text/plain" - }, - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "auth": null - }, - "response": [ - { - "id": "80262638-fdff-4a08-a846-a9224aa933a1", - "name": "Zoekactie geslaagd\n", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"labore nulla minim aliqua anim\"\n }\n },\n \"_embedded\": {\n \"ouders\": [\n {\n \"burgerservicenummer\": \"555555021\",\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"ouderAanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"datumIngangFamilierechtelijkeBetrekking\": {\n \"dag\": 3,\n \"datum\": \"1968-07-21\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"naam\": {\n \"geslachtsnaam\": \"Vries\",\n \"voorletters\": \"P.J.\",\n \"voornamen\": \"Pieter Jan\",\n \"voorvoegsel\": \"de\",\n \"adellijkeTitelPredikaat\": {\n \"code\": \"JV\",\n \"omschrijving\": \"jonkvrouw\",\n \"soort\": \"predikaat\"\n },\n \"volledigeNaam\": \"Pieter Jan de Vries\",\n \"inOnderzoek\": {\n \"geslachtsnaam\": false,\n \"voornamen\": false,\n \"voorvoegsel\": false,\n \"adellijkeTitel\": true,\n \"predikaat\": true,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"2001-06-06\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"inOnderzoek\": {\n \"burgerservicenummer\": {\n \"value\": \"\"\n },\n \"datumIngangFamilierechtelijkeBetrekking\": {\n \"value\": \"\"\n },\n \"geslachtsaanduiding\": {\n \"value\": \"\"\n },\n \"datumIngangOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"geboorte\": {\n \"datum\": {\n \"dag\": 3,\n \"datum\": \"1973-09-03\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"datum\": false,\n \"land\": false,\n \"plaats\": true,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"1964-04-06\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"geheimhoudingPersoonsgegevens\": false,\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"Ut esse mollit\"\n },\n \"ingeschrevenPersoon\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"Lorem\"\n }\n }\n },\n {\n \"burgerservicenummer\": \"555555021\",\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"ouderAanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"datumIngangFamilierechtelijkeBetrekking\": {\n \"dag\": 3,\n \"datum\": \"2014-07-12\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"naam\": {\n \"geslachtsnaam\": \"Vries\",\n \"voorletters\": \"P.J.\",\n \"voornamen\": \"Pieter Jan\",\n \"voorvoegsel\": \"de\",\n \"adellijkeTitelPredikaat\": {\n \"code\": \"JV\",\n \"omschrijving\": \"jonkvrouw\",\n \"soort\": \"predikaat\"\n },\n \"volledigeNaam\": \"Pieter Jan de Vries\",\n \"inOnderzoek\": {\n \"geslachtsnaam\": false,\n \"voornamen\": false,\n \"voorvoegsel\": false,\n \"adellijkeTitel\": true,\n \"predikaat\": true,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"2008-02-15\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"inOnderzoek\": {\n \"burgerservicenummer\": {\n \"value\": \"\"\n },\n \"datumIngangFamilierechtelijkeBetrekking\": {\n \"value\": \"\"\n },\n \"geslachtsaanduiding\": {\n \"value\": \"\"\n },\n \"datumIngangOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"geboorte\": {\n \"datum\": {\n \"dag\": 3,\n \"datum\": \"1964-10-23\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"datum\": false,\n \"land\": false,\n \"plaats\": true,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"2017-08-06\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"geheimhoudingPersoonsgegevens\": false,\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"Ut eiusmod\"\n },\n \"ingeschrevenPersoon\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"minim ullamco reprehenderit\"\n }\n }\n }\n ]\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "ed77aab9-7d53-413f-b81d-971f787e3131", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "f5f95107-fb14-41fd-92d6-056559d6ee38", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"detail\": \"The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "54ff984c-1eb3-4b0e-813a-46829e643e19", - "name": "Not Found", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5\",\n \"title\": \"Opgevraagde resource bestaat niet.\",\n \"status\": 404,\n \"detail\": \"The server has not found anything matching the Request-URI.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notFound\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "b0a2b289-039a-4768-90e8-a7c62442aa03", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "6907381a-0d91-4206-a880-4a02444559bf", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "cecb4713-1b9a-40f8-9ed1-67896cb147cf", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "71d44dc4-a1ed-4eea-adcf-b9f0721cacc7", - "name": "Not Implemented", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Implemented", - "code": 501, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2\",\n \"title\": \"Not Implemented\",\n \"status\": 501,\n \"detail\": \"The server does not support the functionality required to fulfill the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notImplemented\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "10237afe-64f4-4cf6-a83c-ceaeda89188c", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "b855210a-de96-4125-a3f3-f58fff17ea6f", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://JDrdRUpHk.dqDkSCockv6z+84lgYpQdt\",\n \"title\": \"consequat laborum\",\n \"status\": -92650013,\n \"detail\": \"aute consectetur dolor ea\",\n \"instance\": \"https://zVDETLBZkBgrhcMh.ciyYhvnAotrHGZJ0pk,-aOXJjBEcKtQc\",\n \"code\": \"eu veniam commodo sint\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] - }, - { - "id": "ae0a9728-4965-4dd9-b939-52295dcfb5e0", - "name": "Raadpleeg een ouder van een persoon", - "request": { - "name": "Raadpleeg een ouder van een persoon", - "description": { - "content": "Raadpleeg een ouder van een persoon\n", - "type": "text/plain" - }, - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de ouder.\n" - } - ] - }, - "method": "GET", - "auth": null - }, - "response": [ - { - "id": "57005e23-830f-44ff-bd6f-9c85df3b4c9c", - "name": "Zoekactie geslaagd\n", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de ouder.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"burgerservicenummer\": \"555555021\",\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"ouderAanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"datumIngangFamilierechtelijkeBetrekking\": {\n \"dag\": 3,\n \"datum\": \"1995-09-25\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"naam\": {\n \"geslachtsnaam\": \"Vries\",\n \"voorletters\": \"P.J.\",\n \"voornamen\": \"Pieter Jan\",\n \"voorvoegsel\": \"de\",\n \"adellijkeTitelPredikaat\": {\n \"code\": \"JV\",\n \"omschrijving\": \"jonkvrouw\",\n \"soort\": \"predikaat\"\n },\n \"volledigeNaam\": \"Pieter Jan de Vries\",\n \"inOnderzoek\": {\n \"geslachtsnaam\": true,\n \"voornamen\": false,\n \"voorvoegsel\": false,\n \"adellijkeTitel\": false,\n \"predikaat\": true,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"2005-01-07\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"inOnderzoek\": {\n \"burgerservicenummer\": false,\n \"datumIngangFamilierechtelijkeBetrekking\": true,\n \"geslachtsaanduiding\": false,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"1972-03-03\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n },\n \"geboorte\": {\n \"datum\": {\n \"dag\": 3,\n \"datum\": \"1988-09-28\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"datum\": true,\n \"land\": false,\n \"plaats\": false,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"2011-03-10\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"geheimhoudingPersoonsgegevens\": true,\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"nisi ut ullamco qui\"\n },\n \"ingeschrevenPersoon\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"amet in pariatu\"\n }\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "bb4fd1e3-a274-445e-a4c7-61d4a302bd35", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de ouder.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "be5fe132-f025-40ac-9463-1726701157e4", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de ouder.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"detail\": \"The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "b62b9154-c819-4245-89c2-7d535255310a", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de ouder.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "dc31314a-277f-4e9e-a06f-d834484b7b5c", - "name": "Not Found", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de ouder.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5\",\n \"title\": \"Opgevraagde resource bestaat niet.\",\n \"status\": 404,\n \"detail\": \"The server has not found anything matching the Request-URI.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notFound\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "18af870f-fdc8-433e-ba6e-9138dbcc967a", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de ouder.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "cdfb78b7-98d3-4bba-9cb9-3ffffbd29a03", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de ouder.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "22aa6ae0-9d84-48b8-ae65-d92fb4629ee0", - "name": "Not Implemented", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de ouder.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Implemented", - "code": 501, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2\",\n \"title\": \"Not Implemented\",\n \"status\": 501,\n \"detail\": \"The server does not support the functionality required to fulfill the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notImplemented\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "b31c429d-01b1-4a02-b0d4-17a092bf1d3f", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de ouder.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "652a5a9f-ec44-4762-b3c7-8a2f474f39de", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "ouders", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de ouder.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://JDrdRUpHk.dqDkSCockv6z+84lgYpQdt\",\n \"title\": \"consequat laborum\",\n \"status\": -92650013,\n \"detail\": \"aute consectetur dolor ea\",\n \"instance\": \"https://zVDETLBZkBgrhcMh.ciyYhvnAotrHGZJ0pk,-aOXJjBEcKtQc\",\n \"code\": \"eu veniam commodo sint\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] - } + "key": "Content-Type", + "value": "application/problem+json" + } + ], + "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "0da64419-ff9f-46c6-9b21-c0af03c1e182", + "name": "Not Implemented", + "originalRequest": { + "url": { + "path": [ + "personen" + ], + "host": [ + "{{baseUrl}}" ], - "event": [] + "query": [], + "variable": [] }, + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"fields\": \"\",\n \"type\": \"\",\n \"gemeenteVanInschrijving\": \"0518\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Not Implemented", + "code": 501, + "header": [ { - "id": "047dc83f-d775-4e97-b685-9ff75a05d986", - "name": "partners", - "item": [ - { - "id": "78338198-1847-4ed4-90fb-33c72e1568d4", - "name": "Levert de actuele partners van een persoon", - "request": { - "name": "Levert de actuele partners van een persoon", - "description": { - "content": "Levert de actuele partners van een persoon. Partners uit beëindigde huwelijken of partnerschappen worden niet geretourneerd\n", - "type": "text/plain" - }, - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "auth": null - }, - "response": [ - { - "id": "c038cb96-3a13-4fd8-8ec6-0b80e2c38570", - "name": "Zoekactie geslaagd\n", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"cillum in quis nulla\"\n }\n },\n \"_embedded\": {\n \"partners\": [\n {\n \"burgerservicenummer\": \"555555021\",\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"soortVerbintenis\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"naam\": {\n \"geslachtsnaam\": \"Vries\",\n \"voorletters\": \"P.J.\",\n \"voornamen\": \"Pieter Jan\",\n \"voorvoegsel\": \"de\",\n \"adellijkeTitelPredikaat\": {\n \"code\": \"JV\",\n \"omschrijving\": \"jonkvrouw\",\n \"soort\": \"predikaat\"\n },\n \"volledigeNaam\": \"Pieter Jan de Vries\",\n \"inOnderzoek\": {\n \"geslachtsnaam\": true,\n \"voornamen\": true,\n \"voorvoegsel\": false,\n \"adellijkeTitel\": true,\n \"predikaat\": false,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"1975-02-13\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"geboorte\": {\n \"datum\": {\n \"dag\": 3,\n \"datum\": \"1970-08-16\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"datum\": true,\n \"land\": true,\n \"plaats\": true,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"2021-09-16\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"inOnderzoek\": {\n \"burgerservicenummer\": {\n \"value\": \"\"\n },\n \"geslachtsaanduiding\": {\n \"value\": \"\"\n },\n \"soortVerbintenis\": {\n \"value\": \"\"\n },\n \"datumIngangOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"aangaanHuwelijkPartnerschap\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"value\": \"\"\n },\n \"plaats\": {\n \"value\": \"\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"geheimhoudingPersoonsgegevens\": false,\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"proident \"\n },\n \"ingeschrevenPersoon\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"et dolor aliqua\"\n }\n }\n },\n {\n \"burgerservicenummer\": \"555555021\",\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"soortVerbintenis\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"naam\": {\n \"geslachtsnaam\": \"Vries\",\n \"voorletters\": \"P.J.\",\n \"voornamen\": \"Pieter Jan\",\n \"voorvoegsel\": \"de\",\n \"adellijkeTitelPredikaat\": {\n \"code\": \"JV\",\n \"omschrijving\": \"jonkvrouw\",\n \"soort\": \"predikaat\"\n },\n \"volledigeNaam\": \"Pieter Jan de Vries\",\n \"inOnderzoek\": {\n \"geslachtsnaam\": false,\n \"voornamen\": true,\n \"voorvoegsel\": true,\n \"adellijkeTitel\": false,\n \"predikaat\": true,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"1968-03-24\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"geboorte\": {\n \"datum\": {\n \"dag\": 3,\n \"datum\": \"2018-11-30\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"datum\": true,\n \"land\": false,\n \"plaats\": false,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"1995-06-24\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"inOnderzoek\": {\n \"burgerservicenummer\": {\n \"value\": \"\"\n },\n \"geslachtsaanduiding\": {\n \"value\": \"\"\n },\n \"soortVerbintenis\": {\n \"value\": \"\"\n },\n \"datumIngangOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"aangaanHuwelijkPartnerschap\": {\n \"datum\": {\n \"value\": \"\"\n },\n \"land\": {\n \"value\": \"\"\n },\n \"plaats\": {\n \"value\": \"\"\n },\n \"inOnderzoek\": {\n \"value\": \"\"\n }\n },\n \"geheimhoudingPersoonsgegevens\": false,\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"in deserunt dolor et consectetur\"\n },\n \"ingeschrevenPersoon\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"exercitation\"\n }\n }\n }\n ]\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "9f5d8ffc-c7c4-4938-aa07-208e4c600b6f", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "969e20be-8898-42a8-8704-15887b4fe46a", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"detail\": \"The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "01d626fe-66f0-436c-86e5-dc07143fdceb", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "61759a8b-4cc7-4497-a32d-3de1d63107e7", - "name": "Not Found", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5\",\n \"title\": \"Opgevraagde resource bestaat niet.\",\n \"status\": 404,\n \"detail\": \"The server has not found anything matching the Request-URI.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notFound\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "de81eddc-7d45-4a93-b505-b95457579913", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "39c893b7-1845-4f76-8b06-e786050baf22", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "8f8b4db9-2f62-456f-a9b4-ff904fd7536d", - "name": "Not Implemented", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Implemented", - "code": 501, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2\",\n \"title\": \"Not Implemented\",\n \"status\": 501,\n \"detail\": \"The server does not support the functionality required to fulfill the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notImplemented\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "540033d9-62fa-40bd-be78-c6f40281086b", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "4270622d-1780-4724-a70f-e612b0283997", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://JDrdRUpHk.dqDkSCockv6z+84lgYpQdt\",\n \"title\": \"consequat laborum\",\n \"status\": -92650013,\n \"detail\": \"aute consectetur dolor ea\",\n \"instance\": \"https://zVDETLBZkBgrhcMh.ciyYhvnAotrHGZJ0pk,-aOXJjBEcKtQc\",\n \"code\": \"eu veniam commodo sint\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] - }, - { - "id": "deea5838-f7c6-49c6-be88-b5c931c298a2", - "name": "Raadpleeg de partner van een persoon", - "request": { - "name": "Raadpleeg de partner van een persoon", - "description": { - "content": "Raadpleeg de partner van een persoon\n", - "type": "text/plain" - }, - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de partner.\n" - } - ] - }, - "method": "GET", - "auth": null - }, - "response": [ - { - "id": "266a3dbb-533a-45f7-bddf-d2f54d74e371", - "name": "Zoekactie geslaagd\n", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de partner.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "disabled": false, - "key": "warning", - "value": "299 https://service.../api/.../v1 \"Deze versie van de API is verouderd en zal uit dienst worden genomen op 2018-02-01. Raadpleeg voor meer informatie hier de documentatie: https://omgevingswet.../api/.../v1\".", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/hal+json" - } - ], - "body": "{\n \"burgerservicenummer\": \"555555021\",\n \"geslachtsaanduiding\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"soortVerbintenis\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"naam\": {\n \"geslachtsnaam\": \"Vries\",\n \"voorletters\": \"P.J.\",\n \"voornamen\": \"Pieter Jan\",\n \"voorvoegsel\": \"de\",\n \"adellijkeTitelPredikaat\": {\n \"code\": \"JV\",\n \"omschrijving\": \"jonkvrouw\",\n \"soort\": \"predikaat\"\n },\n \"volledigeNaam\": \"Pieter Jan de Vries\",\n \"inOnderzoek\": {\n \"geslachtsnaam\": false,\n \"voornamen\": false,\n \"voorvoegsel\": false,\n \"adellijkeTitel\": true,\n \"predikaat\": false,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"1946-09-20\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"geboorte\": {\n \"datum\": {\n \"dag\": 3,\n \"datum\": \"1995-05-01\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"datum\": true,\n \"land\": true,\n \"plaats\": true,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"1991-03-16\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"inOnderzoek\": {\n \"burgerservicenummer\": true,\n \"geslachtsaanduiding\": false,\n \"soortVerbintenis\": true,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"1987-01-07\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n },\n \"aangaanHuwelijkPartnerschap\": {\n \"datum\": {\n \"dag\": 3,\n \"datum\": \"1956-04-10\",\n \"jaar\": 1989,\n \"maand\": 5\n },\n \"land\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"plaats\": {\n \"code\": \"6030\",\n \"omschrijving\": \"Nederland\"\n },\n \"inOnderzoek\": {\n \"datum\": true,\n \"land\": false,\n \"plaats\": true,\n \"datumIngangOnderzoek\": {\n \"dag\": 3,\n \"datum\": \"2008-12-03\",\n \"jaar\": 1989,\n \"maand\": 5\n }\n }\n },\n \"geheimhoudingPersoonsgegevens\": true,\n \"_links\": {\n \"self\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": true,\n \"title\": \"proid\"\n },\n \"ingeschrevenPersoon\": {\n \"href\": \"https://datapunt.voorbeeldgemeente.nl/api/v{major-versie}/resourcename/{resource-identificatie}\",\n \"templated\": false,\n \"title\": \"sint do\"\n }\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "1ca5f6b7-f633-450e-9838-88825d56f2ed", - "name": "Bad Request", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de partner.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Bad Request", - "code": 400, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1\",\n \"title\": \"Ten minste één parameter moet worden opgegeven.\",\n \"status\": 400,\n \"detail\": \"The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modification.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"paramsRequired\",\n \"invalidParams\": [\n {\n \"type\": \"https://www.vng.nl/realisatie/api/validaties/integer\",\n \"name\": \"verblijfplaats__huisnummer\",\n \"code\": \"integer\",\n \"reason\": \"Waarde is geen geldige integer.\"\n }\n ]\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "42867cde-2c86-43b1-8af9-5c88a1fec985", - "name": "Unauthorized", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de partner.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2\",\n \"title\": \"Niet correct geauthenticeerd.\",\n \"status\": 401,\n \"detail\": \"The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"authentication\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "bcd82993-3f9b-4c7f-bdb7-3b0426c4651e", - "name": "Forbidden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de partner.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4\",\n \"title\": \"U bent niet geautoriseerd voor deze operatie.\",\n \"status\": 403,\n \"detail\": \"The server understood the request, but is refusing to fulfill it.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"autorisation\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "31e13ebc-9be3-49a1-84d4-0ffb6823e467", - "name": "Not Found", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de partner.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Found", - "code": 404, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5\",\n \"title\": \"Opgevraagde resource bestaat niet.\",\n \"status\": 404,\n \"detail\": \"The server has not found anything matching the Request-URI.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notFound\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "d2628165-7458-4cf1-aa0f-5cfa03af079a", - "name": "Not Acceptable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de partner.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Acceptable", - "code": 406, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7\",\n \"title\": \"Gevraagde contenttype wordt niet ondersteund.\",\n \"status\": 406,\n \"detail\": \"The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to thr accept headers sent in the request\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAcceptable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "78548f5a-cf3f-4569-81e4-80d66269cab5", - "name": "Internal Server Error", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de partner.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1\",\n \"title\": \"Interne server fout.\",\n \"status\": 500,\n \"detail\": \"The server encountered an unexpected condition which prevented it from fulfilling the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"serverError\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "857576f6-ecea-48c4-8848-d856af50c373", - "name": "Not Implemented", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de partner.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Not Implemented", - "code": 501, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2\",\n \"title\": \"Not Implemented\",\n \"status\": 501,\n \"detail\": \"The server does not support the functionality required to fulfill the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notImplemented\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "fe0ca2d0-56bf-49d0-86db-f0c58a06ccb6", - "name": "Service Unavailable", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de partner.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Service Unavailable", - "code": 503, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "f3318935-c227-4828-a608-fab8a007fe56", - "name": "Er is een onverwachte fout opgetreden", - "originalRequest": { - "url": { - "path": [ - "ingeschrevenpersonen", - ":burgerservicenummer", - "partners", - ":id" - ], - "host": [ - "{{baseUrl}}" - ], - "query": [], - "variable": [ - { - "disabled": false, - "type": "any", - "value": "", - "key": "burgerservicenummer", - "description": "(Required) Uniek persoonsnummer\n" - }, - { - "disabled": false, - "type": "any", - "value": "", - "key": "id", - "description": "(Required) De identificatie van de partner.\n" - } - ] - }, - "method": "GET", - "body": {} - }, - "status": "Internal Server Error", - "code": 500, - "header": [ - { - "disabled": false, - "key": "api-version", - "value": "1.0.0", - "description": "" - }, - { - "key": "Content-Type", - "value": "application/problem+json" - } - ], - "body": "{\n \"type\": \"https://JDrdRUpHk.dqDkSCockv6z+84lgYpQdt\",\n \"title\": \"consequat laborum\",\n \"status\": -92650013,\n \"detail\": \"aute consectetur dolor ea\",\n \"instance\": \"https://zVDETLBZkBgrhcMh.ciyYhvnAotrHGZJ0pk,-aOXJjBEcKtQc\",\n \"code\": \"eu veniam commodo sint\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [] + "disabled": false, + "key": "api-version", + "value": "1.0.0", + "description": "" + }, + { + "key": "Content-Type", + "value": "application/problem+json" + } + ], + "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2\",\n \"title\": \"Not Implemented\",\n \"status\": 501,\n \"detail\": \"The server does not support the functionality required to fulfill the request.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notImplemented\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "ffedc3e7-2b50-4776-95f0-baf1b20f1eda", + "name": "Service Unavailable", + "originalRequest": { + "url": { + "path": [ + "personen" + ], + "host": [ + "{{baseUrl}}" + ], + "query": [], + "variable": [] + }, + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"fields\": \"\",\n \"type\": \"\",\n \"gemeenteVanInschrijving\": \"0518\"\n}", + "options": { + "raw": { + "language": "json" } + } + } + }, + "status": "Service Unavailable", + "code": 503, + "header": [ + { + "disabled": false, + "key": "api-version", + "value": "1.0.0", + "description": "" + }, + { + "key": "Content-Type", + "value": "application/problem+json" + } + ], + "body": "{\n \"type\": \"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4\",\n \"title\": \"Bronservice {bron} is tijdelijk niet beschikbaar.\",\n \"status\": 503,\n \"detail\": \"The service is currently unable to handle the request due to a temporary overloading or maintenance of the server.\",\n \"instance\": \"https://datapunt.voorbeeldgemeente.nl/api/v1/resourcenaam?parameter=waarde\",\n \"code\": \"notAvailable\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" + }, + { + "id": "580f58b8-9623-4c06-b934-5c1a45546097", + "name": "Er is een onverwachte fout opgetreden", + "originalRequest": { + "url": { + "path": [ + "personen" + ], + "host": [ + "{{baseUrl}}" ], - "event": [] + "query": [], + "variable": [] + }, + "method": "POST", + "body": { + "mode": "raw", + "raw": "{\n \"fields\": \"\",\n \"type\": \"\",\n \"gemeenteVanInschrijving\": \"0518\"\n}", + "options": { + "raw": { + "language": "json" + } + } + } + }, + "status": "Internal Server Error", + "code": 500, + "header": [ + { + "disabled": false, + "key": "api-version", + "value": "1.0.0", + "description": "" + }, + { + "key": "Content-Type", + "value": "application/problem+json" } ], - "event": [] + "body": "{\n \"type\": \"http://kksLCHUFHZNThOMF.bznzo1DBarwhifs-mv0baKzXNNengWv4KrLsXqC8vCNtXHTaG2G7FKfCNPZc0yEx9Xor1\",\n \"title\": \"non nostrud Ut Lorem\",\n \"status\": -33420380,\n \"detail\": \"sint\",\n \"instance\": \"https://sxooPOBnVDsqWZlnRJStblqWX.ubhwejb8k0s,\",\n \"code\": \"aliquip mollit\"\n}", + "cookie": [], + "_postman_previewlanguage": "json" } ], "event": [] @@ -4916,11 +505,11 @@ } ], "info": { - "_postman_id": "f9ebf6ba-562e-4f84-9c7d-15566d1465a6", - "name": "Bevragen Ingeschreven Personen", + "_postman_id": "eb4010df-4c05-48df-ac7b-fe7ba84c5d3a", + "name": "Bevragen Personen", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { - "content": "API voor het bevragen van ingeschreven personen uit de basisregistratie personen (BRP), inclusief de registratie niet-ingezeten (RNI). Met deze API kun je personen zoeken en actuele gegevens over personen, kinderen, partners en ouders raadplegen.\n\nGegevens die er niet zijn of niet actueel zijn krijg je niet terug. Heeft een persoon bijvoorbeeld geen geldige nationaliteit, en alleen een beëindigd partnerschap, dan krijg je geen gegevens over nationaliteit en partner.\n\nZie de [Functionele documentatie](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/tree/v1.1.0/features) voor nadere toelichting.\n", + "content": "API voor het bevragen van personen uit de basisregistratie personen (BRP), inclusief de registratie niet-ingezeten (RNI). Met deze API kun je personen zoeken en actuele gegevens over personen, kinderen, partners en ouders raadplegen.\n\nGegevens die er niet zijn of niet actueel zijn krijg je niet terug. Heeft een persoon bijvoorbeeld geen geldige nationaliteit, en alleen een beëindigd partnerschap, dan krijg je geen gegevens over nationaliteit en partner.\n\nZie de [Functionele documentatie](https://github.com/VNG-Realisatie/Haal-Centraal-BRP-bevragen/tree/v1.1.0/features) voor nadere toelichting.\n", "type": "text/plain" } }