F2158 - Wijzig partij

Functionaliteit

De functie wijzigt gegevens van een bestaande partij.

  • Het wijzigen, toevoegen, corrigeren of verwijderen van een digitaal adres of van een partijidentificator wordt in aparte functies beschreven.
  • Het ID en het nummer is niet te wijzigen, want dit is een uniek identificerend gegeven.
  • Behalve in uitzonderlijke correctiesituatues wordt het nummer in een Patch- of Put-operatie niet gegwijzigd.

Er zijn 2 operaties waarmee een partij gewijzigd kan worden.

Met een Patch worden alleen de te wijzigen properties opgenomen in de requestbody.

Een Put wordt in het algemeen voorafgegaan door een Get, zodat de actuele waarden van alle properties opgehaald zijn en alleen de te wijzigen properties worden aangepast. Op deze manier wordt de volledige nieuwe inhoud van de resource met een Put call gecommuniceerd naar de provider.

API Call Patch

  • patch ../partij/e8203b1b-f9e1-4fa1-96ce-2bcf36e061c2

Requestbody

In de requestbody van de patch worden alleen die properties opgenomen die vastgelegd moeten worden. Alleen properties die hierna in de requestbody van de PUT-operatie zijn vemeld kunnen onderdeel uitmaken van de requestbody van de patch.

Response

De volledige resource partij wordt geretourneerd.

API Call Put

  • put ../partij/e8203b1b-f9e1-4fa1-96ce-2bcf36e061c2

Requestbody

In de requestbody van de put worden alle properties van de partij met hun vast te leggen waarde opgenomen.

Objecttype - Attribuut Voorbeeld waarde Toelichting
Partij    
- Bezoekadres    
   - NummeraanduidingID Te verwerken  
   - Adresregel 1 Van Puffelenstraat 23  
   - Adresregel 2 9823 SG Tietjerkstradeel  
   - Adresregel 3    
   - Land Nederland Hier wordt technisch een code gebruikt die in de referentielijst Land naar de hier getoonde waarde verwijst
- Correspondentieadres    
   - NummeraanduidingID Te verwerken  
   - Adresregel 1 Janssenstraat 12  
   - Adresregel 2 9821 ST Tietjerkstradeel  
   - Adresregel 3    
   - Land Nederland 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

De volledige resource partij wordt geretourneerd.

Objecttype - Attribuut Voorbeeld waarde Toelichting
Partij    
- id e8203b1b-f9e1-4fa1-96ce-2bcf36e061c2  
- nummer 12345678  
- Bezoekadres    
   - NummeraanduidingID Te verwerken  
   - Adresregel 1 Van Puffelenstraat 23  
   - Adresregel 2 9823 SG Tietjerkstradeel  
   - Adresregel 3    
   - Land Nederland Hier wordt technisch een code gebruikt die in de referentielijst Land naar de hier getoonde waarde verwijst
- Correspondentieadres    
   - NummeraanduidingID Te verwerken  
   - Adresregel 1 Janssenstraat 12  
   - Adresregel 2 9821 ST Tietjerkstradeel  
   - Adresregel 3    
   - Land Nederland 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