F7554 - Registreer partij

Hoe de partij wordt geregistreerd hangt samen met de wijze van het toekennen van de ID’s. Dit vraagstuk staat beschreven in V6577

Vooralsnog gaan we ervan uit dat de ID wordt toegekend door de provider.

Functionaliteit

De functie registreert een nieuwe partij en de daarbij behorende partij-identificator. Aangezien de partij-identificator pas kan worden vastgelegd als de ID van de Partij bekend is, is er niet te ontkomen aan tijdelijke inconsistentie. Met de huidige wijze van toekennen van ID’s (door de provider) zal eerst de partij vastgelegd moeten worden voordat de partij-identificator kan worden vastgelegd met de verwijzing naar de partij.

Een partij kan niet bestaan zonder dat er een partij-identificator bestaat. Zolang de partij-identificator dus niet is vastgelegd (met de juiste “identificeerdePartij” property) is er sprake van een inconsitentie.

Als een partij alleen vastgelegd wordt omdat er geauthenticeerd is, maar de klant of vertegenwoordiger geeft geen toestemming voor hergebruik van de gegevens worden alleen de verplichte properties van de partij vastgelegd. Uiteraard wordt dan ook de partij-identificator vastgelegd.

Partij vastleggen

De partij wordt vastgelegd. Het ID wordt door de provider toegekend. (Issue: Het Nummer moet ook uniek zijn. Dit kan gegarandeerd worden door een controle uit te laten voeren door de provider en daar eventueel een foutmelding te genereren als het Nummer niet uniek blijkt te zijn.

API-call

Post ../partijen

Requestbody

Objecttype - Attribuut Voorbeeld waarde Toelichting
Partij    
- Nummer 123454321  
- Bezoekadres    
   - NummeraanduidingID 3024045390642408  
   - Adresregel 1    
   - Adresregel 2    
   - Adresregel 3    
   - Land 003 Hier wordt technisch een code gebruikt die in de referentielijst Land naar de hier getoonde waarde verwijst
- Correspondentieadres    
   - NummeraanduidingID 3024045390642408  
   - Adresregel 1    
   - Adresregel 2    
   - Adresregel 3    
   - Land 003 Hier wordt technisch een code gebruikt die in de referentielijst Land naar de hier getoonde waarde verwijst
- Interne Notitie    
- Soort partij persoon  
- Indicatie geheimhouding false  
- Voorkeurstaal ‘Nederlands’ Hier wordt technisch een code gebruikt die in de referentielijst Taal naar de hier getoonde waarde verwijst
- Indicatie actief true  
- Voorkeurs digitaal adres    

Response

Objecttype - Attribuut Voorbeeld waarde Toelichting
Partij    
- ID e8203b1b-f9e1-4fa1-96ce-2bcf36e061c2 Automatisch toegekend door provider
- Nummer 123454321  
- Bezoekadres    
   - NummeraanduidingID 3024045390642408  
   - Adresregel 1    
   - Adresregel 2    
   - Adresregel 3    
   - Land Nederland  
- Correspondentieadres    
   - NummeraanduidingID 3024045390642408  
   - Adresregel 1    
   - Adresregel 2    
   - Adresregel 3    
   - Land 003  
- Interne Notitie    
- Soort partij persoon  
- Indicatie geheimhouding false  
- Voorkeurstaal ‘Nederlands’  
- Indicatie actief true  
- Voorkeurs digitaal adres    

Partijidentifcator vastleggen

Vervolgens wordt de partij-identificator vastgelegd.

API Call

  • post ../partij-identificatoren

Requestbody

Objecttype - Attribuut Voorbeeld waarde Toelichting
Partijdidentificator    
- anderePartijIdentificator    
- identificeerdePartij e8203b1b-f9e1-4fa1-96ce-2bcf36e061c2  
- partijidentificator    
   - Object ID 999990019  
   - Soort object ‘Ingeschreven Persoon’ Hier wordt technisch een code gebruikt die in de referentielijst soortObject naar de hier getoonde waarde verwijst
   - Soort object ID ‘Burgerservicenummer’ Hier wordt technisch een code gebruikt die in de referentielijst soortObjectId naar de hier getoonde waarde verwijst
   - Register ‘Basisregistratie Personen’ Hier wordt technisch een code gebruikt die in de referentielijst externRegsister naar de hier getoonde waarde verwijst

Response

Objecttype - Attribuut Voorbeeld waarde Toelichting
Partijdidentificator    
- ID e8c8fde8-a8c4-4a02-94f6-e9596c28c6df Automatisch toegekend door provider
- anderePartijIdentificator    
- identificeerdePartij e8203b1b-f9e1-4fa1-96ce-2bcf36e061c2  
- partijidentificator    
   - Object ID 999990019  
   - Soort object ‘Ingeschreven Persoon’  
   - Soort object ID ‘Burgerservicenummer’  
   - Register ‘Basisregistratie Personen’  

Saga (foutafhandeling)

  • Indien het vastleggen van de partij door de provider niet lukt, wordt er een response geleverd met een relevante HTTP-foutcode en een zo accuraat mogelijke toelicht van het opgetreden probleem.

  • Indien de partij wel is vastgelegd (en er dus een responsecode ‘201’ met responsebody is ontvangen, maar de partij-identificator kan niet worden vastgelegd door de provider, dient de consumer zelf de zojuist aangemaakte partij te verwijderen.