{"openapi":"3.0.1","info":{"description":"De Relatie API biedt toegang tot relaties binnen Realworks. Met deze API kunnen relaties worden gezocht, geraadpleegd, aangemaakt en bijgewerkt. Daarnaast kunnen kenmerken worden beheerd en zijn medewerkers en relatiegegevens beschikbaar via specifieke endpoints.\n\n#### Zo gebruik je deze API\n1. Zoek eerst of de relatie al bestaat met `GET /relaties/v1` om dubbele relaties te voorkomen.\n2. Maak een nieuwe relatie aan met `POST /relaties/v1` wanneer deze nog niet bestaat.\n3. Gebruik het geretourneerde `relatieId` om de relatie op te halen of bij te werken.\n4. Gebruik de beschikbare endpoints om kenmerken toe te voegen of medewerkers en relaties op te vragen.\n\nGebruik het `relatieId` in Agenda, Taken, Wonen, Nieuwbouw en andere API's die relaties ondersteunen.\n\n#### Bijzonderheden\n* Gebruik bij voorkeur het unieke `relatieId` voor het ophalen en wijzigen van relaties.\n* Alleen relaties die voor de gebruikte API-token zijn vrijgegeven worden teruggegeven.\n* Bij meerdere vestigingen kan met `afdelingscode` worden gefilterd.\n* Relaties kunnen worden gefilterd op onder andere relatiesoort, e-mailadres en wijzigingsdatum.\n* Kenmerken kunnen afzonderlijk aan bedrijven, contactpersonen, particulieren en medewerkers worden gekoppeld.\n\n#### Laatste wijzigingen\n* `relatieId` is geïntroduceerd als unieke identifier voor relaties.\n* POST- en PUT-endpoints gebruiken `relatieId` voor het aanmaken en wijzigen van relaties.\n* Nieuwe endpoints toegevoegd voor het beheren van kenmerken per relatiesoort.","title":"Relatie"},"externalDocs":{"description":"OpenAPI Specification","url":"/openapi-doc/v1/Relatie"},"servers":[{"url":"https://api.realworks.nl"}],"security":[{"rwauth":[]}],"tags":[{"name":"Relatie"}],"paths":{"/relaties/v1":{"get":{"description":"\nGebruik dit endpoint voor het zoeken naar relaties die expliciet aan jouw token zijn vrijgegeven.\n\nFilter op type met `relatiesoort` bijv. `MEDEWERKER` om alleen die relatie type te ontvangen.\n\n**Let op:** dit endpoint toont alleen relaties die **released** zijn naar het token;\n\nhet is dus niet geschikt als  `afdelings-medewerkerslijst` wanneer medewerkers niet zijn vrijgegeven.<br/>Token met RELATIE toegang<br/>Token met RELATIE publication level","operationId":"zoekenRelaties","parameters":[{"description":"Publication Level: **BASIS**<br/><br/>Indien er sprake is van meerdere vestigingen, kan in het veld <b>Afdelingscode</b> op specifieke vestiging gefilterd worden. (veld leeg geeft alle beschikbare data van alle vestigingen)","in":"query","name":"afdelingscode","required":false,"schema":{"type":"string"}},{"description":"Publication Level: **BASIS**<br/><br/>","explode":true,"in":"query","name":"relatiesoort","required":false,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["BEDRIJF","CONTACTPERSOON","PARTICULIER","MEDEWERKER"]}},"style":"form"},{"description":"Publication Level: **BASIS**<br/><br/>","in":"query","name":"email","required":false,"schema":{"type":"string"}},{"description":"Publication Level: **BASIS**<br/><br/>Heeft de relatie zich uitgeschreven voor de mailing (true) of niet (false)","in":"query","name":"geenMailing","required":false,"schema":{"type":"string","enum":["true","false","all"]}},{"description":"Publication Level: **PLUS**<br/><br/>Kenmerknummer","in":"query","name":"kenmerk","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Publication Level: **BASIS**<br/><br/>invoerdatumVan (ex: _2017-11-03 20:00:00_ or _22017-11-03T20:00:00_ (Safari browser)","in":"query","name":"invoerdatumVan","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Publication Level: **BASIS**<br/><br/>invoerdatumTot (ex: _2017-11-03 20:00:00_ or _2017-11-03T20:00:00_ (Safari browser)","in":"query","name":"invoerdatumTot","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Publication Level: **BASIS**<br/><br/>laatstBijgewerktVan (ex: _2017-11-03 20:00:00_ or _2017-11-03T20:00:00_ (Safari browser)","in":"query","name":"laatstBijgewerktVan","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"Publication Level: **BASIS**<br/><br/>laatstBijgewerktTot (ex: _2017-11-03 20:00:00_ or _2017-11-03T20:00:00_ (Safari browser)","in":"query","name":"laatstBijgewerktTot","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"gewijzigdNa (ex: _2017-11-03 20:00:00_ or _2017-11-03T20:00:00_ (Safari browser)","in":"query","name":"gewijzigdNa","required":false,"schema":{"type":"string","format":"date-time"}},{"description":" (min: _1_, max: _100_)","in":"query","name":"aantal","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":100}},{"in":"query","name":"vanaf","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiSearchResultsRelatie"}}},"description":"Succes"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Fout in aanroep"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"content":{},"description":"Te veel aanvragen"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Zoeken door relaties","tags":["Relatie"]},"post":{"description":"","operationId":"relatiesCreëren","requestBody":{"content":{"application/json;charset=UTF-8":{"examples":{"BedrijfPayload":{"description":"BedrijfPayload","summary":"If you choose BEDRIJF in relatiesoort","value":{"relatiesoort":"BEDRIJF","bedrijfsnaam":"string","mobielTelefoonnummer":"123-1331-122","straat":"string","email":"ab@realworks.com","telefoonnummer":"123-1331-122","postcode":"112133","accountmanager":"accountManager","huisnummer":"12","huisnummertoevoeging":"1","woonplaats":"string","afdelingscode":"afdelingscode"}},"ContactPersonPayload":{"description":"ContactPersonPayload","summary":"If you choose CONTACTPERSOON in relatiesoort","value":{"titel":"string","land":"string","companyId":"string","relatiesoort":"CONTACTPERSOON","initialen":"string","tussenvoegsel":"string","achternaam":"string","geslacht":"V","roepnaam":"string","email":"ab@realworks.com","straat":"string","afdelingscode":"afdelingscode","postcode":"112133","accountmanager":"accountManager","telefoonnummer":"123-1331-122","huisnummer":"12","huisnummertoevoeging":"1","woonplaats":"string","mobielTelefoonnummer":"123-1331-122"}},"ParticulierPayload":{"description":"ParticulierPayload","summary":"If you choose PARTICULIER in relatiesoort","value":{"initialen":"string","tussenvoegsel":"string","achternaam":"string","geslacht":"M","roepnaam":"string","relatiesoort":"PARTICULIER","land":"string","titel":"string","afdelingscode":"afdelingscode","huisnummer":"12","huisnummertoevoeging":"1","woonplaats":"string","telefoonnummer":"123-1331-122","postcode":"112133","accountmanager":"accountManager","straat":"string","email":"ab@realworks.com","mobielTelefoonnummer":"123-1331-122"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/BedrijfPayload"},{"$ref":"#/components/schemas/ContactPersonPayload"},{"$ref":"#/components/schemas/ParticulierPayload"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncWritePathReply"}}},"description":"Response ontvangen"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Fout in aanroep"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"description":"Too Many Requests"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Relatie toevoegen","tags":["Relatie"]},"put":{"description":"","operationId":"relatieUpdate","requestBody":{"content":{"application/json;charset=UTF-8":{"examples":{"BedrijfUpdatePayload":{"description":"BedrijfUpdatePayload","summary":"If you choose BEDRIJF in relatiesoort","value":{"bedrijfsnaam":"string","relatiesoort":"BEDRIJF","id":0,"postcode":"112133","woonplaats":"string","accountmanager":"accountManager","telefoonnummer":"123-1331-122","huisnummer":"12","huisnummertoevoeging":"1","afdelingscode":"afdelingscode","straat":"string","email":"ab@realworks.com","mobielTelefoonnummer":"123-1331-122"}},"ContactPersonUpdatePayload":{"description":"ContactPersonUpdatePayload","summary":"If you choose CONTACTPERSOON in relatiesoort","value":{"initialen":"string","tussenvoegsel":"string","achternaam":"string","geslacht":"M","relatiesoort":"CONTACTPERSOON","roepnaam":"string","companyId":"string","land":"string","titel":"string","id":0,"mobielTelefoonnummer":"123-1331-122","telefoonnummer":"123-1331-122","woonplaats":"string","huisnummer":"12","huisnummertoevoeging":"1","accountmanager":"accountManager","postcode":"112133","afdelingscode":"afdelingscode","email":"ab@realworks.com","straat":"string"}},"ParticulierUpdatePayload":{"description":"ParticulierUpdatePayload","summary":"If you choose PARTICULIER in relatiesoort","value":{"relatiesoort":"PARTICULIER","initialen":"string","tussenvoegsel":"string","achternaam":"string","geslacht":"V","roepnaam":"string","land":"string","titel":"string","id":0,"afdelingscode":"afdelingscode","huisnummer":"12","huisnummertoevoeging":"1","woonplaats":"string","accountmanager":"accountManager","postcode":"112133","telefoonnummer":"123-1331-122","straat":"string","email":"ab@realworks.com","mobielTelefoonnummer":"123-1331-122"}}},"schema":{"oneOf":[{"$ref":"#/components/schemas/BedrijfUpdatePayload"},{"$ref":"#/components/schemas/ContactPersonUpdatePayload"},{"$ref":"#/components/schemas/ParticulierUpdatePayload"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncWritePathReply"}}},"description":"Response ontvangen"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Fout in aanroep"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"description":"Too Many Requests"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"relatie wijzigen","tags":["Relatie"]}},"/relaties/v1/afdelingen/{afdelingscode}/bedrijven/{relatieId}/kenmerken/{kenmerkId}":{"put":{"description":"","operationId":"createCompanyCharacteristics","parameters":[{"in":"path","name":"afdelingscode","required":true,"schema":{"type":"string"}},{"in":"path","name":"relatieId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"kenmerkId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncWritePathReply"}}},"description":"Response ontvangen"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Fout in aanroep"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"description":"Too Many Requests"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Kenmerk toevoegen aan bedrijf","tags":["Relatie"]}},"/relaties/v1/afdelingen/{afdelingscode}/contactpersonen/{relatieId}/kenmerken/{kenmerkId}":{"put":{"description":"","operationId":"createContactCharacteristics","parameters":[{"in":"path","name":"afdelingscode","required":true,"schema":{"type":"string"}},{"in":"path","name":"relatieId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"kenmerkId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncWritePathReply"}}},"description":"Response ontvangen"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Fout in aanroep"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"description":"Too Many Requests"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Kenmerk toevoegen aan contactpersoon","tags":["Relatie"]}},"/relaties/v1/afdelingen/{afdelingscode}/medewerkers/{relatieId}/kenmerken/{kenmerkId}":{"put":{"description":"","operationId":"createEmployeeCharacteristics","parameters":[{"in":"path","name":"afdelingscode","required":true,"schema":{"type":"string"}},{"in":"path","name":"relatieId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"kenmerkId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncWritePathReply"}}},"description":"Response ontvangen"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Fout in aanroep"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"description":"Too Many Requests"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Kenmerk toevoegen aan medewerker","tags":["Relatie"]}},"/relaties/v1/afdelingen/{afdelingscode}/personen/{relatieId}/kenmerken/{kenmerkId}":{"put":{"description":"","operationId":"createPersonCharacteristics","parameters":[{"in":"path","name":"afdelingscode","required":true,"schema":{"type":"string"}},{"in":"path","name":"relatieId","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"kenmerkId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncWritePathReply"}}},"description":"Response ontvangen"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Fout in aanroep"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"description":"Too Many Requests"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Kenmerk toevoegen aan persoon","tags":["Relatie"]}},"/relaties/v1/bedrijf/{afdelingscode}/{relatiecode}":{"get":{"description":"Token met RELATIE toegang<br/>Token met RELATIE publication level","operationId":"zoekenRelatieBedrijf","parameters":[{"in":"path","name":"afdelingscode","required":true,"schema":{"type":"string"}},{"in":"path","name":"relatiecode","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/Relatie"}}},"description":"Succes"},"400":{"description":"Foutief verzoek"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"description":"Too Many Requests"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Relatiegegevens bedrijf ophalen","tags":["Relatie"]}},"/relaties/v1/contactpersoon/{afdelingscode}/{relatiecode}":{"get":{"description":"Token met RELATIE toegang<br/>Token met RELATIE publication level","operationId":"zoekenRelatieContactpersoon","parameters":[{"in":"path","name":"afdelingscode","required":true,"schema":{"type":"string"}},{"in":"path","name":"relatiecode","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/Relatie"}}},"description":"Succes"},"400":{"description":"Foutief verzoek"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"description":"Too Many Requests"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Relatiegegevens contactpersoon ophalen","tags":["Relatie"]}},"/relaties/v1/kenmerken":{"get":{"description":"Token met RELATIE toegang<br/>Token met RELATIE publication level >= PLUS","operationId":"zoekenKenmerken","parameters":[{"description":"Publication Level: **PLUS**<br/><br/>Bedrijf, alle afdelingen vallen hieronder","in":"query","name":"bedrijfscode","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiSearchResultsKenmerk"}}},"description":"Succes"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Fout in aanroep"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"content":{},"description":"Te veel aanvragen"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Zoeken door kenmerken","tags":["Relatie"]}},"/relaties/v1/medewerker":{"get":{"description":"Gebruik dit endpoint om een specifieke medewerker op te halen wanneer die medewerker aan jouw token is vrijgegeven.\n\nVoor een volledige medewerkerslijst op basis van afdelings-toegang (zonder release) gebruik je dit endpoint.\n\nVoor rijkere velden (waar beschikbaar) gebruik `GET /relaties/v1` met `relatiesoort=MEDEWERKER`.\n\n","operationId":"zoekenMedewerkers","parameters":[{"in":"query","name":"aantal","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":100}},{"description":" (min: _1_, max: _100_)","in":"query","name":"vanaf","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32"}},{"in":"query","name":"afdelingscode","required":false,"schema":{"type":"string"}},{"description":"gewijzigdNa (ex: _2017-11-03 20:00:00_ or _2017-11-03T20:00:00_ (Safari browser)","in":"query","name":"gewijzigdNa","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/ApiSearchResultsRelatieMedewerker"}}},"description":"Succes"},"400":{"description":"Foutief verzoek"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"description":"Too Many Requests"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Zoeken door medewerkers","tags":["Relatie"]}},"/relaties/v1/medewerker/{afdelingscode}/{relatiecode}":{"get":{"description":"Token met RELATIE toegang<br/>Token met RELATIE publication level","operationId":"zoekenRelatieMedewerker","parameters":[{"in":"path","name":"afdelingscode","required":true,"schema":{"type":"string"}},{"in":"path","name":"relatiecode","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/Relatie"}}},"description":"Succes"},"400":{"description":"Foutief verzoek"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"description":"Too Many Requests"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Relatiegegevens medewerker ophalen","tags":["Relatie"]}},"/relaties/v1/particulier/{afdelingscode}/{relatiecode}":{"get":{"description":"Token met RELATIE toegang<br/>Token met RELATIE publication level","operationId":"zoekenRelatieParticulier","parameters":[{"in":"path","name":"afdelingscode","required":true,"schema":{"type":"string"}},{"in":"path","name":"relatiecode","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/Relatie"}}},"description":"Succes"},"400":{"description":"Foutief verzoek"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"description":"Too Many Requests"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Relatiegegevens particulier ophalen","tags":["Relatie"]}},"/relaties/v1/{relatieId}":{"get":{"description":"Token met RELATIE toegang<br/>Token met RELATIE publication level","operationId":"zoekenRelatiesId","parameters":[{"in":"path","name":"relatieId","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/Relatie"}}},"description":"Succes"},"400":{"description":"Foutief verzoek"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"description":"Too Many Requests"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Zoek relaties op id","tags":["Relatie"]}}},"components":{"schemas":{"Adresgegevens":{"type":"object","properties":{"bedrijfsadres":{"$ref":"#/components/schemas/Bedrijfsadres"},"huisadres":{"$ref":"#/components/schemas/Huisadres"},"toekomstigAdres":{"$ref":"#/components/schemas/ToekomstigAdres"}},"description":"RelatieAdresgegevens","nullable":true},"AdresgegevensMedewerker":{"type":"object","properties":{"bedrijfsadres":{"$ref":"#/components/schemas/Bedrijfsadres"}},"description":"RelatieAdresgegevensMedewerker","nullable":true},"ApiSearchResultsKenmerk":{"type":"object","properties":{"paginering":{"$ref":"#/components/schemas/PaginationInfo"},"resultaten":{"type":"array","items":{"$ref":"#/components/schemas/Kenmerk"}}},"description":"Zoekresultaten"},"ApiSearchResultsRelatie":{"type":"object","properties":{"paginering":{"$ref":"#/components/schemas/PaginationInfo"},"resultaten":{"type":"array","items":{"$ref":"#/components/schemas/Relatie"}}},"description":"Zoekresultaten"},"ApiSearchResultsRelatieMedewerker":{"type":"object","properties":{"paginering":{"$ref":"#/components/schemas/PaginationInfo"},"resultaten":{"type":"array","items":{"$ref":"#/components/schemas/RelatieMedewerker"}}},"description":"Zoekresultaten"},"BedrijfPayload":{"type":"object","allOf":[{"$ref":"#/components/schemas/RelatieCreatePayload"},{"type":"object","properties":{"bedrijfsnaam":{"minLength":1,"type":"string","description":"bedrijfsnaam"},"relatiesoort":{"minLength":1,"type":"string","description":"relatiesoort","example":"BEDRIJF"}}}],"description":"Bedrijf payload data","required":["afdelingscode","bedrijfsnaam","email","relatiesoort"]},"BedrijfUpdatePayload":{"type":"object","allOf":[{"$ref":"#/components/schemas/RelatieUpdatePayload"},{"type":"object","properties":{"bedrijfsnaam":{"minLength":1,"type":"string","description":"bedrijfsnaam"},"relatiesoort":{"minLength":1,"type":"string","description":"relatiesoort","example":"BEDRIJF"}}}],"description":"Bedrijf payload data","required":["afdelingscode","bedrijfsnaam","email","id","relatiesoort"]},"Bedrijfsadres":{"type":"object","properties":{"bedrijfsnaam":{"type":"string","description":"Publication Level: BASIS<br/>Bedrijfsnaam","nullable":true},"vestigingsHuisnummer":{"type":"string","description":"Publication Level: BASIS<br/>Huisnummer","nullable":true},"vestigingsHuisnummertoevoeging":{"type":"string","description":"Publication Level: BASIS<br/>Toevoeging","nullable":true},"vestigingsLand":{"type":"string","description":"Publication Level: BASIS<br/>Land vestigingsadres","nullable":true},"vestigingsPlaats":{"type":"string","description":"Publication Level: BASIS<br/>Plaatsnaam vestigingsadres","nullable":true},"vestigingsPostcode":{"type":"string","description":"Publication Level: BASIS<br/>Postcode vestigingsadres","nullable":true},"vestigingsadresRegel1":{"type":"string","description":"Publication Level: BASIS<br/>Vestigingsadres adresregel 1","nullable":true},"vestigingsadresRegel2":{"type":"string","description":"Publication Level: BASIS<br/>Vestigingsadres adresregel 2","nullable":true}},"nullable":true},"ContactPersonPayload":{"type":"object","allOf":[{"$ref":"#/components/schemas/RelatieCreatePayload"},{"type":"object","properties":{"achternaam":{"minLength":1,"type":"string","description":"achternaam"},"companyId":{"minLength":1,"type":"string","description":"companyId"},"geslacht":{"type":"string","description":"geslacht","nullable":true,"enum":["M","V","O"]},"initialen":{"type":"string","description":"initialen","nullable":true},"land":{"type":"string","description":"land","nullable":true},"relatiesoort":{"minLength":1,"type":"string","description":"relatiesoort","example":"CONTACTPERSOON"},"roepnaam":{"type":"string","description":"roepnaam","nullable":true},"titel":{"type":"string","description":"titel","nullable":true},"tussenvoegsel":{"type":"string","description":"tussenvoegsel","nullable":true}}}],"description":"Contact person payload data","required":["achternaam","afdelingscode","companyId","email","relatiesoort"]},"ContactPersonUpdatePayload":{"type":"object","allOf":[{"$ref":"#/components/schemas/RelatieUpdatePayload"},{"type":"object","properties":{"achternaam":{"minLength":1,"type":"string","description":"achternaam"},"companyId":{"minLength":1,"type":"string","description":"companyId"},"geslacht":{"type":"string","description":"geslacht","nullable":true,"enum":["M","V","O"]},"initialen":{"type":"string","description":"initialen","nullable":true},"land":{"type":"string","description":"land","nullable":true},"relatiesoort":{"minLength":1,"type":"string","description":"relatiesoort","example":"CONTACTPERSOON"},"roepnaam":{"type":"string","description":"roepnaam","nullable":true},"titel":{"type":"string","description":"titel","nullable":true},"tussenvoegsel":{"type":"string","description":"tussenvoegsel","nullable":true}}}],"description":"Contact person payload data","required":["achternaam","afdelingscode","companyId","email","id","relatiesoort"]},"Email":{"type":"object","properties":{"email":{"type":"string","description":"Publication Level: BASIS<br/>Email adres","nullable":true}}},"ErrorResponse":{"type":"object","properties":{"meldingen":{"type":"array","items":{"type":"string"}}},"description":"Foutmeldingen"},"Huisadres":{"type":"object","properties":{"huisadresHuisnummer":{"type":"string","description":"Publication Level: BASIS<br/>Huisnummer","nullable":true},"huisadresHuisnummertoevoeging":{"type":"string","description":"Publication Level: BASIS<br/>Toevoeging","nullable":true},"huisadresLand":{"type":"string","description":"Publication Level: BASIS<br/>Land huisadres","nullable":true},"huisadresPlaats":{"type":"string","description":"Publication Level: BASIS<br/>Woonplaats huisadres","nullable":true},"huisadresPostcode":{"type":"string","description":"Publication Level: BASIS<br/>Postcode huisadres","nullable":true},"huisadresRegel1":{"type":"string","description":"Publication Level: BASIS<br/>Huisadres adresregel 1","nullable":true},"huisadresRegel2":{"type":"string","description":"Publication Level: BASIS<br/>Huisadres adresregel 2","nullable":true}},"nullable":true},"Kenmerk":{"type":"object","properties":{"actief":{"type":"boolean","description":"Publication Level: PLUS<br/>Actief","nullable":true},"bedrijfscode":{"type":"string","description":"Publication Level: PLUS<br/>Bedrijf, alle afdelingen vallen hieronder","nullable":true},"groep":{"type":"string","description":"Publication Level: PLUS<br/>Kenmerkgroep","nullable":true},"id":{"type":"integer","description":"Publication Level: PLUS<br/>Unieke key van de kenmerk koppeling","format":"int32","nullable":true},"omschrijving":{"type":"string","description":"Publication Level: PLUS<br/>Omschrijving","nullable":true}}},"Kenmerkreferentie":{"type":"object","properties":{"id":{"type":"integer","description":"Publication Level: PLUS<br/>Unieke key van de kenmerk koppeling","format":"int32","nullable":true}}},"Overige":{"type":"object","properties":{"aanhef":{"type":"string","description":"Publication Level: BASIS<br/>Aanhef","nullable":true},"afdelingscode":{"type":"string","description":"Publication Level: BASIS<br/>Vestiging (eigenaar van het object)","nullable":true},"burgelijkeStaat":{"type":"string","description":"Publication Level: COMPLEET<br/>Burgerlijke staat","nullable":true,"enum":["ALLEENSTAAND","ONGEHUWD","GEHUWD","GEHUWD_ONDER_HUWELIJKSE_VOORWAARDEN","GEHUWD_IN_GEMEENSCHAP_VAN_GOEDEREN","SAMENWONEND_MET_SAMENLEVINGSCONTRACT","SAMENWONEND_ZONDER_SAMENLEVINGSCONTRACT","PARTNERREGISTRATIE_IN_GEMEENSCHAP_VAN_GOEDEREN","PARTNERREGISTRATIE_MET_OVERLIJDENSRISICOVERZEKERING","PARTNERREGISTRATIE_MET_PARTNERSCHAPSVOORWAARDEN","WEDUWNAAR","WEDUWE"]},"functie":{"type":"string","description":"Publication Level: COMPLEET<br/>Functie","nullable":true},"functieomschrijving":{"type":"string","description":"Publication Level: COMPLEET<br/>Functieomschrijving","nullable":true},"geboortedatum":{"type":"string","description":"Publication Level: COMPLEET<br/>Geboortedatum","format":"date","nullable":true,"example":"2018-04-18"},"geboortenaam":{"type":"string","description":"Publication Level: COMPLEET<br/>Geboortenaam","nullable":true},"geboorteplaats":{"type":"string","description":"Publication Level: COMPLEET<br/>Geboorteplaats","nullable":true},"geenMailing":{"type":"boolean","description":"Publication Level: BASIS<br/>Geen mailing","nullable":true},"homepage":{"type":"string","description":"Publication Level: BASIS<br/>Homepage","nullable":true},"idNummer":{"type":"string","description":"Publication Level: COMPLEET<br/>ID nummer","nullable":true},"idSoort":{"type":"string","description":"Publication Level: COMPLEET<br/>ID soort","nullable":true,"enum":["PASPOORT","IDENTITEITSKAART","RIJBEWIJS","TOERISTENKAART","VERBLIJFSDOCUMENT","VLUCHTELINGENPASPOORT","VREEMDELINGENPASPOORT","BUITENLANDS_PASPOORT","ELEKTRONISCH_W_DOCUMENT"]},"idUitgiftedatum":{"type":"string","description":"Publication Level: COMPLEET<br/>ID uitgifte datum","nullable":true,"example":"2018-04-18"},"idUitgifteplaats":{"type":"string","description":"Publication Level: COMPLEET<br/>ID uitgifte plaats","nullable":true},"idVervaldatum":{"type":"string","description":"Publication Level: COMPLEET<br/>ID vervaldatum","format":"date","nullable":true,"example":"2018-04-18"},"invoerdatum":{"type":"string","description":"Publication Level: BASIS<br/>Datum invoer","nullable":true,"example":"2007-12-03 10:15:30"},"kvkNummer":{"type":"string","description":"Publication Level: COMPLEET<br/>KvK-nummer","nullable":true},"laatstBijgewerkt":{"type":"string","description":"Publication Level: BASIS<br/>Laatst bijgewerkt","nullable":true,"example":"2007-12-03 10:15:30"},"mailingUitschrijfLink":{"type":"string","description":"Publication Level: BASIS<br/>Link waarmee de relatie zich kan uitschrijven voor mailings","nullable":true},"nationaliteit":{"type":"string","description":"Publication Level: COMPLEET<br/>Nationaliteit","nullable":true},"relatiecode":{"type":"string","description":"Publication Level: BASIS<br/>","nullable":true},"titelNa":{"type":"string","description":"Publication Level: BASIS<br/>Titel (na)","nullable":true},"voornamen":{"type":"string","description":"Publication Level: BASIS<br/>Voornamen","nullable":true}},"description":"RelatieOverige","nullable":true},"OverigeMedewerker":{"type":"object","properties":{"aanhef":{"type":"string","description":"Publication Level: BASIS<br/>Aanhef","nullable":true},"afdelingscode":{"type":"string","description":"Publication Level: BASIS<br/>Vestiging (eigenaar van het object)","nullable":true},"functie":{"type":"string","description":"Publication Level: COMPLEET<br/>Functie","nullable":true},"functieomschrijving":{"type":"string","description":"Publication Level: COMPLEET<br/>Functieomschrijving","nullable":true},"geenMailing":{"type":"boolean","description":"Publication Level: BASIS<br/>Geen mailing","nullable":true},"homepage":{"type":"string","description":"Publication Level: BASIS<br/>Homepage","nullable":true},"kvkNummer":{"type":"string","description":"Publication Level: COMPLEET<br/>KvK-nummer","nullable":true},"laatstBijgewerkt":{"type":"string","description":"Publication Level: BASIS<br/>Laatst bijgewerkt","format":"date-time","nullable":true},"mailingUitschrijfLink":{"type":"string","description":"Publication Level: BASIS<br/>Link waarmee de relatie zich kan uitschrijven voor mailings","nullable":true},"relatiecode":{"type":"string","description":"Publication Level: BASIS<br/>","nullable":true},"titelNa":{"type":"string","description":"Publication Level: BASIS<br/>Titel (na)","nullable":true},"voornamen":{"type":"string","description":"Publication Level: BASIS<br/>Voornamen","nullable":true}},"description":"RelatieOverigeMedewerker","nullable":true},"PaginationInfo":{"type":"object","properties":{"totaalAantal":{"type":"integer","format":"int64"},"volgende":{"type":"string","format":"uri","nullable":true}},"description":"Pagineringsinformatie"},"ParticulierPayload":{"type":"object","allOf":[{"$ref":"#/components/schemas/RelatieCreatePayload"},{"type":"object","properties":{"achternaam":{"minLength":1,"type":"string","description":"achternaam"},"geslacht":{"type":"string","description":"geslacht","nullable":true,"enum":["M","V","O"]},"initialen":{"type":"string","description":"initialen","nullable":true},"land":{"type":"string","description":"land","nullable":true},"relatiesoort":{"minLength":1,"type":"string","description":"relatiesoort","example":"PARTICULIER"},"roepnaam":{"type":"string","description":"roepnaam","nullable":true},"titel":{"type":"string","description":"titel","nullable":true},"tussenvoegsel":{"type":"string","description":"tussenvoegsel","nullable":true}}}],"description":"Particulier payload data","required":["achternaam","afdelingscode","email","relatiesoort"]},"ParticulierUpdatePayload":{"type":"object","allOf":[{"$ref":"#/components/schemas/RelatieUpdatePayload"},{"type":"object","properties":{"achternaam":{"minLength":1,"type":"string","description":"achternaam"},"geslacht":{"type":"string","description":"geslacht","nullable":true,"enum":["M","V","O"]},"initialen":{"type":"string","description":"initialen","nullable":true},"land":{"type":"string","description":"land","nullable":true},"relatiesoort":{"minLength":1,"type":"string","description":"relatiesoort","example":"PARTICULIER"},"roepnaam":{"type":"string","description":"roepnaam","nullable":true},"titel":{"type":"string","description":"titel","nullable":true},"tussenvoegsel":{"type":"string","description":"tussenvoegsel","nullable":true}}}],"description":"Particulier payload data","required":["achternaam","afdelingscode","email","id","relatiesoort"]},"Relatie":{"type":"object","properties":{"accountmanager":{"type":"string","description":"Publication Level: BASIS<br/>Accountmanager","nullable":true},"achternaam":{"type":"string","description":"Publication Level: BASIS<br/>Achternaam","nullable":true},"adresgegevens":{"$ref":"#/components/schemas/Adresgegevens"},"bedrijfscode":{"type":"string","description":"Publication Level: BASIS<br/>Bedrijf, alle afdelingen vallen hieronder","nullable":true},"emailadressen":{"type":"array","description":"Publication Level: BASIS<br/>","nullable":true,"items":{"$ref":"#/components/schemas/Email"}},"geslacht":{"type":"string","description":"Publication Level: BASIS<br/>Geslacht","nullable":true,"enum":["MAN","VROUW","ONBEKEND"]},"id":{"type":"integer","description":"Publication Level: BASIS<br/>","format":"int32","nullable":true},"initialen":{"type":"string","description":"Publication Level: BASIS<br/>Initialen","nullable":true},"kenmerken":{"type":"array","description":"Publication Level: PLUS<br/>","nullable":true,"items":{"$ref":"#/components/schemas/Kenmerkreferentie"}},"overige":{"$ref":"#/components/schemas/Overige"},"relatiesoort":{"type":"string","description":"Publication Level: BASIS<br/>Soort relatie","nullable":true,"enum":["BEDRIJF","CONTACTPERSOON","PARTICULIER","MEDEWERKER"]},"relatietype":{"type":"string","description":"Publication Level: BASIS<br/>Type relatie","nullable":true},"roepnaam":{"type":"string","description":"Publication Level: BASIS<br/>Roepnaam","nullable":true},"telefoonnummers":{"type":"array","description":"Publication Level: BASIS<br/>","nullable":true,"items":{"$ref":"#/components/schemas/Telefoonnummer"}},"tijdstipLaatsteWijziging":{"type":"string","description":"Tijdstip van laatste wijziging. Dit geeft geen garantie dat er daadwerkelijk iets gewijzigd is, maar geeft slechts een mogelijke wijziging aan.","nullable":true,"example":"2007-12-03 10:15:30"},"titel":{"type":"string","description":"Publication Level: BASIS<br/>Titel","nullable":true},"tussenvoegsel":{"type":"string","description":"Publication Level: BASIS<br/>Tussenv.","nullable":true}}},"RelatieCreatePayload":{"required":["afdelingscode","email","relatiesoort"],"type":"object","properties":{"accountmanager":{"type":"string","description":"accountmanager","nullable":true,"example":"accountManager"},"afdelingscode":{"minLength":1,"type":"string","description":"afdelingscode","example":"afdelingscode"},"email":{"minLength":1,"type":"string","description":"email","example":"ab@realworks.com"},"huisnummer":{"type":"string","description":"huisnummer","nullable":true,"example":"12"},"huisnummertoevoeging":{"type":"string","description":"huisnummertoevoeging","nullable":true,"example":"1"},"mobielTelefoonnummer":{"type":"string","description":"mobielTelefoonnummer","nullable":true,"example":"123-1331-122"},"postcode":{"type":"string","description":"postcode","nullable":true,"example":"112133"},"relatiesoort":{"minLength":1,"type":"string","description":"relatiesoort","example":"BEDRIJF","enum":["BEDRIJF, CONTACTPERSOON, PARTICULIER"]},"straat":{"type":"string","description":"straat","nullable":true},"telefoonnummer":{"type":"string","description":"telefoonnummer","nullable":true,"example":"123-1331-122"},"woonplaats":{"type":"string","description":"woonplaats","nullable":true}},"description":"Relatie create payload data"},"RelatieMedewerker":{"type":"object","properties":{"accountmanager":{"type":"string","description":"Publication Level: BASIS<br/>Accountmanager","nullable":true},"achternaam":{"type":"string","description":"Publication Level: BASIS<br/>Achternaam","nullable":true},"adresgegevens":{"$ref":"#/components/schemas/AdresgegevensMedewerker"},"bedrijfscode":{"type":"string","description":"Publication Level: BASIS<br/>Bedrijf, alle afdelingen vallen hieronder","nullable":true},"emailadressen":{"type":"array","description":"Publication Level: BASIS<br/>","nullable":true,"items":{"$ref":"#/components/schemas/Email"}},"geslacht":{"type":"string","description":"Publication Level: BASIS<br/>Geslacht","nullable":true,"enum":["MAN","VROUW","ONBEKEND"]},"id":{"type":"integer","description":"Publication Level: BASIS<br/>","format":"int32","nullable":true},"initialen":{"type":"string","description":"Publication Level: BASIS<br/>Initialen","nullable":true},"kenmerken":{"type":"array","description":"Publication Level: PLUS<br/>","nullable":true,"items":{"$ref":"#/components/schemas/Kenmerkreferentie"}},"overige":{"$ref":"#/components/schemas/OverigeMedewerker"},"relatiesoort":{"type":"string","description":"Publication Level: BASIS<br/>Soort relatie","nullable":true,"enum":["BEDRIJF","CONTACTPERSOON","PARTICULIER","MEDEWERKER"]},"relatietype":{"type":"string","description":"Publication Level: BASIS<br/>Type relatie","nullable":true},"roepnaam":{"type":"string","description":"Publication Level: BASIS<br/>Roepnaam","nullable":true},"telefoonnummers":{"type":"array","description":"Publication Level: BASIS<br/>","nullable":true,"items":{"$ref":"#/components/schemas/Telefoonnummer"}},"tijdstipLaatsteWijziging":{"type":"string","description":"Tijdstip van laatste wijziging. Dit geeft geen garantie dat er daadwerkelijk iets gewijzigd is, maar geeft slechts een mogelijke wijziging aan.","nullable":true,"example":"2007-12-03 10:15:30"},"titel":{"type":"string","description":"Publication Level: BASIS<br/>Titel","nullable":true},"tussenvoegsel":{"type":"string","description":"Publication Level: BASIS<br/>Tussenv.","nullable":true}}},"RelatieUpdatePayload":{"required":["afdelingscode","email","id","relatiesoort"],"type":"object","properties":{"accountmanager":{"type":"string","description":"accountmanager","nullable":true,"example":"accountManager"},"afdelingscode":{"minLength":1,"type":"string","description":"afdelingscode","example":"afdelingscode"},"email":{"minLength":1,"type":"string","description":"email","example":"ab@realworks.com"},"huisnummer":{"type":"string","description":"huisnummer","nullable":true,"example":"12"},"huisnummertoevoeging":{"type":"string","description":"huisnummertoevoeging","nullable":true,"example":"1"},"id":{"type":"integer","description":"id","format":"int32"},"mobielTelefoonnummer":{"type":"string","description":"mobielTelefoonnummer","nullable":true,"example":"123-1331-122"},"postcode":{"type":"string","description":"postcode","nullable":true,"example":"112133"},"relatiesoort":{"minLength":1,"type":"string","description":"relatiesoort","example":"BEDRIJF","enum":["BEDRIJF, CONTACTPERSOON, PARTICULIER"]},"straat":{"type":"string","description":"straat","nullable":true},"telefoonnummer":{"type":"string","description":"telefoonnummer","nullable":true,"example":"123-1331-122"},"woonplaats":{"type":"string","description":"woonplaats","nullable":true}},"description":"Relatie update payload data"},"SyncWritePathReply":{"type":"object","properties":{"entityId":{"type":"integer","description":"ID van de nieuw gemaakte/bijgewerkte entiteit","format":"int64","nullable":true},"entityKey":{"type":"string","description":"Key van de nieuw gemaakte/bijgewerkte entiteit","nullable":true},"entityType":{"type":"string","description":"Entiteitstype gemaakt/bijgewerkt","nullable":true},"foutmeldingen":{"type":"array","nullable":true,"items":{"type":"string"}},"ontvangstId":{"type":"string","description":"Identifier zoals mogelijk opgegeven door de client, anders gegenereerd. UUID-4"},"result":{"type":"string","enum":["OK","ERROR","EXCEPTION","IN_PROGRESS","WAITING_FOR_S3_UPLOAD"]}}},"Telefoonnummer":{"type":"object","properties":{"nummer":{"type":"string","description":"Publication Level: BASIS<br/>Geformateerde nummer","nullable":true},"type":{"type":"string","description":"Publication Level: BASIS<br/>Type (tel1, tel2, fax en mobile)","nullable":true}}},"ToekomstigAdres":{"type":"object","properties":{"toekomstigAdresFax":{"type":"string","description":"Publication Level: PLUS<br/>Toekomstig adres fax","nullable":true},"toekomstigAdresHuisnummer":{"type":"string","description":"Publication Level: PLUS<br/>Toekomstig adres huisnummer","nullable":true},"toekomstigAdresHuisnummertoevoeging":{"type":"string","description":"Publication Level: PLUS<br/>Toekomstig adres huisnummer toevoeging","nullable":true},"toekomstigAdresIngangsdatum":{"type":"string","description":"Publication Level: PLUS<br/>Toekomstig adres ingangsdatum","format":"date","nullable":true,"example":"2018-04-18"},"toekomstigAdresLand":{"type":"string","description":"Publication Level: PLUS<br/>Toekomstig adres land","nullable":true},"toekomstigAdresPlaats":{"type":"string","description":"Publication Level: PLUS<br/>Toekomstig adres woonplaats","nullable":true},"toekomstigAdresPostcode":{"type":"string","description":"Publication Level: PLUS<br/>Toekomstig adres postcode","nullable":true},"toekomstigAdresRegel1":{"type":"string","description":"Publication Level: PLUS<br/>Toekomstig adres adresregel 1","nullable":true},"toekomstigAdresRegel2":{"type":"string","description":"Publication Level: PLUS<br/>Toekomstig adres adresregel 2","nullable":true},"toekomstigAdresTelefoon":{"type":"string","description":"Publication Level: PLUS<br/>Toekomstig adres telefoon","nullable":true}},"nullable":true}},"securitySchemes":{"rwauth":{"in":"header","name":"Authorization","type":"apiKey"}}}}