HAALCENTRAAL English translation
BRP API / Personen / Features / fields-gezag

valid fields values for requesting the gezag field

# language: en
@input-validatie
Feature: valid fields values for requesting the gezag field

  Rule: the full and exact path (case-sensitive) of a field must be supplied as a fields value in order to request that field

    Scenario Outline: the gezag field is requested with fields value 'gezag'
      When 'gezag' is requested for persons searched by <zoek methode>
      Then the response has no error message

      Examples:
        | zoek methode                       |
        | burgerservicenummer                |
        | adresseerbaar object identificatie |

    @fout-case
    Scenario: the gezag field is requested with fields value 'gezag' when searching with '<zoek methode>'
      When 'gezag' is requested for persons searched by <zoek methode>
      Then the response has an error message
        | naam     | waarde                                                      |
        | type     | https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 |
        | title    | Een of meerdere parameters zijn niet correct.               |
        | status   |                                                         400 |
        | detail   | De foutieve parameter(s) zijn: fields[0].                   |
        | code     | paramsValidation                                            |
        | instance | /haalcentraal/api/brp/personen                              |
      And parameter error messages
        | code   | name      | reason                                       |
        | fields | fields[0] | Parameter bevat een niet bestaande veldnaam. |

      Examples:
        | zoek methode                                          |
        | geslachtsnaam en geboortedatum                        |
        | geslachtsnaam, voornamen en gemeente van inschrijving |
        | nummeraanduiding identificatie                        |
        | postcode en huisnummer                                |
        | straatnaam, huisnummer en gemeente van inschrijving   |

  Rule: it is not permitted to request specific sub-fields of the gezag field

    @fout-case
    Scenario Outline: the gezag field is requested with fields value '<fields>'
      When '<fields>' is requested for persons searched by <zoek methode>
      Then the response has an error message
        | naam     | waarde                                                      |
        | type     | https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1 |
        | title    | Een of meerdere parameters zijn niet correct.               |
        | status   |                                                         400 |
        | detail   | De foutieve parameter(s) zijn: fields[0].                   |
        | code     | paramsValidation                                            |
        | instance | /haalcentraal/api/brp/personen                              |
      And parameter error messages
        | code   | name      | reason                                        |
        | fields | fields[0] | Parameter bevat een niet toegestane veldnaam. |

      Examples:
        | fields             | zoek methode                       |
        | gezag.type         | burgerservicenummer                |
        | gezag.minderjarige | adresseerbaar object identificatie |
        | gezag.ouders       | burgerservicenummer                |
        | gezag.ouder        | adresseerbaar object identificatie |
        | gezag.derde        | burgerservicenummer                |
        | gezag.derden       | adresseerbaar object identificatie |
        | gezag.toelichting  | burgerservicenummer                |
        | gezag.nietBestaand | adresseerbaar object identificatie |