HAALCENTRAAL English translation
BRP API / Personen / Features / verblijfstitel

requesting verblijfstitel fields with fields

# language: en

Feature: requesting verblijfstitel fields with fields

  Background:
    Given national table "Verblijfstitel" has the following values
    | code | omschrijving                                                                   |
    | 00   | Onbekend                                                                       |
    | 37   | Vw 2000 art. 8, onder e, gemeenschapsonderdaan econ. niet-actief, arbeid spec. |

  Rule: a verblijfstitel is supplied only where it is still valid
    - a residence permit is supplied where Datum einde verblijfstitel (end date of the residence permit) (39.20) is empty or has a date in the future
    - a residence permit is NOT supplied where Datum einde verblijfstitel (end date of the residence permit) (39.20) is today or has a date in the past

    Scenario: the person has no verblijfstitel
      Given the person with citizen service number '000000309' has the following data
      | naam                  | waarde |
      | geslachtsnaam (02.40) | Jansen |
      When persons are searched with the following parameters
      | naam                | waarde                          |
      | type                | RaadpleegMetBurgerservicenummer |
      | burgerservicenummer | 000000309                       |
      | fields              | verblijfstitel.aanduiding       |
      Then the response has a person without data

    Scenario: the verblijfstitel has no end date
      Given the person with citizen service number '000000103' has the following 'verblijfstitel' data
      | aanduiding verblijfstitel (39.10) | datum ingang verblijfstitel (39.30) |
      | 37                                | 20210315                            |
      When persons are searched with the following parameters
      | naam                | waarde                          |
      | type                | RaadpleegMetBurgerservicenummer |
      | burgerservicenummer | 000000103                       |
      | fields              | verblijfstitel.aanduiding       |
      Then the response has a person with only the following 'verblijfstitel' data
      | naam                    | waarde                                                                         |
      | aanduiding.code         | 37                                                                             |
      | aanduiding.omschrijving | Vw 2000 art. 8, onder e, gemeenschapsonderdaan econ. niet-actief, arbeid spec. |

    Scenario Outline: the verblijfstitel has <titel>
      Given the person with citizen service number '000000115' has the following 'verblijfstitel' data
      | aanduiding verblijfstitel (39.10) | datum einde verblijfstitel (39.20) | datum ingang verblijfstitel (39.30) |
      | 37                                | <datumEinde>                       | 20210315                            |
      When persons are searched with the following parameters
      | naam                | waarde                          |
      | type                | RaadpleegMetBurgerservicenummer |
      | burgerservicenummer | 000000115                       |
      | fields              | verblijfstitel.aanduiding       |
      Then the response has a person with only the following 'verblijfstitel' data
      | naam                    | waarde                                                                         |
      | aanduiding.code         | 37                                                                             |
      | aanduiding.omschrijving | Vw 2000 art. 8, onder e, gemeenschapsonderdaan econ. niet-actief, arbeid spec. |

      Examples:
      | titel                      | datumEinde |
      | datum einde in de toekomst | 20350315   |
      | datum einde is morgen      | morgen     |

    Scenario Outline: the verblijfstitel has <titel>
      Given the person with citizen service number '000000127' has the following 'verblijfstitel' data
      | aanduiding verblijfstitel (39.10) | datum einde verblijfstitel (39.20) | datum ingang verblijfstitel (39.30) |
      | 37                                | <datumEinde>                       | 20210315                            |
      When persons are searched with the following parameters
      | naam                | waarde                                             |
      | type                | RaadpleegMetBurgerservicenummer                    |
      | burgerservicenummer | 000000127                                          |
      | fields              | burgerservicenummer,verblijfstitel.aanduiding.code |
      Then the response has a person with only the following data
      | naam                | waarde    |
      | burgerservicenummer | 000000127 |

      Examples:
      | titel                       | datumEinde |
      | datum einde is vandaag      | vandaag    |
      | datum einde in het verleden | 20220315   |

  Rule: a verblijfstitel with designation 98 "geen verblijfstitel (meer)" is not included

    Scenario: a lapsed verblijfstitel
      Given the person with citizen service number '000000139' has the following 'verblijfstitel' data
      | aanduiding verblijfstitel (39.10) | datum ingang verblijfstitel (39.30) |
      | 98                                | 20210315                            |
      When persons are searched with the following parameters
      | naam                | waarde                                        |
      | type                | RaadpleegMetBurgerservicenummer               |
      | burgerservicenummer | 000000139                                     |
      | fields              | burgerservicenummer,verblijfstitel.aanduiding |
      Then the response has a person with only the following data
      | naam                | waarde    |
      | burgerservicenummer | 000000139 |

  Rule: A verblijfstitel with an unknown designation is supplied

    Scenario: the person has a verblijfstitel but it is not yet known which one
      Given the person with citizen service number '000000140' has the following 'verblijfstitel' data
      | aanduiding verblijfstitel (39.10) | datum ingang verblijfstitel (39.30) |
      | 00                                | 20210714                            |
      When persons are searched with the following parameters
      | naam                | waarde                          |
      | type                | RaadpleegMetBurgerservicenummer |
      | burgerservicenummer | 000000140                       |
      | fields              | verblijfstitel                  |
      Then the response has a person with only the following 'verblijfstitel' data
      | naam                    | waarde       |
      | aanduiding.code         | 00           |
      | aanduiding.omschrijving | Onbekend     |
      | datumIngang.type        | Datum        |
      | datumIngang.datum       | 2021-07-14   |
      | datumIngang.langFormaat | 14 juli 2021 |