{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"style":{"value":"none"}},"macroMetadata":{"macroId":{"value":"4df76c06-dadf-414a-b1dd-fa87a8afa672"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"b3ab3379-6644-43d3-9a5e-0b92549e33a6"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Audit","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Registratie","type":"text"}]},{"type":"paragraph"},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"1bc9ada3-86ed-4574-87b8-538da7266194","collection":"contentId-6118410708","type":"file"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: '3.0.0'\ninfo:\n title: Digitaal Vlaanderen - Audit Registratie legal logging\n description: |\n De registratie van legal log audit events\n\n # API Versies\n ## v0.10.2\n - veld operatie/tijdstipUitvoering kan nu met of zonder offset\n - de versie zonder offset is deprecated en wordt binnenkort niet meer ondersteund\n\n ## v0.10.1\n - veld registratie/clientid UUID formaat verwijderd uit definitie\n\n ## v0.10.0\n - [audit event model 0.9.4](https://vlaamseoverheid.atlassian.net/wiki/spaces/MDI/pages/6152421573/Legallog+-+Domeinmodel+v0.9.4)\n - registerclientId hernoemt naar clientId\n - OnderwerpsleutelType adresId en gebouwEenheid toegevoegd\n\n ## v0.9.5\n - [audit event model 0.9.3](https://vlaamseoverheid.atlassian.net/wiki/spaces/MDI/pages/6136266753/Legallog+-+Domeinmodel+v0.9.3)\n - x-tracing-id header toegevoegd\n\n ## v0.9.4\n - [audit event model 0.9.2](https://vlaamseoverheid.atlassian.net/wiki/spaces/MDI/pages/6135185492/Legallog+-+Domeinmodel+V0.9.2)\n - x-request-id header toegevoegd. \n - fixed server url voor private endpoints\n - 502 Bad gateway response verwijderd (niet relevant)\n - fixed dubbele definitie van probleem object\n - probleem type definitie nu volgens domein model 0.9.2\n - extra voorbeelden voor fout responses toegevoegd\n\n # Voorbereiding\n Om deze API te kunnen gebruiken moet voldaan zijn aan volgende voorwaarden:\n 1. Gebruiker heeft een asssymetrish sleutelpaar aangemaakt\n 2. Er is een nieuwe client geregistreerd in ACM/IDM samen met de public key van het zonet aangemaakt assymetrisch sleutelpaar.\n 3. Er is een registerClientId bepaald door de API beheerder\n\n # Authenticatie\n AuditEvents kunnen enkel geregistreerd worden met Client credentials. \n Hiervoor moet een ACM/IDM **accesstoken** toegevoegd worden aan de Authorization header.\n\n Een **accessToken** kan je aanmaken op volgende manier:\n\n 1. Creëer een [Json web signature](https://datatracker.ietf.org/doc/html/rfc7515) met de private key \n 2. Stuur een request naar het ACM token request endpoint\n 1. voeg het JWS token toe: client_assertion = JWS token\n 2. voeg de juiste scope toe: scope = **dv_audit_registration_write**\n\n ACM token endpoints:\n 1. voor T&I: https://authenticatie-ti.vlaanderen.be/op/v1/token\n 2. Voor productie: https://authenticatie.vlaanderen.be/op/v1/token\n\n Gebruik het **accessToken** vervolgens bij de registreer audit event operatie:\n - voeg de HTTP header \"authorization\" toe met daarin \"Bearer \" + het **accesstoken**\n - Je kan het token ook gebruiken via deze ui interface: kopieer het accesstoken dan in het Authorize veld. \n Zolang het accestoken geldig is, kan je het blijven gebruiken.\n\n contact:\n name: Team bouwstenen\n email: magda-teambouwstenen@vlaanderen.be\n version: '0.10.2'\nexternalDocs:\n description: 'Legal log service documentatie'\n url: 'https://vlaamseoverheid.atlassian.net/wiki/spaces/MDI/pages/6068013263/Legallog'\nservers:\n - url: 'https://iv.api.{omgeving}.be'\n description: publieke endpoints\n variables:\n omgeving:\n default: 'vlaanderen'\n enum:\n - \"test-vlaanderen\"\n - \"tni-vlaanderen\"\n - \"vlaanderen\"\n - url: 'https://gateway-magda-{omgeving}.apps.os-{infra-omgeving}.magda.cpc.vonet.be/api'\n description: private endpoints\n variables:\n omgeving:\n default: 'tni'\n enum:\n - \"dev\"\n - \"tst\"\n - \"tni\"\n - \"prd\"\n infra-omgeving:\n default: 'tni'\n enum:\n - \"dev\"\n - \"tni\"\n - \"prd\"\n - url: 'http://localhost:38080'\n description: 'local development server'\npaths:\n /audit/v1/registraties:\n post:\n tags:\n - Audit event registratie\n summary: Registreren van audit events\n security:\n - bearer_auth: [ ]\n operationId: audit_registraties_post\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/X-Correlation-Id'\n description: Referte (uuid) om meerdere request transacties te groeperen\n - name: x-tracing-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/X-Tracing-Id'\n description: Referte (uuid) om de request transactie end-to-end uniek te identificeren\n - name: x-request-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/X-Request-Id'\n description: Referte (uuid) om de http request uniek te identificeren\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/AuditEvent'\n required: true\n responses:\n '201':\n description: Created # het event is geregistreerd\n '400':\n description: Ongeldige data verzonden\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\n example:\n Probleem:\n titel: \"validatie fout\"\n status: \"400 Bad request\"\n detail: \"Het element ‘onderdeel’ is een verplicht veld maar ontbreekt.\"\n '401':\n description: Ongeldige authorisatie\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\n example:\n Probleem:\n titel: \"Geen authenticatie\"\n status: \"401 Unauthorized\"\n detail: \"Client heeft geen geldige authenticatie credentials\"\n '500':\n description: Onverwachte fout opgetreden.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\n example:\n Probleem:\n titel: \"Interne fout\"\n status: \"500 Internal server error\"\n detail: \"Een onderdeel van het systeem is onbeschikbaar. De operatie kan niet afgewerkt worden.\"\ncomponents:\n securitySchemes:\n bearer_auth:\n type: http\n scheme: bearer\n bearerFormat: JWS\n schemas:\n X-Correlation-Id:\n description: \"Unieke identificatie van meerdere request transacties die samen een business contect vormen.\"\n type: string\n format: uuid\n maxLength: 36\n example: 9151f21f-43ae-43b4-92f3-f4af67cdf544\n X-Tracing-Id:\n description: \"Unieke identificatie van één end-to-end request transactie.\"\n type: string\n format: uuid\n maxLength: 36\n example: 9151f21f-43ae-43b4-92f3-f4af67cdf544\n X-Request-Id:\n description: \"Unieke identificatie van de HTTP request.\"\n type: string\n format: uuid\n maxLength: 36\n example: 2ca541f2-3887-40a9-97a2-1acd89896be6\n AuditEvent:\n type: object\n properties:\n meta:\n type: object\n properties:\n onderwerpInOnderzoek:\n type: boolean\n default: false\n example:\n onderwerpInOnderzoek: false\n description: >-\n Geeft aan dat er voor het onderwerp van deze operatie een actief onderzoek door de dienst sociale inspectie bezig is.\n additionalProperties: false\n registratie:\n type: object\n properties:\n correlatieId:\n type: string\n format: uuid\n maxLength: 36\n description: >-\n Groepeert meerdere tracingid's onder één business context. Het systeem dat de logketting start, bepaalt dit correlatieid.\n example: 9151f21f-43ae-43b4-92f3-f4af67cdf544\n tracingId:\n type: string\n format: uuid\n maxLength: 36\n description: >-\n Het unieke transactieid van de operatie. Het systeem dat de logketting start, bepaalt dit transactieid.\n example: 9151f21f-43ae-43b4-92f3-f4af67cdf544\n requestId:\n type: string\n format: uuid\n maxLength: 36\n description: >-\n De unieke identificatie van het verstuurde request. Elke nieuwe call genereert een nieuw requestId\n example: 2ca541f2-3887-40a9-97a2-1acd89896be6\n clientId:\n type: string\n maxLength: 36\n description: >-\n De unieke identificatie van het systeem dat de inschrijving in het register uitvoert. Dit id wordt bepaald bij de onboarding van deze service en is een configuratie element van deze service m.a.w. dit id mag niet willekeurig bepaald worden.\n example: AuditRegister test client\n required:\n - correlatieId\n - tracingId\n - requestId\n - clientId\n additionalProperties: false\n description: Meta informatie over het systeem dat het audit event aanmaakt\n operatie:\n type: object\n properties:\n operatie:\n type: string\n maxLength: 256\n description: >-\n De uitgevoerde operatie op het onderwerp. Meestal is dit dan de dienst waarmee de vraag gesteld werd.\n example: GET / vastgoed/V1/aanvragen/123456789\n finaliteit:\n type: object\n properties:\n finaliteitId:\n type: string\n maxLength: 64\n description: >-\n Het doel waarom de operatie uitgevoerd en de informatie verwerkt werd.\n example: \"finaliteit xyz\"\n finaliteitType:\n type: string\n maxLength: 32\n enum:\n - BESCHRIJVING\n - IPDC\n description: >-\n Gebruikt type voor finaliteit.\n description: >-\n Het doel waarom de operatie uitgevoerd en de informatie verwerkt werd.\n additionalProperties: false\n example:\n finaliteitId: finaliteit xyz\n finaliteitType: BESCHRIJVING\n required:\n - finaliteitWaarde\n - finaliteitType\n tijdstipUitvoering:\n type: string\n format: date-time\n description: >-\n Datum/tijdstip wanneer de operatie uitgevoerd werd in het RFC3339 formaat. Opgelet: Deze versie werkt nog met en zonder offset, maar de versie zonder offset is deprecated en wordt verwijderd in de volgende versie.\n example: 2022-01-10T23:20:50.52123+02:00\n required:\n - operatie\n - finaliteit\n - tijdstipVanUitvoering\n additionalProperties: false\n description: De operatie die betrekking heeft op het onderwerp/onderwerpen van deze registratie\n uitvoerder:\n type: object\n properties:\n gebruiker:\n type: object\n properties:\n gebruikerId:\n type: string\n maxLength: 64\n description: >-\n Uniek identificatienummer van de natuurlijke persoon, op basis van een nationaal nummer of een andere persoonsidentificatie zoals bv. personeelsnummer of account.\n Formaat mag enkel getallen bevatten.\n example: '00000000097'\n gebruikerSleutelType:\n type: string\n maxLength: 32\n enum:\n - INSZ\n - GEBRUIKERSIDENTIFICATIE\n description: >-\n Gebruikt sleuteltype voor het gebruikerId.\n required:\n - gebruikerId\n - gebruikerSleutelType\n additionalProperties: false\n example:\n gebruikerId: 79100811546\n gebruikerSleutelType: INSZ\n description: >-\n De gebruiker (natuurlijk persoon) die de bevraging heeft uitgevoerd.\n organisatie:\n type: object\n properties:\n organisatieId:\n type: string\n maxLength: 256\n description: >-\n Uniek identificatienummer van de organisatie\n organisatieSleutelType:\n type: string\n maxLength: 32\n enum:\n - KBONUMMER\n - OVOCODE\n - ENTITEIT\n description: >-\n Gebruikt sleuteltype voor het organisatieId. Indien dit type geen KBONUMMEr of OVOCODE is, moet ENTITEIT gekozen worden.\n required:\n - organisatieId\n - organisatieSleutelType\n additionalProperties: false\n example:\n organisatieId: OVO002311\n organisatieSleutelType: OVOCODE\n description: >-\n De verwerkingsverantwoordelijke die de bevraging uitvoert.\n dataverwerker:\n type: object\n properties:\n dataverwerkerId:\n type: string\n maxLength: 256\n description: >-\n De unieke identificatie van de dataverwerker (organisatie) die de operatie heeft geïnitieerd.\n dataverwerkerSleutelType:\n type: string\n maxLength: 32\n enum:\n - KBONUMMER\n - OVOCODE\n - ENTITEIT\n description: >-\n Gebruikt sleuteltype voor het dataverwerkerId. Indien dit type geen KBONUMMEr of OVOCODE is, moet ENTITEIT gekozen worden.\n dataverwerkerSysteem:\n type: string\n maxLength: 256\n description: >-\n De unieke identificatie van het systeem dat gebruikt werd om de bevraging uit te voeren.\n required:\n - dataverwerkerId\n - dataverwerkerSleutelType\n - dataverwerkerSysteem\n additionalProperties: false\n example:\n dataverwerkerId: \"0425478919\"\n dataverwerkerSleutelType: KBONUMMER\n dataverwerkerSysteem: Fednot.IBOT.2.0.2\n description: >-\n De dataverwerker die de bevraging heeft uitgevoerd.\n required:\n - organisatie\n - dataverwerker\n additionalProperties: false\n description: >-\n De organisatie die de verwerkingsverantwoordelijke is van de operatie. Met dataverwerker wordt de client applicatie informatie meegegeven. Organisatie en dataverwerker kunnen dezelfde zijn.\n onderwerpen:\n type: array\n items:\n type: object\n properties:\n onderwerpId:\n type: string\n maxLength: 256\n description: >-\n Uniek identificatienummer van het onderwerp\n onderwerpSleutelType:\n type: string\n maxLength: 32\n enum:\n - INSZ\n - PERSOONSIDENTIFICATIE\n - CAPAKEY\n - NRPLAAT\n - KBONUMMER\n - GEBOUWEENHEID\n - ADRESID\n description: >-\n Gebruikt sleuteltype voor het onderwerpId.\n additionalProperties: false\n required:\n - onderwerpId\n - onderwerpSleutelType\n minItems: 1\n uniqueItems: true\n example:\n - onderwerpId: 70100811546\n onderwerpSleutelType: INSZ\n - onderwerpId: 78372910283\n onderwerpSleutelType: INSZ\n description: >-\n Over wie/wat werd de bevraging uitgevoerd\n informatie:\n type: array\n items:\n type: object\n properties:\n informatieWaarde:\n type: string\n maxLength: 256\n description: Waarde van het informatieveld.\n informatieType:\n type: string\n maxLength: 32\n description: Type van het informatieveld.\n additionalProperties: false\n example:\n - informatieType: CorrelatieIdBron\n informatieWaarde: 78d77a03-fd88-43e0-a438-5e51f795a62b\n description: Lijst van afnemerspecifieke legal informatie die niet is opgenomen in het standaard model.\n probleem:\n $ref: '#/components/schemas/Probleem'\n required:\n - registratie\n - operatie\n - uitvoerder\n - onderwerpen\n additionalProperties: false\n Probleem:\n description: \"Een representatie van een probleem\"\n required:\n - detail\n - titel\n - status\n type: object\n properties:\n titel:\n type: string\n maxLength: 128\n description: \"Een korte leesbare beschrijving van het probleem.\"\n example: \"validatie fout\"\n status:\n type: string\n maxLength: 64\n description: \"De HTTP status code van het probleem door de server gegenereerd.\"\n example: \"400 Bad request\"\n detail:\n type: string\n maxLength: 256\n description: \"Een leesbare beschrijving van het probleem met extra context.\"\n example: \"Het element ‘onderdeel’ is een verplicht maar ontbreekt.\""},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"3df322d8-4265-463c-9fb7-12c5e2bc729e"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"0d6cc098-169c-4f1d-bfe6-a2cabaa0dfcf"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Consultatie","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"920e5d21-999a-4111-a0da-aaac88941cd1","collection":"contentId-6118410708","type":"file"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: '3.0.0'\ninfo:\n title: Digitaal Vlaanderen - Audit Consultatie legal logging\n description: |\n De consultatie van legal log audit events\n\n # API Versies\n\n ## v0.19.0\n - Enum verwijderd bij de register parameter van het opvragen van de consultaties\n\n ## v0.18.0\n - 200 response in /lijsten/{type} wordt een array van strings\n\n ## v0.17.0\n - dataverwerkerSleutelType.COMMONNAME wordt dataverwerkerSleutelType.ENTITEIT\n - organisatieSleutelType.COMMONNAME wordt organisatieSleutelType.ENTITEIT\n\n ## v0.16.0\n - Enum voor type lijst is nu in hoofdletters\n\n ## v0.15.0\n - register is ook verplicht in POST /audit/V1/consultaties/rapporten\n\n ## v0.14.0\n - zoeken op gebruiker is nu mogelijk in GET /audit/v1/consultaties/registraties en POST /audit/V1/consultaties/rapporten\n - correctie van voorbeeld rijksregisternummer 000000-000-97 -> 00000000097 aangezien rijksregisternummers volledig numeriek moeten zijn\n - velden ivm paginatie die uitgecommentarieerd stonden zijn nu verwijderd\n - aanpassing link naar documentatie zodat deze dezelfde is als in de registratie openapi spec\n - fix endpoints in 'servers:' sectie\n\n ## v0.13.0\n - finaliteiten toegevoegd als zoekcriterium\n - register is verplicht in GET /audit/v1/consultaties/registraties\n - fix van voorbeelden voor header parameters die array waarde aannemen\n - zoeken op meerdere operaties is nu mogelijk\n\n ## v0.12.0\n - Initiële public release\n\n\n contact:\n name: Team bouwstenen\n email: magda-teambouwstenen@vlaanderen.be\n version: '0.19.0'\n\nexternalDocs:\n description: 'Legal log rapportering documentatie'\n url: 'https://vlaamseoverheid.atlassian.net/wiki/spaces/MDI/pages/6068013263/Legallog'\n\nservers:\n - url: 'https://iv.api.{omgeving}.be'\n description: publieke endpoints\n variables:\n omgeving:\n default: 'vlaanderen'\n enum:\n - \"test-vlaanderen\"\n - \"tni-vlaanderen\"\n - \"vlaanderen\"\n - url: 'https://gateway-magda-{omgeving}.apps.os-{infra-omgeving}.magda.cpc.vonet.be/api'\n description: private endpoints\n variables:\n omgeving:\n default: 'tni'\n enum:\n - \"dev\"\n - \"tst\"\n - \"tni\"\n - \"prd\"\n infra-omgeving:\n default: 'tni'\n enum:\n - \"dev\"\n - \"tni\"\n - \"prd\"\n - url: 'http://localhost:48080'\n description: 'local development server'\npaths:\n /audit/v1/consultaties/registraties:\n get:\n tags:\n - Bevragingen\n summary: Online bevraging van audit events\n operationId: audit_consultaties_get\n parameters:\n - $ref: '#/components/parameters/x-correlation-id'\n - $ref: '#/components/parameters/x-tracing-id'\n - $ref: '#/components/parameters/x-request-id'\n - name: register\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Register'\n description: Auditregister waarin gezocht moet worden.\n - name: correlatieId\n in: header\n schema:\n $ref: '#/components/schemas/X-Correlation-Id'\n description: Referte (uuid) om meerdere request transacties te groeperen.\n - name: tracingId\n in: header\n schema:\n $ref: '#/components/schemas/X-Tracing-Id'\n description: Referte (uuid) om de request transactie end-to-end uniek te identificeren.\n - name: finaliteiten\n in: header\n schema:\n type: array\n items:\n $ref: '#/components/schemas/finaliteitId'\n example: finaliteit1,finaliteit2\n description: Het doel waarom de operatie uitgevoerd en de informatie verwerkt werd.\n - name: operaties\n in: header\n schema:\n type: array\n items:\n $ref: '#/components/schemas/operatie'\n example: GET /vastgoed/V1/aanvragen,GET /vastgoed/v1/vergoedingen\n description: De uitgevoerde operatie op het onderwerp. Meestal is dit dan de dienst waarmee de vraag gesteld werd.\n - name: gebruikers\n in: header\n schema:\n type: array\n items:\n $ref: '#/components/schemas/gebruikerId'\n example: 79100811546,20080800141\n description: Uniek identificatienummer van de natuurlijke persoon, op basis van een nationaal nummer of een andere persoonsidentificatie zoals bv. personeelsnummer of account.\n - name: startDatum\n in: header\n schema:\n $ref: '#/components/schemas/dagUitvoering'\n description: datum vanaf wanneer auditevents opgevraagd worden\n example: 2022-01-10\n - name: eindDatum\n in: header\n schema:\n $ref: '#/components/schemas/dagUitvoering'\n description: datum tot wanneer auditevents opgevraagd worden\n example: 2022-01-20\n - name: onderwerpen\n in: header\n schema:\n type: array\n items:\n $ref: '#/components/schemas/onderwerpId'\n example: onderwerp1,onderwerp2\n description: Unieke identificatienummers van de onderwerpen.\n - name: organisaties\n in: header\n schema:\n type: array\n items:\n $ref: '#/components/schemas/organisatieId'\n example: organisatie1,organisatie2\n description: Unieke identificatienummers van de organisaties.\n - name: limit\n in: header\n description: \"Aantal resultaten dat moet teruggeven worden\"\n schema:\n type: integer\n default: 25\n minimum: 1\n maximum: 100\n - name: offset\n in: header\n description: \"De eerste positie van waar resultaten van de query gegeven worden.\"\n schema:\n type: integer\n default: 0\n minimum: 0\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: \"#/components/schemas/AuditEvents\"\n '400':\n description: Ongeldige data verzonden\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\n '401':\n description: Ongeldige authorisatie\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\n '500':\n description: Onverwachte fout opgetreden.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\n /audit/v1/consultaties/rapporten:\n parameters:\n - $ref: '#/components/parameters/x-correlation-id'\n - $ref: '#/components/parameters/x-tracing-id'\n - $ref: '#/components/parameters/x-request-id'\n - name: register\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Register'\n description: Auditregister waarin gezocht moet worden.\n - name: correlatieId\n in: header\n schema:\n $ref: '#/components/schemas/X-Correlation-Id'\n description: Referte (uuid) om meerdere request transacties te groeperen.\n - name: tracingId\n in: header\n schema:\n $ref: '#/components/schemas/X-Tracing-Id'\n description: Referte (uuid) om de request transactie end-to-end uniek te identificeren.\n - name: finaliteiten\n in: header\n schema:\n type: array\n items:\n $ref: '#/components/schemas/finaliteitId'\n example: finaliteit1,finaliteit2\n description: Het doel waarom de operatie uitgevoerd en de informatie verwerkt werd.\n - name: operaties\n in: header\n schema:\n type: array\n items:\n $ref: '#/components/schemas/operatie'\n example: GET /vastgoed/V1/aanvragen,GET /vastgoed/v1/vergoedingen\n description: De uitgevoerde operatie op het onderwerp. Meestal is dit dan de dienst waarmee de vraag gesteld werd.\n - name: gebruikers\n in: header\n schema:\n type: array\n items:\n $ref: '#/components/schemas/gebruikerId'\n example: 79100811546,20080800141\n description: Uniek identificatienummer van de natuurlijke persoon, op basis van een nationaal nummer of een andere persoonsidentificatie zoals bv. personeelsnummer of account.\n - name: startDatum\n in: header\n schema:\n $ref: '#/components/schemas/dagUitvoering'\n description: datum vanaf wanneer auditevents opgevraagd worden\n example: 2022-01-10\n - name: eindDatum\n in: header\n schema:\n $ref: '#/components/schemas/dagUitvoering'\n description: datum tot wanneer auditevents opgevraagd worden\n example: 2022-01-20\n - name: onderwerpen\n in: header\n schema:\n type: array\n items:\n $ref: '#/components/schemas/onderwerpId'\n example: onderwerp1,onderwerp2\n description: Unieke identificatienummers van de onderwerpen.\n - name: organisaties\n in: header\n schema:\n type: array\n items:\n $ref: '#/components/schemas/organisatieId'\n example: organisatie1,organisatie2\n description: Unieke identificatienummers van de organisaties.\n post:\n tags:\n - Rapporten\n summary: Aanvragen van een audit rapport\n operationId: audit_consultaties_post\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n $ref: \"#/components/schemas/Audit-Rapport-Id\"\n '400':\n description: Ongeldige data verzonden\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\n '401':\n description: Ongeldige authorisatie\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\n '500':\n description: Onverwachte fout opgetreden.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\n /audit/v1/consultaties/rapporten/{auditRapportId}:\n parameters:\n - name: auditRapportId\n in: path\n required: true\n schema:\n $ref: '#/components/schemas/Audit-Rapport-Id'\n - $ref: '#/components/parameters/x-correlation-id'\n - $ref: '#/components/parameters/x-tracing-id'\n - $ref: '#/components/parameters/x-request-id'\n get:\n tags:\n - Rapporten\n summary: Opvragen van een audit rapport\n operationId: audit_consultaties_async_get\n responses:\n '200':\n description: OK\n content:\n text/csv: { }\n '400':\n description: Ongeldige data verzonden\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\n '401':\n description: Ongeldige authorisatie\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\n '500':\n description: Onverwachte fout opgetreden.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\n /audit/v1/consultaties/lijsten/{type}:\n get:\n tags:\n - Lijsten\n summary: Consulteren van lijsten\n operationId: audit_consultaties_lijsten_get\n parameters:\n - $ref: '#/components/parameters/x-correlation-id'\n - $ref: '#/components/parameters/x-tracing-id'\n - $ref: '#/components/parameters/x-request-id'\n - name: type\n in: path\n required: true\n description: \"Type lijst dat moet teruggeven worden\"\n schema:\n type: string\n maxLength: 32\n enum:\n - FINALITEITEN\n - OPERATIES\n - REGISTERS\n responses:\n '200':\n description: OK\n content:\n application/json:\n schema:\n type: array\n items:\n type: string\n example: [ \"MAGDA Online\", \"VIP\" ]\n '400':\n description: Ongeldige data verzonden\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\n '401':\n description: Ongeldige authorisatie\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\n '500':\n description: Onverwachte fout opgetreden.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Probleem'\ncomponents:\n schemas:\n Consultatie-Filters:\n type: object\n properties:\n register:\n $ref: '#/components/schemas/Register'\n required: true\n correlatieId:\n $ref: '#/components/schemas/X-Correlation-Id'\n tracingId:\n $ref: '#/components/schemas/X-Tracing-Id'\n operaties:\n type: array\n items:\n $ref: '#/components/schemas/operatie'\n example: [ \"GET /vastgoed/V1/aanvragen\", \"GET /vastgoed/v1/vergoedingen\" ]\n finaliteiten:\n type: array\n items:\n $ref: '#/components/schemas/finaliteitId'\n example: [ \"finaliteit1\", \"finaliteit2\" ]\n gebruikers:\n type: array\n items:\n $ref: '#/components/schemas/gebruikerId'\n example: [ \"79100811546\", \"20080800141\" ]\n startDatum:\n allOf:\n - $ref: '#/components/schemas/dagUitvoering'\n - description: 'De eerste datum van de op te vragen audit records'\n eindDatum:\n allOf:\n - $ref: '#/components/schemas/dagUitvoering'\n - description: 'De laatste datum van de op te vragen audit records'\n onderwerpen:\n type: array\n items:\n $ref: '#/components/schemas/onderwerpId'\n description: Unieke identificatienummers van de onderwerpen.\n example: [ \"onderwerp1\",\"onderwerp2\" ]\n organisaties:\n type: array\n items:\n $ref: '#/components/schemas/organisatieId'\n description: Unieke identificatienummers van de organisaties.\n example: [ \"organisatie1\",\"organisatie2\" ]\n\n Audit-Rapport-Id:\n description: \"Unieke identificatie van een rapport\"\n type: string\n format: uuid\n maxLength: 36\n example: 9151f21f-43ae-43b4-92f3-f4af67cdf544\n X-Correlation-Id:\n description: \"Unieke identificatie van meerdere request transacties die samen een business context vormen.\"\n type: string\n format: uuid\n maxLength: 36\n example: 9151f21f-43ae-43b4-92f3-f4af67cdf544\n X-Tracing-Id:\n description: \"Unieke identificatie van één end-to-end request transactie.\"\n type: string\n format: uuid\n maxLength: 36\n example: 9151f21f-43ae-43b4-92f3-f4af67cdf544\n X-Request-Id:\n description: \"Unieke identificatie van de HTTP request.\"\n type: string\n format: uuid\n maxLength: 36\n example: 2ca541f2-3887-40a9-97a2-1acd89896be6\n clientId:\n type: string\n maxLength: 256\n description: De unieke identificatie van de applicatie die de inschrijving in het register uitvoert.\n example: vastgoedinformatie platform\n dagUitvoering:\n type: string\n format: date\n description: Datums waartussen de auditevents moeten liggen\n example: 2022-01-10\n tijdstipUitvoering:\n type: string\n format: date-time\n description: Datum/tijdstip wanneer de operatie uitgevoerd werd in het RFC3339 formaat.\n example: 2022-01-10T23:20:50.52Z\n operatie:\n type: string\n maxLength: 256\n description: De uitgevoerde operatie op het onderwerp. Meestal is dit dan de dienst waarmee de vraag gesteld werd.\n example: GET /vastgoed/V1/aanvragen/123456789\n metaData:\n type: object\n properties:\n resultset:\n type: object\n properties:\n count:\n type: integer\n format: int64\n description: \"Het totaal aantal gevonden resultaten\"\n minimum: 0\n example: 500\n offset:\n type: integer\n format: int64\n description: \"Het eerste element van deze pagina\"\n minimum: 0\n default: 0\n limit:\n type: integer\n format: int64\n description: \"Het maximaal aantal resultaten op deze pagina\"\n minimum: 1\n maximum: 100\n default: 25\n AuditEvents:\n type: object\n properties:\n metaData:\n $ref: '#/components/schemas/metaData'\n auditEvents:\n type: array\n items:\n $ref: '#/components/schemas/AuditEvent'\n\n Finaliteiten:\n type: array\n items:\n $ref: '#/components/schemas/Finaliteit'\n Operaties:\n type: array\n items:\n $ref: '#/components/schemas/operatie'\n Registers:\n type: array\n items:\n $ref: '#/components/schemas/Register'\n Register:\n type: string\n description: Het register waarin opgezocht moet worden. op te vragen met een /consultaties/lijsten/REGISTERS call.\n maxLength: 256\n example: VIP\n AuditEvent:\n type: object\n properties:\n meta:\n type: object\n properties:\n onderwerpInOnderzoek:\n type: boolean\n example:\n onderwerpInOnderzoek: false\n description: >-\n Geeft aan dat er voor het onderwerp van deze operatie een actief onderzoek door de dienst sociale inspectie bezig is.\n additionalProperties: false\n registratie:\n type: object\n properties:\n correlatieId:\n $ref: '#/components/schemas/X-Correlation-Id'\n tracingId:\n $ref: '#/components/schemas/X-Tracing-Id'\n requestId:\n $ref: '#/components/schemas/X-Request-Id'\n clientId:\n $ref: '#/components/schemas/clientId'\n required:\n - correlatieId\n - tracingId\n - requestId\n - clientId\n additionalProperties: false\n description: Meta informatie over het systeem dat het audit event aanmaakt\n operatie:\n type: object\n properties:\n operatie:\n $ref: '#/components/schemas/operatie'\n finaliteit:\n $ref: '#/components/schemas/Finaliteit'\n tijdstipUitvoering:\n $ref: '#/components/schemas/tijdstipUitvoering'\n required:\n - operatie\n - finaliteit\n - tijdstipUitvoering\n additionalProperties: false\n description: De operatie die betrekking heeft op het onderwerp/onderwerpen van deze registratie\n uitvoerder:\n type: object\n properties:\n gebruiker:\n $ref: '#/components/schemas/Gebruiker'\n organisatie:\n $ref: '#/components/schemas/Organisatie'\n dataverwerker:\n $ref: '#/components/schemas/Dataverwerker'\n required:\n - organisatie\n - dataverwerker\n additionalProperties: false\n description: >-\n De organisatie die de verwerkingsverantwoordelijke is van de operatie. Met dataverwerker wordt de client applicatie informatie meegegeven. Organisatie en dataverwerker kunnen dezelfde zijn.\n onderwerpen:\n type: array\n items:\n $ref: '#/components/schemas/Onderwerp'\n minItems: 1\n uniqueItems: true\n example:\n - onderwerpId: 70100811546\n onderwerpSleutelType: INSZ\n - onderwerpId: 720410623\n onderwerpSleutelType: INSZ\n description: >-\n Over wie/wat werd de bevraging uitgevoerd\n informatie:\n type: array\n items:\n $ref: '#/components/schemas/Informatie'\n description: Lijst van afnemerspecifieke legal informatie die niet is opgenomen in het standaard model.\n probleem:\n $ref: '#/components/schemas/Probleem'\n required:\n - registratie\n - operatie\n - uitvoerder\n - onderwerpen\n additionalProperties: false\n\n Gebruiker:\n type: object\n properties:\n gebruikerId:\n $ref: '#/components/schemas/gebruikerId'\n gebruikerSleutelType:\n $ref: '#/components/schemas/gebruikerSleutelType'\n required:\n - gebruikerId\n - gebruikerSleutelType\n additionalProperties: false\n example:\n gebruikerId: 79100811546\n gebruikerSleutelType: INSZ\n description: >-\n De gebruiker (natuurlijk persoon) die de bevraging heeft uitgevoerd.\n Organisatie:\n type: object\n properties:\n organisatieId:\n $ref: '#/components/schemas/organisatieId'\n organisatieSleutelType:\n $ref: '#/components/schemas/organisatieSleutelType'\n required:\n - organisatieId\n - organisatieSleutelType\n additionalProperties: false\n example:\n organisatieId: OVO002311\n organisatieSleutelType: OVOCODE\n description: >-\n De verwerkingsverantwoordelijke die de bevraging uitvoert.\n Dataverwerker:\n type: object\n properties:\n dataverwerkerId:\n $ref: '#/components/schemas/dataverwerkerId'\n dataverwerkerSleutelType:\n $ref: '#/components/schemas/dataverwerkerSleutelType'\n dataverwerkerSysteem:\n type: string\n maxLength: 256\n description: >-\n De unieke identificatie van het systeem dat gebruikt werd om de bevraging uit te voeren.\n required:\n - dataverwerkerId\n - dataverwerkerSleutelType\n - dataverwerkerSysteem\n additionalProperties: false\n example:\n dataVerwerkerId: 0425478919\n dataVerwerkerSleutelType: KBONUMMER\n dataVerwerkerSysteem: Fednot.IBOT.2.0.2\n description: >-\n De dataverwerker die de bevraging heeft uitgevoerd.\n Finaliteit:\n type: object\n properties:\n finaliteitId:\n $ref: '#/components/schemas/finaliteitId'\n finaliteitType:\n $ref: '#/components/schemas/finaliteitType'\n description: >-\n Het doel waarom de operatie uitgevoerd en de informatie verwerkt werd.\n additionalProperties: false\n example:\n finaliteitId: finaliteit xyz\n finaliteitType: BESCHRIJVING\n required:\n - finaliteitId\n - finaliteitType\n Onderwerp:\n type: object\n properties:\n onderwerpId:\n $ref: '#/components/schemas/onderwerpId'\n onderwerpSleutelType:\n $ref: '#/components/schemas/onderwerpSleutelType'\n additionalProperties: false\n required:\n - onderwerpId\n - onderwerpSleutelType\n Informatie:\n type: object\n properties:\n informatieWaarde:\n $ref: '#/components/schemas/informatieWaarde'\n informatieType:\n $ref: '#/components/schemas/informatieType'\n additionalProperties: false\n example:\n - informatieType: CorrelatieIdBron\n informatieWaarde: 78d77a03-fd88-43e0-a438-5e51f795a62b\n Probleem:\n required:\n - detail\n - titel\n - status\n type: object\n properties:\n type:\n type: string\n description: \"Een URI referentie dat het probleem type identificeerd\"\n titel:\n type: string\n description: \"Een korte leesbare beschrijving van het probleem.\"\n status:\n type: string\n description: \"De HTTP status code van het probleem door de server gegenereerd.\"\n detail:\n type: string\n description: \"Een leesbare beschrijving van het probleem met extra context.\"\n instance:\n type: string\n description: \"Een URI referentie naar de specifieke geval.\"\n description: Een representatie van een probleem bericht\"\n\n onderwerpSleutelType:\n type: string\n maxLength: 32\n enum:\n - INSZ\n - PERSOONSIDENTIFICATIE\n - CAPAKEY\n - NRPLAAT\n - KBONUMMER\n description: Gebruikt sleuteltype voor het onderwerpId.\n onderwerpId:\n type: string\n maxLength: 256\n description: Uniek identificatienummer van het onderwerp\n informatieType:\n type: string\n maxLength: 32\n description: Type van het informatieveld.\n informatieWaarde:\n type: string\n maxLength: 256\n description: Waarde van het informatieveld.\n gebruikerSleutelType:\n type: string\n maxLength: 32\n enum:\n - INSZ\n - GEBRUIKERSIDENTIFICATIE\n description: Gebruikt sleuteltype voor het gebruikerId.\n gebruikerId:\n type: string\n maxLength: 64\n description: Uniek identificatienummer van de natuurlijke persoon, op basis van een nationaal nummer of een andere persoonsidentificatie zoals bv. personeelsnummer of account.\n example: '00000000097'\n dataverwerkerSleutelType:\n type: string\n maxLength: 32\n enum:\n - KBONUMMER\n - OVOCODE\n - ENTITEIT\n description: Gebruikt sleuteltype voor het dataverwerkerId.\n dataverwerkerId:\n type: string\n maxLength: 256\n description: De unieke identificatie van de dataverwerker (organisatie) die de operatie heeft geïnitieerd.\n organisatieSleutelType:\n type: string\n maxLength: 32\n enum:\n - KBONUMMER\n - OVOCODE\n - ENTITEIT\n description: Gebruikt sleuteltype voor het organisatieId.\n organisatieId:\n type: string\n maxLength: 256\n description: Uniek identificatienummer van de organisatie\n finaliteitId:\n type: string\n maxLength: 64\n description: Het doel waarom de operatie uitgevoerd en de informatie verwerkt werd.\n example: \"finaliteit xyz\"\n finaliteitType:\n type: string\n maxLength: 32\n enum:\n - BESCHRIJVING\n - IPDC\n description: Gebruikt type voor finaliteit.\n probleemStatus:\n type: string\n maxLength: 64\n description: statuscode die een duiding geeft van het type probleem\n parameters:\n x-correlation-id:\n name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/X-Correlation-Id'\n description: Referte (uuid) om meerdere request transacties te groeperen\n x-tracing-id:\n name: x-tracing-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/X-Tracing-Id'\n description: Referte (uuid) om de request transactie end-to-end uniek te identificeren\n x-request-id:\n name: x-request-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/X-Request-Id'\n description: Referte (uuid) om de http request uniek te identificeren\n"},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"76d09489-14b7-4138-b2ef-4b062697ca3b"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"2795fb1f-8133-4c32-8776-05a93475681d"}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"LED","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"549317b0-d5fc-4de7-aa0c-69d95bc1878f","collection":"contentId-6118410708","type":"file"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"---\nopenapi: 3.0.2\ninfo:\n title: Digitaal Vlaanderen - Bewijzen\n description: Deze RESTful API is ontwikkeld om leerbewijzen te registreren in LED.\n version: 1.0.0\nservers:\n - url: /api/v1/led\npaths:\n /bewijzen/bewijzenMetControle:\n post:\n tags:\n - Bewijzen\n parameters:\n - in: header\n name: x-correlation-id\n schema:\n type: string\n format: uuid\n required: true\n summary: Aanmaken van een nieuw bewijs met controle\n description: Aanmaken van een nieuw bewijs dat na controle en aanvulling door Automatisch advies doorgestuurd wordt naar de LED.\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Bewijs-Met-Controle-Request'\n required: true\n responses:\n 200:\n description: Correcte verwerking bij AA - Het bewijs is niet geregistreerd bij LED\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Bewijs-Met-Controle-Instance-Data'\n 201:\n description: Correcte verwerking bij AA - Het bewijs is wel geregistreerd bij LED\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Bewijs-Met-Controle-Instance-Data'\n 400:\n description: Ongeldige data in de request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n 401:\n description: Unauthorized\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n /bewijzen/bewijzenMetadata:\n post:\n tags:\n - Bewijzen\n parameters:\n - in: header\n name: x-correlation-id\n schema:\n type: string\n format: uuid\n required: true\n summary: Ophalen van metadata voor bepaalde instatie\n description: Met deze call kan op basis van de instatieId en instatieDoelgroep informatie over de bewijzen die de instatie mogelijk kan uitreiken worden opgehaald. Indien de instatie gekend is maar er zijn op de moment van opvraging geen bewijzen gekend die deze kan uitreiken wordt een lege lijst van bewijzen teruggegeven. Indien de instatie ongekend is wordt de error code 404 Not found teruggegeven.\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Bewijzen-Metadata-Request'\n required: true\n responses:\n 201:\n description: Success - new dossier created in Automatic Advice\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Bewijzen-Metadata-Response'\n 400:\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n 401:\n description: Unauthorized\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n 404:\n description: Not found\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n /bewijzen/bewijzenMetControle/{id}:\n get:\n tags:\n - Bewijzen\n summary: Ophalen status van de registratie van een nieuw bewijs\n description: Met deze call kan op basis van de id die bij de POST werd verkregen de status van de verwerking van een registratie worden opgehaald. Enkel van toepassing in het asynchrone scenario.\n parameters:\n - name: id\n in: path\n description: ID die teruggegeven werd in de registratie\n required: true\n schema:\n type: string\n - in: header\n name: x-correlation-id\n schema:\n type: string\n format: uuid\n required: true\n responses:\n 200:\n description: Success, the response body will contain the instance data\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Bewijs-Met-Controle-Instance-Data'\n 404:\n description: Not Found\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n delete:\n tags:\n - Bewijzen\n summary: Verwijderen van een registratie uit automatisch advies\n description: Verwijderen van een registratie uit automatisch advies. Opgelet, dit verwijderd de registratie enkel uit Automatisch advies niet uit de LED. Enkel van toepassing in het asynchrone scenario. Na 8 uur wordt deze verwijdering automatisch uitgevoerd.\n parameters:\n - name: id\n in: path\n description: ID die teruggegeven werd in de registratie\n required: true\n schema:\n type: string\n - in: header\n name: x-correlation-id\n schema:\n type: string\n format: uuid\n required: true\n responses:\n 204:\n description: Success - the instance is completely deleted\n 404:\n description: Not Found\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n\ncomponents:\n schemas:\n Bewijzen-Metadata-Request:\n description: Root for Bewijzen-Metadata-Request\n type: object\n required:\n - instantieId\n - instantieDoelgroep\n properties:\n instantieId:\n type: string\n instantieDoelgroep:\n type: string\n Bewijzen-Metadata-Response:\n description: Root for Bewijzen-Metadata-Response\n type: object\n properties:\n instantieId:\n type: string\n instantieDoelgroep:\n type: string\n instellingNaam:\n type: string\n bewijzen:\n type: array\n items:\n $ref: '#/components/schemas/Bewijzen'\n Bewijzen:\n description: Root for Bewijzen\n type: object\n properties:\n volledigeNaam:\n type: string\n studierichtingNaam:\n type: string\n periodes:\n type: array\n items:\n $ref: '#/components/schemas/Periodes'\n leverancierNaam:\n type: string\n certificaatCheck:\n type: boolean\n Periodes:\n properties:\n geldigVanaf:\n type: string\n format: date\n geldigTem:\n type: string\n format: date\n Bewijs-Met-Controle-Request:\n description: Root for Bewijs-Met-Controle-Request\n type: object\n required:\n - insz\n - instantieId\n - instantieDoelgroep\n - referte\n - uitreikingsdatum\n - volledigeNaam\n properties:\n referte:\n type: string\n naamLeverancier:\n type: string\n insz:\n type: string\n instantieId:\n type: string\n instantieDoelgroep:\n type: string\n enum: [\"EA\", \"GID\", \"LB\", \"OV\"]\n uitreikingsdatum:\n type: string\n format: date\n volledigeNaam:\n type: string\n instellingNaam:\n type: string\n instellingNummer:\n type: string\n specialisatieNaam:\n type: string\n specialisatieCode:\n type: string\n detailOnderwerpNaam:\n type: string\n detailOnderwerpCode:\n type: string\n urenVolwassenOnderwijs:\n type: string\n alternatieveInstanties:\n type: array\n items:\n $ref: '#/components/schemas/Alternatieve-Instanties'\n bijkomendeInformatie:\n type: array\n items:\n $ref: '#/components/schemas/Bijkomende-Informatie'\n Alternatieve-Instanties:\n description: Root for Alternatieve-Instanties\n type: object\n properties:\n instellingsrol:\n type: string\n naam:\n type: string\n Bijkomende-Informatie:\n description: Root for Bijkomende-Informatie\n type: object\n properties:\n naam:\n type: string\n inhoud:\n type: string\n Bewijs-Met-Controle-Instance-Data:\n title: Root Type for bewijzenmetcontrole\n description: The root of the bewijzenmetcontrole type's schema.\n type: object\n properties:\n advice:\n type: string\n type:\n type: string\n correlationId:\n type: string\n details:\n type: string\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: A URI reference that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be \"about:blank\".\n title:\n type: string\n description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.\n status:\n type: string\n description: The HTTP status code generated by the origin server for this occurrence of the problem.\n detail:\n type: string\n description: A human-readable explanation specific to this occurrence of the problem.\n instance:\n type: string\n description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n description: A representation of a generic error message"},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"e6441771-11c0-4617-b9f9-be7847d8875d"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"bd2056b2-6c6b-4fbb-b7ee-37756eddd746"}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Milieu","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"472e5feb-1311-4d17-ba76-cac631d28e5b","collection":"contentId-6118410708","type":"file"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: \"3.0.2\"\ninfo:\n title: \"Asbestattesten\"\n description: \"Deze dienst maakt het mogelijk om asbestattesten op te vragen uit het asbestinventatris bij OVAM\"\n contact:\n name: \"Magda helpdesk\"\n url: \"https://overheid.vlaanderen.be/magda\"\n license:\n name: \"Asbestinventaris\"\n url: \"https://overheid.vlaanderen.be/magda\"\n version: \"1.0.0\"\nservers:\n - url: \"api/v1/milieu\"\npaths:\n /attesten/asbestattesten/gebouweenheden/{gebouweenheidId}:\n get:\n tags:\n - \"asbestattesten\"\n summary: \"Het asbestId opbragen op basis van de gebouweenheidsId\"\n parameters:\n - name: gebouweenheidId\n in: path\n required: true\n description: \"Id van de gebouweenheid waarvoor gegevens opgevraagd worden\"\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: \"Response met inhoud\"\n content:\n application/json:\n schema:\n $ref: \"#/components/schemas/GebouwEenheidSummary\"\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n /attesten/asbestattesten/{asbestinventarisId}:\n get:\n tags:\n - \"asbestattesten\"\n summary: \"details van een attest opvragen in JSON formaat\"\n parameters:\n - name: asbestinventarisId\n in: path\n required: true\n description: \"Id van de asbestinventaris waarvoor gegevens opgevraagd worden\"\n schema:\n type: string\n format: uuid\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: \"Response met inhoud in JSON formaat van een asbestattest\"\n content:\n application/json:\n schema:\n $ref: \"#/components/schemas/Asbestinventaris\"\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n /attesten/asbestattesten/{asbestinventarisId}/attest:\n get:\n tags:\n - \"asbestattesten\"\n summary: \"het attest opvragen in PDF formaat\"\n parameters:\n - name: asbestinventarisId\n in: path\n required: true\n description: \"Id van de asbestinventaris waarvoor het attest opgevraagd wordt\"\n schema:\n type: string\n format: uuid\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: \"Het pdf attest horende bij de asbestinventaris\"\n content:\n application/pdf:\n schema:\n type: string\n format: binary\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n \n /attesten/asbestattesten:\n get:\n tags:\n - \"asbestattesten\"\n summary: \"Zoek inventarissen\"\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: geowkt\n in: query\n description: \"Geometrie waarbinnen asbestinventarissen worden gezocht. Geeft alle resultaten die voor meer dan 5% binnen de geometrie liggen. Coördinatensysteem (`crs`) is verplicht.\"\n schema:\n type: string\n example: POLYGON((154986.030215235 190913.00871922178,154987.5279744013 190914.9131133676,154989.21246565756 190913.72696459584,154987.87177998378 190911.86510712252,154986.030215235 190913.00871922178))\n - name: crs\n in: query\n description: \"Coördinatensysteem van `geowkt` waarbinnen asbestinventarissen worden gezocht\"\n schema:\n type: string\n example: \"EPSG:31370\"\n - name: gemeentecode\n in: query\n description: \"Gemeentecode van het perceel van de asbestinventaris. `afdelingscode`, `sectiecode`, `perceelnummer` zijn ook vereist.\"\n schema:\n type: string\n example: \"44040\"\n - name: afdelingcode\n in: query\n description: \"Afdelingscode van het perceel van de asbestinventaris. `gemeentecode`, `sectiecode`, `perceelnummer` zijn ook vereist.\"\n schema:\n type: string\n example: \"44040\"\n - name: sectiecode\n in: query\n description: \"Sectiecode van het perceel van de asbestinventaris. `gemeentecode`, `afdelingscode`, `perceelnummer` zijn ook vereist.\"\n schema:\n type: string\n example: \"A\"\n - name: perceelnummer\n in: query\n description: \"Perceelnummer van het perceel van de asbestinventaris.`gemeentecode`, `afdelingscode`, `sectiecode` zijn ook vereist.\"\n schema:\n type: string\n example: \"0297/00K000\"\n - name: gemeentenaam\n in: query\n description: \"Gemeentenaam van het adres van de asbestinventaris. `postcode`, `straatnaam`, `huisnummer` zijn ook vereist.\"\n schema:\n type: string\n - name: postcode\n in: query\n description: \"Postcode van het adres van de asbestinventaris. `gemeentenaam`, `straatnaam`, `huisnummer` zijn ook vereist.\"\n schema:\n type: string\n - name: straatnaam\n in: query\n description: \"Straatnaam van het adres van de asbestinventaris. `gemeentenaam`, `postcode`, `huisnummer` zijn ook vereist.\"\n schema:\n type: string\n - name: huisnummer\n in: query\n description: \"Huisnummer van het adres van de asbestinventaris. `gemeentenaam`, `postcode`, `straatnaam` zijn ook vereist.\"\n schema:\n type: string\n - name: busnummer\n in: query\n description: \"Busnummers van het adres van de asbestinventaris. Optionele parameter. Als het ingevuld is, zijn `gemeentenaam`,`postcode`, `straatnaam`, `huisnummer` ook vereist.\"\n schema:\n type: array\n items:\n type: string\n example:\n - \"001\"\n - \"002\"\n - \"003\"\n - name: vbradresid\n in: query\n description: \"VBR adres ID van de asbestinventaris\"\n schema:\n type: string\n example: \"https://data.vlaanderen.be/id/adres/16256079\"\n responses:\n 200:\n description: \"Alle overeenkomstige inventarissen.\"\n content:\n application/json:\n schema:\n $ref: \"#/components/schemas/Asbestinventarissen\"\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n /attesten/asbestattesten/analyserapport/{analyseRapportId}:\n get:\n tags:\n - \"asbestattesten\"\n summary: \"Download een analyserapport\"\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: analyseRapportId\n in: path\n required: true\n description: \"Id van het analyserapport\"\n schema:\n type: string\n format: uuid\n responses:\n 200:\n description: \"Een analyserapport in pdf dat geüpload werd door de deskundige\"\n content:\n application/pdf:\n schema:\n type: string\n format: binary\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\ncomponents:\n parameters:\n CorrelationId:\n name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n #HTTP Status 400\n BadRequest:\n description: \"Invalid data supplied\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 401\n InvalidAuthorization:\n description: \"Invalid authorization\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 403\n Forbidden:\n description: \"Authentication failed\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 404\n NotFound:\n description: \"Resource not found\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 412\n PreConditionFailed:\n description: Precondition Failed\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 500\n UnexpectedServerError:\n description: \"Unexpected Server Error\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 502\n BadGateway:\n description: \"Bad Gateway\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 503\n ServiceUnavailable:\n description: \"Service unavailable\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 504\n GatewayTimeout:\n description: \"Gateway Timeout\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n schemas:\n Correlation-Id:\n description: \"ID of the transaction. Use this ID for log tracing and incident handling\"\n type: string\n minLength: 10\n maxLength: 36\n\n GebouwEenheidSummary:\n description: \"Beschrijving van de gebouweenheid zoals gekend binnen de asbestinventaris applicatie\"\n properties:\n inventarissen:\n type: array\n items:\n type: object\n properties:\n id:\n type: string\n format: uuid\n\n Asbestinventarissen:\n description: \"Overzicht van de overeenkomstige asbestinventarissen zoals gekend binnen de asbestinventaris applicatie\"\n properties:\n inventarissen:\n $ref: '#/components/schemas/Inventarissen'\n\n Inventarissen:\n type: array\n items:\n type: object\n properties:\n id:\n type: string\n format: uuid\n\n Asbestinventaris:\n description: \"Details van een inventaris\"\n type: object\n properties:\n id:\n type: string\n format: uuid\n attestNummer:\n type: string\n locatieBeschrijving:\n type: string\n description: \"Betreft slechts een indicatie van de locatie. Het bevat niet de officiële locatiegegevens van de overheid\"\n resultaat:\n type: string\n aanleiding:\n type: string\n gemeenschappelijkDeel:\n type: boolean\n gemeenschappelijkeDelen:\n type: array\n items:\n $ref: '#/components/schemas/GemeenschappelijkDeel'\n analyseRapporten:\n type: array\n items:\n $ref: '#/components/schemas/AnalyseRapport'\n uitgegevenOp:\n type: string\n format: date\n geldigTot:\n type: string\n format: date\n attest:\n type: object\n properties:\n id:\n type: string\n format: uuid\n aantalAsbestmaterialen:\n type: integer\n aantalBeperkingen:\n type: integer\n aantalUitsluitingen:\n type: integer\n asbestmaterialen:\n type: array\n items:\n $ref: '#/components/schemas/Asbestmateriaal'\n\n GemeenschappelijkDeel:\n description: 'Identificator naar het gemeenschappelijk deel'\n type: object\n properties:\n type:\n type: string\n id:\n type: string\n format: uuid\n\n AnalyseRapport:\n description: 'Identificator naar het analyse rapport'\n type: object\n properties:\n type:\n type: string\n id:\n type: string\n format: uuid\n\n Asbestmateriaal:\n description: 'Identificator naar het asbestmateriaal'\n type: object\n properties:\n type:\n type: string\n id:\n type: string\n format: uuid\n\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: \"A URI reference that identifies the problem type. This specification encourages that, when de-referenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be about:blank.\"\n title:\n type: string\n description: \"A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.\"\n status:\n type: string\n description: \"The HTTP status code generated by the origin server for this occurrence of the problem.\"\n detail:\n type: string\n description: \"A human-readable explanation specific to this occurrence of the problem.\"\n instance:\n type: string\n description: \"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if de-referenced.\"\n description: \"A representation of a generic error message.\""},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"52bb829b-0615-44b9-8503-d136071bc70c"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"e12ebc10-dd3c-4784-92ee-b21d995705b9"}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Mobility","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"0f3b2159-d6dc-4061-9984-78c2e8d216d1","collection":"contentId-6118410708","type":"file"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken van crossborderRegistration"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: 3.0.3\ninfo:\n title: Expose Data DIV - Crossborder Registrations Service\n description: This RESTful API is designed to query foreign plate registrations data including license, certificate, titular and vehicle. The request will occur based on a country code, a plate number and optionally a date. Release date August 2020.\n contact:\n name: crossBoarderAPI\n email: helpdesk.magda@vlaanderen.be\n license:\n name: crossBoarderAPI\n url: https://overheid.vlaanderen.be/magda\n version: '1.1'\nservers:\n - url: /api/v1/mobility\ntags:\n - name: Mobility\npaths:\n /crossborderRegistrations:\n get:\n tags:\n - Operations for consultation of crossborder registration data\n summary: Query registration crossborder registration data.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Magda-Enduser-ID\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Enduser-Id'\n - name: countryCode\n in: query\n description: The country requested data from.\n required: true\n schema:\n type: string\n - name: plateNr1\n in: query\n description: The plate number part-1.\n required: true\n schema:\n type: string\n - name: plateNr2\n in: query\n description: The plate number part-2.\n required: false\n schema:\n type: string\n - name: dateTime\n in: query\n description: The date for which the data is requested. When not specified, the default will be the current date and time.\n required: false\n schema:\n type: string\n format: date-time\n - name: dataScope\n in: query\n description: Allows to request a smaller data-scope. The default is 'all'. Other options are 'vehicle' and 'titular'\n required: false\n schema:\n $ref: '#/components/schemas/DataScope'\n responses:\n '200':\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Response'\n '204':\n description: No result found.\n '400':\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '401':\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '404':\n description: No data found for the requested parameters.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '500':\n description: An unexpected error occurred.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '502':\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '503':\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '504':\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\ncomponents:\n schemas:\n Response:\n type: object\n description: The object containing the result\n properties:\n '@context':\n type: string\n default: 'https://vlaamseoverheid.atlassian.net/wiki/download/attachments/1693680273/Mobility-context.jsonld'\n self:\n type: string\n description: Link to this request.\n items:\n type: array\n description: An array of crossborderTitular objects.\n items:\n $ref: '#/components/schemas/CrossborderRegistration'\n Correlation-Id:\n description: \"ID of the transaction. Use this ID for log tracing and incident handling.\"\n type: string\n maxLength: 36\n minLength: 10\n Enduser-Id:\n description: \"Reference to the user that triggerd the request.\"\n type: string\n LangString:\n type: object\n description: String with a language attribute\n properties:\n string:\n type: string\n lang:\n type: string\n DataScope:\n type: string\n description: Allows to request a smaller data-scope. The default is 'all'. Other options are 'vehicle' and 'titular'\n enum:\n - vehicle\n - titular\n - all\n identificator:\n type: object\n description: OSLO object representing an identification element\n properties:\n identificator:\n type: string\n OrganisationType:\n type: object\n properties:\n '@type':\n type: string\n default: http://www.w3.org/ns/regorg#orgType\n code:\n type: string\n description: The type of the organisation as defined in the specified country.\n description:\n type: string\n description: The company type description.\n LegalEntity:\n type: object\n properties:\n '@type':\n type: string\n default: http://www.w3.org/ns/regorg#RegisteredOrganization\n code:\n type: string\n description: The legal entity of the company as defined in the specified country.\n description:\n type: string\n description: The company legel type description.\n CrossborderRegistration:\n description: The crossborder registration object.\n type: object\n properties:\n license:\n $ref: '#/components/schemas/License'\n vehicle:\n $ref: '#/components/schemas/Vehicle'\n\n License:\n type: object\n description: The crossborer Titular object\n properties:\n '@id':\n type: string\n description: 'should be generated of the form _:XXX'\n '@type':\n type: string\n description: 'the type of the titular'\n default: 'http://purl.org/dc/terms/Agent'\n type:\n type: string\n description: Indication whether the registration is for a natural person or a moral person/organization.\n person:\n type: object\n description: Person object - only available in case the titular-type is a natural person.\n properties:\n '@id':\n type: string\n description: OSLO Id reference to the Titular object; should be the same value as the titular\n '@type':\n type: string\n description: Indicates that it is a person\n default: http://www.w3.org/ns/person#Person\n lastName:\n description: The last name(s) of the person\n type: array\n items:\n type: string\n firstName:\n description: The first name(s) of the person\n type: array\n items:\n type: string\n organisation:\n type: object\n description: Organisation object only available in case the titular-type is a moral person (organisation).\n properties:\n '@id':\n type: string\n description: OSLO Id reference to the Titular object; should be the same value as the titular @id\n '@type':\n type: string\n description: indicates that it is an organisation\n default: 'http://www.w3.org/ns/org#Organization'\n companyNr:\n $ref: '#/components/schemas/identificator'\n organisationName:\n $ref: '#/components/schemas/LangString'\n organisationType:\n $ref: '#/components/schemas/OrganisationType'\n legalEntity:\n $ref: '#/components/schemas/LegalEntity'\n careOfName:\n type: string\n description: This element is present when the address provided, is a c/o address (care of), i.e. the vehicle holder receives its mail at the address of another person or a company. The element contains the name of the person or company associated with the address.\n registrationLanguageCode:\n type: string\n description: The language code of the registration documents, issued to the holder or owner.\n contactInfo:\n type: object\n description: In OSLO the Address is linked the Agents through the contactInfo\n properties:\n '@type':\n type: string\n description: the contactinfo is of type contactInfo\n default: https://schema.org/ContactPoint\n address:\n type: object\n properties:\n '@type':\n type: string\n description: Address info of the contact address\n default: http://www.w3.org/ns/locn#Address\n streetName:\n $ref: '#/components/schemas/LangString'\n houseNumber:\n type: string\n description: Housenumber of the address.\n box:\n type: string\n description: POBox number of the address.\n postalCode:\n type: string\n description: Postalcode of the address.\n cityName:\n $ref: '#/components/schemas/LangString'\n countryName:\n $ref: '#/components/schemas/LangString'\n countryISO:\n type: string\n description: Country code\n printableLine:\n type: array\n description: The address printable line(s).\n items:\n type: string\n\n\n Vehicle:\n type: object\n properties:\n category:\n type: object\n properties:\n code:\n type: string\n description: >-\n European category code. This entry is used to give the\n information about the type approval which is stated on\n the COC. Despite of the different ApprovalNumber it is\n needed to identify these approvals in an easy way.\n engine:\n items:\n type: object\n properties:\n fuel:\n items:\n type: object\n properties:\n maximumNetPower:\n type: number\n description: Maximum net power for combustion engine.\n format: float\n exhaustEmissionLevelEuro:\n type: string\n description: Exhaust emission level Euro (called Euronorm)\n description: >-\n Object containing specific vehicle technical engine\n specifications\n type: array\n description: Array containing vehicle engine fuel(s) specifications\n description: >-\n Object containing specific vehicle technical engine\n specifications\n type: array\n description: Array containing vehicle engine(s) specifications\n technicPermissibleMaxMass:\n type: number\n description: Maximum permissible mass of the vehicle.\n format: int32\n firstRegistrationDate:\n type: string\n description: >-\n The first registration date of the vehicle (the first time a\n plate was assigned to it). \n format: date\n description: The crossborder vehicle object.\n\n\n\n\n\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: A URI reference that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be \"about:blank\".\n title:\n type: string\n description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.\n status:\n type: string\n description: The HTTP status code generated by the origin server for this occurrence of the problem.\n detail:\n type: string\n description: A human-readable explanation specific to this occurrence of the problem.\n instance:\n type: string\n description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n description: A representation of a generic error message"},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"0406c51e-2b9a-4487-a5d5-c7452139d7cb"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"7ce0af65-0b1b-4a5e-81ce-2097ac87b4f3"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken van crossborderTitulars"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: 3.0.3\ninfo:\n title: Expose Data DIV - Crossborder Titular Service\n description: This RESTful API is designed to query foreign plate titular data (persons and organizations). The request will occur based on a country code, a plate number and optionally a date. Release date August 2020.\n contact:\n name: crossBoarderAPI\n email: helpdesk.magda@vlaanderen.be\n license:\n name: crossBoarderAPI\n url: https://overheid.vlaanderen.be/magda\n version: '1.1'\nservers:\n - url: /api/v1/mobility\ntags:\n - name: Mobility\npaths:\n /crossborderTitulars:\n get:\n tags:\n - Operations for consultation of crossborder titular data\n summary: Query registration crossborder titular data.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Magda-Enduser-ID\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Enduser-Id'\n - name: countryCode\n in: query\n description: The country requested data from.\n required: true\n schema:\n type: string\n - name: plateNr1\n in: query\n description: The plate number part-1.\n required: true\n schema:\n type: string\n - name: plateNr2\n in: query\n description: The plate number part-2.\n required: false\n schema:\n type: string\n - name: dateTime\n in: query\n description: The date for which the data is requested. When not specified, the default will be the current date and time.\n required: false\n schema:\n type: string\n format: date-time\n responses:\n '200':\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Response'\n '204':\n description: No result found.\n '400':\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '401':\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '404':\n description: No data found for the requested parameters.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '500':\n description: An unexpected error occurred.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '502':\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '503':\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '504':\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\ncomponents:\n schemas:\n Response:\n type: object\n description: The object containing the result\n properties:\n '@context':\n type: string\n default: 'https://vlaamseoverheid.atlassian.net/wiki/download/attachments/1693680273/Mobility-context.jsonld'\n self:\n type: string\n description: Link to this request.\n items:\n type: array\n description: An array of crossborderTitular objects.\n items:\n $ref: '#/components/schemas/CrossborderTitular'\n Correlation-Id:\n description: \"ID of the transaction. Use this ID for log tracing and incident handling.\"\n type: string\n maxLength: 36\n minLength: 10\n Enduser-Id:\n description: \"Reference to the user that triggerd the request.\"\n type: string\n LangString:\n type: object\n description: String with a language attribute\n properties:\n string:\n type: string\n lang:\n type: string\n identificator:\n type: object\n description: OSLO object representing an identification element\n properties:\n identificator:\n type: string\n OrganisationType:\n type: object\n properties:\n '@type':\n type: string\n default: http://www.w3.org/ns/regorg#orgType\n code:\n type: string\n description: The type of the organisation as defined in the specified country.\n description:\n type: string\n description: The company type description.\n LegalEntity:\n type: object\n properties:\n '@type':\n type: string\n default: http://www.w3.org/ns/regorg#RegisteredOrganization\n code:\n type: string\n description: The legal entity of the company as defined in the specified country.\n description:\n type: string\n description: The company legel type description.\n CrossborderTitular:\n description: The crossborder titular object.\n type: object\n properties:\n '@id':\n type: string\n description: 'should be generated of the form _:XXX'\n '@type':\n type: string\n description: 'the type of the titular'\n default: 'http://purl.org/dc/terms/Agent'\n type:\n type: string\n description: Indication whether the titular is a natural person or a moral person/organization.\n person:\n type: object\n description: Person object - only available in case the titular-type is a natural person.\n properties:\n '@id':\n type: string\n description: OSLO Id reference to the Titular object; should be the same value as the titular\n '@type':\n type: string\n description: Indicates that it is a person\n default: http://www.w3.org/ns/person#Person\n lastName:\n description: The last name(s) of the person\n type: array\n items:\n type: string\n firstName:\n description: The first name(s) of the person\n type: array\n items:\n type: string\n organisation:\n type: object\n description: Organisation object only available in case the titular-type is a moral person (organisation).\n properties:\n '@id':\n type: string\n description: OSLO Id reference to the Titular object; should be the same value as the titular @id\n '@type':\n type: string\n description: indicates that it is an organisation\n default: 'http://www.w3.org/ns/org#Organization'\n companyNr:\n $ref: '#/components/schemas/identificator'\n organisationName:\n $ref: '#/components/schemas/LangString'\n organisationType:\n $ref: '#/components/schemas/OrganisationType'\n legalEntity:\n $ref: '#/components/schemas/LegalEntity'\n careOfName:\n type: string\n description: This element is present when the address provided, is a c/o address (care of), i.e. the vehicle holder receives its mail at the address of another person or a company. The element contains the name of the person or company associated with the address.\n registrationLanguageCode:\n type: string\n description: The language code of the registration documents, issued to the holder or owner.\n contactInfo:\n type: object\n description: In OSLO the Address is linked the Agents through the contactInfo\n properties:\n '@type':\n type: string\n description: the contactinfo is of type contactInfo\n default: https://schema.org/ContactPoint\n address:\n type: object\n properties:\n '@type':\n type: string\n description: Address info of the contact address\n default: http://www.w3.org/ns/locn#Address\n streetName:\n $ref: '#/components/schemas/LangString'\n houseNumber:\n type: string\n description: Housenumber of the address.\n box:\n type: string\n description: POBox number of the address.\n postalCode:\n type: string\n description: Postalcode of the address.\n cityName:\n $ref: '#/components/schemas/LangString'\n countryName:\n $ref: '#/components/schemas/LangString'\n countryISO:\n type: string\n description: Country code\n printableLine:\n type: array\n description: The address printable line(s).\n items:\n type: string\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: A URI reference that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be \"about:blank\".\n title:\n type: string\n description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.\n status:\n type: string\n description: The HTTP status code generated by the origin server for this occurrence of the problem.\n detail:\n type: string\n description: A human-readable explanation specific to this occurrence of the problem.\n instance:\n type: string\n description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n description: A representation of a generic error message"},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"5e2e411b-34f6-40b0-84ed-693de3b90d75"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"ef337347-5828-4019-89ef-c77037d62768"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken van movementIndications"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: 3.0.3\ninfo:\n title: Expose Data DIV - Movement Indications Service\n description: This RESTful API is designed to query the indications about new or modified registered data at the DIV on a daily basis. It concerns indications of the DIV related datadomains registration and vehicle.\n contact:\n name: movementIndicationsAPI\n email: helpdesk.magda@vlaanderen.be\n license:\n name: movementIndicationsAPI\n url: https://overheid.vlaanderen.be/magda\n version: '1.2'\nservers:\n - url: '/api/v1/mobility'\npaths:\n /movementIndications/registrationsNew:\n get:\n tags:\n - Request movement indications\n summary: Query movement indications on new registrations.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Magda-Enduser-ID\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Enduser-Id'\n - name: date\n in: query\n description: The date for which the indications are requested.\n required: true\n schema:\n type: string\n format: date\n - name: vehicleCategory\n in: query\n description: Allows to filter a specific vehicle category. Filtering only allowed on M1 and M2.\n required: false\n schema:\n type: string\n enum:\n - M1\n - M2\n - name: pageSize\n in: query\n description: Indicates the size of a page in a paginated collection resource.\n required: false\n schema:\n type: number\n - name: after\n in: query\n description: Indicates the element before the first element of the requested page in a cursor-based paginated collection resource.\n required: false\n schema:\n type: string\n responses:\n '200':\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Response'\n '204':\n description: No result found.\n '400':\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '401':\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '404':\n description: No data found for the requested parameters.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '500':\n description: An unexpected error occurred.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '502':\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '503':\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '504':\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n /movementIndications/registrationsChangedDataLicense:\n get:\n tags:\n - Request movement indications\n summary: Query movement indications on registrations with changed license data.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Magda-Enduser-ID\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Enduser-Id'\n - name: date\n in: query\n description: The date for which the indications are requested.\n required: true\n schema:\n type: string\n format: date\n - name: vehicleCategory\n in: query\n description: Allows to filter a specific vehicle category. Filtering only allowed on M1 and M2.\n required: false\n schema:\n type: string\n enum:\n - M1\n - M2\n - name: pageSize\n in: query\n description: Indicates the size of a page in a paginated collection resource.\n required: false\n schema:\n type: number\n - name: after\n in: query\n description: Indicates the element before the first element of the requested page in a cursor-based paginated collection resource.\n required: false\n schema:\n type: string\n responses:\n '200':\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Response'\n '204':\n description: No result found.\n '400':\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '401':\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '404':\n description: No data found for the requested parameters.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '500':\n description: An unexpected error occurred.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '502':\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '503':\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '504':\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n /movementIndications/registrationsChangedDataVehicle:\n get:\n tags:\n - Request movement indications\n summary: Query movement indications on registrations with changed vehicle data.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Magda-Enduser-ID\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Enduser-Id'\n - name: date\n in: query\n description: The date for which the indications are requested.\n required: true\n schema:\n type: string\n format: date\n - name: vehicleCategory\n in: query\n description: Allows to filter a specific vehicle category. Filtering only allowed on M1 and M2.\n required: false\n schema:\n type: string\n enum:\n - M1\n - M2\n - name: pageSize\n in: query\n description: Indicates the size of a page in a paginated collection resource.\n required: false\n schema:\n type: number\n - name: after\n in: query\n description: Indicates the element before the first element of the requested page in a cursor-based paginated collection resource.\n required: false\n schema:\n type: string\n responses:\n '200':\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Response'\n '204':\n description: No result found.\n '400':\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '401':\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '404':\n description: No data found for the requested parameters.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '500':\n description: An unexpected error occurred.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '502':\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '503':\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '504':\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n /movementIndications/registrationsTransferred:\n get:\n tags:\n - Request movement indications\n summary: Query movement indications on transferred registrations.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Magda-Enduser-ID\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Enduser-Id'\n - name: date\n in: query\n description: The date for which the indications are requested.\n required: true\n schema:\n type: string\n format: date\n - name: vehicleCategory\n in: query\n description: Allows to filter a specific vehicle category. Filtering only allowed on M1 and M2.\n required: false\n schema:\n type: string\n enum:\n - M1\n - M2\n - name: pageSize\n in: query\n description: Indicates the size of a page in a paginated collection resource.\n required: false\n schema:\n type: number\n - name: after\n in: query\n description: Indicates the element before the first element of the requested page in a cursor-based paginated collection resource.\n required: false\n schema:\n type: string\n responses:\n '200':\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Response'\n '204':\n description: No result found.\n '400':\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '401':\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '404':\n description: No data found for the requested parameters.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '500':\n description: An unexpected error occurred.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '502':\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '503':\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '504':\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n /movementIndications/registrationsUnregistered:\n get:\n tags:\n - Request movement indications\n summary: Query movement indications on unregistered registrations.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Magda-Enduser-ID\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Enduser-Id'\n - name: date\n in: query\n description: The date for which the indications are requested.\n required: true\n schema:\n type: string\n format: date\n - name: vehicleCategory\n in: query\n description: Allows to filter a specific vehicle category. Filtering only allowed on M1 and M2.\n required: false\n schema:\n type: string\n enum:\n - M1\n - M2\n - name: pageSize\n in: query\n description: Indicates the size of a page in a paginated collection resource.\n required: false\n schema:\n type: number\n - name: after\n in: query\n description: Indicates the element before the first element of the requested page in a cursor-based paginated collection resource.\n required: false\n schema:\n type: string\n responses:\n '200':\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Response'\n '204':\n description: No result found.\n '400':\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '401':\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '404':\n description: No data found for the requested parameters.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '500':\n description: An unexpected error occurred.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '502':\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '503':\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '504':\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n /movementIndications/registrationsCrossedOut:\n get:\n tags:\n - Request movement indications\n summary: Query movement indications on crossed-out registrations.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Magda-Enduser-ID\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Enduser-Id'\n - name: date\n in: query\n description: The date for which the indications are requested.\n required: true\n schema:\n type: string\n format: date\n - name: vehicleCategory\n in: query\n description: Allows to filter a specific vehicle category. Filtering only allowed on M1 and M2.\n required: false\n schema:\n type: string\n enum:\n - M1\n - M2\n - name: pageSize\n in: query\n description: Indicates the size of a page in a paginated collection resource.\n required: false\n schema:\n type: number\n - name: after\n in: query\n description: Indicates the element before the first element of the requested page in a cursor-based paginated collection resource.\n required: false\n schema:\n type: string\n responses:\n '200':\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Response'\n '204':\n description: No result found.\n '400':\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '401':\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '404':\n description: No data found for the requested parameters.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '500':\n description: An unexpected error occurred.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '502':\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '503':\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '504':\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n /movementIndications/transactions:\n get:\n tags:\n - Request movement indications\n summary: Query movement indications on all registration related transactions.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Magda-Enduser-ID\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Enduser-Id'\n - name: date\n in: query\n description: The date for which the indications are requested.\n required: true\n schema:\n type: string\n format: date\n - name: vehicleCategory\n in: query\n description: Allows to filter a specific vehicle category. Filtering only allowed on M1 and M2.\n required: false\n schema:\n type: string\n enum:\n - M1\n - M2\n - name: pageSize\n in: query\n description: Indicates the size of a page in a paginated collection resource.\n required: false\n schema:\n type: number\n - name: after\n in: query\n description: Indicates the element before the first element of the requested page in a cursor-based paginated collection resource.\n required: false\n schema:\n type: string\n responses:\n '200':\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Response'\n '204':\n description: No result found.\n '400':\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '401':\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '404':\n description: No data found for the requested parameters.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '500':\n description: An unexpected error occurred.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '502':\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '503':\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '504':\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n /movementIndications/rowDetails:\n get:\n tags:\n - Request movement indications\n summary: Query details of movementindications\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Magda-Enduser-ID\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Enduser-Id'\n - name: plateNr\n in: query\n description: The plate number as a principal parameter.\n required: false\n schema:\n type: string\n - name: plateUID\n in: query\n description: The license unique identifier linked to the plate number as a principal parameter.\n required: false\n schema:\n type: string\n - name: vin\n in: query\n description: The vehicle identification number as a principal parameter.\n required: false\n schema:\n type: string\n - name: unifier\n in: query\n description: The unifier of the vehicle identification number.
To be specified always in combination with the VIN.\n required: false\n schema:\n type: string\n - name: certificateId\n in: query\n description: The certificate (CIM) Id as a principal parameter.\n required: false\n schema:\n type: string\n - name: nationalNr\n in: query\n description: The national number as a principal parameter.\n required: false\n schema:\n type: string\n - name: companyNr\n in: query\n description: The company number as a principal parameter.\n required: false\n schema:\n type: string\n - name: dateTime\n in: query\n description: 'The date for which the data is requested. When not specified, the default will be the current date and time. Always to be specified in combination with a principal query parameter.'\n required: false\n schema:\n type: string\n format: date-time\n - name: transactionUID\n in: query\n description: The transaction unique identifier as a principal parameter.\n required: false\n schema:\n type: string\n - name: pageSize\n in: query\n description: Indicates the size of a page in a paginated collection resource.\n required: false\n schema:\n type: number\n - name: after\n in: query\n description: Indicates the element before the first element of the requested page in a cursor-based paginated collection resource.\n required: false\n schema:\n type: string\n - name: addressEnrichmentPerson\n description: \"Source where titular current addres will be retrieved in case titular is a Person. Omit the query parameter in case the current address is not required.\"\n in: query\n required: false\n schema:\n type: string\n enum:\n - RR\n - KSZ\n - name: addressEnrichmentOrganisation\n description: \"Denotes if titular current addres nees to be provided in case the Titular is an organisation. Omit the query parameter in case the current address is not required.\"\n in: query\n required: false\n schema:\n type: boolean\n default: false\n responses:\n '200':\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/RowDetailsResponse'\n '204':\n description: No result found.\n '400':\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '401':\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '404':\n description: No data found for the requested parameters.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '500':\n description: An unexpected error occurred.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '502':\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '503':\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '504':\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\ncomponents:\n schemas:\n Correlation-Id:\n description: \"ID of the transaction. Use this ID for log tracing and incident handling.\"\n type: string\n maxLength: 36\n minLength: 10\n Enduser-Id:\n description: \"Reference to the user that triggerd the request.\"\n type: string\n LangString:\n type: object\n description: String with a language attribute\n properties:\n string:\n type: string\n lang:\n type: string\n Identificator:\n type: object\n description: OSLO object representing an identification element\n properties:\n identificator:\n type: string\n Concept:\n type: object\n description: A concept in a conceptscheme according to the SKOS vocabulary\n properties:\n '@type':\n type: string\n description: declaration of the type of the object\n default: http://www.w3.org/2004/02/skos/core#Concept\n prefLabel:\n $ref: '#/components/schemas/LangString'\n\n Response:\n type: object\n description: The object containing the result\n properties:\n self:\n type: string\n description: Link to this request.\n items:\n type: array\n description: An array of movement indication objects. The content can be none, one or multiple objects.\n items:\n $ref: '#/components/schemas/MovementIndication'\n total:\n type: number\n description: The total amount of elements in the collection resource following the requested parameters.\n next:\n type: string\n description: Link to the next page.\n\n\n RowDetailsResponse:\n type: object\n description: The object containing the rowDetails result\n properties:\n '@context':\n type: string\n default: 'https://vlaamseoverheid.atlassian.net/wiki/download/attachments/1693680273/Mobility-context.jsonld'\n self:\n type: string\n description: Link to this request.\n items:\n type: array\n description: 'An array of registration objects. The content can be none, one or multiple objects.'\n items:\n $ref: '#/components/schemas/RowDetail'\n total:\n type: number\n description: The total amount of elements in the collection resource following the requested parameters.\n next:\n type: string\n description: Link to the next page.\n RowDetail:\n type: object\n description: The registration object. Attributes will be limited to what is necessary in relation to your legal purposes.\n properties:\n transaction:\n $ref: '#/components/schemas/Transaction'\n license:\n $ref: '#/components/schemas/License'\n titular:\n $ref: '#/components/schemas/Titular'\n driver:\n $ref: \"#/components/schemas/Driver\"\n vehicle:\n $ref: '#/components/schemas/Vehicle'\n certificates:\n type: array\n description: 'An array of certificate data. The content can be none, one or multiple entries.'\n items:\n $ref: '#/components/schemas/Certificate'\n Transaction:\n type: object\n description: The transaction object.\n properties:\n UID:\n type: string\n description: The unique identifier of the transaction object\n typeCode:\n type: string\n description: The type code of the transaction\n subTypeCode:\n type: object\n properties:\n code:\n type: string\n description: The subtype code of the transaction\n description:\n type: string\n description: The description of the subtype of the transaction\n dateTime:\n type: string\n format: date-time\n description: The timestamp when the transaction occured\n info:\n type: object\n description: Object containing additional transaction data.\n properties:\n correctionType:\n type: object\n properties:\n code:\n type: string\n description: The type of the correction\n description:\n type: string\n description: The description of the correction code\n plateNumberPriorTitular:\n type: string\n description: Plate number prior titular\n previousPlateNrTitular:\n type: string\n description: Previous plate number titular\n newVehicle:\n type: boolean\n description: Indication new vehicle\n secondHandVehicle:\n type: boolean\n description: Indication 2nd-hand vehicle\n importedVehicle:\n type: boolean\n description: Indication imported vehicle\n transferAttest:\n type: object\n properties:\n code:\n type: string\n description: The transfer attest code\n description:\n type: string\n description: The description of the transfer attest code\n License:\n type: object\n properties:\n reRegistrationFlag:\n type: string\n description: Indication of re-registration\n languageCode:\n type: string\n description: The language of the license; fr, nl, de, en\n plateType:\n type: object\n properties:\n code:\n type: string\n description: The type code of the plate\n description:\n type: string\n description: The description of the plate type\n lastUpdateDateTime:\n type: string\n description: >-\n Timestamp of last modification of data within\n this object\n format: date-time\n plateNrFormatted:\n type: string\n description: The plate number format [for Police]\n insurance:\n type: object\n properties:\n companyCode:\n type: string\n description: >-\n The reference of the insurance company as\n last-known by the DIV\n countryCode:\n type: string\n description: >-\n The residing country of the insurance\n company as last-known by the DIV\n companyName:\n type: string\n description: >-\n The name of the insurance company as\n last-known by the DIV\n plateUID:\n type: string\n description: >-\n A technical global unique identifier\n corresponding with the plate number (GUID)\n firstRegistrationDateBelgium:\n type: string\n description: >-\n Date of the first registration in Belgium. In\n case of an imported and used vehicle (101), the\n first_immatriculation_date can differ from the\n date of the first registration in Belgium. This\n attribute will contain the date of the first\n registration in the DIV-records to indicate that\n the vehicle in question is an already used\n vehicle, that is registered after import.\n format: date\n expiryDate:\n type: string\n description: The (planned) expiry date (when relevant/known)\n format: date-time\n plateNr:\n type: string\n description: >-\n The plate number; as it appears on the plate,\n without any edit characters.\n status:\n type: object\n properties:\n beginDate:\n type: string\n description: 'The begin date of this status '\n format: date-time\n code:\n type: string\n description: The status of the license (registration)\n endDate:\n type: string\n description: >-\n The end date of this status (as old status)\n filled when a new status becomes active\n format: date-time\n description:\n type: string\n description: >-\n The description of the status code of the\n license\n commercialMaxCapacity:\n type: number\n description: The commercial maximum capacity allowed\n format: int32\n statusLegal:\n type: object\n properties:\n beginDate:\n type: string\n description: The begin date of this status\n format: date-time\n code:\n type: string\n description: The legal status of the license\n endDate:\n type: string\n description: >-\n The end date of this status (as old status)\n filled when a new status becomes active\n format: date-time\n description:\n type: string\n description: >-\n The description of the legal status code of\n the license\n lastRegistrationDate:\n type: string\n description: Date of the last registration\n format: date-time\n creationDateTime:\n type: string\n description: >-\n Timestamp of the creation of this object within\n the datastorage\n format: date-time\n startSituationDate:\n type: string\n description: 'The begin date of the license. '\n format: date-time\n commercialMaxMass:\n type: number\n description: The commercial maximum mass allowed\n format: int32\n description: The license object.\n Titular:\n description: The titular object.\n type: object\n properties:\n '@id':\n type: string\n description: 'Identification of the Titular object, should be generated in the form _:XXX'\n '@type':\n type: string\n description: The type of the titular\n default: 'http://purl.org/dc/terms/Agent'\n type:\n type: string\n description: 'Indication whether the titular is a natural person (NP) or a moral person/organization (M). '\n source:\n type: string\n description: 'Indicating the source of the titular identification number in case different from RR/RN and KBO/BCE.'\n title:\n type: string\n description: 'The titular title of the plate. Example of values: Prince, Princess, Duke, Duchess, Marquis, Marquise, Earldom, Countess, Viscount, …'\n person:\n type: object\n description: Person object - only available in case the titular-type is a natural person.\n properties:\n '@id':\n type: string\n description: OSLO Id reference to the Titular object; should be the same value as the titular @id\n '@type':\n type: string\n description: Indicates that it is a person\n default: 'http://www.w3.org/ns/person#Person'\n nationalNr:\n $ref: '#/components/schemas/Identificator'\n description: The national number of the person\n lastName:\n description: The last name(s) of the person\n type: array\n items:\n type: string\n firstName:\n description: The first name(s) of the person\n type: array\n items:\n type: string\n birthYear:\n type: string\n description: The year of birth of the titular\n organisation:\n type: object\n description: Organisation object only available in case the titular-type is a moral person (organisation).\n properties:\n '@id':\n type: string\n description: OSLO Id reference to the Titular object; should be the same value as the titular @id\n '@type':\n type: string\n description: indicates that it is an organisation\n default: 'http://www.w3.org/ns/org#Organization'\n companyNr:\n $ref: '#/components/schemas/Identificator'\n description: 'The KBO/BCE number of the company. '\n organisationName:\n $ref: '#/components/schemas/LangString'\n description: Name of the organisation\n isLeaseCompany:\n type: string\n description: Indication Y(es) or N(o) whether the organisation is a lease-company (Renta-flag)\n legalFormCode:\n $ref: '#/components/schemas/Concept'\n description: The legal-form code of the company\n legalFormAbbrev:\n $ref: '#/components/schemas/Concept'\n description: The abbreviation of the legal-form of the company.\n contactInfo:\n type: object\n description: In OSLO, the Address is linked the Agents through the contactInfo\n properties:\n '@type':\n type: string\n description: the contactinfo is of type contactInfo\n default: 'https://schema.org/ContactPoint'\n address:\n description: \"Current address of the titutar according to DIV\"\n $ref: '#/components/schemas/Address'\n registrationAddress:\n description: \"The address known by DIV at the moment of inscription.\"\n $ref: '#/components/schemas/Address'\n currentAddress:\n description: \"The current address of the titular. Latest informatie retrieved based the INSZ OR KBO in the respective authentic source by MAGDA. This data block is only returned when addressEnrichment was requested for the corresponsing type of titual (person or organisation).\"\n allOf:\n - $ref: '#/components/schemas/Address'\n - type: object\n properties:\n natRegStreetCode:\n type: string\n\n\n\n Vehicle:\n type: object\n description: The vehicle object.\n properties:\n vin:\n type: string\n description: Vehicle Identification Number or Chassis number. The unique number of the vehicle which is stamped in the vehicle by the manufacturer or competent authority.\n unifier:\n type: string\n description: 'With the VIN, the unifier creates an unique identification for small VIN.'\n category:\n type: object\n properties:\n code:\n type: string\n description: European category code. This entry is used to give the information about the type approval which is stated on the COC. Despite of the different ApprovalNumber it is needed to identify these approvals in an easy way.\n description:\n type: string\n description: 'European category description '\n makeName:\n type: string\n description: The make name of the vehicle.\n commercialName:\n type: string\n description: The commercial name of the vehicle.\n makeDivCode:\n type: string\n description: DIV code of the make name. Will become OBSOLETE in a next release.\n makeTypeDescription:\n type: string\n description: Make type description. Only filled in case of a national homologation. Will become OBSOLETE in a next release.\n firstRegistrationDate:\n type: string\n format: date\n description: 'The first registration date of the vehicle (the first time a plate was assigned to it). '\n firstKnownUseDate:\n type: string\n format: date\n description: 'The first date when the vehicle has been used (not necessary the same date as the first registration date). For example, the scooters were used in Belgium and the registration was only possible in 2015.'\n maxPermLadenMassNational:\n type: number\n format: int32\n description: 'Intended registration/in service maximum permissible laden mass in national traffic. In Belgium this is the maximum national mass (F2). [former mmaNational]'\n type:\n type: string\n description: The type of the vehicle as stated on the approval. This entry is NOT used for commercial description.\n wvta:\n type: string\n description: European homologation type approval number (Whole Vehicle Type-Approval)\n pvaBelgium:\n type: string\n description: Belgian national approval number\n typeApprovalType:\n type: string\n description: This entry is used to give the information about the type approval which is stated on the COC. Despite of the different ApprovalNumber it is needed to identify these approvals in an easy way.\n individualApprovalType:\n type: string\n description: Individual approval type (harmonized/non harmonized)\n variant:\n type: string\n description: The variant of the vehicle as stated on the approval.\n version:\n type: string\n description: The version of the vehicle as stated on the approval.\n dateCOC:\n type: string\n format: date\n description: The date of the COC\n status:\n type: object\n properties:\n code:\n type: string\n description: 'Vehicle status '\n description:\n type: string\n description: Description of the vehicle status\n statusLegal:\n type: object\n properties:\n code:\n type: string\n description: 'Vehicle legal status '\n description:\n type: string\n description: Description of the vehicle legal status\n statusAdministrative:\n type: object\n properties:\n code:\n type: string\n description: 'Vehicle administrative status '\n description:\n type: string\n description: Description of the vehicle administrative status\n accidentDate:\n type: string\n format: date\n description: Date of accident\n demolished:\n type: object\n properties:\n code:\n type: string\n description: Indication of demolishing\n date:\n type: string\n format: date\n description: Destruction or demolished date\n description:\n type: string\n description: Description of code demolished\n sellerCompanyCode:\n type: string\n description: Company code of the seller of the vehicle\n customsStickerCode:\n type: string\n description: The customs sticker code\n counterType:\n type: number\n format: int32\n description: Indication of number of digits on the odometer\n distanceType:\n type: string\n description: Indication of km (K) or miles (M) as used in the vehicle\n techControlValidityDate:\n type: string\n format: date\n description: Valid date of the technical control\n techControlEntryDatetime:\n type: string\n format: date-time\n description: Entry timestamp of the technical control\n importedCertificateCountryCode:\n type: string\n description: Country code (ISO3) of the foreign CIM for the imported vehicle\n importedCertificatePlateNumber:\n type: string\n description: Foreign Plate Number in case of vehicle imported\n importedCertificateRegistrationDate:\n type: string\n format: date\n description: Registration date of the imported vehicle\n codeForBodyWork:\n type: array\n items:\n $ref: '#/components/schemas/VehicleCodeForBodyWork'\n kind:\n type: object\n properties:\n code:\n type: string\n description: Vehicle kind as used in Belgium only.\n description:\n type: string\n description: Description fo the vehicle kind code\n nationalBuildup:\n type: object\n properties:\n code:\n type: string\n description: National buildup codes used by technical inspections.\n description:\n type: string\n description: The description of the national buildup code\n nationalConfiguration:\n type: object\n properties:\n code:\n type: string\n description: National vehicle configuration code used by technical inspections.\n description:\n type: string\n description: Description for the national vehicle configuration code\n colour:\n type: array\n items:\n $ref: '#/components/schemas/VehicleColour'\n offRoad:\n type: string\n description: '''G'' value if the vehicle is an ''off-road''; no values in other cases.'\n technicPermissibleMaxMass:\n type: number\n format: int32\n description: Maximum permissible mass of the vehicle.\n massOfTheVehicleInRunningOrder:\n type: number\n format: int32\n description: Mass of the vehicle in running order\n referenceMass:\n type: number\n description: The reference mass\n actualMassOfTheVehicle:\n type: number\n format: int32\n description: Actual mass of the vehicle\n maxPermMassCombination:\n type: number\n format: int32\n description: Permissible maximum mass of the combination\n numberOfAxles:\n type: number\n format: int32\n description: Number of axles of the vehicle\n loadWheelbaseRatio:\n type: number\n format: float\n description: The load wheelbase ratio for the vehicle\n wheelBase:\n type: number\n format: int32\n description: 'This is the total wheelbase. Unit of mesure: mm. In case of motor vehicle or drawbar trailer: first axle to most rear axle. In case of centre-axle-trailer or semi-trailer: the coupling point to most rear axle.'\n maximumSpeed:\n type: number\n format: int32\n description: 'Maximum vehicle speed. Unit: km/h or miles/h'\n limiterIndicator:\n type: boolean\n description: Indicates if the vehicle has a limiter installed\n handicapIndicator:\n type: boolean\n description: Indicates if vehicle is built for disabled person\n tachoIndicator:\n type: boolean\n description: Indicates a tachograph\n assistanceWithoutPedallingIndicator:\n type: boolean\n description: Only available when a vehicle is a speed pedelec. This attribute indicates an autonomous propulsion.\n sizeHeight:\n type: number\n format: int32\n description: The height of the vehicle\n sizeLength:\n type: number\n format: int32\n description: The length of the vehicle\n sizeWidth:\n type: number\n format: int32\n description: The width of the vehicle\n nrOfSeatingPositions:\n type: number\n format: int32\n description: The number of seating positions (including the driver). The seats designated for use only when the vehicle is stationary are not included.\n numberOfStandingPlaces:\n type: number\n format: int32\n description: Number of standing places\n suspension:\n type: object\n properties:\n code:\n type: string\n description: The suspension code\n description:\n type: string\n description: The description of the suspension code\n exhaustDirectiveRefCode:\n type: string\n description: The directive exhaust emisisons code\n creationDateTime:\n type: string\n format: date-time\n description: Timestamp of the creation of this object within the datastorage\n lastUpdateDateTime:\n type: string\n format: date-time\n description: Timestamp of last modification of data within this object\n engine:\n type: array\n description: Array containing vehicle engine(s) specifications\n items:\n $ref: '#/components/schemas/VehicleEngine'\n VehicleCodeForBodyWork:\n type: object\n description: Object containing specific vehicle code for bodywork\n properties:\n code:\n type: string\n description: Code for bodywork\n description:\n type: string\n description: Description of code for bodywork\n VehicleColour:\n type: object\n description: Object containing the colours for a vehicle\n properties:\n code:\n type: string\n description: Colour code\n description:\n type: string\n description: Description of code for colour\n VehicleEngine:\n type: object\n description: Object containing specific vehicle technical engine specifications\n properties:\n engineNumber:\n type: string\n description: The engine number is the unique number of the engine as marked on the engine.\n engineCapacity:\n type: number\n format: float\n description: Engine capacity (cm^3)\n electricEngineIndicator:\n type: boolean\n description: 'Electric Engine '\n fuel:\n type: array\n description: Array containing vehicle engine fuel(s) specifications\n items:\n $ref: '#/components/schemas/VehicleFuel'\n VehicleFuel:\n type: object\n description: Object containing specific vehicle technical engine specifications\n properties:\n code:\n type: string\n description: The fuel code (carburant)\n description:\n type: string\n description: The fuel description (carburant)\n maximumNetPower:\n type: number\n format: float\n description: Maximum net power for combustion engine. Not used for electric engines.\n euroNormCode:\n type: string\n description: 'The emission euronorm '\n exhaustEmissionLevelEuro:\n type: string\n description: Exhaust emission level Euro (called Euronorm)\n maximumContinuousRatedPower:\n type: number\n format: float\n description: Maximum continuous rated power/30 minutes power\n weightPowerRatio:\n type: number\n format: float\n description: Power mass ratio\n electricEnergyConsWeightedComb:\n type: number\n format: float\n description: 'Electric energy consumption weighted, combined (Wh/km)'\n electricRangeExternChargeable:\n type: number\n format: int32\n description: Electric range externally chargeable hybrid vehicle (km)\n combinedFuelConsumption:\n type: number\n format: float\n description: Combined fuel consumption\n combinedCO2:\n type: number\n format: int32\n description: Combined CO2\n WLTPCombinedCO2:\n type: number\n format: int32\n description: 'All power trains, CO2 emissions of the WLTP combined testing phase'\n weightedCombinedCO2:\n type: number\n format: int32\n description: 'Weighted, combined CO2'\n WLTPWeightedCombinedCO2:\n type: number\n format: int32\n description: 'All power trains, CO2 emissions weighted combined of the WLTP test result'\n particulatesMassBenchTest:\n type: number\n format: float\n description: Mass of particulates bench (engine and vehicle) emission\n Address:\n type: object\n description: \"Address In OSLO format.\"\n properties:\n '@type':\n type: string\n description: \"Address info of the contact address\"\n default: \"http://www.w3.org/ns/locn#Address\"\n lastUpdateSource:\n type: string\n description: \"The datasource from which the last update of the address occurred (‘RR’, ‘BIS’, ‘KBO’, ‘local’)\"\n lastUpdateDateTime:\n type: string\n format: date-time\n description: \"The date and time the address has been last updated from the mentioned data source\"\n streetName:\n $ref: '#/components/schemas/LangString'\n description: \"Street name of the address\"\n houseNumber:\n type: string\n description: \"Housenumber of the address\"\n box:\n type: string\n description: \"POBox number of the address\"\n postalCode:\n type: string\n description: \"Postalcode of the address\"\n cityNisCode:\n type: string\n description: \"Nis code for the city of the address\"\n cityName:\n $ref: '#/components/schemas/LangString'\n description: \"The city name of the address\"\n countryName:\n $ref: '#/components/schemas/LangString'\n description: \"Country name\"\n countryISO:\n type: string\n description: \"Country code (ISO2Code)\"\n Certificate:\n type: object\n description: The certificate object.\n properties:\n id:\n type: string\n description: The id of the certificate CIM\n type:\n type: string\n description: 'The type of the certificate - ORI (Original, DUP (Duplicate), CPY (Copy)'\n beginDate:\n type: string\n format: date-time\n description: The begin date of the certificate\n statusLegal:\n type: object\n properties:\n code:\n type: string\n description: The legal status of the certificate\n endDate:\n type: string\n format: date-time\n description: The end date of this status (as old status) filled when a new status becomes active\n description:\n type: string\n description: The description of the legal status of the certificate\n relatedCertificateId:\n type: string\n description: The id of the related certificate\n Driver:\n type: object\n properties:\n source:\n type: string\n description: Indicating the source of the driver identification.\n address:\n $ref: \"#/components/schemas/Address\"\n description: Address of the driver\n person:\n type: object\n properties:\n '@type':\n type: string\n description: Indicates that it is a person\n default: http://www.w3.org/ns/person#Person\n nationalNr:\n $ref: '#/components/schemas/Identificator'\n description: The national number of the person\n lastName:\n type: array\n description: The last name(s) of the person\n items:\n type: string\n firstName:\n type: array\n description: The first name(s) of the person\n items:\n type: string\n description: Person object.\n description: The driver object.\n\n\n MovementIndication:\n type: object\n properties:\n dateTime:\n type: string\n format: date-time\n description: The timestamp of the movement indication\n transactionTypeCode:\n type: string\n description: The type code of the transaction.\n enum:\n - NEW\n - REG\n - CGR\n - CGV\n - TRA\n - UNR\n - RAD\n objectKey:\n type: object\n description: The object containing the object key reference values. An attribute key reference value only is available following the business legal purposes.\n properties:\n plateNr:\n type: string\n description: The plate number.\n plateUID:\n type: string\n description: The license plate related technical unique identifier.\n vin:\n type: string\n description: The vehicle identification number.\n unifier:\n type: string\n description: The unifier of the vehicle identification number. Always used in combination with the VIN.\n transactionUID:\n type: string\n description: The transaction related technical unique identifier. Can only be available when the movement indication is related to a registration.\n required:\n - dateTime\n - transactionTypeCode\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: A URI reference that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be \"about:blank\".\n title:\n type: string\n description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.\n status:\n type: string\n description: The HTTP status code generated by the origin server for this occurrence of the problem.\n detail:\n type: string\n description: A human-readable explanation specific to this occurrence of the problem.\n instance:\n type: string\n description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n description: A representation of a generic error message\n"},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"3092da8c-48bf-41c7-bb76-2d12ed76115a"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"a78f949a-d180-4c13-b025-ab3d76f2282e"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken van registrations"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: 3.0.3\ninfo:\n title: Expose Data DIV - Registrations Service\n description: 'This RESTful API is designed to query current data registered at the DIV. It returns data of the registration-domain including sub-domains license, certificate, titular and vehicle. Release date August 2020.'\n contact:\n name: registrationsAPI\n email: helpdesk.magda@vlaanderen.be\n license:\n name: registrationsAPI\n url: 'https://overheid.vlaanderen.be/magda'\n version: '1.2'\nservers:\n - url: /api/v1/mobility\npaths:\n /registrations:\n get:\n tags:\n - Request Registrations\n summary: Operations for consultation of registrations current data.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Magda-Enduser-ID\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Enduser-Id'\n - name: plateNr\n in: query\n description: The plate number as a principal parameter.\n required: false\n schema:\n type: string\n - name: plateUID\n in: query\n description: The license unique identifier linked to the plate number as a principal parameter.\n required: false\n schema:\n type: string\n - name: vin\n in: query\n description: The vehicle identification number as a principal parameter.\n required: false\n schema:\n type: string\n - name: unifier\n in: query\n description: The unifier of the vehicle identification number.
To be specified always in combination with the VIN.\n required: false\n schema:\n type: string\n - name: certificateId\n in: query\n description: The certificate (CIM) Id as a principal parameter.\n required: false\n schema:\n type: string\n - name: nationalNr\n in: query\n description: The national number as a principal parameter.\n required: false\n schema:\n type: string\n - name: companyNr\n in: query\n description: The company number as a principal parameter.\n required: false\n schema:\n type: string\n - name: dateTime\n in: query\n description: 'The date for which the data is requested. When not specified, the default will be the current date and time. Always to be specified in combination with a principal query parameter.'\n required: false\n schema:\n type: string\n format: date-time\n - name: transactionUID\n in: query\n description: The transaction unique identifier as a principal parameter.\n required: false\n schema:\n type: string\n - name: pageSize\n in: query\n description: Indicates the size of a page in a paginated collection resource.\n required: false\n schema:\n type: number\n - name: after\n in: query\n description: Indicates the element before the first element of the requested page in a cursor-based paginated collection resource.\n required: false\n schema:\n type: string\n - name: addressEnrichmentPerson\n description: \"Source where titular current addres will be retrieved in case titular is a Person. Omit the query parameter in case the current address is not required.\"\n in: query\n required: false\n schema:\n type: string\n enum:\n - RR\n - KSZ\n - name: addressEnrichmentOrganisation\n description: \"Denotes if titular current addres nees to be provided in case the Titular is an organisation. Omit the query parameter in case the current address is not required.\"\n in: query\n required: false\n schema:\n type: boolean\n default: false\n responses:\n '200':\n headers:\n X-Magda-Exceptions:\n description: \"Contains \\\"Uitzonderingen\\\" returned by the MAGDA SOAP services called by the business service to do the data enhancements\"\n schema:\n $ref: '#/components/schemas/MagdaExceptionList'\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Response'\n '204':\n description: No result found.\n '400':\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '401':\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '404':\n description: No data found for the requested parameters.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '500':\n description: An unexpected error occurred.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '502':\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '503':\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '504':\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\ncomponents:\n schemas:\n Response:\n type: object\n description: The object containing the result\n properties:\n '@context':\n type: string\n default: 'https://vlaamseoverheid.atlassian.net/wiki/download/attachments/1693680273/Mobility-context.jsonld'\n self:\n type: string\n description: Link to this request.\n items:\n type: array\n description: 'An array of registration objects. The content can be none, one or multiple objects.'\n items:\n $ref: '#/components/schemas/Registration'\n total:\n type: number\n description: The total amount of elements in the collection resource following the requested parameters.\n next:\n type: string\n description: Link to the next page.\n Correlation-Id:\n description: \"ID of the transaction. Use this ID for log tracing and incident handling.\"\n type: string\n maxLength: 36\n minLength: 10\n Enduser-Id:\n type: string\n description: \"Reference to the user that triggerd the request.\"\n LangString:\n type: object\n description: String with a language attribute\n properties:\n string:\n type: string\n lang:\n type: string\n Identificator:\n type: object\n description: OSLO object representing an identification element\n properties:\n identificator:\n type: string\n Concept:\n type: object\n description: A concept in a conceptscheme according to the SKOS vocabulary\n properties:\n '@type':\n type: string\n description: declaration of the type of the object\n default: http://www.w3.org/2004/02/skos/core#Concept\n prefLabel:\n $ref: '#/components/schemas/LangString'\n\n Registration:\n type: object\n description: The registration object. Attributes will be limited to what is necessary in relation to your legal purposes.\n properties:\n license:\n $ref: '#/components/schemas/License'\n certificates:\n type: array\n description: 'An array of certificate data. The content can be none, one or multiple entries.'\n items:\n $ref: '#/components/schemas/Certificate'\n titular:\n $ref: '#/components/schemas/Titular'\n transaction:\n $ref: '#/components/schemas/Transaction'\n vehicle:\n $ref: '#/components/schemas/Vehicle'\n License:\n type: object\n description: The license object.\n properties:\n plateNr:\n type: string\n description: 'The plate number; as it appears on the plate, without any edit characters.'\n plateUID:\n type: string\n description: 'A technical global unique identifier corresponding with the plate number (GUID)'\n plateNrFormatted:\n type: string\n description: 'The plate number format [for Police]'\n plateType:\n type: object\n properties:\n code:\n type: string\n description: The type code of the plate\n description:\n type: string\n description: The description of the plate type\n languageCode:\n type: string\n description: 'The language of the license; fr, nl, de, en'\n startSituationDate:\n type: string\n format: date-time\n description: 'The begin date of the license. '\n expiryDate:\n type: string\n format: date-time\n description: The (planned) expiry date (when relevant/known)\n lastRegistrationDate:\n type: string\n format: date-time\n description: Date of the last registration\n firstRegistrationDateBelgium:\n type: string\n format: date\n description: 'Date of the first registration in Belgium. In case of an imported and used vehicle (101), the first_immatriculation_date can differ from the date of the first registration in Belgium. This attribute will contain the date of the first registration in the DIV-records to indicate that the vehicle in question is an already used vehicle, that is registered after import.'\n reRegistrationFlag:\n type: string\n description: Indication of re-registration\n commercialMaxMass:\n type: number\n format: int32\n description: The commercial maximum mass allowed\n commercialMaxCapacity:\n type: number\n format: int32\n description: The commercial maximum capacity allowed\n status:\n type: object\n properties:\n code:\n type: string\n description: The status of the license (registration)\n beginDate:\n type: string\n format: date-time\n description: 'The begin date of this status '\n endDate:\n type: string\n format: date-time\n description: The end date of this status (as old status) filled when a new status becomes active\n description:\n type: string\n description: The description of the status code of the license\n statusLegal:\n type: object\n properties:\n code:\n type: string\n description: The legal status of the license\n beginDate:\n type: string\n format: date-time\n description: 'The begin date of this status '\n endDate:\n type: string\n format: date-time\n description: The end date of this status (as old status) filled when a new status becomes active\n description:\n type: string\n description: The description of the legal status code of the license\n creationDateTime:\n type: string\n format: date-time\n description: Timestamp of the creation of this object within the datastorage\n lastUpdateDateTime:\n type: string\n format: date-time\n description: Timestamp of last modification of data within this object\n Certificate:\n type: object\n description: The certificate object.\n properties:\n id:\n type: string\n description: The id of the certificate CIM\n type:\n type: string\n description: 'The type of the certificate - ORI (Original, DUP (Duplicate), CPY (Copy)'\n beginDate:\n type: string\n format: date-time\n description: The begin date of the certificate\n statusLegal:\n type: object\n properties:\n code:\n type: string\n description: The legal status of the certificate\n endDate:\n type: string\n format: date-time\n description: The end date of this status (as old status) filled when a new status becomes active\n description:\n type: string\n description: The description of the legal status of the certificate\n relatedCertificateId:\n type: string\n description: The id of the related certificate\n Titular:\n description: The titular object.\n type: object\n properties:\n '@id':\n type: string\n description: 'Identification of the Titular object, should be generated in the form _:XXX'\n '@type':\n type: string\n description: The type of the titular\n default: 'http://purl.org/dc/terms/Agent'\n type:\n type: string\n description: 'Indication whether the titular is a natural person (NP) or a moral person/organization (M). '\n source:\n type: string\n description: 'Indicating the source of the titular identification number in case different from RR/RN and KBO/BCE.'\n title:\n type: string\n description: 'The titular title of the plate. Example of values: Prince, Princess, Duke, Duchess, Marquis, Marquise, Earldom, Countess, Viscount, …'\n person:\n type: object\n description: Person object - only available in case the titular-type is a natural person.\n properties:\n '@id':\n type: string\n description: OSLO Id reference to the Titular object; should be the same value as the titular @id\n '@type':\n type: string\n description: Indicates that it is a person\n default: 'http://www.w3.org/ns/person#Person'\n nationalNr:\n $ref: '#/components/schemas/Identificator'\n description: The national number of the person\n lastName:\n description: The last name(s) of the person\n type: array\n items:\n type: string\n firstName:\n description: The first name(s) of the person\n type: array\n items:\n type: string\n birthYear:\n type: string\n description: The year of birth of the titular\n organisation:\n type: object\n description: Organisation object only available in case the titular-type is a moral person (organisation).\n properties:\n '@id':\n type: string\n description: OSLO Id reference to the Titular object; should be the same value as the titular @id\n '@type':\n type: string\n description: indicates that it is an organisation\n default: 'http://www.w3.org/ns/org#Organization'\n companyNr:\n $ref: '#/components/schemas/Identificator'\n description: 'The KBO/BCE number of the company. '\n organisationName:\n $ref: '#/components/schemas/LangString'\n description: Name of the organisation\n isLeaseCompany:\n type: string\n description: Indication Y(es) or N(o) whether the organisation is a lease-company (Renta-flag)\n legalFormCode:\n $ref: '#/components/schemas/Concept'\n description: The legal-form code of the company\n legalFormAbbrev:\n $ref: '#/components/schemas/Concept'\n description: The abbreviation of the legal-form of the company.\n contactInfo:\n type: object\n description: In OSLO, the Address is linked the Agents through the contactInfo\n properties:\n '@type':\n type: string\n description: the contactinfo is of type contactInfo\n default: 'https://schema.org/ContactPoint'\n registrationAddress:\n description: \"The address of the titular at moment of registration of the plate.\"\n $ref: '#/components/schemas/Address'\n address:\n description: \"The address known at DIV. It is to be interpreted as the address of the titular.\"\n $ref: '#/components/schemas/Address'\n currentAddress:\n description: \"The current address of the titular. Latest information retrieved based the INSZ OR KBO in the respective authentic source. This data block is only returned when addressEnrichment was requested for the corresponsing type of titual (person or organisation).\"\n $ref: '#/components/schemas/Address'\n Vehicle:\n type: object\n description: The vehicle object.\n properties:\n vin:\n type: string\n description: Vehicle Identification Number or Chassis number. The unique number of the vehicle which is stamped in the vehicle by the manufacturer or competent authority.\n unifier:\n type: string\n description: 'With the VIN, the unifier creates an unique identification for small VIN.'\n category:\n type: object\n properties:\n code:\n type: string\n description: European category code. This entry is used to give the information about the type approval which is stated on the COC. Despite of the different ApprovalNumber it is needed to identify these approvals in an easy way.\n description:\n type: string\n description: 'European category description '\n makeName:\n type: string\n description: The make name of the vehicle.\n commercialName:\n type: string\n description: The commercial name of the vehicle.\n makeDivCode:\n type: string\n description: DIV code of the make name. Will become OBSOLETE in a next release.\n makeTypeDescription:\n type: string\n description: Make type description. Only filled in case of a national homologation. Will become OBSOLETE in a next release.\n firstRegistrationDate:\n type: string\n format: date\n description: 'The first registration date of the vehicle (the first time a plate was assigned to it). '\n firstKnownUseDate:\n type: string\n format: date\n description: 'The first date when the vehicle has been used (not necessary the same date as the first registration date). For example, the scooters were used in Belgium and the registration was only possible in 2015.'\n maxPermLadenMassNational:\n type: number\n format: int32\n description: 'Intended registration/in service maximum permissible laden mass in national traffic. In Belgium this is the maximum national mass (F2). [former mmaNational]'\n type:\n type: string\n description: The type of the vehicle as stated on the approval. This entry is NOT used for commercial description.\n wvta:\n type: string\n description: European homologation type approval number (Whole Vehicle Type-Approval)\n pvaBelgium:\n type: string\n description: Belgian national approval number\n typeApprovalType:\n type: string\n description: This entry is used to give the information about the type approval which is stated on the COC. Despite of the different ApprovalNumber it is needed to identify these approvals in an easy way.\n individualApprovalType:\n type: string\n description: Individual approval type (harmonized/non harmonized)\n variant:\n type: string\n description: The variant of the vehicle as stated on the approval.\n version:\n type: string\n description: The version of the vehicle as stated on the approval.\n dateCOC:\n type: string\n format: date\n description: The date of the COC\n status:\n type: object\n properties:\n code:\n type: string\n description: 'Vehicle status '\n description:\n type: string\n description: Description of the vehicle status\n statusLegal:\n type: object\n properties:\n code:\n type: string\n description: 'Vehicle legal status '\n description:\n type: string\n description: Description of the vehicle legal status\n statusAdministrative:\n type: object\n properties:\n code:\n type: string\n description: 'Vehicle administrative status '\n description:\n type: string\n description: Description of the vehicle administrative status\n accidentDate:\n type: string\n format: date\n description: Date of accident\n demolished:\n type: object\n properties:\n code:\n type: string\n description: Indication of demolishing\n date:\n type: string\n format: date\n description: Destruction or demolished date\n description:\n type: string\n description: Description of code demolished\n sellerCompanyCode:\n type: string\n description: Company code of the seller of the vehicle\n customsStickerCode:\n type: string\n description: The customs sticker code\n counterType:\n type: number\n format: int32\n description: Indication of number of digits on the odometer\n distanceType:\n type: string\n description: Indication of km (K) or miles (M) as used in the vehicle\n techControlValidityDate:\n type: string\n format: date\n description: Valid date of the technical control\n techControlEntryDatetime:\n type: string\n format: date-time\n description: Entry timestamp of the technical control\n importedCertificateCountryCode:\n type: string\n description: Country code (ISO3) of the foreign CIM for the imported vehicle\n importedCertificatePlateNumber:\n type: string\n description: Foreign Plate Number in case of vehicle imported\n importedCertificateRegistrationDate:\n type: string\n format: date\n description: Registration date of the imported vehicle\n codeForBodyWork:\n type: array\n items:\n $ref: '#/components/schemas/VehicleCodeForBodyWork'\n kind:\n type: object\n properties:\n code:\n type: string\n description: Vehicle kind as used in Belgium only.\n description:\n type: string\n description: Description fo the vehicle kind code\n nationalBuildup:\n type: object\n properties:\n code:\n type: string\n description: National buildup codes used by technical inspections.\n description:\n type: string\n description: The description of the national buildup code\n nationalConfiguration:\n type: object\n properties:\n code:\n type: string\n description: National vehicle configuration code used by technical inspections.\n description:\n type: string\n description: Description for the national vehicle configuration code\n colour:\n type: array\n items:\n $ref: '#/components/schemas/VehicleColour'\n offRoad:\n type: string\n description: '''G'' value if the vehicle is an ''off-road''; no values in other cases.'\n technicPermissibleMaxMass:\n type: number\n format: int32\n description: Maximum permissible mass of the vehicle.\n massOfTheVehicleInRunningOrder:\n type: number\n format: int32\n description: Mass of the vehicle in running order\n referenceMass:\n type: number\n description: The reference mass\n actualMassOfTheVehicle:\n type: number\n format: int32\n description: Actual mass of the vehicle\n maxPermMassCombination:\n type: number\n format: int32\n description: Permissible maximum mass of the combination\n numberOfAxles:\n type: number\n format: int32\n description: Number of axles of the vehicle\n loadWheelbaseRatio:\n type: number\n format: float\n description: The load wheelbase ratio for the vehicle\n wheelBase:\n type: number\n format: int32\n description: 'This is the total wheelbase. Unit of mesure: mm. In case of motor vehicle or drawbar trailer: first axle to most rear axle. In case of centre-axle-trailer or semi-trailer: the coupling point to most rear axle.'\n maximumSpeed:\n type: number\n format: int32\n description: 'Maximum vehicle speed. Unit: km/h or miles/h'\n limiterIndicator:\n type: boolean\n description: Indicates if the vehicle has a limiter installed\n handicapIndicator:\n type: boolean\n description: Indicates if vehicle is built for disabled person\n tachoIndicator:\n type: boolean\n description: Indicates a tachograph\n assistanceWithoutPedallingIndicator:\n type: boolean\n description: Only available when a vehicle is a speed pedelec. This attribute indicates an autonomous propulsion.\n sizeHeight:\n type: number\n format: int32\n description: The height of the vehicle\n sizeLength:\n type: number\n format: int32\n description: The length of the vehicle\n sizeWidth:\n type: number\n format: int32\n description: The width of the vehicle\n nrOfSeatingPositions:\n type: number\n format: int32\n description: The number of seating positions (including the driver). The seats designated for use only when the vehicle is stationary are not included.\n numberOfStandingPlaces:\n type: number\n format: int32\n description: Number of standing places\n suspension:\n type: object\n properties:\n code:\n type: string\n description: The suspension code\n description:\n type: string\n description: The description of the suspension code\n exhaustDirectiveRefCode:\n type: string\n description: The directive exhaust emisisons code\n creationDateTime:\n type: string\n format: date-time\n description: Timestamp of the creation of this object within the datastorage\n lastUpdateDateTime:\n type: string\n format: date-time\n description: Timestamp of last modification of data within this object\n engine:\n type: array\n description: Array containing vehicle engine(s) specifications\n items:\n $ref: '#/components/schemas/VehicleEngine'\n VehicleCodeForBodyWork:\n type: object\n description: Object containing specific vehicle code for bodywork\n properties:\n code:\n type: string\n description: Code for bodywork\n description:\n type: string\n description: Description of code for bodywork\n VehicleColour:\n type: object\n description: Object containing the colours for a vehicle\n properties:\n code:\n type: string\n description: Colour code\n description:\n type: string\n description: Description of code for colour\n VehicleEngine:\n type: object\n description: Object containing specific vehicle technical engine specifications\n properties:\n engineNumber:\n type: string\n description: The engine number is the unique number of the engine as marked on the engine.\n engineCapacity:\n type: number\n format: float\n description: Engine capacity (cm^3)\n electricEngineIndicator:\n type: boolean\n description: 'Electric Engine '\n fuel:\n type: array\n description: Array containing vehicle engine fuel(s) specifications\n items:\n $ref: '#/components/schemas/VehicleFuel'\n VehicleFuel:\n type: object\n description: Object containing specific vehicle technical engine specifications\n properties:\n code:\n type: string\n description: The fuel code (carburant)\n description:\n type: string\n description: The fuel description (carburant)\n maximumNetPower:\n type: number\n format: float\n description: Maximum net power for combustion engine. Not used for electric engines.\n euroNormCode:\n type: string\n description: 'The emission euronorm '\n exhaustEmissionLevelEuro:\n type: string\n description: Exhaust emission level Euro (called Euronorm)\n maximumContinuousRatedPower:\n type: number\n format: float\n description: Maximum continuous rated power/30 minutes power\n weightPowerRatio:\n type: number\n format: float\n description: Power mass ratio\n electricEnergyConsWeightedComb:\n type: number\n format: float\n description: 'Electric energy consumption weighted, combined (Wh/km)'\n electricRangeExternChargeable:\n type: number\n format: int32\n description: Electric range externally chargeable hybrid vehicle (km)\n combinedFuelConsumption:\n type: number\n format: float\n description: Combined fuel consumption\n combinedCO2:\n type: number\n format: int32\n description: Combined CO2\n WLTPCombinedCO2:\n type: number\n format: int32\n description: 'All power trains, CO2 emissions of the WLTP combined testing phase'\n weightedCombinedCO2:\n type: number\n format: int32\n description: 'Weighted, combined CO2'\n WLTPWeightedCombinedCO2:\n type: number\n format: int32\n description: 'All power trains, CO2 emissions weighted combined of the WLTP test result'\n particulatesMassBenchTest:\n type: number\n format: float\n description: Mass of particulates bench (engine and vehicle) emission\n Address:\n type: object\n description: \"Address In OSLO format.\"\n properties:\n '@type':\n type: string\n description: \"Address info of the contact address\"\n default: \"http://www.w3.org/ns/locn#Address\"\n lastUpdateSource:\n type: string\n description: \"The datasource from which the last update of the address occurred (‘RR’, ‘BIS’, ‘KBO’, ‘local’)\"\n lastUpdateDateTime:\n type: string\n format: date-time\n description: \"The date and time the address has been last updated from the mentioned data source\"\n streetName:\n $ref: '#/components/schemas/LangString'\n description: \"Street name of the address\"\n natRegStreetCode:\n type: string\n description: \"streetcode which defines a street in the municipality.\"\n houseNumber:\n type: string\n description: \"Housenumber of the address\"\n box:\n type: string\n description: \"POBox number of the address\"\n postalCode:\n type: string\n description: \"Postalcode of the address\"\n cityNisCode:\n type: string\n description: \"Nis code for the city of the address\"\n cityName:\n $ref: '#/components/schemas/LangString'\n description: \"The city name of the address\"\n countryName:\n $ref: '#/components/schemas/LangString'\n description: \"Country name\"\n countryISO:\n type: string\n description: \"Country code (ISO2Code)\"\n Transaction:\n type: object\n description: The transaction object.\n properties:\n UID:\n type: string\n description: The unique identifier of the transaction object\n typeCode:\n type: string\n description: The type code of the transaction\n subTypeCode:\n type: object\n properties:\n code:\n type: string\n description: The subtype code of the transaction\n description:\n type: string\n description: The description of the subtype of the transaction\n dateTime:\n type: string\n format: date-time\n description: The timestamp when the transaction occured\n info:\n type: object\n description: Object containing additional transaction data.\n properties:\n correctionType:\n type: object\n properties:\n code:\n type: string\n description: The type of the correction\n description:\n type: string\n description: The description of the correction code\n plateNumberPriorTitular:\n type: string\n description: Plate number prior titular\n previousPlateNrTitular:\n type: string\n description: Previous plate number titular\n newVehicle:\n type: boolean\n description: Indication new vehicle\n secondHandVehicle:\n type: boolean\n description: Indication 2nd-hand vehicle\n importedVehicle:\n type: boolean\n description: Indication imported vehicle\n transferAttest:\n type: object\n properties:\n code:\n type: string\n description: The transfer attest code\n description:\n type: string\n description: The description of the transfer attest code\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: 'A URI reference that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be \"about:blank\".'\n title:\n type: string\n description: 'A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.'\n status:\n type: string\n description: The HTTP status code generated by the origin server for this occurrence of the problem.\n detail:\n type: string\n description: A human-readable explanation specific to this occurrence of the problem.\n instance:\n type: string\n description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n description: A representation of a generic error message\n MagdaException:\n required:\n - code\n - date\n - diagnosis\n - origin\n - type\n - instance\n type: object\n properties:\n code:\n type: integer\n description: \"HTTP status code of the request from which this exception stemmed.\"\n origin:\n maxLength: 5\n type: string\n description: \"Who originated this exception.\"\n type:\n type: string\n description: \"Specifies the kind of Exception that occurred. ERROR: The main flow could not be executed successfully. WARNING: The main flow was executed successfully, but there was a non-blocking problem. INFO: The main flow was executed without any problem, but there is addition information that can be communicated.\"\n enum:\n - ERROR\n - WARNING\n - INFO\n date:\n type: string\n description: \"Date-time (yyyy-MM-dd'T'HH:mm:ssXXX) when the error was found.\"\n format: date-time\n diagnosis:\n type: string\n description: \"Short explation of the exception. The possible values are explained in the user guide.\"\n circumstance:\n type: string\n description: \"More details of the cause of the exception.\"\n annotations:\n type: string\n description: \"Not yet in use. To be worked out later.\"\n elementReferences:\n type: string\n description: \"Contains a reference to the payload element on which this exception is applicable.\"\n instance:\n type: string\n description: \"Contains a reference to the user that sent the original request.\"\n description: \"A representation of a MAGDA exception.\"\n MagdaExceptionList:\n type: object\n properties:\n content:\n type: array\n items:\n $ref: '#/components/schemas/MagdaException'\n"},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"09b7540f-dddd-457a-8d7d-c36684fc6153"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"723c6c93-3dd9-4cde-90c3-31f4e51bbc52"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken van registrationsHistory"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: 3.0.3\ninfo:\n title: Expose Data DIV - Registrations History Service\n description: This RESTful API is designed to query historical data registered at the DIV. It returns data of the registration including license, certificate, titular and vehicle. Release August 2020\n contact:\n name: \"registrationsHistoryAPI\"\n email: \"helpdesk.magda@vlaanderen.be\"\n license:\n name: \"registrationsHistoryAPI\"\n url: \"https://overheid.vlaanderen.be/magda\"\n version: \"1.1\"\nservers:\n - url: api/v1/mobility\ntags:\n - name: Mobility\npaths:\n /registrationsHistory:\n get:\n tags:\n - Operations for consultation of Registrations History data\n summary: Query registration historical data. At least one of the principal parameters should be defined.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Magda-Enduser-ID\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Enduser-Id'\n - name: dateTimeFrom\n in: query\n description: The start date and time of the period where for the data requested. Always to be specified in combination with the dateTimeTo and a principal query parameter.\n required: true\n schema:\n type: string\n format: date-time\n - name: dateTimeTo\n in: query\n description: The end date and time of the periode where for the data requested. Always to be specified in combination with the dateTimeFrom and a principal query parameter.\n required: true\n schema:\n type: string\n format: date-time\n - name: plateNr\n in: query\n description: The plate number as a principal parameter.\n required: false\n schema:\n type: string\n - name: plateUID\n in: query\n description: '[WAIT] The license plate unique identifier as a principal parameter.'\n required: false\n schema:\n type: string\n - name: vin\n in: query\n description: The vehicle identification number as a principal parameter.\n required: false\n schema:\n type: string\n - name: unifier\n in: query\n description: The unifier of the vehicle identification number.
Optional to be specified always in combination with the VIN.\n required: false\n schema:\n type: string\n - name: nationalNr\n in: query\n description: The national number as a principal parameter.\n required: false\n schema:\n type: string\n - name: companyNr\n in: query\n description: The company number as a principal parameter.\n required: false\n schema:\n type: string\n - name: pageSize\n in: query\n description: Indicates the size of a page in a paginated collection resource.\n required: false\n schema:\n type: number\n - name: after\n in: query\n description: Indicates the element before the first element of the requested page in a cursor-based paginated collection resource.\n required: false\n schema:\n type: string\n responses:\n '200':\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Response'\n '204':\n description: No result found.\n '400':\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '401':\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '404':\n description: No data found for the requested parameters.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '500':\n description: An unexpected error occurred.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '502':\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '503':\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '504':\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\ncomponents:\n schemas:\n Response:\n type: object\n description: The object containing the result\n properties:\n '@context':\n type: string\n default: 'https://vlaamseoverheid.atlassian.net/wiki/download/attachments/1693680273/Mobility-context.jsonld'\n self:\n type: string\n description: Link to this request.\n items:\n type: array\n description: An array of registration objects. The content can be none, one or multiple objects.\n items:\n $ref: '#/components/schemas/Registration'\n total:\n type: number\n description: The total amount of elements in the collection resource following the requested parameters.\n next:\n type: string\n description: Link to the next page.\n Correlation-Id:\n description: \"ID of the transaction. Use this ID for log tracing and incident handling.\"\n type: string\n maxLength: 36\n minLength: 10\n Enduser-Id:\n description: \"Reference to the user that triggerd the request.\"\n type: string\n LangString:\n type: object\n description: String with a language attribute\n properties:\n string:\n type: string\n lang:\n type: string\n Identificator:\n type: object\n description: OSLO object representing an identification element\n properties:\n identificator:\n type: string\n Concept:\n type: object\n description: A concept in a conceptscheme according to the SKOS vocabulary\n properties:\n '@type':\n type: string\n description: declaration of the type of the object\n default: http://www.w3.org/2004/02/skos/core#Concept\n prefLabel:\n $ref: '#/components/schemas/LangString'\n Registration:\n type: object\n description: The registration object.
Attributes will be limited to what is necessary in relation to your legal purposes.\n properties:\n license:\n $ref: '#/components/schemas/License'\n certificates:\n type: array\n description: An array of certificate data. The content can be none, one or multiple entries.\n items:\n $ref: '#/components/schemas/Certificate'\n titular:\n $ref: '#/components/schemas/Titular'\n transaction:\n $ref: '#/components/schemas/Transaction'\n vehicle:\n $ref: '#/components/schemas/Vehicle'\n License:\n type: object\n description: The license object.\n properties:\n plateNr:\n type: string\n description: The plate number; as it appears on the plate, without any edit characters.\n plateUID:\n type: string\n description: A technical global unique identifier corresponding with the plate number (GUID) [for Febiac]\n plateNrFormatted:\n type: string\n description: 'The plate number format [for Police]'\n plateType:\n type: object\n properties:\n code:\n type: string\n description: The type code of the plate\n description:\n type: string\n description: The description of the plate type\n languageCode:\n type: string\n description: 'The language of the license; fr, nl, de, en'\n startSituationDate:\n type: string\n format: date-time\n description: 'The begin date of the license. '\n expiryDate:\n type: string\n format: date-time\n description: The (planned) expiry date (when relevant/known)\n lastRegistrationDate:\n type: string\n format: date-time\n description: Date of the last registration\n firstRegistrationDateBelgium:\n type: string\n format: date\n description: Date of the first registration in Belgium. In case of an imported and used vehicle (101), the first_immatriculation_date can differ from the date of the first registration in Belgium. This attribute will contain the date of the first registration in the DIV-records to indicate that the vehicle in question is an already used vehicle, that is registered after import.\n reRegistrationFlag:\n type: string\n description: Indication of re-registration\n commercialMaxMass:\n type: number\n format: int32\n description: The commercial maximum mass allowed\n commercialMaxCapacity:\n type: number\n format: int32\n description: The commercial maximum capacity allowed\n status:\n type: object\n properties:\n code:\n type: string\n description: The status of the license (registration)\n beginDate:\n type: string\n format: date-time\n description: 'The begin date of this status '\n endDate:\n type: string\n format: date-time\n description: The end date of this status (as old status) filled when a new status becomes active\n description:\n type: string\n description: The description of the status code of the license\n statusLegal:\n type: object\n properties:\n code:\n type: string\n description: The legal status of the license\n beginDate:\n type: string\n format: date-time\n description: The begin date of this status\n endDate:\n type: string\n format: date-time\n description: The end date of this status (as old status) filled when a new status becomes active\n description:\n type: string\n description: The description of the legal status code of the license\n creationDateTime:\n type: string\n format: date-time\n description: Timestamp of the creation of this object within the datastorage\n lastUpdateDateTime:\n type: string\n format: date-time\n description: Timestamp of last modification of data within this object\n Certificate:\n type: object\n description: The certificate object.\n properties:\n id:\n type: string\n description: The id of the certificate CIM\n type:\n type: string\n description: The type of the certificate - ORI (Original, DUP (Duplicate), CPY (Copy)\n beginDate:\n type: string\n format: date-time\n description: The begin date of the certificate\n statusLegal:\n type: object\n properties:\n code:\n type: string\n description: The legal status of the certificate\n endDate:\n type: string\n format: date-time\n description: The end date of this status (as old status) filled when a new status becomes active\n description:\n type: string\n description: The description of the legal status of the certificate\n relatedCertificateId:\n type: string\n description: The id of the related certificate\n\n Titular:\n description: The titular object.\n type: object\n properties:\n '@id':\n type: string\n description: 'Identification of the Titular object, should be generated in the form _:XXX'\n '@type':\n type: string\n description: The type of the titular\n default: 'http://purl.org/dc/terms/Agent'\n type:\n type: string\n description: 'Indication whether the titular is a natural person (NP) or a moral person/organization (M). '\n source:\n type: string\n description: 'Indicating the source of the titular identification number in case different from RR/RN and KBO/BCE.'\n title:\n type: string\n description: 'The titular title of the plate. Example of values: Prince, Princess, Duke, Duchess, Marquis, Marquise, Earldom, Countess, Viscount, …'\n person:\n type: object\n description: Person object - only available in case the titular-type is a natural person.\n properties:\n '@id':\n type: string\n description: OSLO Id reference to the Titular object; should be the same value as the titular @id\n '@type':\n type: string\n description: Indicates that it is a person\n default: 'http://www.w3.org/ns/person#Person'\n nationalNr:\n $ref: '#/components/schemas/Identificator'\n description: The national number of the person\n lastName:\n description: The last name(s) of the person\n type: array\n items:\n type: string\n firstName:\n description: The first name(s) of the person\n type: array\n items:\n type: string\n birthYear:\n type: string\n description: The year of birth of the titular\n organisation:\n type: object\n description: Organisation object only available in case the titular-type is a moral person (organisation).\n properties:\n '@id':\n type: string\n description: OSLO Id reference to the Titular object; should be the same value as the titular @id\n '@type':\n type: string\n description: indicates that it is an organisation\n default: 'http://www.w3.org/ns/org#Organization'\n companyNr:\n $ref: '#/components/schemas/Identificator'\n description: 'The KBO/BCE number of the company. '\n organisationName:\n $ref: '#/components/schemas/LangString'\n description: Name of the organisation\n isLeaseCompany:\n type: string\n description: Indication Y(es) or N(o) whether the organisation is a lease-company (Renta-flag)\n legalFormCode:\n $ref: '#/components/schemas/Concept'\n description: The legal-form code of the company\n legalFormAbbrev:\n $ref: '#/components/schemas/Concept'\n description: The abbreviation of the legal-form of the company.\n contactInfo:\n type: object\n description: In OSLO, the Address is linked the Agents through the contactInfo\n properties:\n '@type':\n type: string\n description: the contactinfo is of type contactInfo\n default: 'https://schema.org/ContactPoint'\n registrationAddress:\n description: \"The address of the titular at moment of registration of the plate.\"\n $ref: '#/components/schemas/Address'\n address:\n description: \"The address known at DIV. It is to be interpreted as the address of the titular.\"\n $ref: '#/components/schemas/Address'\n Address:\n type: object\n description: \"Address In OSLO format.\"\n properties:\n '@type':\n type: string\n description: \"Address info of the contact address\"\n default: \"http://www.w3.org/ns/locn#Address\"\n lastUpdateSource:\n type: string\n description: \"The datasource from which the last update of the address occurred (‘RR’, ‘BIS’, ‘KBO’, ‘local’)\"\n lastUpdateDateTime:\n type: string\n format: date-time\n description: \"The date and time the address has been last updated from the mentioned data source\"\n streetName:\n $ref: '#/components/schemas/LangString'\n description: \"Street name of the address\"\n houseNumber:\n type: string\n description: \"Housenumber of the address\"\n box:\n type: string\n description: \"POBox number of the address\"\n postalCode:\n type: string\n description: \"Postalcode of the address\"\n cityNisCode:\n type: string\n description: \"Nis code for the city of the address\"\n cityName:\n $ref: '#/components/schemas/LangString'\n description: \"The city name of the address\"\n countryName:\n $ref: '#/components/schemas/LangString'\n description: \"Country name\"\n countryISO:\n type: string\n description: \"Country code (ISO2Code)\"\n\n Vehicle:\n type: object\n description: The vehicle object.\n properties:\n vin:\n type: string\n description: Vehicle Identification Number or Chassis number. The unique number of the vehicle which is stamped in the vehicle by the manufacturer or competent authority.\n unifier:\n type: string\n description: With the VIN, the unifier creates an unique identification for small VIN.\n category:\n type: object\n properties:\n code:\n type: string\n description: European category code. This entry is used to give the information about the type approval which is stated on the COC. Despite of the different ApprovalNumber it is needed to identify these approvals in an easy way.\n description:\n type: string\n description: European category description\n makeName:\n type: string\n description: The make name of the vehicle.\n commercialName:\n type: string\n description: The commercial name of the vehicle.\n makeDivCode:\n type: string\n description: DIV code of the make name. Will become OBSOLETE in a next release.\n makeTypeDescription:\n type: string\n description: Make type description. Only filled in case of a national homologation. Will become OBSOLETE in a next release.\n firstRegistrationDate:\n type: string\n format: date\n description: The first registration date of the vehicle (the first time a plate was assigned to it).\n firstKnownUseDate:\n type: string\n format: date\n description: The first date when the vehicle has been used (not necessary the same date as the first registration date). For example, the scooters were used in Belgium and the registration was only possible in 2015.\n maxPermLadenMassNational:\n type: number\n format: int32\n description: Intended registration/in service maximum permissible laden mass in national traffic. In Belgium this is the maximum national mass (F2). [former mmaNational]\n type:\n type: string\n description: The type of the vehicle as stated on the approval. This entry is NOT used for commercial description.\n wvta:\n type: string\n description: European homologation type approval number (Whole Vehicle Type-Approval)\n pvaBelgium:\n type: string\n description: Belgian national approval number\n typeApprovalType:\n type: string\n description: This entry is used to give the information about the type approval which is stated on the COC. Despite of the different ApprovalNumber it is needed to identify these approvals in an easy way.\n individualApprovalType:\n type: string\n description: Individual approval type (harmonized/non harmonized)\n variant:\n type: string\n description: The variant of the vehicle as stated on the approval.\n version:\n type: string\n description: The version of the vehicle as stated on the approval.\n dateCOC:\n type: string\n format: date\n description: The date of the COC\n status:\n type: object\n properties:\n code:\n type: string\n description: Vehicle status\n description:\n type: string\n description: Description of the vehicle status\n statusLegal:\n type: object\n properties:\n code:\n type: string\n description: Vehicle legal status\n description:\n type: string\n description: Description of the vehicle legal status\n statusAdministrative:\n type: object\n properties:\n code:\n type: string\n description: Vehicle administrative status\n description:\n type: string\n description: Description of the vehicle administrative status\n accidentDate:\n type: string\n format: date\n description: Date of accident\n demolished:\n type: object\n properties:\n code:\n type: string\n description: Indication of demolishing\n date:\n type: string\n format: date\n description: Destruction or demolished date\n description:\n type: string\n description: Description of code demolished\n sellerCompanyCode:\n type: string\n description: Company code of the seller of the vehicle\n customsStickerCode:\n type: string\n description: The customs sticker code\n counterType:\n type: number\n format: int32\n description: Indication of number of digits on the odometer\n distanceType:\n type: string\n description: Indication of km (K) or miles (M) as used in the vehicle\n techControlValidityDate:\n type: string\n format: date\n description: Valid date of the technical control\n techControlEntryDatetime:\n type: string\n format: date-time\n description: Entry timestamp of the technical control\n importedCertificateCountryCode:\n type: string\n description: Country code (ISO3) of the foreign CIM for the imported vehicle\n importedCertificatePlateNumber:\n type: string\n description: Foreign Plate Number in case of vehicle imported\n importedCertificateRegistrationDate:\n type: string\n format: date\n description: Registration date of the imported vehicle\n codeForBodyWork:\n type: array\n items:\n $ref: '#/components/schemas/VehicleCodeForBodyWork'\n kind:\n type: object\n properties:\n code:\n type: string\n description: Vehicle kind as used in Belgium only.\n description:\n type: string\n description: Description fo the vehicle kind code\n nationalBuildup:\n type: object\n properties:\n code:\n type: string\n description: National buildup codes used by technical inspections.\n description:\n type: string\n description: The description of the national buildup code\n nationalConfiguration:\n type: object\n properties:\n code:\n type: string\n description: National vehicle configuration code used by technical inspections.\n description:\n type: string\n description: Description for the national vehicle configuration code\n colour:\n type: array\n items:\n $ref: '#/components/schemas/VehicleColour'\n offRoad:\n type: string\n description: '''G'' value if the vehicle is an ''off-road''; no values in other cases.'\n technicPermissibleMaxMass:\n type: number\n format: int32\n description: Maximum permissible mass of the vehicle.\n massOfTheVehicleInRunningOrder:\n type: number\n format: int32\n description: Mass of the vehicle in running order\n referenceMass:\n type: number\n description: The reference mass\n actualMassOfTheVehicle:\n type: number\n format: int32\n description: Actual mass of the vehicle\n maxPermMassCombination:\n type: number\n format: int32\n description: Permissible maximum mass of the combination\n numberOfAxles:\n type: number\n format: int32\n description: Number of axles of the vehicle\n loadWheelbaseRatio:\n type: number\n format: float\n description: The load wheelbase ratio for the vehicle\n wheelBase:\n type: number\n format: int32\n description: 'This is the total wheelbase. Unit of mesure: mm. In case of motor vehicle or drawbar trailer: first axle to most rear axle. In case of centre-axle-trailer or semi-trailer: the coupling point to most rear axle.'\n maximumSpeed:\n type: number\n format: int32\n description: 'Maximum vehicle speed. Unit: km/h or miles/h'\n limiterIndicator:\n type: boolean\n description: Indicates if the vehicle has a limiter installed\n handicapIndicator:\n type: boolean\n description: Indicates if vehicle is built for disabled person\n tachoIndicator:\n type: boolean\n description: Indicates a tachograph\n assistanceWithoutPedallingIndicator:\n type: boolean\n description: Only available when a vehicle is a speed pedelec. This attribute indicates an autonomous propulsion.\n sizeHeight:\n type: number\n format: int32\n description: The height of the vehicle\n sizeLength:\n type: number\n format: int32\n description: The length of the vehicle\n sizeWidth:\n type: number\n format: int32\n description: The width of the vehicle\n nrOfSeatingPositions:\n type: number\n format: int32\n description: The number of seating positions (including the driver). The seats designated for use only when the vehicle is stationary are not included.\n numberOfStandingPlaces:\n type: number\n format: int32\n description: Number of standing places\n suspension:\n type: object\n properties:\n code:\n type: string\n description: The suspension code\n description:\n type: string\n description: The description of the suspension code\n exhaustDirectiveRefCode:\n type: string\n description: The directive exhaust emisisons code\n creationDateTime:\n type: string\n format: date-time\n description: Timestamp of the creation of this object within the datastorage\n lastUpdateDateTime:\n type: string\n format: date-time\n description: Timestamp of last modification of data within this object\n engine:\n type: array\n description: Array containing vehicle engine(s) specifications\n items:\n $ref: '#/components/schemas/VehicleEngine'\n VehicleCodeForBodyWork:\n type: object\n description: Object containing specific vehicle code for bodywork\n properties:\n code:\n type: string\n description: Code for bodywork\n description:\n type: string\n description: Description of code for bodywork\n VehicleColour:\n type: object\n description: Object containing the colours for a vehicle\n properties:\n code:\n type: string\n description: Colour code\n description:\n type: string\n description: Description of code for colour\n VehicleEngine:\n type: object\n description: Object containing specific vehicle technical engine specifications\n properties:\n engineNumber:\n type: string\n description: The engine number is the unique number of the engine as marked on the engine.\n engineCapacity:\n type: number\n format: float\n description: Engine capacity (cm^3)\n electricEngineIndicator:\n type: boolean\n description: Electric Engine\n fuel:\n type: array\n description: Array containing vehicle engine fuel(s) specifications\n items:\n $ref: '#/components/schemas/VehicleFuel'\n VehicleFuel:\n type: object\n description: Object containing specific vehicle technical engine specifications\n properties:\n code:\n type: string\n description: The fuel code (carburant)\n description:\n type: string\n description: The fuel description (carburant)\n maximumNetPower:\n type: number\n format: float\n description: Maximum net power for combustion engine. Not used for electric engines.\n euroNormCode:\n type: string\n description: The emission euronorm\n exhaustEmissionLevelEuro:\n type: string\n description: Exhaust emission level Euro (called Euronorm)\n maximumContinuousRatedPower:\n type: number\n format: float\n description: Maximum continuous rated power/30 minutes power\n weightPowerRatio:\n type: number\n format: float\n description: Power mass ratio\n electricEnergyConsWeightedComb:\n type: number\n format: float\n description: Electric energy consumption weighted, combined (Wh/km)\n electricRangeExternChargeable:\n type: number\n format: int32\n description: Electric range externally chargeable hybrid vehicle (km)\n combinedFuelConsumption:\n type: number\n format: float\n description: Combined fuel consumption\n combinedCO2:\n type: number\n format: int32\n description: Combined CO2\n WLTPCombinedCO2:\n type: number\n format: int32\n description: All power trains, CO2 emissions of the WLTP combined testing phase\n weightedCombinedCO2:\n type: number\n format: int32\n description: Weighted, combined CO2\n WLTPWeightedCombinedCO2:\n type: number\n format: int32\n description: All power trains, CO2 emissions weighted combined of the WLTP test result\n particulatesMassBenchTest:\n type: number\n format: float\n description: Mass of particulates bench (engine and vehicle) emission\n Transaction:\n type: object\n description: The transaction object.\n properties:\n UID:\n type: string\n description: The unique identifier of the transaction object\n typeCode:\n type: string\n description: The type code of the transaction\n subTypeCode:\n type: object\n properties:\n code:\n type: string\n description: The subtype code of the transaction\n description:\n type: string\n description: The description of the subtype of the transaction\n dateTime:\n type: string\n format: date-time\n description: The timestamp when the transaction occured\n info:\n type: object\n description: Object containing additional transaction data.\n properties:\n correctionType:\n type: object\n properties:\n code:\n type: string\n description: The type of the correction\n description:\n type: string\n description: The description of the correction code\n plateNumberPriorTitular:\n type: string\n description: Plate number prior titular\n previousPlateNrTitular:\n type: string\n description: Previous plate number titular\n newVehicle:\n type: boolean\n description: Indication new vehicle\n secondHandVehicle:\n type: boolean\n description: Indication 2nd-hand vehicle\n importedVehicle:\n type: boolean\n description: Indication imported vehicle\n transferAttest:\n type: object\n properties:\n code:\n type: string\n description: The transfer attest code\n description:\n type: string\n description: The description of the transfer attest code\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: A URI reference that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be \"about:blank\".\n title:\n type: string\n description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.\n status:\n type: string\n description: The HTTP status code generated by the origin server for this occurrence of the problem.\n detail:\n type: string\n description: A human-readable explanation specific to this occurrence of the problem.\n instance:\n type: string\n description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n description: A representation of a generic error message"},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"4217c01c-1fe5-45cd-8171-b38f68d903d4"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"893ca5ac-434f-42ab-8fcb-59b9dae3efb7"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken van registrationTitular"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: 3.0.3\ninfo:\n title: Expose Data DIV - Registrations Titular Service\n description: 'This RESTful API is designed to query the data registered at the DIV with focus on finding the current titular for a plate number or vin. It returns data of the registration-domain including sub-domains license, titular and vehicle. Release January 30 - 2021.'\n contact:\n name: registrationsTitularAPI\n email: helpdesk.magda@vlaanderen.be\n license:\n name: RegistrationsTitularAPI\n url: https://overheid.vlaanderen.be/magda\n version: '1.2'\nservers:\n - url: '/api/v1/mobility'\npaths:\n /registrationsTitular:\n get:\n tags:\n - Operations for consultation of Registrations Titular data\n summary: Query registration data by request parameters. At least one of the principal parameters should be defined. Main source is DIV data, enriched with current address of titular when requested and allowed\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Magda-Enduser-ID\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Enduser-Id'\n - name: addressEnrichment\n description: When set to true, currentAddress of titular is added to the response. When false only the adress know at DIV is returned\n in: query\n required: false\n schema:\n type: boolean\n default: false\n - name: plateNr\n in: query\n description: The plate number as a principal parameter.\n required: false\n schema:\n type: string\n - name: vin\n in: query\n description: The vehicle identification number as a principal parameter.\n required: false\n schema:\n type: string\n - name: unifier\n in: query\n description: 'The unifier of the vehicle identification number.
To be specified always in combination with the VIN. '\n required: false\n schema:\n type: string\n - name: dateTime\n in: query\n description: 'The date for which the data is requested. When not specified, the default will be the current date and time. Always to be specified in combination with a principal query parameter.'\n required: false\n schema:\n type: string\n format: date-time\n - name: addressEnrichmentPerson\n description: \"Source where titular current addres will be retrieved in case titular is a Person. Omit the query parameter in case the current address is not required.\"\n in: query\n required: false\n schema:\n type: string\n enum:\n - RR\n - KSZ\n - name: addressEnrichmentOrganisation\n description: \"Denotes if titular current addres nees to be provided in case the Titular is an organisation. Omit the query parameter in case the current address is not required.\"\n in: query\n required: false\n schema:\n type: boolean\n default: false\n responses:\n '200':\n headers:\n X-Magda-Exceptions:\n description: \"Contains \\\"Uitzonderingen\\\" returned by the MAGDA SOAP services called by the business service to do the data enhancements\"\n schema:\n $ref: '#/components/schemas/MagdaExceptionList'\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Response'\n '204':\n description: No result found.\n '400':\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '401':\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '404':\n description: No data found for the requested parameters.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '500':\n description: An unexpected error occurred.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '502':\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '503':\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n '504':\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\ncomponents:\n schemas:\n Response:\n type: object\n description: The object containing the result\n properties:\n \"@context\":\n type: string\n default: 'https://vlaamseoverheid.atlassian.net/wiki/download/attachments/1693680273/Mobility-context.jsonld'\n self:\n type: string\n description: Link to this request.\n items:\n type: array\n description: An array of registration objects. The content can be none or one object.\n items:\n $ref: '#/components/schemas/Registration'\n Correlation-Id:\n description: \"ID of the transaction. Use this ID for log tracing and incident handling.\"\n type: string\n maxLength: 36\n minLength: 10\n Enduser-Id:\n description: \"Reference to the user that triggerd the request.\"\n type: string\n LangString:\n type: object\n description: String with a language attribute\n properties:\n string:\n type: string\n lang:\n type: string\n Identificator:\n type: object\n description: OSLO object representing an identification element\n properties:\n identificator:\n type: string\n Concept:\n type: object\n description: A concept in a conceptscheme according to the SKOS vocabulary\n properties:\n '@type':\n type: string\n description: declaration of the type of the object\n default: http://www.w3.org/2004/02/skos/core#Concept\n prefLabel:\n $ref: '#/components/schemas/LangString'\n Registration:\n type: object\n description: The registration object.
Attributes will be limited to what is necessary in relation to your legal purposes.\n properties:\n driver:\n $ref: \"#/components/schemas/Driver\"\n license:\n $ref: '#/components/schemas/License'\n titular:\n $ref: '#/components/schemas/Titular'\n vehicle:\n $ref: '#/components/schemas/Vehicle'\n License:\n type: object\n description: The license object.\n properties:\n plateNr:\n type: string\n description: The plate number; as it appears on the plate, without any edit characters.\n plateUID:\n type: string\n description: 'A technical global unique identifier corresponding with the plate number (GUID) [for Febiac]'\n plateNrFormatted:\n type: string\n description: 'The plate number format [for Police]'\n plateType:\n type: object\n properties:\n code:\n type: string\n description: The type code of the plate\n description:\n type: string\n description: The description of the plate type\n languageCode:\n type: string\n description: The language of the license; fr, nl, de, en\n startSituationDate:\n type: string\n format: date-time\n description: The begin date of the license.\n expiryDate:\n type: string\n format: date-time\n description: The (planned) expiry date (when relevant/known)\n lastRegistrationDate:\n type: string\n format: date-time\n description: Date of the last registration\n firstRegistrationDateBelgium:\n type: string\n format: date\n description: Date of the first registration in Belgium. In case of an imported and used vehicle (101), the first_immatriculation_date can differ from the date of the first registration in Belgium. This attribute will contain the date of the first registration in the DIV-records to indicate that the vehicle in question is an already used vehicle, that is registered after import.\n reRegistrationFlag:\n type: string\n description: Indication of re-registration\n commercialMaxMass:\n type: number\n format: int32\n description: The commercial maximum mass allowed\n commercialMaxCapacity:\n type: number\n format: int32\n description: The commercial maximum capacity allowed\n status:\n type: object\n properties:\n code:\n type: string\n description: The status of the license (registration)\n beginDate:\n type: string\n format: date-time\n description: 'The begin date of this status '\n endDate:\n type: string\n format: date-time\n description: The end date of this status (as old status) filled when a new status becomes active\n description:\n type: string\n description: The description of the status code of the license\n statusLegal:\n type: object\n properties:\n code:\n type: string\n description: The legal status of the license\n beginDate:\n type: string\n format: date-time\n description: 'The begin date of this status '\n endDate:\n type: string\n format: date-time\n description: The end date of this status (as old status) filled when a new status becomes active\n description:\n type: string\n description: The description of the legal status code of the license\n creationDateTime:\n type: string\n format: date-time\n description: Timestamp of the creation of this object within the datastorage\n lastUpdateDateTime:\n type: string\n format: date-time\n description: Timestamp of last modification of data within this object\n Titular:\n description: The titular object.\n type: object\n properties:\n \"@id\":\n type: string\n description: 'Identification of the Titular object, should be generated in the form _:XXX'\n '@type':\n type: string\n description: The type of the titular\n default: 'http://purl.org/dc/terms/Agent'\n type:\n type: string\n description: \"Indication whether the titular is a natural person (NP) or a moral person/organisation (M).\"\n source:\n type: string\n description: \"Indicating the source of the titular identification number in case different from RR/RN and KBO/BCE.\"\n title:\n type: string\n description: 'The titular title of the plate. Example of values: Prince, Princess, Duke, Duchess, Marquis, Marquise, Earldom, Countess, Viscount, …'\n person:\n type: object\n description: Person object - only available in case the titular-type is a natural person.\n properties:\n \"@id\":\n type: string\n description: OSLO Id reference to the Titular object; should be the same value as the titular @Id\n '@type':\n type: string\n description: Indicates that it is a person\n default: http://www.w3.org/ns/person#Person\n nationalNr:\n $ref: '#/components/schemas/Identificator'\n description: The national number of the person\n lastName:\n description: The last name(s) of the person\n type: array\n items:\n type: string\n firstName:\n description: The first name(s) of the person\n type: array\n items:\n type: string\n birthYear:\n type: string\n description: The year of birth of the titular\n organisation:\n type: object\n description: Organisation object only available in case the titular-type is a moral person (organisation).\n properties:\n \"@id\":\n type: string\n description: OSLO Id reference to the Titular object; should be the same value as the titular @Id\n '@type':\n type: string\n description: indicates that it is an organisation\n default: http://www.w3.org/ns/org#Organization\n companyNr:\n $ref: '#/components/schemas/Identificator'\n description: 'The KBO/BCE number of the company. '\n organisationName:\n $ref: '#/components/schemas/LangString'\n description: Name of the organisation\n isLeaseCompany:\n type: string\n description: Indication Y(es) or N(o) whether the organisation is a lease-company (Renta-flag)\n legalFormCode:\n $ref: '#/components/schemas/Concept'\n description: The legal-form code of the company\n legalFormAbbrev:\n $ref: '#/components/schemas/Concept'\n description: The abbreviation of the legal-form of the company.\n contactInfo:\n type: object\n description: In OSLO, the Address is linked the Agents through the contactInfo\n properties:\n '@type':\n type: string\n description: the contactinfo is of type contactInfo\n default: 'https://schema.org/ContactPoint'\n address:\n description: \"The address known at DIV. It is to be interpreted as the address of the titular at the moment of inscription.\"\n $ref: '#/components/schemas/Address'\n currentAddress:\n description: \"The current address of the titular. Latest informatie retrieved based the INSZ OR KBO in the respective authentic source. This data block is only returned when addressEnrichment was requested for the corresponsing type of titual (person or organisation).\"\n $ref: '#/components/schemas/Address'\n Vehicle:\n type: object\n description: The vehicle object.\n properties:\n vin:\n type: string\n description: Vehicle Identification Number or Chassis number. The unique number of the vehicle which is stamped in the vehicle by the manufacturer or competent authority.\n unifier:\n type: string\n description: With the VIN, the unifier creates an unique identification for small VIN.\n category:\n type: object\n properties:\n code:\n type: string\n description: European category code. This entry is used to give the information about the type approval which is stated on the COC. Despite of the different ApprovalNumber it is needed to identify these approvals in an easy way.\n description:\n type: string\n description: European category description\n makeName:\n type: string\n description: The make name of the vehicle.\n commercialName:\n type: string\n description: The commercial name of the vehicle.\n makeDivCode:\n type: string\n description: DIV code of the make name. Will become OBSOLETE in a next release.\n makeTypeDescription:\n type: string\n description: Make type description. Only filled in case of a national homologation. Will become OBSOLETE in a next release.\n firstRegistrationDate:\n type: string\n format: date\n description: The first registration date of the vehicle (the first time a plate was assigned to it).\n firstKnownUseDate:\n type: string\n format: date\n description: The first date when the vehicle has been used (not necessary the same date as the first registration date). For example, the scooters were used in Belgium and the registration was only possible in 2015.\n maxPermLadenMassNational:\n type: number\n format: int32\n description: 'Intended registration/in service maximum permissible laden mass in national traffic. In Belgium this is the maximum national mass (F2). [former mmaNational]'\n type:\n type: string\n description: The type of the vehicle as stated on the approval. This entry is NOT used for commercial description.\n wvta:\n type: string\n description: European homologation type approval number (Whole Vehicle Type-Approval)\n pvaBelgium:\n type: string\n description: Belgian national approval number\n typeApprovalType:\n type: string\n description: This entry is used to give the information about the type approval which is stated on the COC. Despite of the different ApprovalNumber it is needed to identify these approvals in an easy way.\n individualApprovalType:\n type: string\n description: Individual approval type (harmonized/non harmonized)\n variant:\n type: string\n description: The variant of the vehicle as stated on the approval.\n version:\n type: string\n description: The version of the vehicle as stated on the approval.\n dateCOC:\n type: string\n format: date\n description: The date of the COC\n status:\n type: object\n properties:\n code:\n type: string\n description: Vehicle status\n description:\n type: string\n description: Description of the vehicle status\n statusLegal:\n type: object\n properties:\n code:\n type: string\n description: Vehicle legal status\n description:\n type: string\n description: Description of the vehicle legal status\n statusAdministrative:\n type: object\n properties:\n code:\n type: string\n description: Vehicle administrative status\n description:\n type: string\n description: Description of the vehicle administrative status\n accidentDate:\n type: string\n format: date\n description: Date of accident\n demolished:\n type: object\n properties:\n code:\n type: string\n description: Indication of demolishing\n date:\n type: string\n format: date\n description: Destruction or demolished date\n description:\n type: string\n description: Description of code demolished\n sellerCompanyCode:\n type: string\n description: Company code of the seller of the vehicle\n customsStickerCode:\n type: string\n description: The customs sticker code\n counterType:\n type: number\n format: int32\n description: Indication of number of digits on the odometer\n distanceType:\n type: string\n description: Indication of km (K) or miles (M) as used in the vehicle\n techControlValidityDate:\n type: string\n format: date\n description: Valid date of the technical control\n techControlEntryDatetime:\n type: string\n format: date-time\n description: Entry timestamp of the technical control\n importedCertificateCountryCode:\n type: string\n description: Country code (ISO3) of the foreign CIM for the imported vehicle\n importedCertificatePlateNumber:\n type: string\n description: Foreign Plate Number in case of vehicle imported\n importedCertificateRegistrationDate:\n type: string\n format: date\n description: Registration date of the imported vehicle\n codeForBodyWork:\n type: array\n items:\n $ref: '#/components/schemas/VehicleCodeForBodyWork'\n kind:\n type: object\n properties:\n code:\n type: string\n description: Vehicle kind as used in Belgium only.\n description:\n type: string\n description: Description fo the vehicle kind code\n nationalBuildup:\n type: object\n properties:\n code:\n type: string\n description: National buildup codes used by technical inspections.\n description:\n type: string\n description: The description of the national buildup code\n nationalConfiguration:\n type: object\n properties:\n code:\n type: string\n description: National vehicle configuration code used by technical inspections.\n description:\n type: string\n description: Description for the national vehicle configuration code\n colour:\n type: array\n items:\n $ref: '#/components/schemas/VehicleColour'\n offRoad:\n type: string\n description: '''G'' value if the vehicle is an ''off-road''; no values in other cases.'\n technicPermissibleMaxMass:\n type: number\n format: int32\n description: Maximum permissible mass of the vehicle.\n massOfTheVehicleInRunningOrder:\n type: number\n format: int32\n description: Mass of the vehicle in running order\n referenceMass:\n type: number\n description: The reference mass\n actualMassOfTheVehicle:\n type: number\n format: int32\n description: Actual mass of the vehicle\n maxPermMassCombination:\n type: number\n format: int32\n description: Permissible maximum mass of the combination\n numberOfAxles:\n type: number\n format: int32\n description: Number of axles of the vehicle\n loadWheelbaseRatio:\n type: number\n format: float\n description: The load wheelbase ratio for the vehicle\n wheelBase:\n type: number\n format: int32\n description: 'This is the total wheelbase. Unit of mesure: mm. In case of motor vehicle or drawbar trailer: first axle to most rear axle. In case of centre-axle-trailer or semi-trailer: the coupling point to most rear axle.'\n maximumSpeed:\n type: number\n format: int32\n description: 'Maximum vehicle speed. Unit: km/h or miles/h'\n limiterIndicator:\n type: boolean\n description: Indicates if the vehicle has a limiter installed\n handicapIndicator:\n type: boolean\n description: Indicates if vehicle is built for disabled person\n tachoIndicator:\n type: boolean\n description: Indicates a tachograph\n assistanceWithoutPedallingIndicator:\n type: boolean\n description: Only available when a vehicle is a speed pedelec. This attribute indicates an autonomous propulsion.\n sizeHeight:\n type: number\n format: int32\n description: The height of the vehicle\n sizeLength:\n type: number\n format: int32\n description: The length of the vehicle\n sizeWidth:\n type: number\n format: int32\n description: The width of the vehicle\n nrOfSeatingPositions:\n type: number\n format: int32\n description: The number of seating positions (including the driver). The seats designated for use only when the vehicle is stationary are not included.\n numberOfStandingPlaces:\n type: number\n format: int32\n description: Number of standing places\n suspension:\n type: object\n properties:\n code:\n type: string\n description: The suspension code\n description:\n type: string\n description: The description of the suspension code\n exhaustDirectiveRefCode:\n type: string\n description: The directive exhaust emisisons code\n creationDateTime:\n type: string\n format: date-time\n description: Timestamp of the creation of this object within the datastorage\n lastUpdateDateTime:\n type: string\n format: date-time\n description: Timestamp of last modification of data within this object\n engine:\n type: array\n description: Array containing vehicle engine(s) specifications\n items:\n $ref: '#/components/schemas/VehicleEngine'\n VehicleCodeForBodyWork:\n type: object\n description: Object containing specific vehicle code for bodywork\n properties:\n code:\n type: string\n description: Code for bodywork\n description:\n type: string\n description: Description of code for bodywork\n VehicleColour:\n type: object\n description: Object containing the colours for a vehicle\n properties:\n code:\n type: string\n description: Colour code\n description:\n type: string\n description: Description of code for colour\n VehicleEngine:\n type: object\n description: Object containing specific vehicle technical engine specifications\n properties:\n engineNumber:\n type: string\n description: The engine number is the unique number of the engine as marked on the engine.\n engineCapacity:\n type: number\n format: float\n description: Engine capacity (cm^3)\n electricEngineIndicator:\n type: boolean\n description: Electric Engine\n fuel:\n type: array\n description: Array containing vehicle engine fuel(s) specifications\n items:\n $ref: '#/components/schemas/VehicleFuel'\n VehicleFuel:\n type: object\n description: Object containing specific vehicle technical engine specifications\n properties:\n code:\n type: string\n description: The fuel code (carburant)\n description:\n type: string\n description: The fuel description (carburant)\n maximumNetPower:\n type: number\n format: float\n description: Maximum net power for combustion engine. Not used for electric engines.\n euroNormCode:\n type: string\n description: The emission euronorm\n exhaustEmissionLevelEuro:\n type: string\n description: Exhaust emission level Euro (called Euronorm)\n maximumContinuousRatedPower:\n type: number\n format: float\n description: Maximum continuous rated power/30 minutes power\n weightPowerRatio:\n type: number\n format: float\n description: Power mass ratio\n electricEnergyConsWeightedComb:\n type: number\n format: float\n description: 'Electric energy consumption weighted, combined (Wh/km)'\n electricRangeExternChargeable:\n type: number\n format: int32\n description: Electric range externally chargeable hybrid vehicle (km)\n combinedFuelConsumption:\n type: number\n format: float\n description: Combined fuel consumption\n combinedCO2:\n type: number\n format: int32\n description: Combined CO2\n WLTPCombinedCO2:\n type: number\n format: int32\n description: All power trains, CO2 emissions of the WLTP combined testing phase\n weightedCombinedCO2:\n type: number\n format: int32\n description: Weighted, combined CO2\n WLTPWeightedCombinedCO2:\n type: number\n format: int32\n description: All power trains, CO2 emissions weighted combined of the WLTP test result\n particulatesMassBenchTest:\n type: number\n format: float\n description: Mass of particulates bench (engine and vehicle) emission\n Address:\n type: object\n description: \"Address In OSLO format.\"\n properties:\n '@type':\n type: string\n description: \"Address info of the contact address\"\n default: \"http://www.w3.org/ns/locn#Address\"\n lastUpdateSource:\n type: string\n description: \"The datasource from which the last update of the address occurred (‘RR’, ‘BIS’, ‘KBO’, ‘local’)\"\n lastUpdateDateTime:\n type: string\n format: date-time\n description: \"The date and time the address has been last updated from the mentioned data source\"\n streetName:\n $ref: '#/components/schemas/LangString'\n description: \"Street name of the address\"\n natRegStreetCode:\n type: string\n description: \"streetcode which defines a street in the municipality.\"\n houseNumber:\n type: string\n description: \"Housenumber of the address\"\n box:\n type: string\n description: \"POBox number of the address\"\n postalCode:\n type: string\n description: \"Postalcode of the address\"\n cityNisCode:\n type: string\n description: \"Nis code for the city of the address\"\n cityName:\n $ref: '#/components/schemas/LangString'\n description: \"The city name of the address\"\n countryName:\n $ref: '#/components/schemas/LangString'\n description: \"Country name\"\n countryISO:\n type: string\n description: \"Country code (ISO2Code)\"\n\n Driver:\n type: object\n properties:\n source:\n type: string\n description: Indicating the source of the driver identification.\n address:\n $ref: \"#/components/schemas/Address\"\n description: Address of the driver\n person:\n type: object\n properties:\n '@type':\n type: string\n description: Indicates that it is a person\n default: http://www.w3.org/ns/person#Person\n nationalNr:\n $ref: '#/components/schemas/Identificator'\n description: The national number of the person\n lastName:\n type: array\n description: The last name(s) of the person\n items:\n type: string\n firstName:\n type: array\n description: The first name(s) of the person\n items:\n type: string\n description: Person object.\n description: The driver object.\n\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: A URI reference that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be \"about:blank\".\n title:\n type: string\n description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.\n status:\n type: string\n description: The HTTP status code generated by the origin server for this occurrence of the problem.\n detail:\n type: string\n description: A human-readable explanation specific to this occurrence of the problem.\n instance:\n type: string\n description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n description: A representation of a generic error message\n MagdaException:\n required:\n - code\n - date\n - diagnosis\n - origin\n - type\n - instance\n type: object\n properties:\n code:\n type: integer\n description: \"HTTP status code of the request from which this exception stemmed.\"\n origin:\n maxLength: 5\n type: string\n description: \"Who originated this exception.\"\n type:\n type: string\n description: \"Specifies the kind of Exception that occurred. ERROR: The main flow could not be executed successfully. WARNING: The main flow was executed successfully, but there was a non-blocking problem. INFO: The main flow was executed without any problem, but there is addition information that can be communicated.\"\n enum:\n - ERROR\n - WARNING\n - INFO\n date:\n type: string\n description: \"Date-time (yyyy-MM-dd'T'HH:mm:ssXXX) when the error was found.\"\n format: date-time\n diagnosis:\n type: string\n description: \"Short explation of the exception. The possible values are explained in the user guide.\"\n circumstance:\n type: string\n description: \"More details of the cause of the exception.\"\n annotations:\n type: string\n description: \"Not yet in use. To be worked out later.\"\n elementReferences:\n type: string\n description: \"Contains a reference to the payload element on which this exception is applicable.\"\n instance:\n type: string\n description: \"Contains a reference to the user that sent the original request.\"\n description: \"A representation of a MAGDA exception.\"\n MagdaExceptionList:\n type: object\n properties:\n content:\n type: array\n items:\n $ref: '#/components/schemas/MagdaException'\n"},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"db06fec7-d839-4fd3-bcf8-d782d34af222"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"bedf6685-a39a-42fe-a939-b545848bb50a"}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Onderneming","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"adressenLocaties","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"11c5a5cf-eb85-4347-8106-95adb7330c8d","collection":"contentId-6118410708","type":"file"}}]},{"type":"paragraph"},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: \"3.0.2\"\ninfo:\n title: \"Digitaal vlaanderen - adres locaties\"\n description: \"Deze dienst geeft adresinformatie die beschikbaar is in KBO en in GRAR (Gebouwen- & AdressenRegister). Meer specifiek worden de adreslocaties opgehaald.\"\n contact:\n name: \"Magda helpdesk\"\n url: \"https://overheid.vlaanderen.be/magda\"\n license:\n name: \"Adreslocaties\"\n url: \"https://overheid.vlaanderen.be/magda\"\n version: \"1.0.0\"\nservers:\n - url: \"api/v1/onderneming\"\n\npaths:\n /ondernemingen/adressenLocaties/{ondernemingsNummer}:\n get:\n tags:\n - \"Adressenlocaties\"\n summary: \"Haalt de adressenlocaties op van een gegeven ondernemingsnummer.\"\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: ondernemingsNummer\n in: path\n required: true\n schema:\n $ref: '#/components/schemas/ondernemingsNummer'\n responses:\n 200:\n description: \"Response met inhoud\"\n content:\n application/json:\n schema:\n $ref: \"#/components/schemas/adresLocatieLijstObject\"\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\ncomponents:\n parameters:\n CorrelationId:\n name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n #HTTP Status 400\n BadRequest:\n description: \"Invalid data supplied\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 401\n InvalidAuthorization:\n description: \"Invalid authorization\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 403\n Forbidden:\n description: \"Authentication failed\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 404\n NotFound:\n description: \"Resource not found\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 412\n PreConditionFailed:\n description: Precondition Failed\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 500\n UnexpectedServerError:\n description: \"Unexpected Server Error\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 502\n BadGateway:\n description: \"Bad Gateway\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 503\n ServiceUnavailable:\n description: \"Service unavailable\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 504\n GatewayTimeout:\n description: \"Gateway Timeout\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n\n schemas:\n Correlation-Id:\n description: \"ID van de transactie. Gebruik deze ID voor het tracen van logs en voor het afhandelen van incidenten.\"\n type: string\n minLength: 10\n maxLength: 36\n\n adresLocatieLijstObject:\n type: object\n properties:\n \"@context\":\n type: string\n example: \"https://vlaamseoverheid.atlassian.net/wiki/download/attachments/6118410708/adressenLocaties-context.jsonld?api=v2\"\n ondernemingsNummer:\n $ref: '#/components/schemas/ondernemingsNummer'\n soortOnderneming:\n $ref: '#/components/schemas/soortOnderneming'\n adresLocatieLijst:\n type: array\n items:\n $ref: '#/components/schemas/adresLocatie'\n required:\n - ondernemingsNummer\n adresLocatie:\n type: object\n properties:\n kboAdres:\n $ref: '#/components/schemas/kboAdres'\n grarAdressen:\n type: array\n items:\n $ref: '#/components/schemas/grarAdres'\n\n ondernemingsNummer:\n description: \"Ondernemingsnummer zoals gekend bij KBO\"\n type: string\n pattern: \"[0-9]{10}\"\n \n soortOnderneming:\n type: object \n description: \"Duidt aan of de onderneming een natuurlijk persoon of rechtspersoon betreft. Komt niet terug bij een vestiging.\"\n properties:\n code:\n type: object\n properties:\n waarde:\n type: integer\n maxLength: 1\n description: \"1: Natuurlijke persoon, 2: Rechtspersoon\"\n example: 1\n beschrijving:\n type: string\n maxLength: 255\n description: \"1: Natuurlijke persoon, 2: Rechtspersoon\"\n example: \"Natuurlijke persoon\"\n required: \n - waarde\n kboAdres:\n type: object\n properties:\n datumBegin:\n type: string\n format: date\n datumEinde: \n type: string\n format: date\n straat:\n type: object\n properties:\n code:\n type: string\n maxLength: 4\n description: \"RR code van straat\"\n naam:\n type: string\n maxLength: 120\n huisNummer:\n type: string\n maxLength: 15\n example: \"75A\"\n busNummer:\n type: string\n maxLength: 15\n example: \"101\"\n gemeente:\n type: object\n properties:\n nisCode:\n type: string\n pattern: \"[0-9]{1,5}\"\n postCode:\n type: string\n maxLength: 15\n example: \"2800\"\n naam:\n type: string\n maxLength: 120\n example: \"Mechelen\"\n staat:\n type: string\n maxLength: 120\n description: \"Buitenlandse staat\"\n example: \"OH\"\n land:\n type: object\n properties:\n nisCode:\n type: string\n pattern: \"[0-9]{3}\"\n isoCode:\n type: string\n pattern: \"[a-zA-A0-9]{2,3}\"\n naam:\n type: string\n maxLength: 120\n example: \"België\"\n required:\n - nisCode\n taal:\n type: object\n description: \"Bevat code en omschrijving van de taal waarin het adres terugkomt.\"\n properties:\n code:\n type: object\n properties:\n waarde:\n type: string\n example: 0\n maxLength: 2\n description: \"De taal van het adres in code (0, 1, 2, 3). Opm.: Er kunnen mogelijk andere codes terugkomen, maar deze krijgen dan geen Beschrijving. Het betreft hier voor ons onbekende codes die we vanuit KBO hebben ontvangen.\"\n beschrijving:\n type: string\n maxLength: 255\n example: \"onbekend\"\n description: \"0: onbekend, 1: fr, 2: nl, 3: de\"\n required:\n - waarde\n required:\n - code\n type:\n type: object\n properties:\n code:\n type: object\n properties:\n waarde:\n type: string\n minLength: 3\n maxLength: 3\n description: \"Type adres: 001: Onderneming, 002: Vestiging, 003: Bijhuis\"\n example: \"001\"\n beschrijving: \n type: string\n maxLength: 255\n description: \"Type adres: 001: Onderneming, 002: Vestiging, 003: Bijhuis\"\n example: \"Onderneming\"\n required:\n - waarde\n required:\n - code\n \n grarAdres:\n type: object\n properties:\n taalCode:\n type: string\n enum:\n - \"nl\"\n - \"fr\"\n - \"de\"\n - \"en\"\n grarId:\n type: number\n straat:\n type: object\n properties:\n grarId:\n type: number\n naam:\n type: string\n maxLength: 120\n huisNummer:\n type: string\n maxLength: 15\n example: \"75A\"\n busNummer:\n type: string\n maxLength: 15\n example: \"101\"\n postKanton:\n type: string\n pattern: \"[1-9][0-9]{3}\"\n homoniemToevoeging:\n type: string\n maxLength: 50\n description: \"Toevoeging die toelaat het onderscheid te maken tussen twee straten die dezelfde naam hebben binnen dezelfde gemeente.\"\n adresPositie:\n type: object\n properties:\n coördinaat:\n type: string\n maxLength: 50\n example: \"POINT (110892.88 210440.22)\"\n positieGeometrieMethode:\n type: string\n enum:\n - aangeduidDoorBeheerder\n - afgeleidVanObject\n - geïnterpoleerd\n positieSpecificatie:\n type: string\n enum:\n - gemeente\n - straat\n - perceel\n - lot\n - standplaats\n - ligplaats\n - gebouw\n - gebouweenheid\n - ingang\n - wegsegment\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: \"A URI reference that identifies the problem type. This specification encourages that, when de-referenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be about:blank.\"\n title:\n type: string\n description: \"A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.\"\n status:\n type: string\n description: \"The HTTP status code generated by the origin server for this occurrence of the problem.\"\n detail:\n type: string\n description: \"A human-readable explanation specific to this occurrence of the problem.\"\n instance:\n type: string\n description: \"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if de-referenced.\"\n description: \"A representation of a generic error message.\""},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"bc80c42f-151c-47e3-8514-1f3d4a6ee6a6"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"7b4ac57b-2934-435c-a50d-ada46fde7767"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"CompanyCompositionControls","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"1b3cb1e6-5ce5-4a3e-b1ff-dfe22d2726ca","collection":"contentId-6118410708","type":"file"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: \"3.0.3\"\ninfo:\n title: \"Digitaal Vlaanderen - UBO register API\"\n description: \"API to request data from the UBO register at FodFin. Release Sep23\"\n contact:\n name: \"Magda helpdesk\"\n url: \"https://overheid.vlaanderen.be/magda\"\n license:\n name: \"UBO register\"\n url: \"https://overheid.vlaanderen.be/magda\"\n version: \"1.0.0\"\nservers:\n - url: \"api/v1/company\"\npaths: \n /ubo/companyCompositions/controls:\n get:\n tags:\n - \"controls\"\n summary: \"Finds all actives controls for a specified company\"\n operationId: getCompanyControls\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: companyNumber\n in: header\n description: CBE/foreign identifier\n required: true\n schema:\n maxLength: 30\n minLength: 1\n type: string\n - name: controlType\n in: query\n description: Define a control type to filter the returned controls\n required: false\n schema:\n $ref: '#/components/schemas/ControlType'\n \n responses:\n 200:\n description: \"Response with payload\"\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/ResumedControlDTO'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n /ubo/controls/{controlId}:\n get:\n tags:\n - \"controls\"\n summary: \"request the control based on the ControlId.\"\n operationId: getControlDetails\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: controlId\n in: path\n required: true\n schema:\n type: integer\n format: int64\n responses:\n 200:\n description: \"Response with payload\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DetailedControlDTO'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n\ncomponents:\n parameters:\n CorrelationId:\n name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n #HTTP Status 400\n BadRequest:\n description: \"Invalid data supplied\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 401\n InvalidAuthorization:\n description: \"Invalid authorization\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 403\n Forbidden:\n description: \"Authentication failed\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 404\n NotFound:\n description: \"Resource not found\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 412\n PreConditionFailed:\n description: Precondition Failed\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 500\n UnexpectedServerError:\n description: \"Unexpected Server Error\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 502\n BadGateway:\n description: \"Bad Gateway\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 503\n ServiceUnavailable:\n description: \"Service unavailable\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 504\n GatewayTimeout:\n description: \"Gateway Timeout\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n schemas:\n Correlation-Id:\n description: \"ID of the transaction. Use this ID for log tracing and incident handling\"\n type: string\n minLength: 10\n maxLength: 36\n ResumedControlDTO:\n type: object\n properties:\n beneficiaryName:\n type: string\n description: Control's beneficiary\n nullable: true\n beneficiaryLastName:\n type: string\n description: Control's last name beneficiary\n nullable: true\n beneficiaryFirstName:\n type: string\n description: Control's first name beneficiary\n nullable: true\n beneficiarySitranNames:\n type: object\n additionalProperties:\n type: string\n description: Control's name translatable\n nullable: true\n description: Control's name translatable\n beneficiaryIdentifier:\n type: string\n description: Company BCE/foreign identifier\n nullable: true\n controlId:\n type: integer\n description: Technical id\n format: int64\n beneficiaryType:\n type: string\n description: Beneficiary's type\n enum:\n - COMPANY\n - PERSON\n - CATEGORY\n controlType:\n type: string\n description: Control's type\n enum:\n - NONE\n - PERCENT\n - OTHER\n - CEO\n - BOARD_MEMBER\n - REPRESENTATIVE\n - DAILY_MANAGER\n - FOUNDER\n - PHYSICAL_PERSON\n - CATEGORY\n - OTHER_NON_PROFIT\n - CATEGORY_TRUST\n - OTHER_TRUST\n - BENEFICIARIES\n - PROTECTOR\n - TRUSTEE\n - SETTLOR\n percentInVote:\n type: number\n description: Control vote percentage\n percent:\n type: number\n description: Control capital percentage\n groupName:\n type: string\n description: Group's name to which the control belongs\n nullable: true\n groupId:\n type: number\n description: Group's identifier to which the control belongs\n derogated:\n type: boolean\n description: Define the control derogation status\n validated:\n type: boolean\n description: Define if the control has been validated by the owner\n belgian:\n type: boolean\n description: Define if the control is belgian\n description: Resumed representation of the control business object\n DetailedControlDTO:\n type: object\n properties:\n controlId:\n type: integer\n description: Control id\n format: int64\n controlType:\n type: string\n description: Control's type\n nullable: true\n beginDate:\n type: string\n description: Control's start date\n nullable: true\n endDate:\n type: string\n description: Control's end date\n nullable: true\n percentInVote:\n type: number\n description: Control capital percentage\n percent:\n type: number\n description: Control vote percentage\n beneficiary:\n $ref: '#/components/schemas/BeneficiaryDTO'\n companyIdentifier:\n type: string\n description: Company BCE/foreign identifier\n nullable: true\n group:\n $ref: '#/components/schemas/GroupDTO'\n comment:\n type: string\n description: Comment\n nullable: true\n derogated:\n type: boolean\n description: Define the control derogation status\n documents:\n type: array\n description: Set of supporting documents\n items:\n $ref: '#/components/schemas/ControlDocumentResumedDTO'\n description:\n type: string\n description: Description\n nullable: true\n BeneficiaryDTO:\n type: object\n properties:\n identifier:\n type: string\n description: Beneficiary's identifier\n nullable: true\n type:\n type: string\n description: Beneficiary's type\n nullable: true\n description: Beneficiary\n discriminator:\n propertyName: type\n mapping:\n COMPANY: '#/components/schemas/CompanyDTO'\n PERSON: '#/components/schemas/PersonDTO'\n CATEGORY: '#/components/schemas/CategoryDTO'\n oneOf:\n - $ref: '#/components/schemas/PersonDTO'\n - $ref: '#/components/schemas/CompanyDTO'\n - $ref: '#/components/schemas/CategoryDTO'\n GroupDTO:\n type: object\n properties:\n id:\n type: string\n description: Group's id\n nullable: true\n name:\n type: string\n description: Group's type\n nullable: true\n description: Group to which the control belongs\n ControlDocumentResumedDTO:\n type: object\n properties:\n name:\n type: string\n description: Name of the supporting document\n nullable: true\n uuid:\n type: string\n description: UUI of the supporting document, id is needed to retrieve document\n nullable: true\n controlId:\n type: integer\n description: Name of the beneficiary\n format: int64\n type:\n type: string\n description: The type of document\n nullable: true\n dueDate:\n type: string\n description: The dueDate of the document\n format: date\n nullable: true\n documentId:\n type: integer\n description: 'The documentId '\n format: int64\n removed:\n type: boolean\n description: A boolean to show if removed or not\n description: Set of supporting documents\n PersonDTO:\n type: object\n properties:\n identifier:\n type: string\n description: Beneficiary's identifier\n nullable: true\n type:\n type: string\n description: Beneficiary's type\n nullable: true\n firstName:\n type: string\n description: Person's firstname\n nullable: true\n lastName:\n type: string\n description: Person's lastname\n nullable: true\n birthDate:\n type: string\n description: Person's birthdate\n nullable: true\n nationalities:\n type: array\n description: Person's nationalities\n items:\n type: string\n description: Person's nationalities\n nullable: true\n CompanyDTO:\n type: object\n properties:\n identifier:\n type: string\n description: Beneficiary's identifier\n nullable: true\n type:\n type: string\n description: Beneficiary's type\n nullable: true\n name:\n type: string\n description: Company's name\n nullable: true\n sitranNames:\n type: object\n additionalProperties:\n type: string\n description: Control's name translatable\n nullable: true\n description: Control's name translatable\n creationDate:\n type: string\n description: Company's creation date\n format: date\n nullable: true\n companyType:\n type: string\n description: Company's type\n enum:\n - NON_PROFIT\n - ARTICLE2\n - FOREIGN_TRUST\n - FOREIGN\n - NONE\n nacebelCodes:\n type: object\n additionalProperties:\n type: object\n additionalProperties:\n type: string\n description: Nacebel codes\n nullable: true\n description: Nacebel codes\n description: Nacebel codes\n CategoryDTO:\n type: object\n properties:\n identifier:\n type: string\n description: Beneficiary's identifier\n nullable: true\n type:\n type: string\n description: Beneficiary's type\n nullable: true\n name:\n type: string\n description: Category's name\n nullable: true\n ControlType:\n type: string\n description: Control's type\n enum:\n - NONE\n - PERCENT\n - OTHER\n - CEO\n - BOARD_MEMBER\n - REPRESENTATIVE\n - DAILY_MANAGER\n - FOUNDER\n - PHYSICAL_PERSON\n - CATEGORY\n - OTHER_NON_PROFIT\n - CATEGORY_TRUST\n - OTHER_TRUST\n - BENEFICIARIES\n - PROTECTOR\n - TRUSTEE\n - SETTLOR\n\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: \"A URI reference that identifies the problem type. This specification encourages that, when de-referenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be about:blank.\"\n title:\n type: string\n description: \"A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.\"\n status:\n type: string\n description: \"The HTTP status code generated by the origin server for this occurrence of the problem.\"\n detail:\n type: string\n description: \"A human-readable explanation specific to this occurrence of the problem.\"\n instance:\n type: string\n description: \"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if de-referenced.\"\n description: \"A representation of a generic error message.\""},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"337b4042-4448-4af7-a647-b8678b44a1a1"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"3b539360-d430-409d-9c0b-9db90f129c13"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"socialBillRetainment","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"d23f1c9a-45df-4ab6-a91a-99a11bc1bfa7","collection":"contentId-6118410708","type":"file"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: 3.0.3\ninfo:\n title: company.socialBillRetainment Service\n description: ''\n contact:\n name: company.socialBillRetainmentAPI\n email: helpdesk.magda@vlaanderen.be\n license:\n name: company.socialBillRetainmentAPI\n url: 'https://overheid.vlaanderen.be/magda'\n version: '1.0'\nservers:\n - url: /api/v1/company\ntags:\n - name: socialBillRetainment\npaths:\n /socialBillRetainment/retainmentObligations/search:\n post:\n tags:\n - socialBillRetainment\n summary: Post Search Social Retainment Obligations\n description: |-\n This operation is used to request the social retainment obligations given a list of employerIdentifications:\n - enterpriseNumber (CBE number)\n - vatNumber (European VAT identification)\n - otherId (official foreign indentifier)\n\n The answer contains the social retainment information for each employerIdentification in the request.\n operationId: searchRetainmentObligations\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n description: Maximum 200 employerIdentifications per request.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SearchRetainmentObligationsRequest'\n required: true\n\n responses:\n \"200\":\n description: Retainment Obligation\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/BillRetainmentObligationsResponse'\n '400':\n $ref: '#/components/responses/BadRequest'\n '401':\n $ref: '#/components/responses/InvalidAuthorization'\n '403':\n $ref: '#/components/responses/NoAttestationAuthorization'\n '404':\n $ref: '#/components/responses/AttestationNotFound'\n '412':\n $ref: '#/components/responses/PreConditionFailed'\n '500':\n $ref: '#/components/responses/UnexpectedServerError'\n '502':\n $ref: '#/components/responses/BadGateway'\n '503':\n $ref: '#/components/responses/ServiceUnavailable'\n '504':\n $ref: '#/components/responses/GatewayTimeout'\n\ncomponents:\n responses:\n BadRequest:\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n InvalidAuthorization:\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n NoAttestationAuthorization:\n description: Not authorized to obtain this attestation\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n AttestationNotFound:\n description: Attestation not found\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n PreConditionFailed:\n description: Precondition Failed\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n UnexpectedServerError:\n description: Unexpected Server Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n BadGateway:\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n ServiceUnavailable:\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n GatewayTimeout:\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n schemas:\n SearchRetainmentObligationsRequest:\n type: object\n properties:\n \"@context\":\n type: string\n default: \"https://vlaamseoverheid.atlassian.net/wiki/download/attachments/6118410708/context-socialBillretainment.jsonld?api=v2\"\n employerIdentifications:\n maxItems: 100\n minItems: 1\n type: array\n items:\n type: string\n BillRetainmentObligationsResponse:\n allOf:\n - $ref: '#/components/schemas/Context'\n - $ref: '#/components/schemas/Collection'\n - type: object\n properties:\n items:\n type: array\n items:\n $ref: '#/components/schemas/BillRetainmentObligations'\n Context:\n type: object\n properties:\n \"@context\":\n type: string\n default: \"https://vlaamseoverheid.atlassian.net/wiki/download/attachments/6118410708/context-socialBillretainment.jsonld?api=v2\"\n Collection:\n required:\n - total\n type: object\n properties:\n total:\n type: integer\n description: Total number of items.\n format: int32\n description: Collection of items.\n x-parent: true\n EmployerIdentification:\n type: array\n maxItems: 3\n items:\n $ref: '#/components/schemas/EnterpriseIdentification'\n description: \"Array with at least one employer identifications is required enterpriseNumber,\\\n \\ vatNumber, otherId to identify the (sub)contractor. EmployerIdentification can be enterpriseNumber, vatNumber, otherId identifier. The searches of the employeridentifications are case-sensitive and will be conducted in uppercase.\"\n EnterpriseIdentification:\n type: object\n properties:\n identification:\n type: string\n type:\n type: string\n enum:\n - enterpriseNumber\n - vatNumber\n - otherId\n BillRetainmentObligations:\n type: object\n properties:\n status:\n type: string\n description: Response status for the request of an Employer\n enum:\n - employerFoundBillRetainment\n - employerNotFoundBillRetainment\n - unexpectedError\n employer:\n type: object\n properties:\n employerIdentification:\n $ref: '#/components/schemas/EmployerIdentification'\n decisionDate:\n type: string\n description: Date when the decision for retainment obligation was made\n format: date-time\n retainmentObligation:\n type: boolean\n description: Decision on retainment obligation\n retainmentExpirationDate:\n type: string\n description: Date to which the decision is valid (only filled in while RetainmentObligation\n is false)\n format: date-time\n\n Correlation-Id:\n description: \"ID of the transaction. Use this ID for log tracing and incident handling.\"\n type: string\n maxLength: 36\n minLength: 10\n\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: 'A URI reference that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be \"about:blank\".'\n title:\n type: string\n description: 'A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.'\n status:\n type: string\n description: The HTTP status code generated by the origin server for this occurrence of the problem.\n detail:\n type: string\n description: A human-readable explanation specific to this occurrence of the problem.\n instance:\n type: string\n description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n description: A representation of a generic error message\n "},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"0d01fb7f-0c20-4780-b6c4-1305d5c6d625"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"40efa384-b98a-4110-b019-de42ed8a0b3f"}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Organisaties","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Verenigingen","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"6e30728c-8ad2-4b16-8ecd-dcb154ad80cd","collection":"contentId-6118410708","type":"file"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: \"3.0.2\"\ninfo:\n title: \"Verenigingen\"\n description: \"Een api voor het beheer van een (feitelijke) verenigingen voor verenigingsregister\"\n contact:\n name: \"Magda helpdesk\"\n url: \"https://overheid.vlaanderen.be/magda\"\n license:\n name: \"Verenigingen\"\n url: \"https://overheid.vlaanderen.be/magda\"\n version: \"1.0.0\"\nservers:\n - url: \"api/v1/organisaties\"\n\npaths:\n /verenigingen/verenigingen/{vCode}:\n get:\n tags:\n - Opvragen van verenigingen\n summary: Vraag het detail van een vereniging op.\n parameters:\n - name: vCode\n in: path\n description: De vCode van de vereniging\n required: true\n schema:\n type: string\n - name: expectedSequence\n in: query\n description: Sequentiewaarde verkregen bij creatie of aanpassing vereniging.\n schema:\n type: integer\n format: int64\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n 200:\n description: Het detail van een vereniging\n headers:\n ETag:\n description: De versie van de aangepaste vereniging.\n schema:\n type: string\n description: De versie van de aangepaste vereniging.\n format: ''\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.DetailVerenigingResponse\n 400:\n $ref: \"#/components/responses/BadRequest\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n\n patch:\n tags:\n - Decentraal beheer van verenigingen\n summary: Wijzig de basisgegevens van een vereniging.\n description: \"Enkel velden die worden doorgestuurd in de request worden verwerkt. Null waarden worden niet verwerkt.\\r\\nWanneer er wijzigingen veroorzaakt zijn door de request, bevat de response een sequence header.\\r\\n \\r\\nNa het uitvoeren van deze actie wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de aanpassing\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: vCode\n in: path\n description: De vCode van de vereniging\n required: true\n schema:\n type: string\n - name: If-Match\n in: header\n description: >-\n If-Match header met ETag van de laatst gekende versie van de\n vereniging.\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: ''\n content:\n application/json:\n schema:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.WijzigBasisgegevens.FeitelijkeVereniging.RequestModels.WijzigBasisgegevensRequest\n responses:\n 200:\n description: Er waren geen wijzigingen\n 202:\n description: De basisgegevens van de vereniging werden gewijzigd\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de aangepaste vereniging.\n schema:\n type: string\n description: De versie van de aangepaste vereniging.\n format: ''\n Location:\n description: De locatie van de aangepaste vereniging.\n schema:\n type: string\n description: De locatie van de aangepaste vereniging.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequestValidation\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n\n /verenigingen/verenigingen/{vCode}/contactgegevens:\n post:\n tags:\n - Decentraal beheer van verenigingen\n summary: Voeg een contactgegeven toe.\n description: \"Na het uitvoeren van deze actie wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de aanpassing\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: vCode\n in: path\n description: De VCode van de vereniging\n required: true\n schema:\n type: string\n - name: If-Match\n in: header\n description: >-\n If-Match header met ETag van de laatst gekende versie van de\n vereniging.\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Het toe te voegen contactgegeven\n content:\n application/json:\n schema:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.FeitelijkeVereniging.VoegContactGegevenToe.RequestsModels.VoegContactgegevenToeRequest\n responses:\n 202:\n description: Het contactgegeven werd goedgekeurd.\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de geregistreerde vereniging.\n schema:\n type: string\n description: De versie van de geregistreerde vereniging.\n format: ''\n Location:\n description: De locatie van de toegevoegde contactgegeven.\n schema:\n type: string\n description: De locatie van de toegevoegde contactgegeven.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequestValidation\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n\n /verenigingen/verenigingen/{vCode}/contactgegevens/{contactgegevenId}:\n delete:\n tags:\n - Decentraal beheer van verenigingen\n summary: Verwijder een contactgegeven.\n description: \"Na het uitvoeren van deze actie wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de aanpassing\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: vCode\n in: path\n description: De unieke identificatie code van deze vereniging\n required: true\n schema:\n type: string\n - name: contactgegevenId\n in: path\n description: >-\n De unieke identificatie code van dit contactgegeven binnen de\n vereniging\n required: true\n schema:\n type: integer\n format: int32\n - name: If-Match\n in: header\n description: >-\n If-Match header met ETag van de laatst gekende versie van de\n vereniging.\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '202':\n description: Het contactgegeven werd verwijderd.\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de geregistreerde vereniging.\n schema:\n type: string\n description: De versie van de geregistreerde vereniging.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequestValidation\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n\n patch:\n tags:\n - Decentraal beheer van verenigingen\n summary: Wijzig een contactgegeven.\n description: \"Na het uitvoeren van deze actie wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de aanpassing\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: vCode\n in: path\n description: De unieke identificatie code van deze vereniging\n required: true\n schema:\n type: string\n - name: contactgegevenId\n in: path\n description: >-\n De unieke identificatie code van dit contactgegeven binnen de\n vereniging\n required: true\n schema:\n type: integer\n format: int32\n - name: If-Match\n in: header\n description: >-\n If-Match header met ETag van de laatst gekende versie van de\n vereniging.\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Het te wijzigen contactgegeven\n content:\n application/json:\n schema:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.FeitelijkeVereniging.WijzigContactgegeven.RequestModels.WijzigContactgegevenRequest\n responses:\n '200':\n description: Er waren geen wijzigingen.\n '202':\n description: De wijziging werd aanvaard.\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de geregistreerde vereniging.\n schema:\n type: string\n description: De versie van de geregistreerde vereniging.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequestValidation\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n\n /verenigingen/verenigingen/{vCode}/historiek:\n get:\n tags:\n - Opvragen van verenigingen\n summary: Vraag de historiek van een vereniging op.\n description: \"De historiek van een vereniging geeft zicht op de wijzigingen op de verenigingsdata zoals terug te vinden in het register.\\r\\n \\r\\nDe gebeurtenissen met naam “WerdGewijzigd” betekenen voor de basisgegevens het volgende:\\r\\n- data werd toegevoegd (een waarde werd toegevoegd na registratie van de vereniging)\\r\\n- data werd gewijzigd (de bestaande waarde werd gewijzigd)\\r\\n- data werd verwijderd (de waarde werd verwijderd)\\r\\n \\r\\nContactgegevens, locaties en vertegenwoordigers maken geen onderdeel uit van de basisgegevens.\\r\\nWijzigingen op deze data genereren gebeurtenissen met de namen “WerdToegevoegd”, “WerdGewijzigd” en “WerdVerwijderd”.\"\n parameters:\n - name: vCode\n in: path\n description: De vCode van de vereniging\n required: true\n schema:\n type: string\n - name: expectedSequence\n in: query\n description: Sequentiewaarde verkregen bij creatie of aanpassing vereniging.\n schema:\n type: integer\n format: int64\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: De historiek van een vereniging\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Historiek.ResponseModels.HistoriekResponse\n 400:\n $ref: \"#/components/responses/BadRequest\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n /verenigingen/verenigingen/{vCode}/kbo:\n patch:\n tags:\n - Wijzigen van gegevens uit KBO\n summary: Wijzig de basisgegevens.\n description: \"Enkel velden die worden doorgestuurd in de request worden verwerkt. Null waarden worden niet verwerkt.\\r\\nWanneer er wijzigingen veroorzaakt zijn door de request, bevat de response een sequence header.\\r\\n \\r\\nNa het uitvoeren van deze actie wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de aanpassing\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: vCode\n in: path\n description: De vCode van de vereniging\n required: true\n schema:\n type: string\n - name: If-Match\n in: header\n description: >-\n If-Match header met ETag van de laatst gekende versie van de\n vereniging.\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: ''\n content:\n application/json:\n schema:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.WijzigBasisgegevens.MetRechtspersoonlijkheid.RequestModels.WijzigBasisgegevensRequest\n responses:\n '200':\n description: Er waren geen wijzigingen\n '202':\n description: De basisgegevens van de vereniging werden gewijzigd\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de aangepaste vereniging.\n schema:\n type: string\n description: De versie van de aangepaste vereniging.\n format: ''\n Location:\n description: De locatie van de aangepaste vereniging.\n schema:\n type: string\n description: De locatie van de aangepaste vereniging.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequest\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n /verenigingen/verenigingen/{vCode}/kbo/contactgegevens/{contactgegevenId}:\n patch:\n tags:\n - Wijzigen van gegevens uit KBO\n summary: Wijzig een contactgegeven uit KBO.\n description: \"Na het uitvoeren van deze actie wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de aanpassing\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: vCode\n in: path\n description: De unieke identificatie code van deze vereniging\n required: true\n schema:\n type: string\n - name: contactgegevenId\n in: path\n description: >-\n De unieke identificatie code van dit contactgegeven binnen de\n vereniging\n required: true\n schema:\n type: integer\n format: int32\n - name: If-Match\n in: header\n description: >-\n If-Match header met ETag van de laatst gekende versie van de\n vereniging.\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: Het te wijzigen contactgegeven\n content:\n application/json:\n schema:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.VerenigingMetRechtspersoonlijkheid.WijzigContactgegeven.RequestModels.WijzigContactgegevenRequest\n responses:\n '200':\n description: Er waren geen wijzigingen.\n '202':\n description: De wijziging werd aanvaard.\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de geregistreerde vereniging.\n schema:\n type: string\n description: De versie van de geregistreerde vereniging.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequest\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n /verenigingen/verenigingen/{vCode}/kbo/locaties/{locatieId}:\n patch:\n tags:\n - Wijzigen van gegevens uit KBO\n summary: Wijzig de maatschappelijke zetel volgens KBO.\n description: \"Na het uitvoeren van deze actie wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de aanpassing\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: vCode\n in: path\n description: De VCode van de vereniging\n required: true\n schema:\n type: string\n - name: locatieId\n in: path\n description: >-\n De unieke identificatie code van de maatschappelijke zetel volgens\n KBO binnen de vereniging.\n required: true\n schema:\n type: integer\n format: int32\n - name: If-Match\n in: header\n description: >-\n If-Match header met ETag van de laatst gekende versie van de\n vereniging.\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: De te wijzigen gegevens\n content:\n application/json:\n schema:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Locaties.VerenigingMetRechtspersoonlijkheid.WijzigMaatschappelijkeZetel.RequestModels.WijzigMaatschappelijkeZetelRequest\n example:\n locatie:\n isPrimair: true\n naam: Naam locatie\n responses:\n '200':\n description: Er waren geen wijzigingen.\n '202':\n description: De locatie werd gewijzigd.\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de geregistreerde vereniging.\n schema:\n type: string\n description: De versie van de geregistreerde vereniging.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequest\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n\n /verenigingen/verenigingen/{vCode}/locaties:\n post:\n tags:\n - Decentraal beheer van verenigingen\n summary: Voeg een locatie toe.\n description: \"Na het uitvoeren van deze actie wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de aanpassing\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: vCode\n in: path\n description: De VCode van de vereniging\n required: true\n schema:\n type: string\n - name: If-Match\n in: header\n description: >-\n If-Match header met ETag van de laatst gekende versie van de\n vereniging.\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: De toe te voegen locatie\n content:\n application/json:\n schema:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Locaties.FeitelijkeVereniging.VoegLocatieToe.RequestModels.VoegLocatieToeRequest\n responses:\n '202':\n description: De locatie werd goedgekeurd.\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de geregistreerde vereniging.\n schema:\n type: string\n description: De versie van de geregistreerde vereniging.\n format: ''\n Location:\n description: De locatie van de toegevoegde locatie.\n schema:\n type: string\n description: De locatie van de toegevoegde locatie.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequestValidation\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n\n /verenigingen/verenigingen/{vCode}/locaties/{locatieId}:\n delete:\n tags:\n - Decentraal beheer van verenigingen\n summary: Verwijder een locatie.\n description: \"Na het uitvoeren van deze actie wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de aanpassing\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: vCode\n in: path\n description: De unieke identificatie code van deze vereniging\n required: true\n schema:\n type: string\n - name: locatieId\n in: path\n description: >-\n De unieke identificatie code van deze locatie die verwijderd moet\n worden\n required: true\n schema:\n type: integer\n format: int32\n - name: If-Match\n in: header\n description: >-\n If-Match header met ETag van de laatst gekende versie van de\n vereniging.\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '202':\n description: De vertegenwoordiger werd verwijderd van deze vereniging.\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de geregistreerde vereniging.\n schema:\n type: string\n description: De versie van de geregistreerde vereniging.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequestValidation\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n\n patch:\n tags:\n - Decentraal beheer van verenigingen\n summary: Wijzig een locatie.\n description: \"Na het uitvoeren van deze actie wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de aanpassing\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: vCode\n in: path\n description: De VCode van de vereniging\n required: true\n schema:\n type: string\n - name: locatieId\n in: path\n description: De unieke identificatie code van deze locatie binnen de vereniging.\n required: true\n schema:\n type: integer\n format: int32\n - name: If-Match\n in: header\n description: >-\n If-Match header met ETag van de laatst gekende versie van de\n vereniging.\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: De te wijzigen locatie\n content:\n application/json:\n schema:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Locaties.FeitelijkeVereniging.WijzigLocatie.RequestModels.WijzigLocatieRequest\n responses:\n '200':\n description: Er waren geen wijzigingen.\n '202':\n description: De locatie werd goedgekeurd.\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de geregistreerde vereniging.\n schema:\n type: string\n description: De versie van de geregistreerde vereniging.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequestValidation\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n /verenigingen/verenigingen/{vCode}/stop:\n post:\n tags:\n - Decentraal beheer van verenigingen\n summary: Stoppen van een vereniging.\n description: \"Wanneer er wijzigingen veroorzaakt zijn door de request, bevat de response een sequence header.\\r\\n \\r\\nNa het uitvoeren van deze actie wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de aanpassing\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: vCode\n in: path\n description: De vCode van de vereniging\n required: true\n schema:\n type: string\n - name: If-Match\n in: header\n description: >-\n If-Match header met ETag van de laatst gekende versie van de\n vereniging.\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: ''\n content:\n application/json:\n schema:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Stop.RequestModels.StopVerenigingRequest\n responses:\n '200':\n description: Er waren geen wijzigingen\n '202':\n description: De vereniging werd gestopt\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de aangepaste vereniging.\n schema:\n type: string\n description: De versie van de aangepaste vereniging.\n format: ''\n Location:\n description: De locatie van de aangepaste vereniging.\n schema:\n type: string\n description: De locatie van de aangepaste vereniging.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequestValidation\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n\n /verenigingen/verenigingen/{vCode}/vertegenwoordigers:\n post:\n tags:\n - Decentraal beheer van verenigingen\n summary: Voeg een vertegenwoordiger toe.\n description: \"Na het uitvoeren van deze actie wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de aanpassing\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: vCode\n in: path\n description: De vCode van de vereniging\n required: true\n schema:\n type: string\n - name: If-Match\n in: header\n description: >-\n If-Match header met ETag van de laatst gekende versie van de\n vereniging.\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: De gegevens van de toe te voegen vertegenwoordiger\n content:\n application/json:\n schema:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Vertegenwoordigers.FeitelijkeVereniging.VoegVertegenwoordigerToe.RequestModels.VoegVertegenwoordigerToeRequest\n responses:\n '202':\n description: De vertegenwoordiger werd toegevoegd.\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de geregistreerde vereniging.\n schema:\n type: string\n description: De versie van de geregistreerde vereniging.\n format: ''\n Location:\n description: De locatie van de toegevoegde vertegenwoordiger.\n schema:\n type: string\n description: De locatie van de toegevoegde vertegenwoordiger.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequestValidation\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n\n /verenigingen/verenigingen/{vCode}/vertegenwoordigers/{vertegenwoordigerId}:\n delete:\n tags:\n - Decentraal beheer van verenigingen\n summary: Verwijder een vertegenwoordiger.\n description: \"Na het uitvoeren van deze actie wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de aanpassing\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: vCode\n in: path\n description: De unieke identificatie code van deze vereniging\n required: true\n schema:\n type: string\n - name: vertegenwoordigerId\n in: path\n description: >-\n De unieke identificatie code van deze vertegenwoordiger die\n verwijderd moet worden\n required: true\n schema:\n type: integer\n format: int32\n - name: If-Match\n in: header\n description: >-\n If-Match header met ETag van de laatst gekende versie van de\n vereniging.\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '202':\n description: De vertegenwoordiger werd verwijderd van deze vereniging.\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de geregistreerde vereniging.\n schema:\n type: string\n description: De versie van de geregistreerde vereniging.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequestValidation\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n\n patch:\n tags:\n - Decentraal beheer van verenigingen\n summary: Wijzig een vertegenwoordiger.\n description: \"Na het uitvoeren van deze actie wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de aanpassing\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: vCode\n in: path\n description: De unieke identificatie code van deze vereniging\n required: true\n schema:\n type: string\n - name: vertegenwoordigerId\n in: path\n description: >-\n De unieke identificatie code van deze vertegenwoordiger binnen de\n vereniging\n required: true\n schema:\n type: integer\n format: int32\n - name: If-Match\n in: header\n description: >-\n If-Match header met ETag van de laatst gekende versie van de\n vereniging.\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: De gegevens van de vertegenwoordiger die gewijzigd moeten worden\n content:\n application/json:\n schema:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Vertegenwoordigers.FeitelijkeVereniging.WijzigVertegenwoordiger.RequestModels.WijzigVertegenwoordigerRequest\n responses:\n '200':\n description: Er waren geen wijzigingen.\n '202':\n description: De vertegenwoordiger werd gewijzigd.\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de geregistreerde vereniging.\n schema:\n type: string\n description: De versie van de geregistreerde vereniging.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequestValidation\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n\n /verenigingen/verenigingen/feitelijkeverenigingen:\n post:\n tags:\n - Registratie\n summary: Registreer een feitelijke vereniging.\n description: \"Bij het registreren van de vereniging wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de zonet geregistreerde vereniging\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: VR-BevestigingsToken\n in: header\n description: \"Dit token wordt gebruikt als bevestiging dat de vereniging uniek is,\\r\\n ondanks de voorgestelde duplicaten.\"\n schema:\n type: string\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: De gegevens van de te registreren vereniging\n content:\n application/json:\n schema:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.FeitelijkeVereniging.RequetsModels.RegistreerFeitelijkeVerenigingRequest\n responses:\n '202':\n description: De feitelijke vereniging werd geregistreerd.\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de geregistreerde vereniging.\n schema:\n type: string\n description: De versie van de geregistreerde vereniging.\n format: ''\n Location:\n description: De locatie van de geregistreerde vereniging.\n schema:\n type: string\n description: De locatie van de geregistreerde vereniging.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequestValidation\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 409:\n description: >-\n Er zijn één of meerdere mogelijke duplicaten van deze vereniging\n gevonden.\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.PotentialDuplicatesResponse\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n /verenigingen/verenigingen/kbo:\n post:\n tags:\n - Registratie\n summary: Registreer een vereniging met rechtspersoonlijkheid vanuit de KBO.\n description: \"Bij het registreren van de vereniging wordt een sequentie teruggegeven via de `VR-Sequence` header.\\r\\nDeze waarde kan gebruikt worden in andere endpoints om op te volgen of de zonet geregistreerde vereniging\\r\\nal is doorgestroomd naar deze endpoints.\"\n parameters:\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n requestBody:\n description: De gegevens van de te registreren vereniging\n content:\n application/json:\n schema:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.MetRechtspersoonlijkheid.RequestModels.RegistreerVerenigingUitKboRequest\n responses:\n '200':\n description: De vereniging was reeds geregistreerd in het register.\n headers:\n Location:\n description: De locatie van de geregistreerde vereniging.\n schema:\n type: string\n description: De locatie van de geregistreerde vereniging.\n format: ''\n '202':\n description: De vereniging met rechtspersoonlijkheid werd geregistreerd.\n headers:\n VR-Sequence:\n description: Het sequence nummer van deze request.\n schema:\n type: string\n description: Het sequence nummer van deze request.\n format: ''\n ETag:\n description: De versie van de geregistreerde vereniging.\n schema:\n type: string\n description: De versie van de geregistreerde vereniging.\n format: ''\n Location:\n description: De locatie van de geregistreerde vereniging.\n schema:\n type: string\n description: De locatie van de geregistreerde vereniging.\n format: ''\n 400:\n $ref: \"#/components/responses/BadRequestValidation\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\n\n /verenigingen/verenigingen/zoeken:\n get:\n tags:\n - Opvragen van verenigingen\n summary: Zoek verenigingen op.\n description: \"Dit endpoint laat toe verenigingen op te zoeken.\\r\\nVoor de zoekterm `q` kan je gebruik maken van volledige termen, of gebruik maken van wildcards.\\r\\n- `q=Liedekerke` zoekt in alle velden naar de volledige term,\\r\\n- `q=Liedeke*` zoekt in alle velden naar een term die begint met 'Liedeke',\\r\\n- `q=*kerke` zoekt in alle velden naar een term die eindigt op 'kerke',\\r\\n- `q=*kerke*` zoekt in alle velden naar een term die 'kerke' bevat.\\r\\nOm te zoeken binnen een bepaald veld, gebruik je de naam van het veld.\\r\\n- `q=gemeente:Liedekerke`\\r\\n- `q=korteNaam:DV*`\\r\\nOm te zoeken op een genest veld, beschrijf je het pad naar het veld.\\r\\n- `q=locaties.postcode:1000`\\r\\nStandaard gebruiken we een paginatie limiet van 50 verenigingen.\\r\\nOm een andere limiet te gebruiken, geef je de parameter `limit` mee.\\r\\nDe maximum limiet die kan gebruikt worden is 1000.\\r\\n- `q=...&limit=100`\\r\\nOm de volgende pagina's op te vragen, geef je de parameter `offset` mee.\\r\\n- `q=...&offset=50`\\r\\n- `q=...&offset=30&limit=30`\\r\\nEr kan enkel gepagineerd worden binnen de eerste 1000 resultaten.\\r\\nDit betekent dat de som van limit en offset nooit meer kan bedragen dan 1000.\"\n parameters:\n - name: q\n in: query\n description: De querystring\n schema:\n type: string\n - name: sort\n in: query\n description: De velden om op te sorteren\n schema:\n type: string\n - name: offset\n in: query\n description: Het aantal items dat overgeslagen zal worden\n schema:\n type: integer\n format: int32\n - name: limit\n in: query\n description: Het aantal items dat (maximaal) zal worden opgehaald\n schema:\n type: integer\n format: int32\n - name: X-Correlation-Id\n in: header\n description: Deze id identificeert de request.\n required: true\n schema:\n type: string\n format: uuid\n responses:\n '200':\n description: Indien de zoekopdracht succesvol was.\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.SearchVerenigingenResponse\n 400:\n $ref: \"#/components/responses/BadRequestValidation\"\n 401:\n $ref: \"#/components/responses/InvalidAuthorization\"\n 403:\n $ref: \"#/components/responses/Forbidden\"\n 404:\n $ref: \"#/components/responses/NotFound\"\n 412:\n $ref: \"#/components/responses/PreConditionFailed\"\n 500:\n $ref: \"#/components/responses/UnexpectedServerError\"\n 502:\n $ref: \"#/components/responses/BadGateway\"\n 503:\n $ref: \"#/components/responses/ServiceUnavailable\"\n 504:\n $ref: \"#/components/responses/GatewayTimeout\"\ncomponents:\n responses:\n #HTTP Status 400\n BadRequest:\n description: \"Invalid data supplied\"\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails\n\n BadRequestValidation:\n description: \"Invalid data supplied\"\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ValidationProblemDetails\n #HTTP Status 401\n InvalidAuthorization:\n description: \"Invalid authorization\"\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails\n #HTTP Status 403\n Forbidden:\n description: \"Authentication failed\"\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails\n #HTTP Status 404\n NotFound:\n description: \"Resource not found\"\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails\n #HTTP Status 412\n PreConditionFailed:\n description: \"Precondition Failed\"\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails\n #HTTP Status 500\n UnexpectedServerError:\n description: \"Unexpected Server Error\"\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails\n #HTTP Status 502\n BadGateway:\n description: \"Bad Gateway\"\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails\n #HTTP Status 503\n ServiceUnavailable:\n description: \"Service unavailable\"\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails\n #HTTP Status 504\n GatewayTimeout:\n description: \"Gateway Timeout\"\n content:\n application/json:\n schema:\n $ref: >-\n #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails\n schemas:\n AssociationRegistry.Admin.Api.Verenigingen.Common.Adres:\n type: object\n properties:\n straatnaam:\n type: string\n description: De straat van het adres\n huisnummer:\n type: string\n description: Het huisnummer van het adres\n busnummer:\n type: string\n description: Het busnummer van het adres\n postcode:\n type: string\n description: De postcode van het adres\n gemeente:\n type: string\n description: De gemeente van het adres\n land:\n type: string\n description: Het land van het adres\n additionalProperties: false\n description: Een adres van een locatie\n AssociationRegistry.Admin.Api.Verenigingen.Common.AdresId:\n type: object\n properties:\n broncode:\n type: string\n description: De code van de bron van het adres\n bronwaarde:\n type: string\n description: De unieke identificator volgens de bron\n additionalProperties: false\n description: De unieke identificator van het adres in een andere bron\n AssociationRegistry.Admin.Api.Verenigingen.Common.DoelgroepRequest:\n type: object\n properties:\n minimumleeftijd:\n maximum: 150\n minimum: 0\n type: integer\n description: De minimum leeftijd voor de doelgroep\n format: int32\n default: 0\n maximumleeftijd:\n maximum: 150\n minimum: 0\n type: integer\n description: De maximum leeftijd voor de doelgroep\n format: int32\n default: 150\n additionalProperties: false\n description: >-\n De doelgroep waar de activiteiten van deze vereniging zich op\n concentreert\n AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenContactgegeven:\n type: object\n properties:\n contactgegeventype:\n type: string\n description: \"Het type contactgegeven\\r\\n\\r\\nMogelijke waarden:\\r\\n- E-mail\\r\\n- SocialMedia\\r\\n- Telefoon\\r\\n- Website\"\n example: E-mail\n waarde:\n type: string\n description: De waarde van het contactgegeven\n beschrijving:\n maxLength: 128\n type: string\n description: >-\n Vrij veld die het het contactgegeven beschrijft (bijv: algemeen,\n administratie, ...)\n isPrimair:\n type: boolean\n description: Duidt het contactgegeven aan als primair contactgegeven\n additionalProperties: false\n description: Het toe te voegen contactgegeven\n AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenLocatie:\n type: object\n properties:\n locatietype:\n type: string\n description: \"Het soort locatie dat beschreven wordt

\\r\\nMogelijke waarden:
\\r\\n- Activiteiten
\\r\\n- Correspondentie - Slechtséén maal mogelijk
\"\n isPrimair:\n type: boolean\n description: Duidt aan dat dit de primaire locatie is\n naam:\n maxLength: 128\n type: string\n description: Een beschrijvende naam voor de locatie\n adresId:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.AdresId\n description: De unieke identificator van het adres in een andere bron\n adres:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.Adres\n description: Het adres van de locatie\n additionalProperties: false\n description: Een locatie van een vereniging\n AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenVertegenwoordiger:\n type: object\n properties:\n insz:\n type: string\n description: >-\n Dit is de unieke identificatie van een vertegenwoordiger, dit kan\n een rijksregisternummer of bisnummer zijn\n voornaam:\n type: string\n description: De voornaam van de vertegenwoordiger\n achternaam:\n type: string\n description: De achternaam van de vertegenwoordiger\n rol:\n type: string\n description: Dit is de rol van de vertegenwoordiger binnen de vereniging\n roepnaam:\n type: string\n description: Dit is de roepnaam van de vertegenwoordiger\n isPrimair:\n type: boolean\n description: >-\n Dit duidt aan dat dit de unieke primaire contactpersoon is voor alle\n communicatie met overheidsinstanties\n e-mail:\n type: string\n description: Het e-mailadres van de vertegenwoordiger\n telefoon:\n type: string\n description: Het telefoonnummer van de vertegenwoordiger\n mobiel:\n type: string\n description: Het mobiel nummer van de vertegenwoordiger\n socialMedia:\n type: string\n description: Het socialmedia account van de vertegenwoordiger\n additionalProperties: false\n description: Een vertegenwoordiger van een vereniging\n AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.FeitelijkeVereniging.VoegContactGegevenToe.RequestsModels.VoegContactgegevenToeRequest:\n type: object\n properties:\n contactgegeven:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenContactgegeven\n description: Het toe te voegen contactgegeven\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.FeitelijkeVereniging.WijzigContactgegeven.RequestModels.TeWijzigenContactgegeven:\n type: object\n properties:\n waarde:\n type: string\n description: De waarde van het contactgegeven\n beschrijving:\n maxLength: 128\n type: string\n description: >-\n Vrij veld die het het contactgegeven beschrijft (bijv: algemeen,\n administratie, ...)\n isPrimair:\n type: boolean\n description: Duidt het contactgegeven aan als primair contactgegeven\n additionalProperties: false\n description: Het te wijzigen contactgegeven\n AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.FeitelijkeVereniging.WijzigContactgegeven.RequestModels.WijzigContactgegevenRequest:\n type: object\n properties:\n contactgegeven:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.FeitelijkeVereniging.WijzigContactgegeven.RequestModels.TeWijzigenContactgegeven\n description: Het te wijzigen contactgegeven\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.VerenigingMetRechtspersoonlijkheid.WijzigContactgegeven.RequestModels.TeWijzigenContactgegeven:\n type: object\n properties:\n beschrijving:\n maxLength: 128\n type: string\n description: >-\n Vrij veld die het het contactgegeven beschrijft (bijv: algemeen,\n administratie, ...)\n isPrimair:\n type: boolean\n description: Duidt het contactgegeven aan als primair contactgegeven\n additionalProperties: false\n description: Het te wijzigen contactgegeven\n AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.VerenigingMetRechtspersoonlijkheid.WijzigContactgegeven.RequestModels.WijzigContactgegevenRequest:\n type: object\n properties:\n contactgegeven:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.VerenigingMetRechtspersoonlijkheid.WijzigContactgegeven.RequestModels.TeWijzigenContactgegeven\n description: Het te wijzigen contactgegeven\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Adres:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n straatnaam:\n type: string\n description: De straat van de locatie\n huisnummer:\n type: string\n description: Het huisnummer van de locatie\n busnummer:\n type: string\n description: Het busnummer van de locatie\n postcode:\n type: string\n description: De postcode van de locatie\n gemeente:\n type: string\n description: De gemeente van de locatie\n land:\n type: string\n description: Het land van de locatie\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.AdresId:\n type: object\n properties:\n broncode:\n type: string\n description: De identificator voor dit adres bij de Adresbron\n bronwaarde:\n type: string\n description: De bron waar het AdresId naar verwijst\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.AdresVerwijzing:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Contactgegeven:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n contactgegevenId:\n type: integer\n description: >-\n De unieke identificatie code van dit contactgegeven binnen de\n vereniging\n format: int32\n contactgegeventype:\n type: string\n description: Het type contactgegeven\n waarde:\n type: string\n description: De waarde van het contactgegeven\n beschrijving:\n maxLength: 128\n type: string\n description: >-\n Vrij veld die het het contactgegeven beschrijft (bijv: algemeen,\n administratie, ...)\n isPrimair:\n type: boolean\n description: Duidt het contactgegeven aan als primair contactgegeven\n bron:\n type: string\n description: \"De bron die dit contactgegeven beheert\\r\\n
\\r\\n Mogelijke waarden:
\\r\\n - Initiator
\\r\\n - KBO\"\n additionalProperties: false\n description: Een contactgegeven van een vereniging\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.DetailVerenigingResponse:\n type: object\n properties:\n '@context':\n type: string\n description: De JSON-LD open data context\n vereniging:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.VerenigingDetail\n metadata:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Metadata\n description: >-\n De metadata van de vereniging, deze bevat bv de datum van laatste\n aanpassing\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.DoelgroepResponse:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n minimumleeftijd:\n type: integer\n description: De minimum leeftijd voor de doelgroep\n format: int32\n maximumleeftijd:\n type: integer\n description: De maximum leeftijd voor de doelgroep\n format: int32\n additionalProperties: false\n description: >-\n De doelgroep waar de activiteiten van deze vereniging zich op\n concentreert\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.GerelateerdeVereniging:\n type: object\n properties:\n kboNummer:\n type: string\n description: Het KBO nummer van de gerelateerde vereniging\n vCode:\n type: string\n description: >-\n De unieke identificator van de gerelateerde vereniging in het\n verenigingsregister\n naam:\n type: string\n description: De naam van de gerelateerde vereniging\n detail:\n type: string\n description: De link naar het beheer detail van de gerelateerde vereniging\n magdaDetail:\n type: string\n description: Magda naar het beheer detail van de gerelateerde vereniging\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.GestructureerdeIdentificator:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n nummer:\n type: string\n description: De externe identificator van de vereniging in de bron\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.HoofdactiviteitVerenigingsloket:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n code:\n type: string\n description: De code van de hoofdactivititeit\n naam:\n type: string\n description: De beschrijving van de hoofdactivititeit\n additionalProperties: false\n description: De hoofdactivititeit van een vereniging volgens het verenigingsloket\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Locatie:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n locatieId:\n type: integer\n description: De unieke identificatie code van deze locatie binnen de vereniging\n format: int32\n locatietype:\n type: string\n description: \"Het soort locatie dat beschreven wordt

\\r\\nMogelijke waarden:
\\r\\n- Activiteiten
\\r\\n- Correspondentie - Slechts één maal mogelijk
\\r\\n- Maatschappelijke zetel volgens KBO - Enkel mogelijk voor verenigingen met rechtspersoonlijkheid
\"\n isPrimair:\n type: boolean\n description: Duidt aan dat dit de primaire locatie is\n naam:\n type: string\n description: Een beschrijvende naam voor de locatie\n adres:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Adres\n description: De adrescomponenten van de locatie\n adresvoorstelling:\n type: string\n description: Een standaard geformatteerde weergave van het adres van de locatie\n adresId:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.AdresId\n description: De identifier van het adres op een externe bron\n verwijstNaar:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.AdresVerwijzing\n description: De verwijzing naar een adres in het adresregister\n bron:\n type: string\n description: \"De bron die deze locatie beheert.\\r\\n
\\r\\n Mogelijke waarden:
\\r\\n - Initiator
\\r\\n - KBO\"\n additionalProperties: false\n description: Een locatie van een vereniging\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Metadata:\n type: object\n properties:\n datumLaatsteAanpassing:\n type: string\n description: >-\n De datum waarop de laatste aanpassing uitgevoerd is op de gegevens\n van de vereniging\n additionalProperties: false\n description: >-\n De metadata van de vereniging, deze bevat bv de datum van laatste\n aanpassing\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Relatie:\n type: object\n properties:\n relatietype:\n type: string\n description: Het type relatie\n andereVereniging:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.GerelateerdeVereniging\n description: de gerelateerde vereniging\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Sleutel:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n bron:\n type: string\n description: De bron van de sleutel\n waarde:\n type: string\n description: De externe identificator van de vereniging in de bron\n codeerSysteem:\n type: string\n description: het codeersysteem van de sleutel\n gestructureerdeIdentificator:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.GestructureerdeIdentificator\n description: De gestructureerde identificator\n additionalProperties: false\n description: >-\n Een uniek identificerende sleutel van deze vereniging in een externe\n bron\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.VerenigingDetail:\n type: object\n properties:\n '@type':\n type: string\n description: Het json-ld type\n vCode:\n type: string\n description: De unieke identificatie code van deze vereniging\n corresponderendeVCodes:\n type: array\n items:\n type: string\n verenigingstype:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.VerenigingsType\n description: Het type van deze vereniging\n naam:\n type: string\n description: Naam van de vereniging\n roepnaam:\n type: string\n description: >-\n Roepnaam van de vereniging. Dit veld is enkel aanwezig bij\n verenigingen met rechtspersoonlijkheid\n default: null\n korteNaam:\n type: string\n description: Korte naam van de vereniging\n korteBeschrijving:\n type: string\n description: Korte beschrijving van de vereniging\n startdatum:\n type: string\n description: Datum waarop de vereniging gestart is\n einddatum:\n type: string\n description: Datum waarop de vereniging gestopt is\n doelgroep:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.DoelgroepResponse\n description: >-\n De doelgroep waar de activiteiten van deze vereniging zich op\n concentreert\n status:\n type: string\n description: \"Status van de vereniging

\\r\\n Mogelijke waarden:
\\r\\n - Actief
\\r\\n - Gestopt
\"\n isUitgeschrevenUitPubliekeDatastroom:\n type: boolean\n description: Is deze vereniging uitgeschreven uit de publieke datastroom\n hoofdactiviteitenVerenigingsloket:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.HoofdactiviteitVerenigingsloket\n description: >-\n De hoofdactivititeiten van deze vereniging volgens het\n verenigingsloket\n contactgegevens:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Contactgegeven\n description: De contactgegevens van deze vereniging\n locaties:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Locatie\n description: Alle locaties waar deze vereniging actief is\n vertegenwoordigers:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Vertegenwoordiger\n description: Alle vertegenwoordigers van deze vereniging\n sleutels:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Sleutel\n description: De sleutels van deze vereniging\n relaties:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Relatie\n description: De relaties van deze vereniging\n bron:\n type: string\n description: \"De bron die deze vereniging beheert.\\r\\n
\\r\\n Mogelijke waarden:
\\r\\n - Initiator
\\r\\n - KBO\"\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.VerenigingsType:\n type: object\n properties:\n code:\n type: string\n description: De code van het type vereniging\n naam:\n type: string\n description: De beschrijving van het type vereniging\n additionalProperties: false\n description: Het type van een vereniging\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Vertegenwoordiger:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n vertegenwoordigerId:\n type: integer\n description: >-\n De unieke identificatie code van deze vertegenwoordiger binnen de\n vereniging\n format: int32\n insz:\n type: string\n description: Het insz van deze vertegenwoordiger\n voornaam:\n type: string\n description: >-\n Dit is de voornaam van de vertegenwoordiger volgens het\n rijksregister\n achternaam:\n type: string\n description: >-\n Dit is de achternaam van de vertegenwoordiger volgens het\n rijksregister\n roepnaam:\n type: string\n description: Dit is de roepnaam van de vertegenwoordiger\n rol:\n type: string\n description: Dit is de rol van de vertegenwoordiger binnen de vereniging\n isPrimair:\n type: boolean\n description: >-\n Dit duidt aan dat dit de unieke primaire contactpersoon is voor alle\n communicatie met overheidsinstanties\n e-mail:\n type: string\n description: Het e-mailadres van de vertegenwoordiger\n telefoon:\n type: string\n description: Het telefoonnummer van de vertegenwoordiger\n mobiel:\n type: string\n description: Het mobiel nummer van de vertegenwoordiger\n socialMedia:\n type: string\n description: Het socialmedia account van de vertegenwoordiger\n vertegenwoordigerContactgegevens:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.VertegenwoordigerContactgegevens\n description: de contactgegevens van de vertegenwoordiger\n bron:\n type: string\n description: \"De bron die deze vertegenwoordiger beheert.\\r\\n
\\r\\n Mogelijke waarden:
\\r\\n - Initiator
\\r\\n - KBO\"\n additionalProperties: false\n description: Een vertegenwoordiger van een vereniging\n AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.VertegenwoordigerContactgegevens:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n isPrimair:\n type: boolean\n description: >-\n Dit duidt aan dat dit de unieke primaire contactpersoon is voor alle\n communicatie met overheidsinstanties\n e-mail:\n type: string\n description: Het e-mailadres van de vertegenwoordiger\n telefoon:\n type: string\n description: Het telefoonnummer van de vertegenwoordiger\n mobiel:\n type: string\n description: Het mobiel nummer van de vertegenwoordiger\n socialMedia:\n type: string\n description: Het socialmedia account van de vertegenwoordiger\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Historiek.ResponseModels.HistoriekGebeurtenisResponse:\n type: object\n properties:\n beschrijving:\n type: string\n description: De beschrijving van de gebeurtenis\n gebeurtenis:\n type: string\n description: Het type van de gebeurtenis\n data:\n description: De relevante data die hoort bij de gebeurtenis\n initiator:\n type: string\n description: Instantie die de vereniging heeft geregistreerd of gewijzigd\n tijdstip:\n type: string\n description: Het tijdstip waarop de gebeurtenis plaatsvond\n additionalProperties: false\n description: Een gebeurtenis van een vereniging\n AssociationRegistry.Admin.Api.Verenigingen.Historiek.ResponseModels.HistoriekResponse:\n type: object\n properties:\n '@context':\n type: string\n description: De JSON-LD open data context\n vCode:\n type: string\n description: De unieke identificatie code van deze vereniging\n gebeurtenissen:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Historiek.ResponseModels.HistoriekGebeurtenisResponse\n description: Alle gebeurtenissen van deze vereniging\n additionalProperties: false\n description: Alle gebeurtenissen van deze vereniging\n AssociationRegistry.Admin.Api.Verenigingen.Locaties.FeitelijkeVereniging.VoegLocatieToe.RequestModels.VoegLocatieToeRequest:\n type: object\n properties:\n locatie:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenLocatie\n description: Een locatie van een vereniging\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Locaties.FeitelijkeVereniging.WijzigLocatie.RequestModels.TeWijzigenLocatie:\n type: object\n properties:\n locatietype:\n type: string\n description: \"Het soort locatie dat beschreven wordt

\\r\\nMogelijke waarden:
\\r\\n- Activiteiten
\\r\\n- Correspondentie - Slechts één maal mogelijk
\"\n isPrimair:\n type: boolean\n description: Duidt aan dat dit de primaire locatie is\n naam:\n maxLength: 128\n type: string\n description: Een beschrijvende naam voor de locatie\n adresId:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.AdresId\n description: De unieke identificator van het adres in een andere bron\n adres:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.Adres\n description: Het adres van de locatie\n additionalProperties: false\n description: Een locatie van een vereniging\n AssociationRegistry.Admin.Api.Verenigingen.Locaties.FeitelijkeVereniging.WijzigLocatie.RequestModels.WijzigLocatieRequest:\n type: object\n properties:\n locatie:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Locaties.FeitelijkeVereniging.WijzigLocatie.RequestModels.TeWijzigenLocatie\n description: Een locatie van een vereniging\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Locaties.VerenigingMetRechtspersoonlijkheid.WijzigMaatschappelijkeZetel.RequestModels.TeWijzigenMaatschappelijkeZetel:\n type: object\n properties:\n isPrimair:\n type: boolean\n description: Duidt aan dat dit de primaire locatie is\n naam:\n maxLength: 128\n type: string\n description: Een beschrijvende naam voor de locatie\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Locaties.VerenigingMetRechtspersoonlijkheid.WijzigMaatschappelijkeZetel.RequestModels.WijzigMaatschappelijkeZetelRequest:\n type: object\n properties:\n locatie:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Locaties.VerenigingMetRechtspersoonlijkheid.WijzigMaatschappelijkeZetel.RequestModels.TeWijzigenMaatschappelijkeZetel\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Registreer.DuplicaatVerenigingContract:\n type: object\n properties:\n vCode:\n type: string\n description: De unieke identificatie code van deze vereniging\n naam:\n type: string\n description: Naam van de vereniging\n korteNaam:\n type: string\n description: Korte naam van de vereniging\n verenigingstype:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.VerenigingsType\n description: Type van de vereniging\n hoofdactiviteitenVerenigingsloket:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.HoofdactiviteitVerenigingsloket\n description: >-\n De hoofdactivititeiten van deze vereniging volgens het\n verenigingsloket\n locaties:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.Locatie\n description: Alle locaties waar deze vereniging actief is\n links:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.VerenigingLinks\n description: Weblinks i.v.m. deze vereniging\n additionalProperties: false\n description: Een mogelijke duplicaat van de te registreren vereniging\n AssociationRegistry.Admin.Api.Verenigingen.Registreer.FeitelijkeVereniging.RequetsModels.RegistreerFeitelijkeVerenigingRequest:\n required:\n - naam\n type: object\n properties:\n naam:\n type: string\n description: Naam van de vereniging\n korteNaam:\n type: string\n description: Korte naam van de vereniging\n korteBeschrijving:\n type: string\n description: Korte beschrijving van de vereniging\n startdatum:\n type: string\n description: >-\n Datum waarop de vereniging gestart is. Deze datum mag niet later\n zijn dan vandaag\n format: date\n doelgroep:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.DoelgroepRequest\n description: >-\n De doelgroep waar de activiteiten van deze vereniging zich op\n concentreert\n isUitgeschrevenUitPubliekeDatastroom:\n type: boolean\n description: Is deze vereniging uitgeschreven uit de publieke datastroom\n contactgegevens:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenContactgegeven\n description: De contactgegevens van deze vereniging\n locaties:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenLocatie\n description: Alle locaties waar deze vereniging actief is\n vertegenwoordigers:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenVertegenwoordiger\n description: De vertegenwoordigers van deze vereniging\n hoofdactiviteitenVerenigingsloket:\n type: array\n items:\n type: string\n description: De codes van de hoofdactivititeiten volgens het verenigingsloket\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Registreer.HoofdactiviteitVerenigingsloket:\n type: object\n properties:\n code:\n type: string\n description: De code van de hoofdactivititeit\n naam:\n type: string\n description: De beschrijving van de hoofdactivititeit\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Registreer.Locatie:\n type: object\n properties:\n locatietype:\n type: string\n description: Het soort locatie dat beschreven wordt\n isPrimair:\n type: boolean\n description: Duidt aan dat dit de primaire locatie is\n adresvoorstelling:\n type: string\n description: Het samengestelde adres van de locatie\n naam:\n type: string\n description: Een beschrijvende naam voor de locatie\n postcode:\n type: string\n description: Het busnummer van de locatie\n gemeente:\n type: string\n description: De gemeente van de locatie\n additionalProperties: false\n description: Een locatie van een vereniging\n AssociationRegistry.Admin.Api.Verenigingen.Registreer.MetRechtspersoonlijkheid.RequestModels.RegistreerVerenigingUitKboRequest:\n required:\n - kboNummer\n type: object\n properties:\n kboNummer:\n type: string\n description: Kbo nummer van de vereniging\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Registreer.PotentialDuplicatesResponse:\n type: object\n properties:\n bevestigingsToken:\n type: string\n description: \"Dit token wordt gebruikt als bevestiging dat de vereniging uniek is en geregistreerd mag worden,\\r\\n ondanks de voorgestelde duplicaten.\"\n readOnly: true\n mogelijkeDuplicateVerenigingen:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.DuplicaatVerenigingContract\n description: \"Een lijst van verenigingen die mogelijks een duplicaat zijn\\r\\n van de vereniging uit de registreer aanvraag\"\n readOnly: true\n instance:\n type: string\n description: URI naar de specifieke instantie van dit probleem.\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Registreer.VerenigingLinks:\n type: object\n properties:\n detail:\n type: string\n description: De link naar het beheer detail van de vereniging\n format: uri\n magdaDetail:\n type: string\n description: Magda link naar het beheer detail van de vereniging\n format: uri\n additionalProperties: false\n description: Weblinks i.v.m. deze vereniging\n AssociationRegistry.Admin.Api.Verenigingen.Registreer.VerenigingsType:\n type: object\n properties:\n code:\n type: string\n description: De code van het type van deze vereniging\n naam:\n type: string\n description: De beschrijving van het type van deze vereniging\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.DoelgroepResponse:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n minimumleeftijd:\n type: integer\n description: De minimum leeftijd voor de doelgroep\n format: int32\n maximumleeftijd:\n type: integer\n description: De maximum leeftijd voor de doelgroep\n format: int32\n additionalProperties: false\n description: >-\n De doelgroep waar de activiteiten van deze vereniging zich op\n concentreert\n AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.GestructureerdeIdentificator:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n nummer:\n type: string\n description: De externe identificator van de vereniging in de bron\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.HoofdactiviteitVerenigingsloket:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n code:\n type: string\n description: De verkorte code van de hoofdactiviteit\n naam:\n type: string\n description: De volledige beschrijving van de hoofdactiviteit\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Locatie:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n locatietype:\n type: string\n description: \"Het soort locatie dat beschreven wordt

\\r\\nMogelijke waarden:
\\r\\n- Activiteiten
\\r\\n- Correspondentie - Slechts één maal mogelijk
\\r\\n- Maatschappelijke zetel volgens KBO - Enkel mogelijk voor verenigingen met rechtspersoonlijkheid
\"\n isPrimair:\n type: boolean\n description: Is dit de primaire locatie van deze vereniging\n adresvoorstelling:\n type: string\n description: De volledige adresvoorstelling van de locatie\n naam:\n type: string\n description: De naam van de locatie\n postcode:\n type: string\n description: De postcode van de locatie\n gemeente:\n type: string\n description: De gemeente waarin de locatie ligt\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Metadata:\n type: object\n properties:\n pagination:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Pagination\n description: De paginatie metaData\n additionalProperties: false\n description: >-\n In deze metadata plaatsen we alle relevante metadata voor de\n zoekopdracht, de paginering informatie\n AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Pagination:\n type: object\n properties:\n totalCount:\n type: integer\n description: Het totaal aantal verenigingen dat voldoet aan de zoekcriteria\n format: int64\n offset:\n type: integer\n description: Het aantal overgeslagen resultaten\n format: int32\n limit:\n type: integer\n description: Het maximum aantal teruggegeven resultaten\n format: int32\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.SearchVerenigingenResponse:\n type: object\n properties:\n '@context':\n type: string\n description: De JSON-LD open data context\n verenigingen:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Vereniging\n description: >-\n Dit is de lijst van verenigingen die het resultaat van de\n zoekopdracht zijn\n metadata:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Metadata\n description: >-\n In deze metadata plaatsen we alle relevante metadata voor de\n zoekopdracht, de paginering informatie\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Sleutel:\n type: object\n properties:\n '@id':\n type: string\n description: De json-ld id\n '@type':\n type: string\n description: Het json-ld type\n bron:\n type: string\n description: De bron van de sleutel\n waarde:\n type: string\n description: De externe identificator van de vereniging in de bron\n codeerSysteem:\n type: string\n description: het codeersysteem van de sleutel\n gestructureerdeIdentificator:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.GestructureerdeIdentificator\n description: De gestructureerde identificator\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Vereniging:\n type: object\n properties:\n '@type':\n type: string\n description: Het json-ld type\n vCode:\n type: string\n description: De vCode van de vereniging\n corresponderendeVCodes:\n type: array\n items:\n type: string\n description: De vCodes van de corresponderende verenigingen\n verenigingstype:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.VerenigingsType\n description: Het type van de vereniging\n naam:\n type: string\n description: De naam van de vereniging\n roepnaam:\n type: string\n description: >-\n Roepnaam van de vereniging. Dit veld is enkel aanwezig bij\n verenigingen met rechtspersoonlijkheid\n default: null\n korteNaam:\n type: string\n description: De korte naam van de vereniging\n status:\n type: string\n description: \"Status van de vereniging

\\r\\n Mogelijke waarden:
\\r\\n - Actief
\\r\\n - Gestopt
\"\n startdatum:\n type: string\n description: Datum waarop de vereniging gestart is\n einddatum:\n type: string\n description: Datum waarop de vereniging gestopt is \n doelgroep:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.DoelgroepResponse\n description: >-\n De doelgroep waar de activiteiten van deze vereniging zich op\n concentreert\n hoofdactiviteitenVerenigingsloket:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.HoofdactiviteitVerenigingsloket\n description: De lijst van hoofdactiviteiten erkend door het vereningingsloket\n locaties:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Locatie\n description: De locaties waar de vereniging actief is\n sleutels:\n type: array\n items:\n $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Sleutel\n description: De sleutels van deze vereniging\n links:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.VerenigingLinks\n description: Weblinks i.v.m. deze vereniging\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.VerenigingLinks:\n type: object\n properties:\n detail:\n type: string\n description: De link naar het beheer detail van de vereniging\n format: uri\n magdaDetail:\n type: string\n description: Magda link naar het beheer detail van de vereniging\n format: uri\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.VerenigingsType:\n type: object\n properties:\n code:\n type: string\n description: De code van het type vereniging\n naam:\n type: string\n description: De beschrijving van het type vereniging\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Stop.RequestModels.StopVerenigingRequest:\n required:\n - einddatum\n type: object\n properties:\n einddatum:\n type: string\n description: De datum waarop de vereniging gestopt werd.\n format: date\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Vertegenwoordigers.FeitelijkeVereniging.VoegVertegenwoordigerToe.RequestModels.VoegVertegenwoordigerToeRequest:\n type: object\n properties:\n vertegenwoordiger:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenVertegenwoordiger\n description: De toe te voegen vertegenwoordiger\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.Vertegenwoordigers.FeitelijkeVereniging.WijzigVertegenwoordiger.RequestModels.TeWijzigenVertegenwoordiger:\n type: object\n properties:\n rol:\n type: string\n description: Dit is de rol van de vertegenwoordiger binnen de vereniging\n roepnaam:\n type: string\n description: Dit is de roepnaam van de vertegenwoordiger\n isPrimair:\n type: boolean\n description: >-\n Dit duidt aan dat dit de unieke primaire contactpersoon is voor alle\n communicatie met overheidsinstanties\n e-mail:\n type: string\n description: Het e-mailadres van de vertegenwoordiger\n telefoon:\n type: string\n description: Het telefoonnummer van de vertegenwoordiger\n mobiel:\n type: string\n description: Het mobiel nummer van de vertegenwoordiger\n socialMedia:\n type: string\n description: Het socialmedia account van de vertegenwoordiger\n additionalProperties: false\n description: De te wijzigen vertegenwoordiger\n AssociationRegistry.Admin.Api.Verenigingen.Vertegenwoordigers.FeitelijkeVereniging.WijzigVertegenwoordiger.RequestModels.WijzigVertegenwoordigerRequest:\n type: object\n properties:\n vertegenwoordiger:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Vertegenwoordigers.FeitelijkeVereniging.WijzigVertegenwoordiger.RequestModels.TeWijzigenVertegenwoordiger\n description: De te wijzigen vertegenwoordiger\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.WijzigBasisgegevens.FeitelijkeVereniging.RequestModels.WijzigBasisgegevensRequest:\n type: object\n properties:\n naam:\n type: string\n description: Nieuwe naam van de vereniging\n korteNaam:\n type: string\n description: Nieuwe korte naam van de vereniging\n korteBeschrijving:\n type: string\n description: Nieuwe korte beschrijving van de vereniging\n startdatum:\n type: string\n description: >-\n Nieuwe startdatum (yyyy-MM-dd) van de vereniging. Deze datum mag\n niet later zijn dan vandaag\n doelgroep:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.DoelgroepRequest\n description: >-\n De doelgroep waar de activiteiten van deze vereniging zich op\n concentreert\n hoofdactiviteitenVerenigingsloket:\n type: array\n items:\n type: string\n description: >-\n De codes van de nieuwe hoofdactiviteiten volgens het\n verenigingsloket\n isUitgeschrevenUitPubliekeDatastroom:\n type: boolean\n description: >-\n Is deze vereniging uitgeschreven uit de publiek datastroom, dit kan\n enkel gewijzigd worden voor een feitelijke vereniging\n additionalProperties: false\n AssociationRegistry.Admin.Api.Verenigingen.WijzigBasisgegevens.MetRechtspersoonlijkheid.RequestModels.WijzigBasisgegevensRequest:\n type: object\n properties:\n korteBeschrijving:\n type: string\n description: Nieuwe korte beschrijving van de vereniging\n doelgroep:\n allOf:\n - $ref: >-\n #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.DoelgroepRequest\n description: >-\n De doelgroep waar de activiteiten van deze vereniging zich op\n concentreert\n hoofdactiviteitenVerenigingsloket:\n type: array\n items:\n type: string\n description: >-\n De codes van de nieuwe hoofdactiviteiten volgens het\n verenigingsloket\n roepnaam:\n type: string\n description: De nieuwe roepnaam van de vereniging\n additionalProperties: false\n Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails:\n type: object\n properties:\n type:\n type: string\n description: URI referentie die het probleem type bepaalt.\n title:\n type: string\n description: Korte omschrijving van het probleem.\n detail:\n type: string\n description: Specifieke details voor dit probleem.\n status:\n type: integer\n description: HTTP status code komende van de server voor dit probleem.\n format: int32\n instance:\n type: string\n description: URI naar de specifieke instantie van dit probleem.\n additionalProperties: false\n Be.Vlaanderen.Basisregisters.BasicApiProblem.ValidationError:\n type: object\n properties:\n code:\n type: string\n reason:\n type: string\n additionalProperties: false\n Be.Vlaanderen.Basisregisters.BasicApiProblem.ValidationProblemDetails:\n type: object\n properties:\n validationErrors:\n type: object\n additionalProperties:\n type: array\n items:\n $ref: >-\n #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ValidationError\n description: Validatie fouten.\n type:\n type: string\n description: URI referentie die het probleem type bepaalt.\n title:\n type: string\n description: Korte omschrijving van het probleem.\n detail:\n type: string\n description: Specifieke details voor dit probleem.\n status:\n type: integer\n description: HTTP status code komende van de server voor dit probleem.\n format: int32\n instance:\n type: string\n description: URI naar de specifieke instantie van dit probleem.\n additionalProperties: false\n"},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"bff851f8-3a61-4c6d-8059-4d89093814a5"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"7d4cc899-dd7f-444d-880a-bbae0a23df12"}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Persoon","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Persoon","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"0e1ebd99-86da-4424-84a7-0f168ea080dc","collection":"contentId-6118410708","type":"file"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: \"3.0.3\"\ninfo:\n title: \"Persoon domein\"\n description: \"Deze api bevat alle schema's van de diensten in het domain persoon.\"\n contact:\n name: \"Magda helpdesk\"\n url: \"https://overheid.vlaanderen.be/magda\"\n license:\n name: \"Persoon domein\"\n url: \"https://overheid.vlaanderen.be/magda\"\n version: \"1.0.0\"\nservers:\n - url: \"api/v1/persoon\"\npaths: \n /handtekeningen:\n get:\n tags:\n - \"handtekeningen\"\n summary: \"Deze dienst haalt de handtekening op zoals die op de identiteitskaart staat\"\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: x-insz\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Rijksregisternummer'\n responses:\n 200:\n description: \"handtekening\"\n content:\n application/json:\n schema:\n $ref: \"#/components/schemas/Handtekening\"\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n \n /pasfotos:\n get:\n tags:\n - \"pasfotos\"\n summary: \"Deze dienst haalt de pasfoto op zoals die op de identiteitskaart staat\"\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: x-insz\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Rijksregisternummer'\n responses:\n 200:\n description: \"pasfoto\"\n content:\n application/json:\n schema:\n $ref: \"#components/schemas/Pasfoto\"\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\ncomponents:\n parameters:\n CorrelationId:\n name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n #HTTP Status 400\n BadRequest:\n description: \"Invalid data supplied\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 401\n InvalidAuthorization:\n description: \"Invalid authorization\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 403\n Forbidden:\n description: \"Authentication failed\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 404\n NotFound:\n description: \"Resource not found\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 412\n PreConditionFailed:\n description: Precondition Failed\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 500\n UnexpectedServerError:\n description: \"Unexpected Server Error\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 502\n BadGateway:\n description: \"Bad Gateway\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 503\n ServiceUnavailable:\n description: \"Service unavailable\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 504\n GatewayTimeout:\n description: \"Gateway Timeout\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n schemas:\n Correlation-Id:\n description: \"ID van de transactie. Wordt gebruikt voor log tracering en incident afhandeling\"\n type: string\n minLength: 10\n maxLength: 36\n\n Rijksregisternummer:\n description: \"Het rijksregisternummer van de persoon\"\n type: string\n pattern: '^\\d{11}$'\n\n Kleur:\n description: 'Gegevens over een kleur'\n type: object\n properties:\n id:\n description: |\n 'identificatiecode van de kleur:'\n '0: onbekend'\n '1: zwart-wit'\n '2: kleur'\n type: string\n label:\n description: 'de omschjrijving van de kleur'\n type: string\n\n\n Handtekening:\n description: \"De handtekening informatie\"\n type: object\n properties:\n rijksregisternummer:\n $ref: '#/components/schemas/Rijksregisternummer'\n kaartnummer:\n description: 'nummer van de identiteitskaart'\n type: string\n pattern: '^\\d{12}'\n basisdocumentDatum:\n description: 'Datum waarop het basisdocument is uitgegeven'\n type: string\n format: date\n afbeelding:\n description: 'De afbeelding van de handtekening in Base64 encoding'\n type: string\n format: byte\n\n Pasfoto:\n description: \"De pasfoto informatie\"\n type: object\n properties:\n rijksregisternummer:\n $ref: '#/components/schemas/Rijksregisternummer'\n updateDatum:\n description: 'Datum waarop de foto is aangepast'\n type: string\n format: date\n kleur:\n $ref: '#/components/schemas/Kleur'\n afbeelding:\n description: 'De afbeelding van de handtekening in Base64 encoding'\n type: string\n format: Base64\n\n\n\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: \"URI referentie die het probleem identificeert. Deze specificatie moedigt aan om, wanneer de referentie wordt verwijderd, een leesbare documentatie te bieden voor het probleemtype. Als dit element niet aanwezig is, wordt aangenomen dat de waarde about:blank is.\"\n title:\n type: string\n description: \"Een korte, voor mensen leesbare samenvatting van het probleemtype. Het MAG NIET veranderen tussen verschillende voorkomens van de fout, behalve voor doeleinden van lokalisatie.\"\n status:\n type: string\n description: \"De HTTP-statuscode die is gegenereerd door de oorspronkelijke server voor dit optreden van het probleem.\"\n detail:\n type: string\n description: \"Een voor mensen leesbare uitleg die specifiek is voor dit optreden van het probleem.\"\n instance:\n type: string\n description: \"Een URI-referentie die het specifieke optreden van het probleem identificeert. Het kan al dan niet meer informatie opleveren als de referentie wordt verwijderd.\"\n description: \"Een weergave van een algemene foutmelding.\""},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"554a328a-1b77-4b0a-af7a-6fa5817ea0bf"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"c0cfd706-5a72-4b5a-a780-cab686574806"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"OfficialDocuments","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"a0a00328-7280-42d5-9da3-ba4679451adc","collection":"contentId-6118410708","type":"file"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: 3.0.3\ninfo:\n title: officialDocument Services\n description: 'This RESTful API is designed to allow natural persons to query and download the official documents that are available in the DABS database. Release date April 2022.'\n contact:\n name: officialDocumentsAPI\n email: helpdesk.magda@vlaanderen.be\n license:\n name: officialDocumentsAPI\n url: 'https://overheid.vlaanderen.be/magda'\n version: '1.0'\nservers:\n - url: /api/v1/person\npaths:\n /officialDocumentReferences:\n get:\n tags:\n - Person\n summary: Operations for getting the references of the official documents in the DABS database related to a particular National Number.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: personNumber\n in: query\n description: The national number of a person to search for in any role except the role “ABS”.\n required: true\n schema:\n $ref: '#/components/schemas/NationalNumberType'\n - name: language\n in: query\n required: false\n schema:\n $ref: '#/components/schemas/LanguageType'\n responses:\n 200:\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ReferencesResponse'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/NoAttestationAuthorization'\n 404:\n $ref: '#/components/responses/AttestationNotFound'\n 412:\n $ref: '#/components/responses/PreConditionFailed'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n /officialDocuments:\n get:\n tags:\n - Person\n summary: Operations for getting the extract or conformal copy of an official document from the DABS databaseby means of a reference aquired through the GET officialDocumetsList service.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: personNumber\n in: query\n description: The national number of a person to search for in any role except the role “ABS”.\n required: true\n schema:\n $ref: '#/components/schemas/NationalNumberType'\n - name: language\n in: query\n description: The language of the document requested.\n required: false\n schema:\n $ref: '#/components/schemas/LanguageType'\n - name: documentReference\n in: query\n description: The reference of document requested.\n required: true\n schema:\n type: string\n - name: actType\n in: query\n description: The format of the document requested\n required: true\n schema:\n $ref: '#/components/schemas/ActType'\n\n responses:\n 200:\n description: The result.\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DocumentResponse'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/NoAttestationAuthorization'\n 404:\n $ref: '#/components/responses/AttestationNotFound'\n 412:\n $ref: '#/components/responses/PreConditionFailed'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n /officialDocumentMigrations:\n get:\n tags:\n - Person\n summary: Operations for requesting the migration of an official document.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: migrationCommand\n in: query\n description: The number of the migration command\n required: true\n schema:\n $ref: '#/components/schemas/MigrationCommandType'\n\n responses:\n 200:\n description: The result.\n content:\n application/pdf:\n schema:\n $ref: '#/components/schemas/MigrationResponse'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/NoAttestationAuthorization'\n 404:\n $ref: '#/components/responses/AttestationNotFound'\n 412:\n $ref: '#/components/responses/PreConditionFailed'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\ncomponents:\n responses:\n BadRequest:\n description: Invalid data supplied\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n InvalidAuthorization:\n description: Invalid authorization\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n NoAttestationAuthorization:\n description: Not authorized to obtain this attestation\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n AttestationNotFound:\n description: Attestation not found\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n PreConditionFailed:\n description: Precondition Failed\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n UnexpectedServerError:\n description: Unexpected Server Error\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n BadGateway:\n description: Bad Gateway\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n ServiceUnavailable:\n description: Service unavailable\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n GatewayTimeout:\n description: Gateway Timeout\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n schemas:\n ReferencesResponse:\n type: object\n description: 'The object containing the result'\n properties:\n self:\n type: string\n description: 'Link to this request.'\n responseDateTime:\n type: string\n format: date-time\n items:\n type: array\n description: 'An array of registration objects. The content can be none, one or multiple objects.'\n items:\n $ref: '#/components/schemas/OfficialDocumentInfo'\n DocumentResponse:\n type: string\n format: binary\n description: 'Response containing the PDF document'\n Correlation-Id:\n description: \"ID of the transaction. Use this ID for log tracing and incident handling.\"\n type: string\n maxLength: 36\n minLength: 10\n LanguageType:\n description: Language selection enumeration\n type: string\n enum:\n - nl\n - fr\n - de\n ActType:\n type: string\n enum:\n - C\n - E\n - A\n DocType:\n description: An enum class that indicates the type of document to which an object is linked to\n type: string\n enum:\n - ABSENCE_CERTIFICATE\n - ADOPTION_CERTIFICATE\n - ANNULMENT_CERTIFICATE\n - AUTHORITY_DECISION\n - BIRTH_CERTIFICATE\n - DEATH_CERTIFICATE\n - DECLARATION_OF_LIFELESS_CHILD_CERTIFICATE\n - DIVORCE_CERTIFICATE\n - FIRSTNAME_CHANGE_CERTIFICATE\n - MARRIAGE_CERTIFICATE\n - MANUAL_UPDATE_DOCUMENT\n - NAME_CHANGE_CERTIFICATE\n - NATIONALITY_CERTIFICATE\n - PRENATAL_RECOGNITION_CERTIFICATE\n - RECOGNITION_CERTIFICATE\n - SEX_CHANGE_CERTIFICATE\n - UPDATE_DOCUMENT\n Error:\n description: 'Error type as provided by the DABS application'\n properties:\n errorCode:\n type: integer\n description: 'The numeric code of the error.'\n arguments:\n type: array\n description: 'Some argument associated to the error detected by the system'\n items:\n type: string\n msg:\n type: string\n description: \"Message describing the error related to “errorCode”.\"\n OfficialDocumentInfo:\n description: Information on an official documnt linked to a person.\n type: object\n required:\n - reference\n properties:\n factDate:\n $ref: \"#/components/schemas/DateType\"\n reference:\n description: 'Reference of the official document, used to request the document'\n type: string\n type:\n $ref: '#/components/schemas/DocType'\n copy:\n $ref: '#/components/schemas/ElementType'\n extract:\n $ref: '#/components/schemas/ElementType'\n art16:\n $ref: '#/components/schemas/ElementType'\n migrationCommand:\n type: string\n ElementType:\n properties:\n element:\n type: string\n language:\n $ref: '#/components/schemas/LanguageType'\n DateType:\n type: object\n properties:\n century:\n type: integer\n day:\n type: integer\n month:\n type: integer\n year:\n type: integer\n NationalNumberType:\n type: string\n pattern: \"[0-9]{10,11}\"\n example: \"70012533955\"\n description: \"The national number of the concerned person.\"\n MigrationCommandType:\n type: string\n description: The string used for requesting the migration of a paper version to an electronic version\n MigrationResponse:\n type: object\n description: Response from the migration command\n properties:\n responseDateTime:\n type: string\n format: date-time\n fileInfo:\n $ref: '#/components/schemas/FileInfoType'\n FileInfoType:\n type: object\n description: description of the file for which the migration was requested\n properties:\n docReference:\n type: string\n message:\n type: string\n notificationId:\n type: string\n error:\n type: string\n\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: 'A URI reference that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be \"about:blank\".'\n title:\n type: string\n description: 'A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.'\n status:\n type: string\n description: The HTTP status code generated by the origin server for this occurrence of the problem.\n detail:\n type: string\n description: A human-readable explanation specific to this occurrence of the problem.\n instance:\n type: string\n description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n DABSException:\n properties:\n error:\n type: array\n description: 'List of errors that are leading DABS/BAEC to raise an exception.'\n items:\n $ref: '#/components/schemas/Error'\n traceid:\n type: string\n description: 'Reference of the \"trace\" record in the trace system of DABS/BAEC at the NR.'\n description: A representation of a generic error message\n "},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"ea7b5f72-15ca-4d34-8811-dbf25d208935"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"40e594e7-2fa5-42b8-b292-c2d4ce6e4667"}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"SocEcon","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Tewerkstellingsondersteunende Maatregelen (nog in ontwikkeling!)","type":"text"}]},{"type":"paragraph","content":[{"text":"Dit document zal in de toekomst mogelijks nog wijzigen!","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"a41c0863-a284-43f1-8f92-8d72af2f10fc","collection":"contentId-6118410708","type":"file"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: \"3.0.2\"\ninfo:\n title: \"Digitaal Vlaanderen - Tewerkstellingondersteunende Maatregelen\"\n description: \"Tewerkstelling gerelateerde diensten in het domein Sociale Economie. Release date: Apr23\"\n contact:\n name: \"Magda helpdesk\"\n url: \"https://overheid.vlaanderen.be/magda\"\n license:\n name: \"Tewerkstelling gerateerde diensten\"\n url: \"https://overheid.vlaanderen.be/magda\"\n version: \"1.0.0\"\nservers:\n - url: \"api/v1/socEcon\"\npaths:\n /tewerkstelling/ondersteunendeMaatregelen:\n get:\n tags:\n - VDAB\n - API 1\n summary: \"Vraag van DWSE om de tewerkstellingsondersteunende maatregel voor een burger op te halen\"\n operationId: tewerkstellingsondersteunendeMaatregelen\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Insz\n in: header\n description: Insz van de burger\n required: true\n style: simple\n explode: false\n schema:\n type: string\n pattern: '^\\d{11}$'\n - name: maatregelType\n in: query\n description: Geeft aan over welk type maatregel het gaat\n required: true\n style: form\n explode: true\n schema:\n type: string\n - name: collectiefMaatwerkBedrijf\n in: query\n description: Geeft aan of het een collectief maatwerkbedrijf is\n required: true\n style: form\n explode: true\n schema:\n type: boolean\n - name: aanvraagdatumWerkgever\n in: query\n description: Datum waarop de werkgever een aanvraag tot opening subsidiedossier heeft gedaan bij WSE\n required: true\n style: form\n explode: true\n schema:\n type: string\n format: date\n responses:\n 200:\n description: \"OK\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/TewerkstellingsondersteunendeMaatregelVDAB'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n /tewerkstelling/ondersteuningsnoodEvaluatieAanvragen:\n post:\n tags:\n - VDAB\n - API 2\n summary: \"Bericht van DWSE om een (her)evaluatie aan te vragen voor een bestaande tewerkstellingsondersteunende maatregel\"\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n content:\n multipart/form-data:\n schema:\n type: object\n required:\n - request\n properties:\n request:\n $ref: '#/components/schemas/OndersteuningsnoodEvaluatieAanvraag'\n documentBestanden:\n type: array\n items:\n type: string\n format: binary\n required: true\n responses:\n 200:\n description: \"Verzoek geregistreerd\"\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n /tewerkstelling/subsidiedossiers:\n get:\n tags:\n - DWSE\n - API 6\n summary: \"GET subsidiedossier\"\n operationId: subsidiedossiers\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Insz\n in: header\n description: Insz van de burger\n required: true\n style: simple\n explode: false\n schema:\n type: string\n pattern: '^\\d{11}$'\n - name: subsidiedossierReferentie\n in: query\n required: false\n schema:\n type: string\n responses:\n 200:\n description: \"OK\"\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/Subsidiedossier'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n post:\n tags:\n - VDAB\n - API 5\n summary: \"Endpoint dat gebruikt kan worden door DWSE om een subsidiedossier of eventuele updates door te sturen naar de VDAB\"\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Insz\n in: header\n description: Header met de insz van de burger\n required: true\n style: simple\n explode: false\n schema:\n type: string\n pattern: '^\\d{11}$'\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/SubsidiedossierUpdateVraag'\n required: true\n responses:\n 200:\n description: \"Verzoek geregistreerd\"\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n /tewerkstelling/ondersteuningsnoodEvaluatieResultaten/{evaluatieAanvraagReferentie}:\n post:\n tags:\n - DWSE\n - API 3\n summary: \"POST Zend Evaluatie Resultaat\"\n operationId: ondersteuningsnoodEvaluatieResultaten\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: evaluatieAanvraagReferentie\n in: path\n description: Referentie van de evaluatie aanvraag\n required: true\n style: simple\n explode: false\n schema:\n type: string\n requestBody:\n description: evaluatie resultaat payload\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/EvaluatieResultaatMutatie'\n required: true\n responses:\n 200:\n description: \"Verzoek geregistreerd\"\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n /tewerkstelling/ondersteunendeMaatregelen/{maatregelReferentie}:\n post:\n tags:\n - DWSE\n - API 4\n summary: \"POST maatregel\"\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: X-Insz\n in: header\n description: Header met de insz van de burger\n required: true\n style: simple\n explode: false\n schema:\n type: string\n pattern: '^\\d{11}$'\n - name: maatregelReferentie\n in: path\n description: Referentie van de maatregel\n required: true\n style: simple\n explode: false\n schema:\n type: string\n requestBody:\n description: Omschrijving van de body van de request\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/TewerkstellingsondersteunendeMaatregelMutatie'\n required: true\n responses:\n 200:\n description: \"Verzoek geregistreerd\"\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n\n\ncomponents:\n parameters:\n CorrelationId:\n name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n #HTTP Status 400\n BadRequest:\n description: \"Invalid data supplied\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 401\n InvalidAuthorization:\n description: \"Invalid authorization\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 403\n Forbidden:\n description: \"Authentication failed\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 404\n NotFound:\n description: \"Resource not found\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 412\n PreConditionFailed:\n description: Precondition Failed\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 500\n UnexpectedServerError:\n description: \"Unexpected Server Error\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 502\n BadGateway:\n description: \"Bad Gateway\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 503\n ServiceUnavailable:\n description: \"Service unavailable\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 504\n GatewayTimeout:\n description: \"Gateway Timeout\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n schemas:\n Correlation-Id:\n description: \"ID of the transaction. Use this ID for log tracing and incident handling\"\n type: string\n minLength: 10\n maxLength: 36\n\n TewerkstellingsondersteunendeMaatregelVDAB:\n type: object\n properties:\n referentie:\n type: string\n description: Unieke referentie naar de maatregel binnen de VDAB\n type:\n type: string\n description: Het type maatregel\n status:\n $ref: '#/components/schemas/TewerkstellingsondersteunendeMaatregelStatus'\n duurtijdInJaar:\n type: integer\n description: De duurtijd van de maatregel uitgedrukt in jaren\n startdatum:\n type: string\n description: De start datum\n format: date\n einddatum:\n type: string\n description: De eind datum\n format: date\n startpakket:\n $ref: '#/components/schemas/Startpakket'\n startdatumArbeidsbeperkingImw:\n type: string\n description: Startdatum van de eerste arbeidsbeperking met loonpremie of begeleidingsnood, nodig in kader van IMW zodat WSE de juiste premie kan bepalen.\n format: date\n description: De details voor een tewerkstellingsondersteunende maatregel voor een burger\n TewerkstellingsondersteunendeMaatregelWSE:\n type: object\n properties:\n type:\n type: string\n description: Het type maatregel\n status:\n $ref: '#/components/schemas/TewerkstellingsondersteunendeMaatregelStatus'\n duurtijdInJaar:\n type: integer\n description: De duurtijd van de maatregel uitgedrukt in jaren\n startdatum:\n type: string\n description: De start datum\n format: date\n einddatum:\n type: string\n description: De eind datum\n format: date\n startpakket:\n $ref: '#/components/schemas/Startpakket'\n correctie:\n $ref: '#/components/schemas/Correctie'\n description: De details voor een tewerkstellingsondersteunende maatregel voor een burger\n\n TewerkstellingsondersteunendeMaatregelStatus:\n type: string\n description: Mogelijke maatregel status waarden\n enum:\n - NIET_ONDERZOCHT\n - TOEGEKEND\n - GEWEIGERD\n\n Startpakket:\n required:\n - afgetopt\n - begeleidingsnood\n - loonpremiePercentage\n type: object\n properties:\n loonpremiePercentage:\n type: integer\n description: Tussenkomst in de loonkost om rendementsverlies te compenseren, in percentage uitgedrukt\n begeleidingsnood:\n $ref: '#/components/schemas/Begeleidingsnood'\n afgetopt:\n type: boolean\n description: Geeft aan of het al dan niet over een afgetopt startpakket gaat\n description: Het startpakket gekoppeld aan een maatregel\n Begeleidingsnood:\n type: string\n description: Een indicatie van de begeleidingsnood\n enum:\n - HOOG\n - MIDDEN\n - LAAG\n - GEEN\n\n OndersteuningsnoodEvaluatieAanvraag:\n description: Een aanvraag om een tewerkstellingsondersteunende maatregel te evalueren\n type: object\n required:\n - datum\n - subsidiedossier\n - referentie\n properties:\n referentie:\n type: string\n description: de referentie van de evaluatieAanvraag\n datum:\n type: string\n description: Datum waarop de aanvraag gedaan werd\n format: date\n subsidiedossier:\n $ref: '#/components/schemas/SubsidiedossierReferentie'\n documenten:\n type: array\n items:\n $ref: '#/components/schemas/Document'\n SubsidiedossierReferentie:\n description: De referentie naar het subsidiedossier zoals gekend door de werkgever\n type: object\n required:\n - referentie\n - maatregelType\n properties:\n referentie:\n type: string\n description: De referentie\n maatregelType:\n type: string\n description: Het type maatregel\n Document:\n description: Een document dat uitgewisseld kan worden\n type: object\n required:\n - type\n - naam\n properties:\n type:\n $ref: '#/components/schemas/DocumentType'\n naam:\n type: string\n description: De naam van het document\n\n DocumentType:\n description: Document type\n type: string\n enum:\n - MOTIVATIEVERSLAG\n - ONDERSTEUNINGSPLAN\n - ANDERE\n\n SubsidiedossierUpdateVraag:\n description: Verzoek om de gegevens omtrent een subsidiedossier aan te passen\n type: object\n properties:\n mutatie:\n $ref: '#/components/schemas/VDABMutatie'\n dossier:\n $ref: '#/components/schemas/Subsidiedossier'\n VDABMutatie:\n description: De context waarin een tewerkstellingsondersteunende maatregel werd aangepast\n type: object\n required:\n - referentie\n - type\n - tijdstip\n properties:\n referentie:\n description: Een referentie naar de mutatie\n type: string\n format: uuid\n type:\n $ref: '#/components/schemas/VDABMutatieType'\n tijdstip:\n description: Tijdstip van de mutatie\n type: string\n format: date-time\n\n VDABMutatieType:\n description: \"De tewerkstellingsondersteunende maatregel mutatie types\"\n enum:\n - NIEUW\n - WIJZIGING\n - ANNULATIE\n\n Subsidiedossier:\n description: De gegevens voor een subsidiedossier\n type: object\n required:\n - referentie\n - status\n - maatregelType\n - creatieNaarAanleidingVanOvergangsmaatregel\n properties:\n referentie:\n type: string\n description: dossier referentie\n persoon:\n $ref: '#/components/schemas/Persoon'\n startdatum:\n description: De start datum\n type: string\n format: date\n einddatum:\n description: De eind datum\n type: string\n format: date\n omschrijving:\n description: Omschrijving van het dossier\n type: string\n creatieNaarAanleidingVanOvergangsmaatregel:\n description: Waarde dat aangeeft dat het dosier aangemaakt werd naar aanleiding van een overgangsmaatregel\n type: boolean\n status:\n $ref: '#/components/schemas/SubsidiedossierStatus'\n maatregelType:\n description: Het type tewerkstellingsondersteunende maatregel\n type: string\n regeling:\n $ref: '#/components/schemas/Regeling'\n vestiging:\n $ref: '#/components/schemas/Vestiging'\n begeleidingspartijen:\n $ref: '#/components/schemas/Begeleidingspartijen'\n Persoon:\n description: \"Een persoon in de context van een subsidiedossier\"\n required:\n - insz\n type: object\n properties:\n insz:\n type: string\n zelfstandige:\n type: boolean\n description: Geeft aan of het om een zelfstandige gaat\n SubsidiedossierStatus:\n description: Mogelijke status waarden voor een subsidiedossier\n type: string\n enum:\n - IN_BEHANDELING\n - ACTIEF\n - AFGESLOTEN\n - GEWEIGERD\n Regeling:\n description: Verzameling van regelingsperiodes met bijhorende % loonpremie en hoogte begeleidingsnood op niveau van subsidiedossier\n type: object\n properties:\n beslissingsdatumBetaling:\n description: De datum waarop WSE beslist heeft dat de betaling mag doorgevoerd worden\n type: string\n format: date\n periodes:\n type: array\n items:\n $ref: '#/components/schemas/Regelingsperiode'\n Vestiging:\n description: Beschrijving van de vestiging in een subsidiedossier\n type: object\n properties:\n bedrijf:\n $ref: '#/components/schemas/BedrijfReferentie'\n contactpersoon:\n $ref: '#/components/schemas/Contactpersoon'\n buitenlandseVestiging:\n $ref: '#/components/schemas/BuitenlandseVestiging'\n collectiefMaatwerkBedrijf:\n description: Geeft aan of het om een collectief maatwerk bedrijf gaat\n type: boolean\n Begeleidingspartijen:\n description: De partijen die instaan voor de begeleiding van de burger\n type: object\n properties:\n externeDienstverleners:\n description: Een extern bedrijf dat de begeleiding verzorgt. De gegevens van de effectieve begeleiders van het extern bedrijf zijn niet beschikbaar\n type: array\n items:\n $ref: '#/components/schemas/ExterneDienstverlener'\n interneBegeleiders:\n description: een interne begeleider van de vestiging waarvoor het subsidiedossier is opgezet\n type: array\n items:\n $ref: '#/components/schemas/ContactPersoonReferentie'\n collegaCoaches:\n type: array\n items:\n $ref: '#/components/schemas/ContactPersoonReferentie'\n Regelingsperiode:\n description: Percentage loonpremie en hoogte begeleidingsnood voor een specifieke periode\n type: object\n properties:\n startdatum:\n type: string\n description: De start datum\n format: date\n einddatum:\n type: string\n description: De eind datum\n format: date\n loonpremiePercentage:\n type: integer\n description: Het loonpremie percentage\n begeleidingsnood:\n $ref: '#/components/schemas/Begeleidingsnood'\n\n BedrijfReferentie:\n description: De referentie naar een bedrijf\n required:\n - ondernemingsnummer\n type: object\n properties:\n ondernemingsnummer:\n description: Het ondernemingsnummer\n type: string\n vestigingsnummer:\n description: Het vestigingnummer\n type: string\n telefoon:\n description: Het telefoonnummer\n type: string\n emailAdres:\n description: Het email adres\n type: string\n Contactpersoon:\n description: Contactpersoon gegevens\n required:\n - achternaam\n - voornaam\n type: object\n properties:\n achternaam:\n description: De achternaam\n type: string\n voornaam:\n description: De voornaam\n type: string\n telefoon:\n description: Het telefoonnummer\n type: string\n emailAdres:\n description: Het email adres\n type: string\n BuitenlandseVestiging:\n description: Beschrijving van de buitenlandse vestiging in een subsidiedossier\n type: object\n properties:\n naam:\n description: De naam van het bedrijf/vestiging\n type: string\n adres:\n $ref: '#/components/schemas/Adres'\n telefoon:\n description: Het telefoonnummer\n type: string\n emailAdres:\n description: Het email adres\n type: string\n\n\n ExterneDienstverlener:\n type: object\n properties:\n startdatum:\n description: De (optionele) start datum\n type: string\n format: date\n einddatum:\n description: De (optionele) eind datum\n type: string\n format: date\n bedrijf:\n $ref: '#/components/schemas/BedrijfReferentie'\n buitenlandseVestiging:\n $ref: '#/components/schemas/BuitenlandseVestiging'\n ContactPersoonReferentie:\n description: De referentie naar een contact persoon die actief was in de tijd\n type: object\n properties:\n startdatum:\n description: De (optionele) start datum\n type: string\n format: date\n einddatum:\n description: De (optionele) eind datum\n type: string\n format: date\n contactpersoon:\n $ref: '#/components/schemas/Contactpersoon'\n Adres:\n description: Een adres beschrijving\n type: object\n properties:\n ongestructureerd:\n $ref: '#/components/schemas/OngestructureerdAdres'\n landcode:\n description: De land code (ISO-2)\n type: string\n OngestructureerdAdres:\n description: Een ongestructureerd adres\n type: object\n properties:\n adreslijnen:\n type: array\n items:\n type: string\n\n EvaluatieResultaatMutatie:\n description: De resultaten die doorgezonden worden voor evaluatie\n type: object\n properties:\n evaluatieResultaat:\n $ref: '#/components/schemas/Evaluatieresultaat'\n mutatie:\n $ref: '#/components/schemas/WSEMutatie'\n WSEMutatie:\n required:\n - referentie\n - tijdstip\n - type\n type: object\n properties:\n referentie:\n type: string\n description: Een referentie naar de mutatie\n format: uuid\n type:\n $ref: '#/components/schemas/MutatieType'\n tijdstip:\n type: string\n description: Tijdstip van de mutatie\n format: date-time\n description: De context waarin een tewerkstellingsondersteunende maatregel werd aangepast\n MutatieType:\n type: string\n description: |\n De tewerkstellingsondersteunende maatregel mutatie types\n enum:\n - NIEUW\n - WIJZIGING\n - ANNULATIE\n\n Evaluatieresultaat:\n properties:\n subsidiedossier:\n $ref: '#/components/schemas/SubsidiedossierReferentie'\n beslissingsdatum:\n type: string\n format: date\n statusEvaluatieAanvraag:\n type: string\n enum:\n - GOEDGEKEURD\n - GEWEIGERD\n redenWeigering:\n type: string\n enum:\n - NIET_UITVOERBAAR\n - WEIGERING_MEDEWERKING\n - ADMINISTRATIEVE_WEIGERING\n - ANDERE\n evaluatieRegelingsperiode:\n type: array\n items:\n type: object\n properties:\n startdatum:\n type: string\n format: date\n einddatum:\n type: string\n format: date\n loonpremiePercentage:\n type: integer\n begeleidingsnood:\n $ref: '#/components/schemas/Begeleidingsnood'\n opmerkingen:\n type: string\n correctie:\n $ref: '#/components/schemas/Correctie'\n Correctie:\n type: object\n properties:\n reden:\n type: string\n enum:\n - HOC\n - FOUT\n opmerkingen:\n type: string\n TewerkstellingsondersteunendeMaatregelMutatie:\n type: object\n properties:\n maatregel:\n $ref: '#/components/schemas/TewerkstellingsondersteunendeMaatregelWSE'\n mutatie:\n $ref: '#/components/schemas/WSEMutatie'\n\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: \"A URI reference that identifies the problem type. This specification encourages that, when de-referenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be about:blank.\"\n title:\n type: string\n description: \"A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.\"\n status:\n type: string\n description: \"The HTTP status code generated by the origin server for this occurrence of the problem.\"\n detail:\n type: string\n description: \"A human-readable explanation specific to this occurrence of the problem.\"\n instance:\n type: string\n description: \"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if de-referenced.\"\n description: \"A representation of a generic error message.\""},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"2d92b0fb-cd6f-42e6-90e7-1c9577929e51"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"d8e4905a-538a-49ed-bfc8-ffacdd912cf9"}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"SocZek","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"handicap","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"8df9655a-b6b1-486a-a4a0-bd8e463ff980","collection":"contentId-6118410708","type":"file"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: \"3.0.2\"\ninfo:\n title: \"Digitaal Vlaanderen - Volledige Dossiers Handicap\"\n description: \"Deze dienst geeft alle info rond een dossier handicap\"\n contact:\n name: \"Magda helpdesk\"\n url: \"https://overheid.vlaanderen.be/magda\"\n license:\n name: \"Volledige dossiers Handicap\"\n url: \"https://overheid.vlaanderen.be/magda\"\n version: \"1.0.0\"\nservers:\n - url: \"api/v1/socZek\"\npaths: \n /handicap/volledigeDossiers:\n get:\n tags:\n - \"VolledigeDossiers\"\n summary: \"Haalt volledige dossier op basis van rijksregisternummer\"\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - name: rrnr\n description: \"Rijksregisternummer\"\n in: query\n required: true\n schema:\n type: string\n responses:\n 200:\n description: \"Response met inhoud\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DossierInfo'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\ncomponents:\n parameters:\n CorrelationId:\n name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n #HTTP Status 400\n BadRequest:\n description: \"Invalid data supplied\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 401\n InvalidAuthorization:\n description: \"Invalid authorization\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 403\n Forbidden:\n description: \"Authentication failed\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 404\n NotFound:\n description: \"Resource not found\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 412\n PreConditionFailed:\n description: Precondition Failed\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 500\n UnexpectedServerError:\n description: \"Unexpected Server Error\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 502\n BadGateway:\n description: \"Bad Gateway\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 503\n ServiceUnavailable:\n description: \"Service unavailable\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 504\n GatewayTimeout:\n description: \"Gateway Timeout\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n schemas:\n Correlation-Id:\n description: \"ID of the transaction. Use this ID for log tracing and incident handling\"\n type: string\n minLength: 10\n maxLength: 36\n\n DossierInfo:\n type: object\n properties:\n \"@context\":\n type: string\n default: 'https://vlaamseoverheid.atlassian.net/wiki/download/attachments/485949995/handicapvolledigeDossiers-context.jsonld?api=v2'\n wettelijkeVertegenwoordigers:\n type: array\n items:\n $ref: '#/components/schemas/WettelijkeVertegenwoordiger'\n persoonsgegevens:\n $ref: '#/components/schemas/Persoon'\n persoonsvolgendBudget:\n $ref: '#/components/schemas/PersoonsvolgendBudget'\n rth:\n $ref: '#/components/schemas/RTH'\n overeenkomsten:\n $ref: '#/components/schemas/NietPvbGebondenZorg'\n diagnose:\n $ref: '#/components/schemas/Diagnose'\n hulpmiddelen:\n $ref: '#/components/schemas/Hulpmiddelen'\n Adres:\n type: object\n properties:\n '@type':\n type: string\n enum:\n - AdresVoorstelling\n straatnaam:\n $ref: '#/components/schemas/TaalString'\n huisnummer:\n type: string\n busnummer:\n type: string\n postcode:\n type: string\n postnaam:\n $ref: '#/components/schemas/TaalString'\n land:\n $ref: '#/components/schemas/TaalString'\n volledigAdres:\n $ref: '#/components/schemas/TaalString'\n Bedrag:\n type: number\n format: double\n Punten:\n type: number\n format: double\n TaalString:\n type: object\n properties:\n nl:\n type: string\n fr:\n type: string\n Diagnose:\n type: object\n properties:\n laatsteVerslag:\n $ref: '#/components/schemas/Verslag'\n stoornissen:\n type: array\n items:\n $ref: '#/components/schemas/Stoornis'\n handicaps:\n type: array\n items:\n $ref: '#/components/schemas/Handicap'\n iqTest:\n $ref: '#/components/schemas/IQTest'\n motorischeBeperkingen:\n $ref: '#/components/schemas/MotorischeBeperkingen'\n zelfredzaamheid:\n $ref: '#/components/schemas/Zelfredzaamheid'\n zorgZwaarte:\n $ref: '#/components/schemas/ZorgZwaarte'\n beperkingen:\n type: array\n items:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n stoornisCodes:\n type: array\n writeOnly: true\n items:\n $ref: '#/components/schemas/Stoornis'\n DossierInfoCodeOmschrijving:\n required:\n - code\n - omschrijving\n type: object\n properties:\n code:\n type: string\n omschrijving:\n type: string\n ErkenningHandicap:\n type: object\n properties:\n heeftHandicap:\n type: string\n enum:\n - JA\n - NEEN\n startdatum:\n type: string\n format: date\n einddatum:\n type: string\n format: date\n Fout:\n required:\n - bericht\n - type\n type: object\n properties:\n bericht:\n type: string\n code:\n type: string\n type:\n type: string\n enum:\n - BEVEILIGING\n - VALIDATIE\n - DATA\n - SYSTEEM\n - ONBEKEND\n - XSD_VALIDATIE\n - REQUEST\n xml:\n name: fout\n namespace: http://www.vaph.be/common\n Handicap:\n type: object\n properties:\n code:\n type: string\n naam:\n type: string\n HulpmiddelDoelgroep:\n type: object\n properties:\n omschrijving:\n type: string\n categorien:\n uniqueItems: true\n type: array\n items:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n IQTest:\n type: object\n properties:\n p:\n type: number\n format: double\n v:\n type: number\n format: double\n t:\n type: number\n format: double\n datum:\n type: string\n format: date\n type:\n type: string\n verslag:\n $ref: '#/components/schemas/Verslag'\n HulpmiddelBewijs:\n type: object\n properties:\n factuurdatum:\n type: string\n format: date\n factuurReferentie:\n type: string\n leverancier:\n type: string\n bedrag:\n $ref: '#/components/schemas/Bedrag'\n betaalbaar:\n type: boolean\n Hulpmiddelen:\n type: object\n properties:\n doelgroepen:\n type: array\n items:\n $ref: '#/components/schemas/HulpmiddelDoelgroep'\n hulpmiddel:\n type: array\n items:\n $ref: '#/components/schemas/Hulpmiddel'\n Hulpmiddel:\n type: object\n properties:\n code:\n type: string\n naam:\n type: string\n domein:\n type: string\n omschrijving:\n type: string\n aanvraagdatum:\n type: string\n format: date\n facturenBetaalbaarVanaf:\n type: string\n format: date\n toegewezenBedrag:\n $ref: '#/components/schemas/Bedrag'\n bewijzen:\n type: array\n items:\n $ref: '#/components/schemas/HulpmiddelBewijs'\n status:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n MdtVerslagNemer:\n type: object\n properties:\n mdt:\n $ref: '#/components/schemas/Organisatie'\n mdtMedewerker:\n $ref: '#/components/schemas/Persoon'\n startdatum:\n type: string\n format: date\n einddatum:\n type: string\n format: date\n MotorischeBeperkingen:\n type: object\n properties:\n verslag:\n $ref: '#/components/schemas/Verslag'\n bovensteLedematenLinks:\n type: string\n bovensteLedematenRechts:\n type: string\n ondersteLedematenLinks:\n type: string\n ondersteLedematenRechts:\n type: string\n wervelkolom:\n type: string\n stappen300m:\n type: string\n NietPvbGebondenZorg:\n type: object\n properties:\n mfc:\n type: array\n items:\n $ref: '#/components/schemas/MfcOvereenkomst'\n odb:\n type: array\n items:\n $ref: '#/components/schemas/OdbOvereenkomst'\n geinterneerden:\n type: array\n items:\n $ref: '#/components/schemas/GeinterneerdenOvereenkomst'\n forensischeVAPHUnit:\n type: array\n items:\n $ref: '#/components/schemas/ForensischeVaphUnitOvereenkomst'\n nah:\n type: array\n items:\n $ref: '#/components/schemas/NahOvereenkomst'\n BestedingOvereenkomst:\n type: object\n properties:\n startdatum:\n type: string\n format: date\n einddatum:\n type: string\n format: date\n type:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n zorgaanbieder:\n $ref: '#/components/schemas/Zorgaanbieder'\n zorgpunten:\n $ref: '#/components/schemas/Bedrag'\n bedrag:\n $ref: '#/components/schemas/Bedrag'\n MfcOvereenkomst:\n type: object\n properties:\n startdatum:\n type: string\n format: date\n einddatum:\n type: string\n format: date\n type:\n $ref: '#/components/schemas/OvereenkomstType'\n zorgaanbieder:\n $ref: '#/components/schemas/Zorgaanbieder'\n zorgpunten:\n $ref: '#/components/schemas/Punten'\n dagopvang:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n dagBesteding:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n diagnostiek:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n behandeling:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n begeleiding:\n type: boolean\n verblijf:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n toegangsPoortJeugdrechter:\n type: boolean\n toegangsPoortMaatschappelijkeNoodzaak:\n type: boolean\n intersectoraalTraject:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n datumUitstroom:\n type: string\n format: date\n redenUitstroom:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n redenUitstroomUitleg:\n type: string\n OdbOvereenkomst:\n type: object\n properties:\n startdatum:\n type: string\n format: date\n einddatum:\n type: string\n format: date\n type:\n $ref: '#/components/schemas/OvereenkomstType'\n zorgaanbieder:\n $ref: '#/components/schemas/Zorgaanbieder'\n dagondersteuning:\n type: number\n woonondersteuning:\n type: integer\n individuelePsychosocialeBegeleiding:\n type: integer\n individuelePsychosocialeBegeleidingDagen:\n type: number\n format: double\n datumUitstroom:\n type: string\n format: date\n GeinterneerdenOvereenkomst:\n type: object\n properties:\n startdatum:\n type: string\n format: date\n einddatum:\n type: string\n format: date\n type:\n $ref: '#/components/schemas/OvereenkomstType'\n zorgaanbieder:\n $ref: '#/components/schemas/Zorgaanbieder'\n module:\n type: string\n ForensischeVaphUnitOvereenkomst:\n type: object\n properties:\n startdatum:\n type: string\n format: date\n einddatum:\n type: string\n format: date\n type:\n $ref: '#/components/schemas/OvereenkomstType'\n zorgaanbieder:\n $ref: '#/components/schemas/Zorgaanbieder'\n NahOvereenkomst:\n type: object\n properties:\n startdatum:\n type: string\n format: date\n einddatum:\n type: string\n format: date\n type:\n $ref: '#/components/schemas/OvereenkomstType'\n zorgaanbieder:\n $ref: '#/components/schemas/Zorgaanbieder'\n redenUitstroom:\n type: string\n Persoon:\n type: object\n properties:\n '@type':\n type: string\n default: Persoon\n achternaam:\n type: string\n voornaam:\n type: string\n geslacht:\n type: string\n heeftGeboorte:\n $ref: '#/components/schemas/Geboorte'\n volledigeNaam:\n type: string\n contactinfo:\n $ref: '#/components/schemas/Contact'\n rijksregisternummer:\n $ref: '#/components/schemas/Registratie'\n dossiernummer:\n $ref: '#/components/schemas/Registratie'\n erkenningHandicap:\n $ref: '#/components/schemas/ErkenningHandicap'\n ondernemingsnummer:\n $ref: '#/components/schemas/Registratie'\n Geboorte:\n type: object\n properties:\n '@type':\n type: string\n enum:\n - PersoonsGebeurtenis\n datum:\n type: string\n format: date\n Contact:\n type: object\n properties:\n telefoon:\n type: string\n email:\n type: string\n adres:\n $ref: '#/components/schemas/Adres'\n Organisatie:\n type: object\n properties:\n '@type':\n type: string\n enum:\n - Organisatie\n ondernemingsnummer:\n $ref: '#/components/schemas/Registratie'\n erkenningsnummer:\n $ref: '#/components/schemas/Registratie'\n naam:\n type: string\n contactinfo:\n $ref: '#/components/schemas/Contact'\n Registratie:\n type: object\n properties:\n notatie:\n type: string\n agent:\n type: string\n enum:\n - rijksregister\n - KBO\n - VAPH\n RTH:\n type: array\n items:\n $ref: '#/components/schemas/RthRegistratie'\n RthRegistratie:\n type: object\n properties:\n zorgaanbieder:\n $ref: '#/components/schemas/Zorgaanbieder'\n registraties:\n type: array\n items:\n $ref: '#/components/schemas/RthRegistratiesPerJaar'\n RthRegistratiesPerJaar:\n type: object\n properties:\n jaar:\n type: integer\n aantalRegistraties:\n type: integer\n gebruiktePunten:\n type: number\n Stoornis:\n type: object\n properties:\n code:\n type: string\n naam:\n type: string\n verslag:\n $ref: '#/components/schemas/Verslag'\n Verslag:\n type: object\n properties:\n verzendingsdatum:\n type: string\n format: date\n mdtVerslagNemer:\n $ref: '#/components/schemas/MdtVerslagNemer'\n WettelijkeVertegenwoordiger:\n type: object\n properties:\n persoon:\n $ref: '#/components/schemas/Persoon'\n wettelijkeVertegenwoordigerType:\n _comment: Omzetten naar codetabel\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n Zelfredzaamheid:\n type: object\n properties:\n elida:\n type: number\n format: double\n barthel:\n type: number\n format: double\n verslag:\n $ref: '#/components/schemas/Verslag'\n ZorgZwaarte:\n type: object\n properties:\n bWaarde:\n type: number\n format: double\n pWaarde:\n type: number\n format: double\n verslag:\n $ref: '#/components/schemas/Verslag'\n zziWaarden:\n type: array\n items:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n Zorgaanbieder:\n type: object\n properties:\n organisatie:\n $ref: '#/components/schemas/Organisatie'\n persoon:\n $ref: '#/components/schemas/Persoon'\n PersoonsvolgendBudget:\n type: object\n properties:\n ondersteuningsplannen:\n type: array\n items:\n $ref: '#/components/schemas/Ondersteuningsplan'\n inAfwachtingVanBudgetOfExtraBudget:\n type: string\n enum:\n - JA\n - NEEN\n budget:\n $ref: '#/components/schemas/Budget'\n Ondersteuningsplan:\n type: object\n properties:\n verzendingsdatum:\n type: string\n format: date\n gewoneVraag:\n $ref: '#/components/schemas/Vraag'\n dringendeVraag:\n $ref: '#/components/schemas/Vraag'\n Vraag:\n type: object\n properties:\n ondersteuningsfuncties:\n type: array\n items:\n $ref: '#/components/schemas/OndersteuningsFunctie'\n gevraagdeBudgetcategorie:\n _comment: Om te zetten naar codetabel\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n OndersteuningsFunctie:\n type: object\n properties:\n functie:\n type: string\n frequentie:\n type: string\n eenheid:\n type: string\n Budget:\n type: object\n properties:\n startdatum:\n type: string\n format: date\n einddatum:\n type: string\n format: date\n startDatumEersteContract:\n type: string\n format: date\n terugvorderbaarVoorschot:\n $ref: '#/components/schemas/Bedrag'\n budgetcategorie:\n _comment: om te zetten naar codetabel\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n toegewezenZorgpunten:\n $ref: '#/components/schemas/Punten'\n jaarbudgetten:\n type: array\n items:\n $ref: '#/components/schemas/JaarBudget'\n overeenkomsten:\n type: array\n items:\n $ref: '#/components/schemas/BestedingOvereenkomst'\n dagbesteding:\n $ref: '#/components/schemas/Dagbesteding'\n tekortenHuidigeOndersteuning:\n type: string\n noodAanToezicht:\n type: string\n enum:\n - JA\n - NEEN\n vraagMotiveringMeerwaarde:\n type: string\n vraagOndersteuningsplan:\n type: string\n JaarBudget:\n type: object\n properties:\n jaar:\n type: integer\n type:\n type: string\n enum:\n - PAB\n - PVB\n - PAB_PVB\n startdatum:\n type: string\n format: date\n einddatum:\n type: string\n format: date\n budgethoogte:\n $ref: '#/components/schemas/Bedrag'\n saldoBudget:\n $ref: '#/components/schemas/Bedrag'\n Dagbesteding:\n type: object\n properties:\n activiteiten:\n type: array\n items:\n $ref: '#/components/schemas/Activiteit'\n Activiteit:\n type: object\n properties:\n type:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n toelichting:\n type: string\n regime:\n type: string\n enum:\n - DEELTIJDS\n - VOLTIJDS\n OvereenkomstType:\n type: object\n properties:\n hoofdtype:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n subtype:\n $ref: '#/components/schemas/DossierInfoCodeOmschrijving'\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: \"A URI reference that identifies the problem type. This specification encourages that, when de-referenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be about:blank.\"\n title:\n type: string\n description: \"A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.\"\n status:\n type: string\n description: \"The HTTP status code generated by the origin server for this occurrence of the problem.\"\n detail:\n type: string\n description: \"A human-readable explanation specific to this occurrence of the problem.\"\n instance:\n type: string\n description: \"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if de-referenced.\"\n description: \"A representation of a generic error message.\""},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"e855001c-fe0d-4b39-9c26-061839fb4e98"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"bbce3b74-4c72-44cf-ad52-223af1023d6c"}}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Sociale Huisvesting","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"f33baeb5-df22-450d-a8fc-dba1f7a7a04c","collection":"contentId-6118410708","type":"file"}}]},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"displayRequestDuration":{"value":"false"},"showExtensions":{"value":"false"},"__bodyContent":{"value":"openapi: 3.0.3\ninfo:\n title: VMSW Woningen\n description: 'This RESTful API is designed to query current data registered at VMSW. Release date October, 2023.'\n contact:\n name: \"Magda helpdesk\"\n email: helpdesk.magda@vlaanderen.be\n license:\n name: socialeHuisvestingAPI\n url: 'https://overheid.vlaanderen.be/magda'\n version: '0.4'\nservers:\n - url: /api/v1/socZek\npaths:\n '/socialeHuisvesting/dossiers/zoeken':\n post:\n tags:\n - CIR - Dossiers\n operationId: CIRApi_dossiersZoeken\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n description: Dossier zoek criteria\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DossierDienstZoekCriteria'\n example: {\"dossierType\":null,\"dossierStatus\":\"REG\",\"dossierNummer\":null,\"postCode\":\"3500\",\"aanvragerRijksregisternummer\":\"65052643390\",\"creatieDatumVanaf\":\"2023-07-31T00:00:00+00:00\",\"creatieDatumTot\":null,\"updateDatumVanaf\":null,\"updateDatumTot\":null,\"ontvangstDatumVanaf\":null,\"ontvangstDatumTot\":null,\"nietGesynchroniseerd\":null,\"partijCode\":null}\n\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DossierDienstZoekResultaten'\n 204:\n description: No Content\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DossierDienstZoekResultaten'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/dossiers/dossier/{dossierNummer}':\n get:\n tags:\n - CIR - Dossiers\n operationId: CIRApi_dossier\n parameters:\n - name: dossierNummer\n in: path\n description: Nummer van het gevraagde dossier\n required: true\n schema:\n type: string\n nullable: true\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DossierDienstDossier'\n 204:\n description: No Content\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DossierDienstDossier'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n put:\n tags:\n - CIR - Dossiers\n operationId: CIRApi_dossierUpdate\n parameters:\n - name: dossierNummer\n in: path\n description: Nummer van het gevraagde dossier\n required: true\n schema:\n type: string\n nullable: true\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n description: bijgerkte dossier informatie\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DossierDienstDossierWijziging'\n responses:\n 200:\n description: Success\n content:\n application/json:\n schema:\n type: integer\n format: int64\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/dossiers/dossierMetBijlages/{dossierNummer}':\n get:\n tags:\n - CIR - Dossiers\n operationId: CIRApi_dossierMetBijlagen\n summary: Geeft de detail informatie van een welbepaald dossier terug, inclusief de inhoud van de bijlages\n description: \"Het CIR centraliseert alle dossiers\\r\\n
Deze methode maakt het mogelijk om alle informatie over een bepaalhet dossier op te halen\"\n parameters:\n - name: dossierNummer\n in: path\n description: Nummer van het gevraagde dossier\n required: true\n schema:\n type: string\n nullable: true\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DossierDienstDossier'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/dossiers/bevestigDossierVerwerking':\n post:\n tags:\n - CIR - Dossiers\n operationId: CIRApi_BevestigDossierVerwerking\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n description: Dossier bevestiging\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DossierDienstDossierVersieBevestiging'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n type: boolean\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/dossiers/wijzigDossierRangschikkingen':\n post:\n tags:\n - CIR - Dossiers\n operationId: CIRApi_WijzigDossierRangschikkingen\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n description: Dossier Ranglijsten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DossierDienstDossierRanglijstWijzigingen'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n type: integer\n format: int64\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/dossiers/zwarteLijstMeldingen':\n post:\n tags:\n - CIR - Dossiers\n operationId: CIRApi_ZwartelijstMeldingen\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n description: Zwarte Lijst Melding\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ZwarteLijstMeldingen'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n type: boolean\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/dossiers/bijlage':\n post:\n tags:\n - CIR - Dossiers\n operationId: CIRApi_bijlage\n summary: >-\n Haalt een specifiek bestand op van een dossier aan de hand van het dossiernummer en bijlage identificatie.\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DossierDienstBijlageCriteria'\n responses:\n 200:\n description: Success\n content:\n application/octet-stream:\n schema:\n type: string\n format: binary\n nullable: true\n 204: \n description: No Content\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/dossiers/partijInformatieWijzigingen':\n post:\n tags:\n - CIR - Dossiers\n operationId: CIRApi_PartijInformatieWijziging\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n description: Partij Informatie\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/PartijInformatieWijzigingen'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n type: boolean\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/dossiers/zwarteLijstMeldingVoor':\n post:\n tags:\n - CIR - Dossiers\n operationId: CIRApi_zwarteLijstMelding\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetZwarteLijstMeldingVerzoek'\n responses:\n 200:\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetZwarteLijstMelding'\n 204:\n description: No Content\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetZwarteLijstMelding'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/dossiers/verwerkDossierActie':\n post:\n tags:\n - CIR - Dossiers\n operationId: CIRApi_VerwerkDossier\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n description: Zwarte Lijst Melding\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/DossierDienstDossierActie'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n type: boolean\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/gemeentes':\n get:\n tags:\n - CIR - Gemeentes\n operationId: CIRApi_Gemeentes\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GemeenteDienstZoekResultaats'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/gemeentes/wijkenVoorGemeente/{gemeenteNisCode}':\n get:\n tags:\n - CIR - Gemeentes\n operationId: CIRApi_Wijken\n parameters:\n - name: gemeenteNisCode\n in: path\n description: Stad of gemeente code (NIS)\n required: true\n schema:\n type: string\n nullable: true\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: Success\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GemeenteDienstWijken'\n 204:\n description: No Content\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GemeenteDienstWijken'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n put:\n tags:\n - CIR - Gemeentes\n operationId: CIRApi_GemeenteBijwerken\n parameters:\n - name: gemeenteNisCode\n in: path\n description: NIS Code van de hoofdgemeente\n required: true\n schema:\n type: string\n nullable: true\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n description: Zwarte Lijst Melding\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GemeenteDienstWijken'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n type: boolean\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/woningen/{vmswWoningId}':\n get:\n tags:\n - CWR-Woningen\n description: Woninggegevens ophalen op basis van het VmswWoningId\n operationId: GET_Woning\n parameters:\n - name: vmswWoningId\n in: path\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/WoningV2Response'\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n patch:\n tags:\n - CWR-Woningen\n description: Gegevens van een bestaande woning wijzigen.\n operationId: PATCH_WoningDetailsWijzigen\n parameters:\n - name: vmswWoningId\n in: path\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/V2WoningWijzigen'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/WoningV2Response'\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/woningen':\n get:\n tags:\n - CWR-Woningen\n description: Bestaande woning zoeken.\n operationId: GET_Woningen\n parameters:\n - name: woonmaatschappijWoningId\n in: query\n schema:\n type: string\n - name: woonmaatschappijWoningCode\n in: query\n schema:\n type: string\n - name: gebouweenheidId\n in: query\n schema:\n type: string\n - name: straatnaam\n in: query\n schema:\n type: string\n - name: huisnummer\n in: query\n schema:\n type: string\n - name: busnummer\n in: query\n schema:\n type: string\n - name: postcode\n in: query\n schema:\n type: string\n - name: gemeenteNISCode\n in: query\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: Ok\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/WoningV2Response'\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n post:\n tags:\n - CWR-Woningen\n description: Woning aanmaken bij VMSW.\n operationId: POST_Woning\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n description: ''\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/V2WoningToevoegen'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/WoningV2Response'\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/woningen/{vmswWoningId}/woningkenmerkscores':\n get:\n tags:\n - CWR-Woningkenmerken\n description: Woningkenmerkscores ophalen voor een woning op basis van het VmswWoningId.\n operationId: GET_Woningkenmerkscores\n parameters:\n - name: vmswWoningId\n in: path\n required: true\n schema:\n type: string\n - name: woningKenmerkCategorie\n in: query\n schema:\n $ref: '#/components/schemas/WoningKenmerkCategorie'\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: Ok\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/WoningKenmerkScoresResponse'\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n patch:\n tags:\n - CWR-Woningkenmerken\n description: WoningkenmerkScores updaten voor kenmerken van een specifiek woning.\n operationId: PATCH_Woningkenmerkscores\n parameters:\n - name: vmswWoningId\n in: path\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/WoningKenmerkScoreWijzigen'\n responses:\n 200:\n description: Ok\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/WoningKenmerkScoresResponse'\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n\n '/socialeHuisvesting/woningbezettingen':\n post:\n tags:\n - CWR-Woningen\n summary: Nieuwe bezetting\n operationId: nieuwe-woningbezetting\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n content:\n application/json:\n schema:\n type: array\n items:\n $ref: '#/components/schemas/WoningBezetting'\n responses:\n 201:\n $ref: '#/components/responses/Response'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/woningbezettingen/{woning-bezetting-id}':\n patch:\n summary: Update bezetting\n tags:\n - CWR-Woningen\n operationId: update-woning-bezetting\n parameters:\n - name: woning-bezetting-id\n in: path\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/WoningBezetting'\n responses:\n 200:\n description: OK\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n delete:\n summary: Verwijder bezetting\n description: 'Woonmaatschappij verwijdert informatie over bestaande bezetting in CWR, bijvoorbeeld indien iets foutief doorgestuurd werd'\n operationId: delete-woning-bezetting\n tags:\n - CWR-Woningen\n parameters:\n - name: woning-bezetting-id\n in: path\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 204:\n description: No Content\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n get:\n operationId: get-woning-bezetting\n parameters:\n - name: woning-bezetting-id\n in: path\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n tags:\n - CWR-Woningen\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Response'\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/notificaties/{registerId}/messages/head':\n post:\n tags:\n - Notificaties\n summary: Lees en vergrendel bericht\n description: >-\n Het bericht dat gelezen wordt, wordt gelocked en moet nadien opnieuw\n worden vrijgegeven via een PUT call.\n operationId: POST_Messages\n parameters:\n - name: registerId\n in: path\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 201:\n description: Message successfully retrieved and locked.\n headers:\n Content-Type:\n required: true\n schema:\n type: string\n description: Media-type of the resource\n default: application/atom+xml;type=entry;charset=utf-8\n BrokerProperties:\n description: >-\n JSON-encoded representation for the unit of communication\n between Service Bus clients. More info on:\n https://learn.microsoft.com/en-us/rest/api/servicebus/message-headers-and-properties\n required: true\n schema:\n type: object\n example:\n CorrelationId: 44d276e3-81a6-410c-a1ba-06573f254851\n LockToken: 73f378c2-2c64-403b-91df-a711cc56cbb0\n MessageId: random string\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/AsynchroonBerichtResponse'\n 204:\n description: No messages available within the specified timeout period.\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n delete:\n tags:\n - Notificaties\n summary: Lees en verwijder bericht\n operationId: LeesEnVerwijderBericht\n parameters:\n - name: registerId\n in: path\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: OK\n headers:\n Content-Type:\n required: true\n schema:\n type: string\n description: Media-type of the resource\n default: application/atom+xml;type=entry;charset=utf-8\n BrokerProperties:\n description: >-\n JSON-encoded representation for the unit of communication\n between Service Bus clients. More info on:\n https://learn.microsoft.com/en-us/rest/api/servicebus/message-headers-and-properties\n required: true\n schema:\n type: object\n example:\n CorrelationId: 44d276e3-81a6-410c-a1ba-06573f254851\n LockToken: 73f378c2-2c64-403b-91df-a711cc56cbb0\n MessageId: random string\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/AsynchroonBerichtResponse'\n 204:\n description: No messages available within the specified timeout period.\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n '/socialeHuisvesting/notificaties/{registerId}/messages/{messageId}/{lockToken}':\n put:\n tags:\n - Notificaties\n summary: Ontgrendel bericht\n operationId: PUT_UnlockBericht\n parameters:\n - name: registerId\n in: path\n required: true\n schema:\n type: string\n - name: messageId\n in: path\n description: ''\n required: true\n schema:\n type: string\n - name: lockToken\n in: path\n description: ''\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: Message successfully unlocked.\n headers:\n Content-Type:\n required: true\n schema:\n type: string\n description: Media-type of the resource\n default: application/atom+xml;type=entry;charset=utf-8\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n delete:\n tags:\n - Notificaties\n summary: Verwijder bericht\n operationId: DELETE_Bericht\n parameters:\n - name: registerId\n in: path\n required: true\n schema:\n type: string\n - name: messageId\n in: path\n description: ''\n required: true\n schema:\n type: string\n - name: lockToken\n in: path\n description: ''\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: Message successfully deleted.\n headers:\n Content-Type:\n required: true\n schema:\n type: string\n description: Media-type of the resource\n default: application/atom+xml;type=entry;charset=utf-8\n 400:\n $ref: '#/components/responses/BadRequest'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/woningen/{vmswWoningId}/markthuurwaarden':\n get:\n tags:\n - CWR-Markthuurwaarden\n description: Markthuurwaarden ophalen voor een woning op basis van het VmswWoningId.\n operationId: GET_GeefMarkthuurwaarde\n parameters:\n - name: vmswWoningId\n in: path\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/MarkthuurwaardeResponse'\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n '/socialeHuisvesting/woningen/markthuurwaarden/simulatie':\n post:\n tags:\n - CWR-Markthuurwaarden\n description: Markthuurwaarden berekenen op basis van opgegeven (tijdelijke) woningkenmerkscores. Deze scores worden NIET opgeslagen.\n operationId: POST_SimuleerMarkthuurwaarde\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/WoningKenmerkScoreLijst'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/MarkthuurwaardeSimulatieResponse'\n 204:\n description: No messages available within the specified timeout period.\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/woningen/{vmswWoningId}/conditiescore':\n get:\n tags:\n - CWR-Conditiescore\n description: Conditiescore ophalen voor een woning op basis van het VmswWoningId.\n operationId: GET_GeefConditiescore\n parameters:\n - name: vmswWoningId\n in: path\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ConditiescoreResponse'\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/woningen/conditiescore/simulatie':\n post:\n tags:\n - CWR-Conditiescore\n description: Conditiescore berekenen op basis van opgegeven (tijdelijke) woningkenmerkscores. Deze scores worden NIET opgeslagen.\n operationId: POST_SimuleerConditiescore\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/WoningKenmerkScoreLijst'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ConditiescoreSimulatieResponse'\n 204:\n description: No messages available within the specified timeout period.\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/woningen/{vmswWoningId}/energiecorrectie':\n get:\n tags:\n - CWR-Energiecorrectie\n description: Energiecorrectie data ophalen voor een woning op basis van het VmswWoningId.\n operationId: GET_GeefEnergiecorrectie\n parameters:\n - name: vmswWoningId\n in: path\n required: true\n schema:\n type: string\n - name: epcVersie\n in: query\n required: true\n schema:\n $ref: '#/components/schemas/EpcVersie'\n default: Huidig\n - name: datumVanaf\n in: query\n required: true\n schema:\n type: string\n format: date\n - name: datumTot\n in: query\n required: true\n schema:\n type: string\n format: date\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/WoningEnergiecorrectieResponse'\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/woningen/{vmswWoningId}/epcwaarden':\n get:\n tags:\n - CWR-EPCWaarden\n description: EPCWaarden data ophalen voor een woning op basis van het VmswWoningId zoals deze gestockeerd is bij WiV.\n operationId: GET_GetEpcVersiesVoorWoning\n parameters:\n - name: vmswWoningId\n in: path\n required: true\n schema:\n type: string\n - name: epcVersieStatus\n in: query\n schema:\n enum:\n - Huidig\n - Historisch\n type: string\n - name: isReferentieVersie\n in: query\n schema:\n type: boolean\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/EpcVersiesResponse'\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/woningen/{vmswWoningId}/epcwaarden/brondata/{documentId}':\n get:\n tags:\n - CWR-EPCWaarden\n description: EPCWaarden document in JSON formaat ophalen voor een woning zoals deze opgeslagen is bij VEKA op basis van het VmswWoningId zoals deze gestockeerd is bij VEKA.\n operationId: GET_GetEpcCertificaatData\n parameters:\n - name: vmswWoningId\n in: path\n required: true\n schema:\n type: string\n - name: documentId\n in: path\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n type: string\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n\n '/socialeHuisvesting/woningen/{vmswWoningId}/epcwaarden/document/{documentId}':\n get:\n tags:\n - CWR-EPCWaarden\n description: EPCWaarden document in PDF formaat ophalen voor een woning op basis van het VmswWoningId zoals deze gestockeerd is bij WiV.\n operationId: GET_GetEpcCertificaatPdf\n parameters:\n - name: vmswWoningId\n in: path\n required: true\n schema:\n type: string\n - name: documentId\n in: path\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: OK\n content:\n application/octet-stream:\n schema:\n type: string\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/woningen/{vmswWoningId}/epcwaarden/certificaat':\n post:\n tags:\n - CWR-EPCWaarden\n description: Deze operatie laat toe om een certificaatnummer van VEKA te gebruiken om de EPCWaarden bij VEKA op te halen en de gegevens te koppelen aan een WiV WoningId\n operationId: POST_PostEpcCertificaat\n parameters:\n - name: vmswWoningId\n in: path\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/VekaEpcRequest'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/EpcVersieResponse'\n 204:\n description: No messages available within the specified timeout period.\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/woningen/{vmswWoningId}/epcwaarden/markeerReferentieversie':\n patch:\n tags:\n - CWR-EPCWaarden\n description: Deze operatie laat toe om een EPC document als refentie van een WoningId aan te duiden bij WiV.\n operationId: PATCH_SetEpcVersieReferentieVersie\n parameters:\n - name: vmswWoningId\n in: path\n required: true\n schema:\n type: string\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n requestBody:\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/EpcReferentieVersieZetten'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/EpcVersieResponse'\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n '/socialeHuisvesting/woningen/{vmswWoningId}/epcwaarden/{epcVersieId}':\n delete:\n tags:\n - CWR-EPCWaarden\n description: Deze operatie laat toe om een versie van een EPC document, gekoppeld aan een WoningId bij WiV te wissen\n operationId: DELETE_VerwijderEpcVersieVoorWoning\n parameters:\n - name: vmswWoningId\n in: path\n required: true\n schema:\n type: string\n - name: epcVersieId\n in: path\n required: true\n schema:\n type: integer\n format: int32\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n responses:\n 200:\n description: OK\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/EpcVersieResponse'\n 400:\n description: Validatiefouten\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ProblemDetailsValidationErrorExtension'\n 401:\n $ref: '#/components/responses/InvalidAuthorization'\n 403:\n $ref: '#/components/responses/Forbidden'\n 404:\n $ref: '#/components/responses/NotFound'\n 500:\n $ref: '#/components/responses/UnexpectedServerError'\n 502:\n $ref: '#/components/responses/BadGateway'\n 503:\n $ref: '#/components/responses/ServiceUnavailable'\n 504:\n $ref: '#/components/responses/GatewayTimeout'\n\n\ncomponents:\n responses:\n #HTTP Status 400\n BadRequest:\n description: \"Invalid data supplied\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 401\n InvalidAuthorization:\n description: \"Invalid authorization\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 403\n Forbidden:\n description: \"Authentication failed\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 404\n NotFound:\n description: \"Resource not found\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 412\n PreConditionFailed:\n description: Precondition Failed\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 500\n UnexpectedServerError:\n description: \"Unexpected Server Error\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 502\n BadGateway:\n description: \"Bad Gateway\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 503\n ServiceUnavailable:\n description: \"Service unavailable\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n #HTTP Status 504\n GatewayTimeout:\n description: \"Gateway Timeout\"\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/ErrorMessage'\n Response:\n description: The object containing the result\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/Response'\n schemas:\n Correlation-Id:\n description: \"ID of the transaction. Use this ID for log tracing and incident handling.\"\n type: string\n maxLength: 36\n minLength: 10\n\n #----------------------- START CIR payloads to be replaced -------------------------------\n\n DossierDienstZoekCriteria:\n type: object\n properties:\n dossierType:\n $ref: '#/components/schemas/RegistrationDossierTypeWaarden'\n dossierStatus:\n $ref: '#/components/schemas/DossierStatusCodeWaarden'\n dossierNummer:\n maxLength: 15\n type: string\n description: Dossiernummer\n nullable: true\n postCode:\n maxLength: 15\n type: string\n description: Postcode van de personen in het dossier.\n nullable: true\n aanvragerRijksregisternummer:\n maxLength: 15\n type: string\n description: Rijksregisternummer van de personen in het dossier.\n nullable: true\n creatieDatumVanaf:\n type: string\n description: Vroegste datum waarop het dossier werd aangemaakt.\n format: date-time\n nullable: true\n creatieDatumTot:\n type: string\n description: Laatste datum waarop het dossier werd aangemaakt.\n format: date-time\n nullable: true\n updateDatumVanaf:\n type: string\n description: Vroegste datum waarop het dossier werd gewijzigd.\n format: date-time\n nullable: true\n updateDatumTot:\n type: string\n description: Laatste datum waarop het dossier werd gewijzigd.\n format: date-time\n nullable: true\n ontvangstDatumVanaf:\n type: string\n description: Vroegste datum waarop het dossier ontvangen werd in het CIR.\n format: date-time\n nullable: true\n ontvangstDatumTot:\n type: string\n description: Laatste datum waarop het dossier ontvangen werd in het CIR.\n format: date-time\n nullable: true\n nietGesynchroniseerd:\n type: boolean\n description: >-\n Geeft aan of de laatste versie van het dossier reeds werd\n gesynchroniseerd.\n nullable: true\n partijCode:\n maxLength: 15\n type: string\n description: >-\n KBO nummer of CIR code van de partij die betrokken is bij het\n dossier.\n nullable: true\n additionalProperties: false\n nullable: true\n DossierDienstZoekResultaat:\n type: object\n properties:\n dossierType:\n $ref: '#/components/schemas/RegistrationDossierTypeWaarden'\n dossierStatus:\n $ref: '#/components/schemas/DossierStatusCodeWaarden'\n dossierNummer:\n maxLength: 15\n type: string\n nullable: true\n inschrijvingsDatum:\n type: string\n format: date-time\n nullable: true\n creatieDatum:\n type: string\n format: date-time\n laatsteWijzigingsDatum:\n type: string\n format: date-time\n nullable: true\n voorNaam:\n maxLength: 48\n type: string\n nullable: true\n naam:\n maxLength: 128\n type: string\n nullable: true\n aanvragerRijksregisternummer:\n maxLength: 15\n type: string\n nullable: true\n versieNummer:\n type: integer\n format: int32\n additionalProperties: false\n nullable: true\n RegistrationDossierTypeWaarden:\n enum:\n - RFH\n - RFM\n - VMU\n - RMA\n type: string\n description: >-\n

Members:

RFH-Aanvraag voor wonen
RFM-Interne mutatie aanvraag
VMU-Verplichte\n mutatie
RMA-Manuele inschrijving

\n nullable: true\n DossierStatusCodeWaarden:\n enum:\n - REG\n - CHKO\n - CHKS\n - OFFER\n - WAITS\n - RJCT\n - RFSD\n - INFOS\n - SAVED\n - TEMP\n - INFOR\n - CHKR\n - WAITO\n - ARCH\n - CNRQ\n - AIIR\n - TREG\n type: string\n description: >-\n

Members:

REG-Ingeschreven
CHKO-in\n onderzoek verhaal
CHKS-In onderzoek
OFFER-In wacht in aanbod
WAITS-In wacht op\n eigen vraag
RJCT-Geschrapt
RFSD-Geweigerd
INFOS-In onderzoek: extra\n info gevraagd
SAVED-Opgeslagen
TEMP-Tijdelijk opgeslagen
INFOR-Ingeschreven in onderzoek
CHKR-Ingeschreven in onderzoek
WAITO-in\n wacht na aanbod
ARCH-Gearchiveerd
CNRQ-Wachten op dossierdeelname
AIIR-Extra\n inkomen info gevraagd
TREG-Tijdelijk na registratie\n

\n nullable: true\n DossierDienstZoekResultaten:\n type: object\n properties:\n dossiers:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstZoekResultaat'\n nullable: true\n additionalProperties: false\n nullable: true\n DossierDienstDossier:\n type: object\n properties:\n dossierStatusHistoriek:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierStatusHistoriek'\n description: Historiek van Statuswijzigingen\n nullable: true\n dossierInkomstenSamenvattingen:\n $ref: '#/components/schemas/DossierDienstDossierInkomstenSamenvattingen'\n dossierPersonen:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierPersoon'\n description: Contacten\n nullable: true\n dossierLocatieVoorkeuren:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierVoorkeurLocatie'\n description: Locatie Voorkeuren\n nullable: true\n dossierOptioneleVoorkeuren:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierOptioneleVoorkeur'\n description: Locatie Voorkeuren\n nullable: true\n dossierEigendommen:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierEigendom'\n description: Eigendommen\n nullable: true\n readOnly: true\n dossierDienstDossierDomicilieHistoriek:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierDomiciliePeriode'\n description: Domicilie Historiek\n nullable: true\n readOnly: true\n dossierBijlages:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierBijlage'\n description: Bijlages\n nullable: true\n dossierBetrokkenPartijen:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierPartij'\n description: Betrokken Partijen (primaire / secundaire verhuurders,...)\n nullable: true\n bewindvoerder:\n $ref: '#/components/schemas/DossierDienstDossierBewindvoerder'\n oudDossier:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstOudDossier'\n nullable: true\n aanvaardingDossiers:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierComment'\n description: Dossier Dienst Dossier Comment\n nullable: true\n dossierZwarteLijsten:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierZwarteLijst'\n description: Dossier Dienst Dossier BlackList\n nullable: true\n dossierPanden:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierPand'\n description: Dossier Dienst Dossier Pand Aanbiedingen\n nullable: true\n dossierHuidigInkomen:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierHuidigInkomen'\n description: Huidig Inkomen\n nullable: true\n readOnly: true\n dossierNummer:\n maxLength: 15\n type: string\n description: DossierNummer\n nullable: true\n example: 2022.09.07.0019\n dossierType:\n $ref: '#/components/schemas/RegistrationDossierTypeWaarden'\n statusCode:\n $ref: '#/components/schemas/DossierStatusCodeWaarden'\n woningVoorkeuren:\n $ref: '#/components/schemas/DossierDienstDossierVoorkeuren'\n inschrijving:\n $ref: '#/components/schemas/DossierDienstDossierInschrijving'\n schrapping:\n $ref: '#/components/schemas/DossierDienstDossierSchrapping'\n woningNood:\n $ref: '#/components/schemas/DossierDienstDossierWoningNood'\n woonsituaties:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierWoonsituatie'\n description: Lijst van woonsituaties voor het dossier\n nullable: true\n readOnly: true\n versieNummer:\n type: integer\n description: Versie nummer van dit dossier\n format: int32\n example: 3\n mogelijkeActies:\n type: array\n items:\n $ref: '#/components/schemas/DossierActieCodeWaarden'\n description: mogelijke acties op het dossier\n nullable: true\n inkomenVoorwaardeStatusCode:\n $ref: '#/components/schemas/InkomenVoorwaardeStatusCodeWaarden'\n eigendomVoorwaardeStatusCode:\n $ref: '#/components/schemas/EigendomVoorwaardeStatusCodeWaarden'\n tijdstipLaatsteHandeling:\n type: string\n description: >-\n Tijdstip waarop het dossier het laatste werd behandeld door\n Kandidaat-huurder, Woonmaatschappij of automatische actie uit het\n CIR.\n format: date-time\n nullable: true\n volmachtWijzigingen:\n $ref: '#/components/schemas/RegistratieVolmachtWijzigingenCodeWaarden'\n additionalProperties: false\n description: Description\n nullable: true\n DossierDienstDossierStatusHistoriek:\n type: object\n properties:\n statusCodeVan:\n $ref: '#/components/schemas/DossierStatusCodeWaarden'\n statusCodeTot:\n $ref: '#/components/schemas/DossierStatusCodeWaarden'\n actie:\n $ref: '#/components/schemas/DossierActieWaarden'\n statusDatum:\n type: string\n description: Datum waarop de status van het dossier wijzigde\n format: date-time\n nullable: true\n example: '2022-10-01T09:45:00.000+02:00'\n partijCode:\n maxLength: 15\n type: string\n description: >-\n KBO nummer of CIR code van de partij die betrokken is bij het\n dossier.\n nullable: true\n commentaar:\n type: string\n description: Notificatie voor gebruiker\n nullable: true\n additionalProperties: false\n description: Historiek van satuswijzigingen\n nullable: true\n DossierDienstDossierInkomstenSamenvattingen:\n type: object\n properties:\n totaalInkomsten:\n type: number\n description: Som van alle inkomsten\n format: double\n nullable: true\n totaalInkomstenGeindexeerd:\n type: number\n description: Geïndexeeerde som van alle inkomsten\n format: double\n nullable: true\n dossierInkomstenSamenvattingen:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierInkomstenSamenvatting'\n description: Inkomsten Samenvattingen\n nullable: true\n readOnly: true\n additionalProperties: false\n nullable: true\n DossierDienstDossierPersoon:\n type: object\n properties:\n contactTypeCode:\n $ref: '#/components/schemas/ContactTypeCodeWaarden'\n contactAardCode:\n $ref: '#/components/schemas/ContactAardCodeWaarden'\n geboorteDatum:\n type: string\n description: Geboortedatum\n format: date-time\n nullable: true\n rijksregisternummer:\n maxLength: 15\n type: string\n description: Rijksregisternummer\n nullable: true\n voorNaam:\n maxLength: 48\n type: string\n description: Voornaam van contact/gezinslid\n nullable: true\n example: Marc\n naam:\n maxLength: 128\n type: string\n description: Achternaam van het contact/gezinslid\n nullable: true\n example: Molenbergs\n genderCode:\n $ref: '#/components/schemas/GenderCodeWaarden'\n burgelijkeStaatCode:\n $ref: '#/components/schemas/BurgelijkeStaatCodeWaarden'\n mantelzorgGeefCode:\n $ref: '#/components/schemas/MantelzorgCodeWaarden'\n mantelzorgGeefPostcode:\n maxLength: 15\n type: string\n description: >-\n Dit is de postcode van de gemeenten van de derde die mantzorg geeft\n van het gezinslid.\n nullable: true\n mantelzorgKrijgCode:\n $ref: '#/components/schemas/MantelzorgCodeWaarden'\n mantelzorgKrijgPostcode:\n maxLength: 15\n type: string\n description: >-\n Dit is de postcode van de gemeenten van de derde die mantzorg krijgt\n van het gezinslid.\n nullable: true\n taalkennisCode:\n $ref: '#/components/schemas/TaalkennisCodeWaarden'\n taalkennisSneltestCode:\n $ref: '#/components/schemas/TaalkennisSneltestCodeWaarden'\n email:\n maxLength: 50\n type: string\n description: E-mailadres van het contact/gezinslid\n nullable: true\n example: Marc.Molenbergs@hotmail.be\n telefoon1:\n maxLength: 15\n type: string\n description: Telefoonnummer van het contact/gezinslid\n nullable: true\n example: 015/43 43 43\n telefoon2:\n maxLength: 15\n type: string\n description: Telefoonnummer van het contact/gezinslid\n nullable: true\n example: 0477 / 43 43 43\n adressen:\n $ref: '#/components/schemas/DossierDienstDossierPersoonAdressen'\n beperkingMutualiteitErkenningCode:\n $ref: '#/components/schemas/BeperkingMutualiteitErkenningCodeWaarden'\n verblijfsAdresCode:\n $ref: '#/components/schemas/VerblijfsAdresCodeWaarden'\n contactInvaliditeitCode:\n $ref: '#/components/schemas/ContactInvaliditeitCodeWaarden'\n werkzaamheidGeschiedenisCode:\n $ref: '#/components/schemas/WerkzaamheidGeschiedenisCodeWaarden'\n contactSubTypeCode:\n $ref: '#/components/schemas/ContactSubTypeCodeWaarden'\n contactAantalKinderenCode:\n $ref: '#/components/schemas/ContactAantalKinderenCodeWaarden'\n contactPersoonTenLaste:\n $ref: '#/components/schemas/RegistratieContactPersoonTenLaste'\n contactErkenningAfhankelijk:\n type: array\n items:\n $ref: '#/components/schemas/RegistratieContactErkenningAfhankelijk'\n description: Geeft aan of de financiële afhankelijkheid erkend is\n nullable: true\n example:\n - LLFP\n - BLIND\n - ULAM\n - ULPA\n registratieContactErkenningInformatieVoorKind:\n type: string\n description: Bijkomende info uit ksz rond handicap\n nullable: true\n registratieContactErkenningInformatieVoorVolwassenen:\n type: string\n description: Bijkomende info uit ksz rond handicap\n nullable: true\n bewindvoerderCode:\n $ref: '#/components/schemas/RegistratieContactBewindvoerderCode'\n bewindvoerderRijksregisternummer:\n maxLength: 15\n type: string\n description: Rijksregisternummer van bewindvoerder (indien bekend)\n nullable: true\n example: '2209280001'\n verbondenAanVennootschap:\n $ref: '#/components/schemas/RegistratieContactVerbondenAanVennootschap'\n additionalProperties: false\n nullable: true\n DossierDienstDossierVoorkeurLocatie:\n type: object\n properties:\n gemeenteNisCode:\n maxLength: 15\n type: string\n description: >-\n Geeft de NIScode van de gemeente weer, waar de Kandidaat-huurder wil\n wonen.\n nullable: true\n example: '41002'\n wijken:\n maxLength: 3000\n type: string\n description: >-\n Geeft de wijk van de gemeente/deelgemeenten weer, waar de\n Kandidaat-huurder wil wonen.\n nullable: true\n example: Ajoin Koté,Amylum Waik\n sorteerIndex:\n type: integer\n description: Sortering van de vragen\n format: int32\n nullable: true\n additionalProperties: false\n nullable: true\n DossierDienstDossierOptioneleVoorkeur:\n type: object\n properties:\n partijCode:\n maxLength: 15\n type: string\n description: >-\n KBO nummer of CIR code van de partij die betrokken is bij het\n dossier.\n nullable: true\n example: '5025'\n optioneleVoorkeurVraagCode:\n $ref: '#/components/schemas/OptioneleVoorkeurVraagCodeWaarden'\n optioneleVoorkeurAntwoordCode:\n maxLength: 5\n type: string\n description: Geeft het antwoord op de optionele voorkeurvragen\n nullable: true\n example: 'YES'\n additionalProperties: false\n nullable: true\n DossierDienstDossierEigendom:\n type: object\n properties:\n rijksregisternummer:\n maxLength: 15\n type: string\n description: Rijksregisternummer gekoppeld aan een eigendom.\n nullable: true\n eigendomTypeCode:\n $ref: '#/components/schemas/EigendomTypeCodeWaarden'\n eigendomAardCode:\n $ref: '#/components/schemas/EigendomAardCodeWaarden'\n waarde:\n maxLength: 15\n type: string\n description: Het percentage van de woning die de persoon bezit.\n nullable: true\n perceelID:\n maxLength: 50\n type: string\n description: Perceel identificatie\n nullable: true\n justificatie:\n type: string\n description: Opmerking van KH bij een gekende eigendom\n nullable: true\n justificatieDeclaratie:\n type: string\n description: Opmerking van KH bij het aangeven van een eigendom\n nullable: true\n straat:\n maxLength: 100\n type: string\n description: Straatnaam van het onroerend goed\n nullable: true\n huisNummer:\n maxLength: 12\n type: string\n description: Huisnummer van het onroerend goed\n nullable: true\n gemeente:\n maxLength: 100\n type: string\n description: Gemeente waarin het onroerend goed zich bevindt\n nullable: true\n postCode:\n maxLength: 15\n type: string\n description: Postcode van de gemeente waarin het onroerend ged zich bevindt\n nullable: true\n gemeenteNisCode:\n maxLength: 15\n type: string\n description: Niscode van de gemeente waarin het onroerend ged zich bevindt\n nullable: true\n landCode:\n maxLength: 5\n type: string\n description: Code van het land waar het onroerend ged zich bevindt\n nullable: true\n additionalProperties: false\n nullable: true\n DossierDienstDossierDomiciliePeriode:\n type: object\n properties:\n landCode:\n maxLength: 5\n type: string\n description: Code van het land waar het gezinslid verbleef\n nullable: true\n rijksregisternummer:\n maxLength: 15\n type: string\n description: Rijksregisternummer gekoppeld aan een dossier.\n nullable: true\n example: '2209280001'\n postCode:\n maxLength: 15\n type: string\n description: Postcode van het adress waar het gezinslid verbleef.\n nullable: true\n gemeente:\n maxLength: 100\n type: string\n description: Gemeente het gezinslid verbleef.\n nullable: true\n gemeenteNisCode:\n maxLength: 15\n type: string\n description: Niscode van de gemeente waar het gezinslid verbleef\n nullable: true\n straat:\n maxLength: 50\n type: string\n description: Straat het gezinslid verbleef.\n nullable: true\n huisNummer:\n maxLength: 15\n type: string\n description: Huisnummer van de woning waarin het gezinslid verbleef.\n nullable: true\n huisNummerBus:\n maxLength: 5\n type: string\n description: Busnummer van de woning waarin het gezinslid verbleef\n nullable: true\n beginDatum:\n type: string\n description: Begindatum vanaf wanneer het gezinslid in de woning verbleef\n format: date-time\n example: '2022-09-25'\n eindDatum:\n type: string\n description: \"Einddatum tot wanneer het geznslid in de woning verbleef\\r\\nEinddatum tot wanneer het geznslid in de woning verbleef\"\n format: date-time\n nullable: true\n example: '2022-09-28'\n additionalProperties: false\n nullable: true\n DossierDienstDossierBijlage:\n type: object\n properties:\n bestandNaam:\n maxLength: 225\n type: string\n description: Naam van het bestand\n nullable: true\n bestandGrootte:\n type: integer\n description: Grootte van het bestand\n format: int32\n nullable: true\n bestandExtensieCode:\n $ref: '#/components/schemas/BestandExtensieCodeWaarden'\n identificatie:\n maxLength: 225\n type: string\n description: Identificatie naam van de bijlage\n nullable: true\n indentificatieRijksregisternummer:\n maxLength: 15\n type: string\n description: RRN van persoon die het bestand opgeladen heeft\n nullable: true\n identificatieBestandCode:\n $ref: '#/components/schemas/IdentificatieBestandCodeWaarden'\n identificatieBestandIndex:\n type: integer\n format: int32\n bestand:\n type: string\n description: Het effectieve bestand zelf\n nullable: true\n opmerking:\n type: string\n description: Opmerkingen die bij het bestand kunnen worden toegevoed\\\n nullable: true\n bijlageDatum:\n type: string\n description: Datum waarop de bijlage werd toegevoegd\n format: date-time\n aanvaardingBijlageCode:\n $ref: '#/components/schemas/AanvaardingBijlageCodeWaarden'\n additionalProperties: false\n nullable: true\n DossierDienstDossierPartij:\n type: object\n properties:\n partijTypeCode:\n $ref: '#/components/schemas/DossierPartijTypeCodeWaarden'\n partijRolCode:\n $ref: '#/components/schemas/DossierPartijRolCodeWaarden'\n partijIdentificatie:\n type: string\n description: >-\n Ondernemingsnummer van de woonmaatschappij, rijksregisternummer voor\n kandidaat-huurder.\n nullable: true\n postCode:\n maxLength: 15\n type: string\n description: Hoofdzetel van de woonmaatschappij.\n nullable: true\n example: '2830'\n gemeente:\n maxLength: 100\n type: string\n description: Gemeente van de hoofdzetel van de woonmaatschappij\n nullable: true\n example: Willebroek\n gemeenteNisCode:\n maxLength: 15\n type: string\n description: Niscode van de gemeente van de betrokken partij\n nullable: true\n straat:\n maxLength: 100\n type: string\n description: Straat van de hoofdzetel van de woonmaatschappij.\n nullable: true\n example: Bos\n huisNummer:\n maxLength: 12\n type: string\n description: Nummer van de hoofdzetel van de woonmaatschappij.\n nullable: true\n example: '502'\n huisNummerBus:\n maxLength: 10\n type: string\n description: Busnummer van de hoofdzetel van de woonmaatschappij.\n nullable: true\n example: X\n additionalProperties: false\n description: Alle betrokken partijen(primaire/secundaire verhuurders)\n nullable: true\n DossierDienstDossierBewindvoerder:\n type: object\n properties:\n rijksregisternummer:\n maxLength: 15\n type: string\n description: Rijksregisternummer van bewindgevoerde\n nullable: true\n example: '2209280001'\n voorNaam:\n maxLength: 48\n type: string\n description: Voornaam van bewindvoerder\n nullable: true\n example: Marc\n naam:\n maxLength: 128\n type: string\n description: Achternaam van bewindvoerder\n nullable: true\n example: Molenbergs\n email:\n maxLength: 50\n type: string\n description: E-mailadres van bewindvoerder\n nullable: true\n example: Marc.Molenbergs@hotmail.be\n telefoon1:\n maxLength: 15\n type: string\n description: Telefoonnummer van bewindvoerder\n nullable: true\n example: 015/43 43 43\n telefoon2:\n maxLength: 15\n type: string\n description: Telefoonnummer van bewindvoerder\n nullable: true\n example: 0477 / 43 43 43\n postCode:\n maxLength: 15\n type: string\n description: Postcode van de domicilie van bewindvoerder\n nullable: true\n example: '2830'\n gemeente:\n maxLength: 100\n type: string\n description: Naam van de gemeente van bewindvoerder\n nullable: true\n example: Willebroek\n gemeenteNisCode:\n maxLength: 15\n type: string\n description: Niscode\n nullable: true\n example: 41002A\n landCode:\n maxLength: 5\n type: string\n nullable: true\n straat:\n maxLength: 100\n type: string\n description: Straat van bewindvoerder\n nullable: true\n example: Bos\n huisNummer:\n maxLength: 12\n type: string\n description: Huisnummer van bewindvoerder\n nullable: true\n example: '502'\n huisNummerBus:\n maxLength: 10\n type: string\n description: Bus nr van bewindvoerder\n nullable: true\n example: X\n additionalProperties: false\n nullable: true\n DossierDienstOudDossier:\n type: object\n properties:\n oudDossierNummer:\n maxLength: 250\n type: string\n nullable: true\n example: '2022.03.25.0001 '\n partijCode:\n maxLength: 15\n type: string\n description: >-\n KBO nummer of CIR code van de partij die betrokken is bij het\n dossier.\n nullable: true\n example: '3343'\n additionalProperties: false\n nullable: true\n DossierDienstDossierComment:\n type: object\n properties:\n aanvaardingTypeCode:\n $ref: '#/components/schemas/AanvaardingDossierTypeCode'\n aanvaardingCode:\n $ref: '#/components/schemas/AanvaardingDossierCode'\n opmerking:\n type: string\n description: opmerking aanvaarding\n nullable: true\n additionalProperties: false\n nullable: true\n DossierDienstDossierZwarteLijst:\n type: object\n properties:\n partijIdentificatie:\n maxLength: 15\n type: string\n description: Rijksregisternummer van kandidaat-hurder/ gezinslid\n nullable: true\n reden:\n $ref: '#/components/schemas/ZwarteLijstRedenCodeWaarden'\n datum:\n type: string\n description: Datum waarop de persoon op de zwarte lijst werd gezet\n format: date-time\n nullable: true\n additionalProperties: false\n nullable: true\n DossierDienstDossierPand:\n type: object\n allOf:\n - $ref: '#/components/schemas/DossierDienstDossierPandUpdate'\n properties:\n pandAanbiedingStatus:\n $ref: '#/components/schemas/DossierPandAanbiedingStatusCodeWaarden'\n partijCode:\n type: string\n description: >-\n KBO nummer of CIR code van de partij die betrokken is bij het\n dossier.\n nullable: true\n example: '1234'\n aanbiedingsDatum:\n type: string\n description: Datum van aanmaak van de aanbieding\n format: date-time\n nullable: true\n statusDatum:\n type: string\n description: Datum (laatste) status wijziging\n format: date-time\n nullable: true\n additionalProperties: false\n nullable: true\n DossierDienstDossierHuidigInkomen:\n type: object\n properties:\n rijksregisternummer:\n maxLength: 15\n type: string\n description: Rijksregisternummer gekoppeld aan een dossier.\n nullable: true\n authentiekebron:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierIncomeAuthentiekebron'\n nullable: true\n gewerktLaatste6Maand:\n type: string\n description: >-\n Geeft per maand aan of de kandidaat-huurder werkte of niet (t= heeft\n gewerkt, f= heeft niet gewerkt).\n nullable: true\n example: T;F;T;F;T;F\n schuldenregeling:\n $ref: '#/components/schemas/SchuldenregelingCodeWaarden'\n onderhoudsgelden:\n $ref: '#/components/schemas/OnderhoudsgeldenCodeWaarden'\n additionalProperties: false\n nullable: true\n GenderCodeWaarden:\n enum:\n - MAN\n - VROUW\n - X\n type: string\n description: >-\n Gender Code (GNDR)

Members:

MAN-Mannelijk
VROUW-Vrouwelijk
X-Onbekend

\n nullable: true\n DossierDienstDossierVoorkeuren:\n type: object\n properties:\n maximaalHuurBedrag:\n type: integer\n description: Maximale huurbedrag die de kandidaathuurder wenst te betalen\n format: int32\n nullable: true\n maximaalHuurLast:\n type: integer\n description: Maximale huurlast die de kandidaathuurder wenst te betalen\n format: int32\n nullable: true\n example: 500\n minimumAantalKamers:\n type: integer\n description: Het minimaal aantal kamers die het gezin wenst\n format: int32\n nullable: true\n example: 2\n maximumAantalKamers:\n type: integer\n description: Het maximaal aantal kamers die het gezin wenst\n format: int32\n nullable: true\n example: 3\n woningTypeCode:\n type: array\n items:\n $ref: '#/components/schemas/WoningTypeCodeWaarden'\n description: Type van de woning die het gezin wenst\n nullable: true\n example:\n - H\n lichamelijkeBeperkingCode:\n $ref: '#/components/schemas/LichamelijkeBeperkingCodeWaarden'\n additionalProperties: false\n description: Woning voorkeuren voor het dossier\n nullable: true\n DossierDienstDossierInschrijving:\n type: object\n properties:\n hulpCode:\n $ref: '#/components/schemas/InschrijfhulpCodeWaarden'\n hulpInformerenCode:\n $ref: '#/components/schemas/InschrijfhulpInformerenCodeWaarden'\n hulpNaam:\n type: string\n description: Naam van organisatie die KH hielp inschrijven\n nullable: true\n hulpEmail:\n maxLength: 50\n type: string\n description: Email adress van inschrijfhulp\n nullable: true\n example: een.goed.mens@live.be\n datum:\n type: string\n description: Eerste indieningsdatum van het dossier\n format: date-time\n nullable: true\n additionalProperties: false\n description: Inschrijvings data van het dossier\n nullable: true\n DossierDienstDossierSchrapping:\n type: object\n properties:\n datum:\n type: string\n description: Datum van schrapping van het dossier\n format: date-time\n nullable: true\n redenCode:\n $ref: '#/components/schemas/SchrappingRedenCodeWaarden'\n additionalProperties: false\n description: Schrapping informatie binnen het dossier\n nullable: true\n DossierDienstDossierWoningNood:\n type: object\n properties:\n redenCode:\n $ref: '#/components/schemas/WoningnoodRedenEnumCode'\n omschrijving:\n type: string\n description: Woningnood reden omschrijving\n nullable: true\n indentificatie:\n type: string\n description: Identificatie van de woonnood\n nullable: true\n additionalProperties: false\n description: Woningnood voor het dossier\n nullable: true\n DossierActieCodeWaarden:\n enum:\n - OFFER\n - CCL\n - OBJCT\n - REQI\n - REF\n - RJCT\n - WAIT\n - WAKE\n - VOL\n - ACC\n - APP\n - ARCH\n - FRAUD\n - DEC\n - NCOMP\n - NORES\n - OVRVW\n - REG\n - RSPND\n - SAVE\n - UNDO\n - ACTUA\n - MIGRA\n - NOACT\n - CCLGW\n - NOCOMP\n - CONF\n - UNDNR\n - UNDRF\n - OND\n type: string\n description: >-\n nvarchar(5)

Members:

OFFER-Aanbod Maken
CCL-Annuleren
OBJCT-Annuleren
REQI-Bijkomende informatie vragen
REF-Weigeren
RJCT-Afwijzen
WAIT-In wacht zetten
WAKE-Uit wacht halen\n
VOL-vrijwillig vertrekken
ACC-Aanbod\n geaccepteerd
APP-Van toepassing zijn
ARCH-Archief
FRAUD-frauduleus
DEC-Overleden
NCOMP-Niet-conform
NORES-Geen antwoord
OVRVW-Overzicht
REG-Register
RSPND-Antwoorden
SAVE-Opslaan
UNDO-Ga terug naar de vorige\n echte staat
ACTUA-Actualisatie
MIGRA-Via de actualisatie zijn wijzigingen aangebracht
NOACT-Actie na 2 jaar inactiviteit
CCLGW-Gegronde weigering door kandidaat-huurder na aanbod\n
NOCOMP-Schrapping door niet voldoen\n inschrijvingsvoorwaarde
CONF-Bevestigen van dossier na\n migratie
UNDNR-Ongedaan maken van vroegere niet\n reactie
UNDRF-Ongedaan maken van vroegere weigering\n
OND-Schrapping door ontdubbeling

\n nullable: true\n InkomenVoorwaardeStatusCodeWaarden:\n enum:\n - EI\n - MCN\n - OK\n type: string\n description: >-\n Resultaat van de automatische\n controle

Members:

EI-Er is extra informatie nodig\n
MCN-Er kan momenteel geen controle uitgevoerd worden\n
OK-U Voldoet

\n nullable: true\n EigendomVoorwaardeStatusCodeWaarden:\n enum:\n - MCN\n - OK\n type: string\n description: >-\n Resultaat van de automatische\n controle

Members:

MCN-Er kan momenteel geen controle\n uitgevoerd worden
OK-U Voldoet

\n nullable: true\n RegistratieVolmachtWijzigingenCodeWaarden:\n enum:\n - 'NO'\n - 'YES'\n - 'UNK'\n type: string\n description: >-\n

Members:

NO-Primaire woonmaatschappij mag geen aanpassingen doen op vraag van de KH.
YES-Primaire woonmaatschappij mag aanpassingen doen op vraag van de KH.
UNK-Onbekend

\n nullable: true\n DossierActieWaarden:\n enum:\n - OFFER\n - CCL\n - OBJCT\n - REQI\n - REF\n - RJCT\n - WAIT\n - WAKE\n - VOL\n - ACC\n - APP\n - ARCH\n - FRAUD\n - DEC\n - NCOMP\n - NORES\n - OVRVW\n - REG\n - RSPND\n - SAVE\n - UNDO\n - ACTUA\n - MIGRA\n - NOACT\n - CCLGW\n - NOCOMP\n - CONF\n - UNDNR\n - UNDRF\n - OND\n type: string\n description: >-\n

Members:

OFFER-Aanbod Maken
CCL-Annuleren
OBJCT-Annuleren
REQI-Bijkomende informatie vragen
REF-Weigeren
RJCT-Afwijzen
WAIT-In wacht zetten
WAKE-Uit wacht halen\n
VOL-vrijwillig vertrekken
ACC-Aanbod\n geaccepteerd
APP-Van toepassing zijn
ARCH-Archief
FRAUD-frauduleus
DEC-Overleden
NCOMP-Niet-conform
NORES-Geen antwoord
OVRVW-Overzicht
REG-Register
RSPND-Antwoorden
SAVE-Opslaan
UNDO-Ga terug naar de vorige\n echte staat
ACTUA-Actualisatie
MIGRA-Via de actualisatie zijn wijzigingen aangebracht
NOACT-Actie na 2 jaar inactiviteit
CCLGW-Gegronde weigering door kandidaat-huurder na aanbod\n
NOCOMP-Schrapping door niet voldoen\n inschrijvingsvoorwaarde
CONF-Bevestigen van dossier na\n migratie
UNDNR-Ongedaan maken van vroegere niet\n reactie
UNDRF-Ongedaan maken van vroegere weigering\n
OND-Schrapping door ontdubbeling

\n nullable: true\n DossierDienstDossierInkomstenSamenvatting:\n type: object\n properties:\n inkomstenJaar:\n type: string\n description: Jaar van het referentie-inkomen\n nullable: true\n example: '2022'\n belastbaarInkomenAanwezigheidCode:\n $ref: '#/components/schemas/BelastbaarInkomenAanwezigheidCodeWaarden'\n belastbaarInkomenJaarTotaal:\n type: number\n description: >-\n Geeft aan hoeveel het totale belastbare inkomen bedraagt op\n jaarbasis.\n format: double\n nullable: true\n example: 12345\n leefLoonAanwezigheidCode:\n $ref: '#/components/schemas/LeefLoonAanwezigheidCodeWaarden'\n leefLoonJaarTotaal:\n type: number\n description: Geeft aan hoeveel het totale leefloon bedraagt op jaarbasis.\n format: double\n nullable: true\n example: 12345\n inkomensVervangendeTegemoetkomingCode:\n $ref: '#/components/schemas/InkomensVervangendeTegemoetkomingCodeWaarden'\n inkomensVervangendeTegemoetkomingJaarTotaal:\n type: number\n description: >-\n Dit is de intensiteit/aard van verblijf dat het gezinslid zal hebben\n in de sociale woning.\n format: double\n nullable: true\n example: 12345\n inkomensPensioenJaarTotaal:\n type: number\n description: Geeft aan hoeveel pensioen het gezinslid krijgt\n format: double\n nullable: true\n example: 12345\n extraBeroepsBuitenlandInkomstenJaarTotaal:\n type: number\n description: Geeft het niet geïndexeerde bedrag van het buitenlandsinkomen\n format: double\n nullable: true\n extraBeroepsInstellingenInkomenstenJaarTotaal:\n type: number\n description: >-\n Geeft het niet-geïndexeerde inkomensbedrag uit Europese of\n internationale instellingen\n format: double\n nullable: true\n rijksregisternummer:\n maxLength: 15\n type: string\n description: Rijksregisternummer gekoppeld aan een dossier.\n nullable: true\n additionalProperties: false\n nullable: true\n ContactTypeCodeWaarden:\n enum:\n - _1\n - _2\n - _3\n - _4\n - _5\n - _6\n - _7\n - _8\n - _9\n - _10\n - _11\n - _12\n - _13\n - _14\n - _15\n - _16\n - _17\n - _20\n - _21\n - _22\n - _23\n - _50\n - _51\n - _0\n type: string\n description: >-\n Contact Type Code\n (RCTPL)

Members:

_1-Referentiepersoon
_2-Echtgenoot, Echtgenote
_3-Zoon, Dochter\n
_4-Schoonzoon, Schoondochter
_5-Kleinzoon, Kleindochter
_6-Vader, Moeder\n
_7-Schoonvader, Schoonmoeder
_8-Grootvader, Grootmoeder
_9-Broer, Zuster\n
_10-Schoonbroer, Schoonzuster
_11-Verwant, Verwante
_12-Zonder\n familieverband
_13-Stiefzoon, Stiefdochter
_14-Achterkleinzoon, Achterkleindochter
_15-Tante, Oom
_16-Nicht, Neef\n (verwantschap: 3de graad)
_17-Nicht, Neef\n (verwantschap: 4de graad)
_20-Gemeenschappen, tehuizen\n
_21-Partner
_22-Wettelijk\n samenwonende
_23-Meemoederschap
_50-SamenwonendePartner
_51-Samenwonend\n
_0-Onbekend

\n nullable: true\n ContactAardCodeWaarden:\n enum:\n - DOM\n - COP\n - VRO\n - OTH\n - SDD\n type: string\n description: >-\n Contact Aard Code\n (RCRT)

Members:

DOM-Inwonend(domicilie)
COP-Co-ouderschap
VRO-Bezoekrecht met\n overnachting
OTH-Ander soort duurzaam verblijf
SDD-Kind gedomicilieerd in buitenland

\n nullable: true\n BurgelijkeStaatCodeWaarden:\n enum:\n - _10\n - _20\n - _25\n - _26\n - _30\n - _40\n - _41\n - _50\n - _51\n - _60\n - _80\n - _81\n - _90\n - _95\n - _96\n - _97\n - _98\n type: string\n description: >-\n Burgelijke Staat

Members:

_10-Ongehuwd
_20-Gehuwd
_25-Nietigverklaring van het\n huwelijk
_26-Putatief huwelijk
_30-Weduwenaar
_40-Echtgescheiden
_41-Echtscheiding uitgesproken met toepassing van de wet van\n 30 juni 1994
_50-Scheiding van tafel en bed en van\n goederen
_51-Scheiding van tafel en bed en van\n goederen uitgesproken met toepassing van de wet van 30 juni 1994
_60-Ontbinding van het huwelijk op een bijzondere wijze
_80-Partnerschap
_81-Beëindiging\n partnerschap
_90-Onbepaald
_95-Op\n verklaring zonder bewijs - Ongehuwd
_96-Op verklaring\n zonder bewijs - Gehuwd
_97-Op verklaring zonder bewijs\n – Gescheiden
_98-Op verklaring zonder bewijs – Weduwe\n (naar)

\n nullable: true\n MantelzorgCodeWaarden:\n enum:\n - 'NO'\n - CARER\n - CAREG\n type: string\n description: >-\n Mantelzorg Code (CARE)

Members:

NO-Geen Manterzorg\n
CARER-Krijgt mantelzorg
CAREG-Geeft\n mantelzorg

\n nullable: true\n TaalkennisCodeWaarden:\n enum:\n - NA\n - 'NO'\n - 'YES'\n type: string\n description: >-\n Resultaat van authentieke\n bron

Members:

NA-Taalkennis kan niet gecontroleerd\n worden
NO-Taalkennis niet in orde
YES-Taalkennis in orde

\n nullable: true\n TaalkennisSneltestCodeWaarden:\n enum:\n - 'NO'\n - 'YES'\n type: string\n description: >-\n

Members:

NO-Taalkennis niet in orde
YES-Taalkennis in orde

\n nullable: true\n DossierDienstDossierPersoonAdressen:\n type: object\n properties:\n contactVoorkeurCode:\n $ref: '#/components/schemas/ContactVoorkeurCodeWaarden'\n domicilie:\n $ref: '#/components/schemas/DossierDienstDossierPersoonAdresDomicilie'\n verblijf:\n $ref: '#/components/schemas/DossierDienstDossierPersoonAdresVerblijf'\n contact:\n $ref: '#/components/schemas/DossierDienstDossierPersoonAdresContact'\n additionalProperties: false\n nullable: true\n BeperkingMutualiteitErkenningCodeWaarden:\n enum:\n - 'NO'\n - 'YES'\n type: string\n description: >-\n Beperking Mutualiteit Erkenning Code\n (RRBM)

Members:

NO-Geen beperking erkend door\n mutualiteit
YES-Beperking erkend door mutualiteit

\n nullable: true\n VerblijfsAdresCodeWaarden:\n enum:\n - DOM\n - ALT\n type: string\n description: >-\n Verblijfs Adres Code (RADR)

Members:

DOM-Domicilie\n Adress
ALT-Verblijfs Adress

\n nullable: true\n ContactInvaliditeitCodeWaarden:\n enum:\n - NINV\n - INV\n type: string\n description: >-\n Contact Invaliditeit Code (RCNV)

Members:

NINV-Geen\n invaliditeit geregistreerd
INV-Invalidateit gekend en\n geregistreerd

\n nullable: true\n WerkzaamheidGeschiedenisCodeWaarden:\n enum:\n - Y6M\n - N6M\n - NA\n type: string\n description: >-\n Werkzaamheid Geschiedenis Code\n (RCLH)

Members:

Y6M-Heeft de afgelopen 6 maanden\n gewerkt
N6M-Heeft de afgelopen 6 maanden niet gewerkt\n
NA-Niet ingevuld

\n nullable: true\n ContactSubTypeCodeWaarden:\n enum:\n - PRGA\n - PRT\n - REU\n - SOJ\n type: string\n description: >-\n Contact Sub Type Code\n (RCSU)

Members:

PRGA-Zwangerschap / Adoptie
PRT-Partner
REU-Familie hereniging
SOJ-Sojourner

\n nullable: true\n ContactAantalKinderenCodeWaarden:\n enum:\n - ONE\n - TWO\n - THRIM\n type: string\n description: >-\n Contact Aantal Kinderen Code (RCNC)

Members:

ONE-Een\n
TWO-Twee
THRIM-Drie of meer

\n nullable: true\n RegistratieContactPersoonTenLaste:\n enum:\n - DEP\n - DDEP\n type: string\n description: >-\n

Members:

DEP-Ten laste
DDEP-Dubbel ten laste

\n nullable: true\n RegistratieContactErkenningAfhankelijk:\n enum:\n - LLFP\n - BLIND\n - ULAM\n - ULPA\n type: string\n description: >-\n

Members:

LLFP-Onderste ledenmaten vijftig percent\n
BLIND-Volledige blindheid
ULAM-Bovenste ledenmaten geamputeerd
ULPA-upper limbs paralysed

\n nullable: true\n RegistratieContactBewindvoerderCode:\n enum:\n - 'YES'\n - UNK\n type: string\n description: >-\n

Members:

YES-Onder bewindvoering
UNK-Niet gekend

\n nullable: true\n RegistratieContactVerbondenAanVennootschap:\n enum:\n - 'NO'\n - 'YES'\n - UNK\n type: string\n description: >-\n

Members:

NO-Kandidaat-huurder is niet verbonden aan\n een vennootschap
YES-Kandidaat-huurder is verbonden\n aan een vennootschap
UNK-Onbekend

\n nullable: true\n OptioneleVoorkeurVraagCodeWaarden:\n enum:\n - OPHV\n - OPST\n - OPKO\n - OPLT\n - OPTR\n - OPDN\n - OPWM\n type: string\n description: >-\n

Members:

OPHV-Hoogste verdieping waar je wilt\n wonen?
OPST-Zijn traptreden in het gebouw of de woning\n een probleem?
OPKO-Heb je een kamer op overschot\n nodig?
OPLT-Heb je een lift nodig?
OPTR-Heb je een terras nodig?
OPDN-Heb je\n een douche nodig?
OPWM-Heb je een aansluiting voor een\n wasmachine nodig?

\n nullable: true\n EigendomTypeCodeWaarden:\n enum:\n - BLE\n - BEBW\n - BEEP\n - BEGB\n - BEGK\n - BEOP\n - BEW\n - EP\n - EVG\n - BAT\n - GB\n - GK\n - SOL\n - ONB\n - OP\n - OPEP\n - VE\n - VEBW\n - VEEP\n - VEGB\n - VEGK\n - VEOP\n - VG\n - VGBW\n - VGEP\n - VGGB\n - VGGK\n - VGOP\n - JUST\n type: string\n description: >-\n Eigendom Type (= Recht Aard) Code\n (ROTP)

Members:

BLE-Blote eigendom
BEBW-Blote eigendom bezwaard met een recht van bewoning
BEEP-Blote eigendom bezwaard met een recht van erfpacht\n
BEGB-Blote eigendom bezwaard met een recht van gebruik\n en bewoning
BEGK-Blote eigendom bezwaard met een recht\n van gebruik
BEOP-Blote eigendom bezwaard met een recht\n van opstal
BEW-Bewoning
EP-Erfpacht\n
EVG-Eventueel vruchtgebruik
BAT-Gebouw
GB-Gebruik en bewoning
GK-Gebruik
SOL-Eigenaar grond
ONB-Onbekend recht
OP-Opstal
OPEP-Opstal bezwaard met een recht van erfpacht
VE-Volle eigendom
VEBW-Volle eigendom\n bezwaard met een recht van bewoning
VEEP-Volle\n eigendom bezwaard met een recht van erfpacht
VEGB-Volle eigendom bezwaard met een recht van gebruik en\n bewoning
VEGK-Volle eigendom bezwaard met een recht\n van gebruik
VEOP-Volle eigendom bezwaard met een recht\n van opstal
VG-Vruchtgebruik
VGBW-Vruchtgebruik bezwaard met een recht van bewoning
VGEP-Vruchtgebruik bezwaard met een recht van erfpacht
VGGB-Vruchtgebruik bezwaard met een recht van gebruik en\n bewoning
VGGK-Vruchtgebruik bezwaard met een recht van\n gebruik
VGOP-Vruchtgebruik bezwaard met een recht van\n opstal
JUST-Code voor extra justificatie of\n justificatiedeclaratie

\n nullable: true\n EigendomAardCodeWaarden:\n enum:\n - APP\n - TERRB\n - HOME\n - CONS\n - HAYF\n - MEAD\n - TRADH\n - HOTEL\n - STD\n - RM\n type: string\n description: >-\n Eigendom Aard Code (ROKD)

Members:

APP-Appartement\n
TERRB-Bouwgrond
HOME-Huis
CONS-Bouwland
HAYF-Hooiland
MEAD-Weiland
TRADH-Handelshuis
HOTEL-Hotel
STD-Studio
RM-Kamer

\n nullable: true\n BestandExtensieCodeWaarden:\n enum:\n - JPG\n - JPEG\n - TIF\n - TIFF\n - PDF\n - PNG\n - GIF\n type: string\n description: >-\n

Members:

JPG-Jpeg
JPEG-Jpeg
TIF-Tagged Image File Format
TIFF-Tagged\n Image File Format
PDF-Acrobat Reader
PNG-Portable Network Graphic
GIF-Afbeelding\n

\n nullable: true\n IdentificatieBestandCodeWaarden:\n enum:\n - DM\n - CCTS\n - CCPD\n - CFR\n - CPA\n - INCA\n - INCE\n - INCPS\n - INCYB\n - INCYM\n - INCNB\n - INCNM\n - PRF\n - OWN\n - REJUU\n - REJUS\n - HONE\n - CRCV\n - CGIV\n - PROXY\n type: string\n description: >-\n Identificatie Bestand Code

Members:

DM-Bijlage rond\n arbeidsongeschiktheid (wederzijds)
CCTS-Bijlage rond\n type verblijf
CCPD-Bijlage rond lichamelijke of\n geestelijke handicap
CFR-Bijlage rond geplande\n gezinshereniging
CPA-Bijlage rond zwangerschaps- of\n adoptieprocedure
INCA-Bijlage rond vrijgestelde\n beroepsinkomsten uit het buitenland
INCE-Bijlage rond\n vrijgestelde beroepsinkomsten verworven bij Europese of internationale\n instellingen
INCPS-Tot 3 bijlages voor opeenvolgende\n loonstroken van de afgelopen 6 maanden
INCYB-Bijlage\n rond collectieve schuldenregeling, budgetbegeleiding of budgetbeheer\n
INCYM-Bijlage rond onderhoudskosten
INCNB-Bijlage rond collectieve schuldenregeling,\n budgetbegeleiding of budgetbeheer
INCNM-Bijlage rond\n onderhoudskosten
PRF-Bijlage rond lichamelijke\n beperking
OWN-Bijlage over eigendomsbestanden
REJUU-Bijlage over additionele eigendommen
REJUS-Bijlage over bestaande eigendommen
HONE-Bijlage over woonsituatie
CRCV-Bijlage\n voor mantelzorg ontvanger
CGIV-Bijlage voor mantelzorg\n gever
PROXY-Bijlage voor volmacht

\n nullable: true\n AanvaardingBijlageCodeWaarden:\n enum:\n - ACC\n - REJ\n - INC\n type: string\n description: >-\n

Members:

ACC-Goedgekeurd
REJ-Afgekeurd
INC-Extra informatie nodig\n

\n nullable: true\n DossierPartijTypeCodeWaarden:\n enum:\n - PP\n - SVK\n - CPA\n - TWN\n - AMC\n - VMSW\n - SHM\n - VWF\n - PROV\n - INMC\n type: string\n description: >-\n

Members:

PP-Private Persoon
SVK-SVK
CPA-OCMW
TWN-Gemeente
AMC-Autonoom Gemeentebedrijf\n
VMSW-VMSW
SHM-SHM
VWF-VWF
PROV-Provincie
INMC-Intercommunale

\n nullable: true\n DossierPartijRolCodeWaarden:\n enum:\n - REQ1\n - REQ2\n - CO\n - SUP\n - S\n - P\n type: string\n description: >-\n

Members:

REQ1-Referentiehuurder1
REQ2-Referentiehuurder2
CO-Medebewoner
SUP-Ondersteunende parij (OCMW…)
S-Secundaire woonmaatschappij
P-Primaire\n woonmaatschappij

\n nullable: true\n AanvaardingDossierTypeCode:\n enum:\n - PCOMP\n - WPREF\n - INCOM\n - PROP\n - PLR2\n - PLR3\n - PLR4\n type: string\n description: >-\n

Members:

PCOMP-PersoonSamenstelling
WPREF-Woningvoorkeuren
INCOM-Inkomsten
PROP-Eigendom
PLR2-Woonnoodpijler2
PLR3-Woonnoodpijler3
PLR4-Woonnoodpijler4\n

\n nullable: true\n AanvaardingDossierCode:\n enum:\n - ACC\n - NCOM\n - FURI\n type: string\n description: >-\n

Members:

ACC-Uitzondering toegekend
NCOM-Uitzondering niet toegekend
FURI-Extra\n informatie nodig

\n nullable: true\n ZwarteLijstRedenCodeWaarden:\n enum:\n - DEF\n - HMNGL\n type: string\n description: >-\n nvarchar(5)

Members:

DEF-Wanbetaling
HMNGL-Huisverwaarlozing

\n nullable: true\n DossierDienstDossierPandUpdate:\n type: object\n properties:\n postCode:\n maxLength: 15\n type: string\n description: Postcode van het aangeboden pand\n nullable: true\n example: '2830'\n gemeente:\n maxLength: 100\n type: string\n description: Naam van de gemeente van het aangeboden pand\n nullable: true\n example: Willebroek\n gemeenteNisCode:\n maxLength: 15\n type: string\n description: Niscode\n nullable: true\n example: 41002A\n straat:\n maxLength: 100\n type: string\n description: Straat van het aangeboden pand\n nullable: true\n example: Bos\n huisNummer:\n maxLength: 12\n type: string\n description: Huisnummer van het aangeboden pand\n nullable: true\n example: '502'\n huisNummerBus:\n maxLength: 10\n type: string\n description: Bus nr van het aangeboden pand\n nullable: true\n example: X\n landNisCode:\n maxLength: 5\n type: string\n description: Land code van het aangeboden pand\n nullable: true\n additionalProperties: false\n nullable: true\n DossierPandAanbiedingStatusCodeWaarden:\n enum:\n - OFFER\n - CCL\n - OBJCT\n - REQI\n - REF\n - RJCT\n - WAIT\n - WAKE\n - VOL\n - ACC\n - APP\n - ARCH\n - FRAUD\n - DEC\n - NCOMP\n - NORES\n - OVRVW\n - REG\n - RSPND\n - SAVE\n - UNDO\n - ACTUA\n - MIGRA\n - NOACT\n - CCLGW\n - NOCOMP\n - CONF\n - UNDNR\n - UNDRF\n - OND\n type: string\n description: >-\n nvarchar(5)

Members:

OFFER-Aanbod Maken
CCL-Annuleren
OBJCT-Annuleren
REQI-Bijkomende informatie vragen
REF-Weigeren
RJCT-Afwijzen
WAIT-In wacht zetten
WAKE-Uit wacht halen\n
VOL-vrijwillig vertrekken
ACC-Aanbod\n geaccepteerd
APP-Van toepassing zijn
ARCH-Archief
FRAUD-frauduleus
DEC-Overleden
NCOMP-Niet-conform
NORES-Geen antwoord
OVRVW-Overzicht
REG-Register
RSPND-Antwoorden
SAVE-Opslaan
UNDO-Ga terug naar de vorige\n echte staat
ACTUA-Actualisatie
MIGRA-Via de actualisatie zijn wijzigingen aangebracht
NOACT-Actie na 2 jaar inactiviteit
CCLGW-Gegronde weigering door kandidaat-huurder na aanbod\n
NOCOMP-Schrapping door niet voldoen\n inschrijvingsvoorwaarde
CONF-Bevestigen van dossier na\n migratie
UNDNR-Ongedaan maken van vroegere niet\n reactie
UNDRF-Ongedaan maken van vroegere weigering\n
OND-Schrapping door ontdubbeling

\n nullable: true\n DossierDienstDossierIncomeAuthentiekebron:\n type: object\n properties:\n inkomenType:\n $ref: '#/components/schemas/HuidigInkomenType'\n jaarMaand:\n maxLength: 15\n type: string\n description: Jaar maand van het inkomen\n nullable: true\n bedrag:\n maxLength: 15\n type: number\n description: Bedrag inkomen\n format: double\n nullable: true\n additionalProperties: false\n nullable: true\n SchuldenregelingCodeWaarden:\n enum:\n - 'YES'\n - 'NO'\n - UNK\n type: string\n description: >-\n

Members:

YES-YES
NO-NO
UNK-UNK

\n nullable: true\n OnderhoudsgeldenCodeWaarden:\n enum:\n - 'YES'\n - 'NO'\n - UNK\n type: string\n description: >-\n

Members:

YES-YES
NO-NO
UNK-UNK

\n nullable: true\n WoningTypeCodeWaarden:\n enum:\n - H\n - R\n - A\n - S\n type: string\n description: >-\n Woning Type (PRES)

Members:

H-Huis
R-Kamer
A-Appartement
S-Studio

\n nullable: true\n LichamelijkeBeperkingCodeWaarden:\n enum:\n - 'NO'\n - 'YES'\n type: string\n description: >-\n Of de KH een aangepaste woning wenst aan medische\n noden

Members:

NO-Geen aanpassing voor lichamelijke\n beperking nodig
YES-Aanpassing voor lichamelijke\n beperking nodig

\n nullable: true\n InschrijfhulpCodeWaarden:\n enum:\n - HC\n - OCMW\n - OTH\n - SUP\n - WH\n - HOEH\n type: string\n description: >-\n Inschrijfhulp Code (RAOP)

Members:

HC-Samen met een\n medewerker van de woonmaatschapij
OCMW-Samen met een\n medewerker van een sociaalHuis
OTH-Samen met andere\n persoon
SUP-Samen met begeleider
WH-Zonder Hulp
HOEH-Gemeentelijk\n woonloket/gemeentelijk woon- en energieloket

\n nullable: true\n InschrijfhulpInformerenCodeWaarden:\n enum:\n - 'NO'\n - 'YES'\n type: string\n description: >-\n Inschrijfhulp Informeren Code\n (PKIS)

Members:

NO-Niet Informeren
YES-Informeren

\n nullable: true\n SchrappingRedenCodeWaarden:\n enum:\n - DEAD\n - SNRE\n - SUNR\n - ASGN\n - OWNR\n - NCOM\n - FRAUD\n - JOAN\n - NACT\n type: string\n description: >-\n Schrapping Redenen (RCNC)

Members:

DEAD-Overlijden\n
SNRE-Tweede niet reactie
SUNR-Tweede\n ongegronde weigering
ASGN-Toewijzing
OWNR-Eigen vraag
NCOM-Niet voldoen aan\n voorwaarden
FRAUD-Frauduleuze verklaringen
JOAN-Gerechterlijk bevel na overlast
NACT-Non-activiteit

\n nullable: true\n WoningnoodRedenEnumCode:\n enum:\n - EHOME\n - UASIL\n - MHP\n - SUBSH\n - SPSC\n type: string\n description: >-\n

Members:

EHOME-Personen die dak- en thuisloos zijn\n of dreigen te worden
UASIL-Jongeren die zelfstandig\n wonen of gaan wonen met begeleiding door een erkende dienst
MHP-Personen met geestelijke gezondheidsproblemen
SUBSH-Personen die in slechte huisvesting wonen
SPSC-Personen die zich in bijzondere omstandigheden van\n sociale aard bevinden

\n nullable: true\n BelastbaarInkomenAanwezigheidCodeWaarden:\n enum:\n - TBV\n - SND\n - S6\n - FT\n - UV\n type: string\n description: >-\n Dit veld geeft aan of er inkomen (FOD Financiën) gevonden werden bij de\n authentieke bron en/of ze opgenomen worden in het\n CIR.

Members:

TBV-Te verifiëren
SND-Succesvol geverifieerd zonder gegevens
S6-Succesvol geverifieerd
FT-Verificatie\n mislukt om technische reden
UV-Niet verifieerbaar of\n verificatie mislukt

\n nullable: true\n LeefLoonAanwezigheidCodeWaarden:\n enum:\n - TBV\n - SND\n - S6\n - FT\n - UV\n type: string\n description: >-\n Dit veld geeft aan of er leefloongegevens gevonden werden bij de\n authentieke bron en/of ze opgenomen worden in het\n CIR.

Members:

TBV-Te verifiëren
SND-Succesvol geverifieerd zonder gegevens
S6-Succesvol geverifieerd
FT-Verificatie\n mislukt om technische reden
UV-Niet verifieerbaar of\n verificatie mislukt

\n nullable: true\n InkomensVervangendeTegemoetkomingCodeWaarden:\n enum:\n - TBV\n - SND\n - S6\n - FT\n - UV\n type: string\n description: >-\n Dit veld geeft aan of er inkomen vervangende-gegevens gevonden werden\n bij de authentieke bron en/of ze opgenomen worden in het\n CIR.

Members:

TBV-Te verifiëren
SND-Succesvol geverifieerd zonder gegevens
S6-Succesvol geverifieerd
FT-Verificatie\n mislukt om technische reden
UV-Niet verifieerbaar of\n verificatie mislukt

\n nullable: true\n ContactVoorkeurCodeWaarden:\n enum:\n - ALT\n - DOM\n - OTH\n type: string\n description: >-\n Wat als contactadres gerbuikt mag\n worden

Members:

ALT-Verblijfs Adress
DOM-Domicilie Adress
OTH-Contact Adress\n

\n nullable: true\n DossierDienstDossierPersoonAdresDomicilie:\n type: object\n properties:\n postCode:\n maxLength: 15\n type: string\n description: Postcode van de domicilie van het contact/gezinslid\n nullable: true\n example: '2830'\n gemeente:\n maxLength: 100\n type: string\n description: Naam van de gemeente waar domicilie gevestigd is.\n nullable: true\n example: Willebroek\n gemeenteNisCode:\n maxLength: 15\n type: string\n description: Gemeenteniscode van het domicilie adress\n nullable: true\n landCode:\n maxLength: 5\n type: string\n description: landcode van de domicilie.\n nullable: true\n straat:\n maxLength: 100\n type: string\n description: Naam van de straat waar domicilie gevestigd is.\n nullable: true\n example: Bos\n huisNummer:\n maxLength: 12\n type: string\n description: Huisnummer waar domicilie gevestigd is.\n nullable: true\n example: '502'\n huisNummerBus:\n maxLength: 10\n type: string\n description: Bus van de domicilie.\n nullable: true\n example: X\n additionalProperties: false\n nullable: true\n DossierDienstDossierPersoonAdresVerblijf:\n type: object\n properties:\n postCode:\n maxLength: 15\n type: string\n description: Postcode waar het contact/gezinslid verblijft.\n nullable: true\n example: '2830'\n gemeente:\n maxLength: 100\n type: string\n description: Gemeente waar het contact/gezinslid verblijft\n nullable: true\n example: Willebroek\n gemeenteNisCode:\n maxLength: 15\n type: string\n description: Niscode van verblijf aanvrager\n nullable: true\n landCode:\n maxLength: 5\n type: string\n description: Niscode van verblijf aanvrager\n nullable: true\n straat:\n maxLength: 100\n type: string\n description: Straat van verblijf van aanvrager\n nullable: true\n example: Bos\n huisNummer:\n maxLength: 12\n type: string\n description: Huisnummer van verblijf aanvrager\n nullable: true\n example: '502'\n huisNummerBus:\n maxLength: 10\n type: string\n description: Bus van verbflijf van het contact/gezinslid\n nullable: true\n example: X\n additionalProperties: false\n nullable: true\n DossierDienstDossierPersoonAdresContact:\n type: object\n properties:\n postCode:\n maxLength: 15\n type: string\n description: De postcode van het postadres van het contact/gezinslid.\n nullable: true\n example: '2830'\n gemeente:\n maxLength: 100\n type: string\n description: De gemeente van het postadres van het contact/gezinslid.\n nullable: true\n example: Willebroek\n gemeenteNisCode:\n maxLength: 15\n type: string\n description: Niscode van het postadres van het contact/gezinslid\n nullable: true\n landCode:\n maxLength: 5\n type: string\n description: De landcode van het postadres van het contact/gezinslid.\n nullable: true\n straat:\n maxLength: 100\n type: string\n description: De straat van het postadres van het contact/gezinslid.\n nullable: true\n example: Bos\n huisNummer:\n maxLength: 12\n type: string\n description: Het huisnummer van het postadres van het contact/gezinslid.\n nullable: true\n example: '502'\n huisNummerBus:\n maxLength: 10\n type: string\n description: De busnummer van het postadres van het contact/gezinslid.\n nullable: true\n example: X\n additionalProperties: false\n nullable: true\n HuidigInkomenType:\n enum:\n - PENS\n - LINC\n - IVT\n - UNEMP\n - INCAP\n type: string\n description: >-\n

Members:

PENS-Pensioen6m
LINC-Leefloon6m
IVT-IVT6m
UNEMP-Werkloosheidsuitkering6m
INCAP-Uitkeringarbeidsongeschikdheid6m

\n nullable: true\n DossierDienstDossierWijziging:\n type: object\n properties:\n dossierPersonen:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierPersoonWijziging'\n description: Contacten\n nullable: true\n dossierBijlages:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierUpdateBijlage'\n nullable: true\n aanvaardingDossier:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierAanvaarding'\n nullable: true\n extraBeroepsInkomsten:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierUpdateExtraBeroepsInkomsten'\n nullable: true\n aanvaardingWoonnood:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierUpdateAanvaardingWoonnood'\n nullable: true\n additionalProperties: false\n description: Description\n nullable: true\n DossierDienstDossierPersoonWijziging:\n type: object\n properties:\n rijksregisternummer:\n maxLength: 15\n type: string\n description: RRN\n nullable: true\n example: '2209280001'\n contactPersoonTenLaste:\n $ref: '#/components/schemas/RegistratieContactPersoonTenLaste'\n taalkennisSneltestCode:\n $ref: '#/components/schemas/TaalkennisSneltestCodeWaarden'\n additionalProperties: false\n nullable: true\n DossierDienstDossierUpdateBijlage:\n type: object\n properties:\n identificatie:\n maxLength: 255\n type: string\n description: Identificatie van de bijlage\n nullable: true\n aanvaardingBijlageCode:\n $ref: '#/components/schemas/AanvaardingBijlageCodeWaarden'\n aanvaardingOpmerking:\n type: string\n description: Geeft de opmerking bij de bijlage\n nullable: true\n additionalProperties: false\n nullable: true\n DossierDienstDossierAanvaarding:\n type: object\n properties:\n typeCode:\n $ref: '#/components/schemas/TypeCodeWaarden'\n aanvaardingCode:\n $ref: '#/components/schemas/AanvaardingCodeWaarden'\n opmerking:\n type: string\n description: Opmerking bij de beslissing.\n nullable: true\n additionalProperties: false\n nullable: true\n DossierDienstDossierUpdateAanvaardingWoonnood:\n type: object\n properties:\n identificatie:\n type: integer\n description: ID van de woonsituatie die goedgekeurd moet worden\n format: int64\n nullable: true\n aanvaardingCode:\n $ref: '#/components/schemas/AanvaardingDossierCode'\n conclusie:\n type: string\n description: Conclusie bij de woonnood\n nullable: true\n additionalProperties: false\n nullable: true\n DossierDienstDossierUpdateExtraBeroepsInkomsten:\n type: object\n properties:\n inkomstenType:\n $ref: '#/components/schemas/ExtraBeroepsInkomstenCodeWaarden'\n jaarTotaal:\n type: number\n description: Geeft het jaar waarin het inkomen werd ontvangen\n format: double\n nullable: true\n example: 2022\n rijksregisternummer:\n maxLength: 15\n type: string\n description: Rijksregisternummer\n nullable: true\n example: '2209280001'\n additionalProperties: false\n nullable: true\n TypeCodeWaarden:\n enum:\n - PCOMP\n - WPREF\n - INCOM\n - PROP\n - PLR2\n - PLR3\n - PLR4\n type: string\n description: >-\n

Members:

PCOMP-PersoonSamenstelling
WPREF-Woningvoorkeuren
INCOM-Inkomsten
PROP-Eigendom
PLR2-Woonnoodpijler2
PLR3-Woonnoodpijler3
PLR4-Woonnoodpijler4\n

\n nullable: true\n AanvaardingCodeWaarden:\n enum:\n - ACC\n - NCOM\n - FURI\n type: string\n description: >-\n

Members:

ACC-Uitzondering toegekend
NCOM-Uitzondering niet toegekend
FURI-Extra\n informatie nodig

\n nullable: true\n ExtraBeroepsInkomstenCodeWaarden:\n enum:\n - FORI\n - INSTI\n type: string\n description: >-\n

Members:

FORI-Inkomsten uit het buitenland
INSTI-Inkomsten uit europese of internationale instellingen\n

\n nullable: true\n DossierDienstDossierVersieBevestiging:\n type: object\n properties:\n dossierNummer:\n type: string\n description: nvarchar(15)\n nullable: true\n example: YYY.MM.DD.XXXX\n partijCode:\n type: string\n description: \"KBO nummer of CIR code van de partij die betrokken is bij het dossier.\\r\\n nvarchar(15)\"\n nullable: true\n versieNummer:\n type: integer\n description: Int\n format: int32\n additionalProperties: false\n nullable: true\n DossierDienstDossierRanglijstWijzigingen:\n type: object\n properties:\n partijCode:\n maxLength: 15\n type: string\n description: >-\n KBO nummer of CIR code van de partij die betrokken is bij het\n dossier.\n nullable: true\n ranglijstWijzigingen:\n type: array\n items:\n $ref: '#/components/schemas/DossierDienstDossierRanglijstWijziging'\n description: >-\n RanglijstWijzigingen kunnen doorgestuurd worden voor meerdere\n gemeentes voor meerdere dossiers\n nullable: true\n additionalProperties: false\n description: >-\n RanglijstWijzigingen kunnen doorgestuurd worden voor meerdere gemeentes\n voor meerdere dossiers\n nullable: true\n DossierDienstDossierRanglijstWijziging:\n type: object\n properties:\n rangLijstType:\n $ref: '#/components/schemas/RangLijstTypeCodeWaarden'\n dossierNummer:\n maxLength: 15\n type: string\n description: ''\n nullable: true\n example: 2022.09.08.0001\n beperkteRegioKeuze:\n $ref: '#/components/schemas/beperkteregiokeuze'\n lokaleBinding:\n $ref: '#/components/schemas/localebinding'\n gemeenteNisCode:\n maxLength: 15\n type: string\n description: Niscode van de gemeente waar de kandidaat-huurder wil wonen.\n nullable: true\n example: '12100'\n wijk:\n type: string\n description: >-\n Geeft de wijk van de gemeente/deelgemeenten weer, waar de\n Kandidaat-huurder wil wonen.\n nullable: true\n criterium1:\n $ref: '#/components/schemas/RangLijstCriteria1CodeWaarden'\n criterium2:\n maxLength: 500\n type: string\n nullable: true\n criterium3:\n maxLength: 500\n type: string\n nullable: true\n rangschikking:\n type: integer\n description: >-\n Geeft weer op welke plaats de kandidaat-huurder op de wachtlijst\n staat.\n format: int32\n nullable: true\n example: 17\n rangschikkingDatum:\n type: string\n description: >-\n Geeft de datum weer wanneer de kandidaat-huurder op de wachtlijst\n geplaatst werd.\n format: date-time\n nullable: true\n additionalProperties: false\n nullable: true\n RangLijstTypeCodeWaarden:\n enum:\n - PLR1\n - PLR2\n - PLR3\n - PLR4\n type: string\n description: >-\n Rang Lijst Type Code (RRTP)

Members:

PLR1-Pijler 1\n
PLR2-Pijler 2
PLR3-Pijler 3
PLR4-Pijler 4

\n nullable: true\n beperkteregiokeuze:\n enum:\n - 'YES'\n - 'NO'\n - UNK\n type: string\n description: >-\n

Members:

YES-Wel beperkte regiokeuze
NO-Geen beperkte regiokeuze
UNK-Niet gekend\n

\n nullable: true\n localebinding:\n enum:\n - 'YES'\n - 'NO'\n - UNK\n type: string\n description: >-\n

Members:

YES-Wel locale binding
NO-Geen locale binding
UNK-Niet gekend

\n nullable: true\n RangLijstCriteria1CodeWaarden:\n enum:\n - H\n - R\n - A\n - S\n - EHOME\n - UASIL\n - MHP\n - SUBSH\n - SPSC\n - D\n - DERES\n - UOCCU\n - OCRWD\n - NCRAT\n - PRFR\n - NOADA\n - TOEZ\n - REHOU\n type: string\n description: >-\n nvarchar(15)

Members:

H-Huis (Pijler 1)
R-Kamer (Pijler 1)
A-Appartement (Pijler 1)\n
S-Studio (Pijler 1)
EHOME-Personen\n die dak- en thuisloos zijn of dreigen te worden (Pijler 2)
UASIL-Jongeren die zelfstandig wonen of gaan wonen met\n begeleiding door een erkende dienst (Pijler 2)
MHP-Personen met geestelijke gezondheidsproblemen (Pijler 2)\n
SUBSH-Personen die in slechte huisvesting wonen\n (Pijler 2)
SPSC-Personen die zich in bijzondere\n omstandigheden van sociale aard bevinden (Pijler 2)
D-Specifieke Doelgroep (Pijler 3)
DERES-Sloop, renovatie en verkoop van de sociale huurwoning\n (Pijler 4)
UOCCU-Onderbezetting van de sociale\n huurwoning (Pijler 4)
OCRWD-Overbezetting van de\n sociale huurwoning (Pijler 4)
NCRAT-Niet meer voldoen\n aan de rationele bezetting (Pijler 4)
PRFR-Vooraf\n vermelde gezinshereniging die plaatsvindt (Pijler 4)
NOADA-Het niet meer nodig hebben van een aangepaste woning\n (Pijler 4)
TOEZ-Het gegrond vinden van het verhaal bij\n de toezichthouder (Pijler 4)
REHOU-Het herhuisvesten\n bij de beëindiging van het hoofdhuurcontract van een ingehuurde woning\n (Pijler 4)

\n nullable: true\n ZwarteLijstMeldingen:\n type: object\n properties:\n partijCode:\n type: string\n description: >-\n KBO nummer of CIR code van de partij die betrokken is bij het\n dossier.\n nullable: true\n meldingen:\n type: array\n items:\n $ref: '#/components/schemas/ZwarteLijstMelding'\n description: ZwarteLijstMeldingen kunnen doorgestuurd worden voor partijen\n nullable: true\n additionalProperties: false\n nullable: true\n ZwarteLijstMelding:\n type: object\n properties:\n rijksregisternummer:\n maxLength: 15\n type: string\n description: RRN van persoon op zwartelijst\n nullable: true\n reden:\n $ref: '#/components/schemas/ZwarteLijstRedenCodeWaarden'\n startDatum:\n type: string\n description: Datum vanaf wanneer persoon op zwartelijst staat\n format: date-time\n additionalProperties: false\n nullable: true\n PartijInformatieWijzigingen:\n type: object\n properties:\n partijCode:\n type: string\n description: >-\n KBO nummer of CIR code van de partij die betrokken is bij het\n dossier.\n nullable: true\n wijzingingen:\n type: array\n items:\n $ref: '#/components/schemas/PartijInformatieWijziging'\n nullable: true\n additionalProperties: false\n nullable: true\n PartijInformatieWijziging:\n type: object\n properties:\n rijksregisternummer:\n maxLength: 15\n type: string\n description: Rijksregisternummer\n nullable: true\n example: '2209280001'\n voorNaam:\n maxLength: 48\n type: string\n description: Voornaam van bewindvoerder\n nullable: true\n example: Marc\n naam:\n maxLength: 128\n type: string\n description: Achternaam van bewindvoerder\n nullable: true\n example: Molenbergs\n email:\n maxLength: 50\n type: string\n description: E-mailadres van bewindvoerder\n nullable: true\n example: Marc.Molenbergs@hotmail.be\n telefoon1:\n maxLength: 15\n type: string\n description: Telefoonnummer van bewindvoerder\n nullable: true\n example: 015/43 43 43\n telefoon2:\n maxLength: 15\n type: string\n description: Telefoonnummer van bewindvoerder\n nullable: true\n example: 0477 / 43 43 43\n adres:\n $ref: '#/components/schemas/PartijAdres'\n registratieTijdstip:\n type: string\n format: date-time\n nullable: true\n additionalProperties: false\n nullable: true\n PartijAdres:\n type: object\n properties:\n postCode:\n maxLength: 15\n type: string\n description: Postcode van de domicilie van bewindvoerder\n nullable: true\n example: '2830'\n gemeente:\n maxLength: 100\n type: string\n description: Naam van de gemeente van bewindvoerder\n nullable: true\n example: Willebroek\n gemeenteNisCode:\n maxLength: 15\n type: string\n description: Niscode\n nullable: true\n example: 41002A\n landCode:\n maxLength: 5\n type: string\n nullable: true\n straat:\n maxLength: 225\n type: string\n description: Straat van bewindvoerder\n nullable: true\n example: Bos\n huisNummer:\n maxLength: 50\n type: string\n description: Huisnummer van bewindvoerder\n nullable: true\n example: '502'\n huisNummerBus:\n maxLength: 50\n type: string\n description: Bus nr van bewindvoerder\n nullable: true\n example: X\n additionalProperties: false\n nullable: true\n GetZwarteLijstMeldingVerzoek:\n type: object\n properties:\n rijksregisternummer:\n type: string\n nullable: true\n example: '12345678901'\n additionalProperties: false\n nullable: true\n GetZwarteLijstMelding:\n type: object\n properties:\n opZwarteLijst:\n type: boolean\n description: Aanduiding of de persoon op de zwartelijst staat of niet.\n partijCode:\n type: string\n description: >-\n KBO nummer of CIR code van de partij die betrokken is bij het\n dossier.\n nullable: true\n reden:\n $ref: '#/components/schemas/ZwarteLijstRedenCodeWaarden'\n startDatum:\n type: string\n description: Datum vanaf wanneer persoon op zwartelijst moet\n format: date-time\n nullable: true\n additionalProperties: false\n nullable: true\n DossierDienstDossierActie:\n type: object\n properties:\n dossierNummer:\n type: string\n description: nvarchar(15)\n nullable: true\n example: YYY.MM.DD.XXXX\n partijCode:\n type: string\n description: >-\n KBO nummer of CIR code van de partij die betrokken is bij het\n dossier.\n nullable: true\n example: '1234'\n actie:\n $ref: '#/components/schemas/DossierActieCodeWaarden'\n commentaar:\n type: string\n description: Commentaar bij de actie\n nullable: true\n datumIngangContract:\n type: string\n description: Datum van ingang contract huurder\n format: date-time\n nullable: true\n pand:\n $ref: '#/components/schemas/DossierDienstDossierPandUpdate'\n additionalProperties: false\n nullable: true\n GemeenteDienstZoekResultaats:\n type: object\n properties:\n gemeentes:\n type: array\n items:\n $ref: '#/components/schemas/GemeenteDienstZoekResultaat'\n nullable: true\n additionalProperties: false\n nullable: true\n GemeenteDienstZoekResultaat:\n type: object\n properties:\n nisCode:\n type: string\n nullable: true\n naam:\n type: string\n nullable: true\n taal:\n type: string\n nullable: true\n regioCode:\n type: string\n nullable: true\n provincieCode:\n type: string\n nullable: true\n districtCode:\n type: string\n nullable: true\n lengteGraad:\n type: number\n format: double\n nullable: true\n breedteGraad:\n type: number\n format: double\n nullable: true\n deelgemeentes:\n type: array\n items:\n $ref: '#/components/schemas/GemeenteDienstZoekResultaatDeelgemeente'\n nullable: true\n additionalProperties: false\n nullable: true\n GemeenteDienstZoekResultaatDeelgemeente:\n type: object\n properties:\n nisCode:\n type: string\n nullable: true\n zip:\n type: string\n nullable: true\n naam:\n type: string\n nullable: true\n additionalProperties: false\n nullable: true\n GemeenteDienstWijken:\n type: object\n properties:\n wijken:\n type: array\n items:\n $ref: '#/components/schemas/GemeenteDienstWijk'\n nullable: true\n additionalProperties: false\n nullable: true\n GemeenteDienstWijk:\n type: object\n properties:\n wijkNaam:\n type: string\n nullable: true\n gemeenteNisCode:\n type: string\n nullable: true\n additionalProperties: false\n nullable: true\n DossierDienstBijlageCriteria:\n required:\n - bijlageIdentificatie\n - dossierNummer\n - partijCode\n type: object\n properties:\n partijCode:\n maxLength: 15\n type: string\n description: >-\n KBO nummer of CIR code van de partij die betrokken is bij het\n dossier.\n example: '5025'\n dossierNummer:\n maxLength: 15\n type: string\n description: DossierNummer nvarchar(15)\n example: YYYY.MM.DD.XXXX\n bijlageIdentificatie:\n type: string\n description: Identificatie van de bijlage\n example: CCTS-0-12345678900\n additionalProperties: false\n nullable: true\n DossierDienstDossierWoonsituatie:\n type: object\n properties:\n omschrijving:\n type: string\n description: Woonsituatie reden omschrijving\n nullable: true\n identificatie:\n type: string\n description: Identificatie van de Woonsituatie\n nullable: true\n additionalProperties: false\n description: Woonsituatie voor het dossier\n nullable: true\n\n #----------------------- END CIR payloads -------------------------------\n\n #----------------------- START CWR WoningenAPI -------------------------------\n WoningV2Response:\n type: object\n properties:\n '@context':\n type: string\n nullable: true\n '@id':\n type: string\n format: uri\n nullable: true\n '@magdaId':\n type: string\n format: uri\n nullable: true\n '@type':\n type: string\n default: WivWoningResource\n nullable: true\n value:\n $ref: '#/components/schemas/WivWoningResource'\n additionalProperties: false\n WivWoningResource:\n type: object\n properties:\n eigenaar:\n $ref: '#/components/schemas/OrganisatieResourceMetOsloType'\n beheerder:\n $ref: '#/components/schemas/OrganisatieResourceMetOsloType'\n verhuringsStelsel:\n enum:\n - Sociale verhuur gesubsidieerd\n - Geconventioneerde verhuur\n - Sociale verhuur\n type: string\n woonmaatschappijWoningId:\n type: string\n description: Het Id van de woning in de applicatie van de woonmaatschappij\n nullable: true\n example: O02034#22\n woonmaatschappijWoningCode:\n type: string\n description: De code voor de woning in de applicatie van de woonmaatschappij\n nullable: true\n example: 29 06 00 00 00 27\n woonmaatschappijWoningGroepCode:\n type: string\n description: De code van de groep waartoe de woning behoort\n nullable: true\n example: ZJV-JVB-V\n bouwjaar:\n type: integer\n format: int32\n nullable: true\n vmswWoningId:\n type: string\n nullable: true\n gebouweenheidIds:\n type: array\n items:\n type: string\n nullable: true\n adres:\n $ref: '#/components/schemas/VmswAdres'\n statistischeSector:\n type: string\n nullable: true\n wijk:\n type: string\n nullable: true\n woningType:\n type: string\n nullable: true\n woningStatus:\n type: string\n nullable: true\n bebouwingsType:\n type: string\n nullable: true\n additionalProperties: false\n VmswAdres:\n type: object\n properties:\n straatnaam:\n $ref: '#/components/schemas/TaalString'\n huisnummer:\n type: string\n nullable: true\n busnummer:\n type: string\n nullable: true\n postcode:\n type: string\n nullable: true\n gemeentenaam:\n $ref: '#/components/schemas/TaalString'\n gemeenteNISCode:\n type: string\n nullable: true\n additionalProperties: false\n TaalString:\n type: object\n properties:\n '@type':\n type: string\n default: http://www.w3.org/1999/02/22-rdf-syntax-ns#langString\n nullable: true\n spelling:\n type: string\n nullable: true\n taal:\n type: string\n default: nl-BE\n nullable: true\n additionalProperties: false\n OrganisatieResourceMetOsloType:\n type: object\n properties:\n '@type':\n type: string\n default: OrganisatieResource\n nullable: true\n organisatieType:\n enum:\n - Woonmaatschappij\n - OCMW\n - Gemeente\n - Private initiatiefnemer\n type: string\n organisatieId:\n type: string\n nullable: true\n additionalProperties: false\n V2WoningWijzigen:\n type: object\n properties:\n status:\n enum:\n - In beheer\n - Uit beheer\n type: string\n nullable: true\n eigenaarOrganisatieId:\n type: string\n nullable: true\n gebouweenheidId:\n type: string\n nullable: true\n example: '16480205'\n woonmaatschappijWoningId:\n type: string\n description: Het Id van de woning in de applicatie van de woonmaatschappij\n nullable: true\n example: O02034#22\n woonmaatschappijWoningCode:\n type: string\n description: De code voor de woning in de applicatie van de woonmaatschappij\n nullable: true\n example: 29 06 00 00 00 27\n woonmaatschappijWoningGroepCode:\n type: string\n description: De code van de groep waartoe de woning behoort\n nullable: true\n example: ZJV-JVB-V\n adres:\n $ref: '#/components/schemas/AdresZoeken'\n bouwjaar:\n type: integer\n format: int32\n nullable: true\n bebouwingsType:\n type: string\n nullable: true\n additionalProperties: false\n AdresZoeken:\n type: object\n properties:\n straatnaam:\n type: string\n nullable: true\n huisnummer:\n type: string\n nullable: true\n busnummer:\n type: string\n nullable: true\n postcode:\n type: string\n nullable: true\n gemeenteNISCode:\n type: string\n nullable: true\n additionalProperties: false\n V2WoningToevoegen:\n type: object\n properties:\n eigenaarOrganisatieId:\n type: string\n nullable: true\n gebouweenheidId:\n type: string\n nullable: true\n example: '16480205'\n woonmaatschappijWoningId:\n type: string\n description: Het Id van de woning in de applicatie van de woonmaatschappij\n nullable: true\n example: O02034#22\n woonmaatschappijWoningCode:\n type: string\n description: De code voor de woning in de applicatie van de woonmaatschappij\n nullable: true\n example: 29 06 00 00 00 27\n woonmaatschappijWoningGroepCode:\n type: string\n description: De code van de groep waartoe de woning behoort\n nullable: true\n example: ZJV-JVB-V\n adres:\n $ref: '#/components/schemas/AdresZoeken'\n bouwjaar:\n type: integer\n format: int32\n nullable: true\n bebouwingsType:\n type: string\n nullable: true\n additionalProperties: false\n ProblemDetailsValidationErrorExtension:\n type: object\n properties:\n validationErrors:\n type: array\n items:\n $ref: '#/components/schemas/ValidationError'\n nullable: true\n readOnly: true\n type:\n type: string\n default: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/{Status}\n nullable: true\n title:\n type: string\n nullable: true\n status:\n type: integer\n format: int32\n detail:\n type: string\n nullable: true\n instance:\n type: string\n nullable: true\n additionalProperties: false\n ValidationError:\n type: object\n properties:\n name:\n type: string\n nullable: true\n readOnly: true\n reason:\n type: string\n nullable: true\n readOnly: true\n additionalProperties: false\n #----------------------- END CWR WoningenAPI payloads -------------------------------\n\n #----------------------- START CWR Woningbezetting payloads -------------------------------\n\n WoningBezetting:\n type: object\n title: WoningBezetting\n properties:\n '@id':\n type: string\n format: uri\n example: 'https://cwr-host/id/woningbezetting/123'\n '@type':\n type: string\n default: WoningBezetting\n woningBezettingsType:\n $ref: '#/components/schemas/WoningBezettingsType'\n vmswWoningId:\n type: string\n datumBezettingVan:\n type: string\n format: date\n datumBezettingTot:\n type: string\n format: date\n description: 'Verplicht veld, maar kan leeg zijn'\n leegstandsType:\n $ref: '#/components/schemas/LeegstandsType'\n verhuring:\n $ref: '#/components/schemas/Verhuring'\n huurstelsel:\n type: string\n description: |-\n - BIS = Verhuring binnen het sociaal stelsel zoals vermeld in het kaderbesluit sociale huur\n - BUS = Verhuring buiten het sociaal stelsel zoals vermeld in artikel 55bis tot en met artikel 55exies van het Kaderbesluit Sociale Huur\n - GW = Goede woning zoals vermeld in hoofdstuk 3 van het ministerieel besluit van 19/12/2008\n - COM = Verhuring als niet-residentieële ruimte (garages, winkels)\n - BOV = Bezettingsovereenkomst gesloten met bijwoners wanneer de laatste huurder overlijdt\n - Andere = Ander soort verhuring\n - NVT = Niet van toepassing\n enum:\n - BIS\n - BUS\n - GW\n - COM\n - BOV\n - Andere\n - NVT\n required:\n - woningBezettingsType\n - vmswWoningId\n - datumBezettingTot\n - huurstelsel\n Verhuring:\n type: object\n title: ''\n description: ''\n properties:\n '@type':\n type: string\n default: Verhuring\n huurder:\n $ref: '#/components/schemas/Agent'\n huurprijsberekening:\n type: array\n items:\n $ref: '#/components/schemas/Huurprijsberekening'\n tijdelijkHuurContract:\n type: boolean\n begindatumHuurContract:\n type: string\n description: Verplicht bij tijdelijk contract\n format: date\n pattern: yyyy-mm-dd\n einddatumHuurContract:\n type: string\n description: Verplicht bij tijdelijk contract\n format: date\n pattern: yyy-mm-dd\n basisHuurprijs:\n type: string\n format: double\n pattern: '[0-9]+\\.?[0-9]*'\n referentieHuurprijs:\n type: string\n format: double\n description: 'Is de referentiehuurprijs van de woning. Deze huurprijs geldt enkel tijdens de overgangsperiode. Gebruik als decimaal scheidingsteken een punt (“.”). Gebruik geen duizend-scheidingsteken, plusteken of enige andere opmaak. Dit veld is enkel verplicht voor woongelegenheden en dit zolang de overgangsregeling vermeld in het kaderbesluit sociale huur van toepassing is.'\n pattern: '[0-9]+\\.?[0-9]*'\n patrimoniumkorting:\n type: string\n description: 'Dit veld is niet van toepassing tijdens de overgangsperiode. Is een decimaal getal. Gebruik als decimaal scheidingsteken een punt (“.”). Gebruik geen duizend-scheidingsteken, plusteken of enige andere opmaak. Dit veld is verplicht voor alle woongelegenheden verhuurd binnen het sociaal stelsel van zodra de patrimoniumkorting effectief ingevoerd wordt.'\n pattern: '[0-9]+\\.?[0-9]*'\n energiecorrectie:\n type: string\n format: double\n description: 'De totale energiecorrectie. Voorlopig kan dit nog niet ingevuld worden. Is een decimaal getal. Gebruik als decimaal scheidingsteken een punt (“.”). Gebruik geen duizend-scheidingsteken, plusteken of enige andere opmaak. Dit veld is verplicht voor alle woongelegenheden verhuurd binnen het sociaal stelsel van zodra de energiecorrectie effectief ingevoerd wordt.'\n pattern: '[0-9]+\\.?[0-9]*'\n huurlasten:\n type: string\n format: double\n pattern: '[0-9]+\\.?[0-9]*'\n toegepasteBasisHuurprijs:\n type: string\n format: double\n pattern: '[0-9]+\\.?[0-9]*'\n gezinsleden:\n type: array\n items:\n $ref: '#/components/schemas/Gezinslid'\n huurOpzegging:\n $ref: '#/components/schemas/HuurOpzegging'\n required:\n - tijdelijkHuurContract\n LeegstandsType:\n type: object\n x-examples: {}\n properties:\n '@type':\n type: string\n default: LeegstandsType\n structureel:\n type: boolean\n leegstandsTypeCode:\n type: integer\n description: |-\n Indien niet-structureel => opties:\n 1 Overlijden van huurder\n 2 Woning die leegstaat in afwachting van verhuring aan de huurde die door renovatie zijn sociale woning gaat ontruimen\n 3 Frictieleegstand\n required:\n - structureel\n Huurprijsberekening:\n type: object\n properties:\n '@type':\n type: string\n default: Huurprijsberekening\n beginDatumHuurprijsberekening:\n type: string\n format: date\n pattern: yyyy-mm-dd\n eindDatumHuurprijsberekening:\n type: string\n format: date\n pattern: yyyy-mm-dd\n personenTenLaste:\n type: string\n format: double\n description: |-\n Is het aantal personen ten laste voor de betreffende huurder zoals van toepassing in het kaderbesluit sociale huur. Is niet altijd hetzelfde als het aantal gezinsleden. Is een getal tussen 0 en 99 (grenzen inbegrepen).\n Het cijfer kan ook **halve personen** ten laste bevatten. PTL is de som van Aantalkinderen en AantalHandicap. Dit veld is niet verplicht wanneer het winkels of garages betreft.\n pattern: '[0-9]+\\.?[0-9]*'\n aantalKinderen:\n type: integer\n format: int32\n aantalMetHandicap:\n type: integer\n format: int32\n aantalGezinsleden:\n type: integer\n format: int32\n totaalInkomen:\n type: string\n format: double\n pattern: '[0-9]+\\.?[0-9]*'\n totaalInkomenNietGeindexeerd:\n type: string\n format: double\n pattern: '[0-9]+\\.?[0-9]*'\n reeleHuur:\n type: string\n format: double\n pattern: '[0-9]+\\.?[0-9]*'\n gezinskorting:\n type: string\n format: double\n pattern: '[0-9]+\\.?[0-9]*'\n onderbezettingsvergoeding:\n type: string\n format: double\n pattern: '[0-9]+\\.?[0-9]*'\n required:\n - beginDatumHuurprijsberekening\n - eindDatumHuurprijsberekening\n - reeleHuur\n Gezinslid:\n type: object\n description: ''\n title: Gezinslid\n properties:\n '@type':\n type: string\n default: Gezinslid\n computerNummer:\n type: string\n description: |\n Het nummer waarmee de huurder in de databank van de SHM wordt geïdentificeerd.\n metHandicap:\n type: boolean\n gezinsRelatie:\n $ref: '#/components/schemas/RelatieType'\n persoon:\n $ref: '#/components/schemas/GeregistreerdPersoon'\n required:\n - gezinsRelatie\n Geboorte:\n title: Geboorte\n x-stoplight:\n id: nzn6f8k9i10uq\n type: object\n properties:\n '@type':\n type: string\n default: Geboorte\n datum:\n type: string\n plaats:\n $ref: '#/components/schemas/Plaats'\n Agent:\n title: Agent\n x-stoplight:\n id: r30hkva8og2gy\n type: object\n description: Dit is een persoon of organisatie aan wie de woning verhuurd wordt\n properties:\n '@type':\n type: string\n default: Agent\n persoon:\n $ref: '#/components/schemas/PersoonRegistratie'\n organisatie:\n $ref: '#/components/schemas/OrganisatieRegistratie'\n HuurOpzegging:\n title: HuurOpzegging\n x-stoplight:\n id: u407h8hjtuktk\n type: object\n properties:\n '@type':\n type: string\n default: HuurOpzegging\n UithuiszettingsReden:\n type: array\n items:\n $ref: '#/components/schemas/TaalString'\n UithuiszettingDetail:\n type: array\n items:\n $ref: '#/components/schemas/TaalString'\n UithuiszettingOpgestart:\n type: boolean\n UithuiszettingEffectief:\n type: boolean\n OntbindingsReden:\n type: array\n items:\n $ref: '#/components/schemas/TaalString'\n OntbindingsDetail:\n type: array\n items:\n $ref: '#/components/schemas/TaalString'\n Nationaliteit:\n title: Nationaliteit\n x-stoplight:\n id: 2xul36lbmwsvc\n type: object\n properties:\n '@type':\n type: string\n default: Nationaliteit\n nationaliteitscode:\n type: string\n nationaliteit:\n type: array\n items:\n $ref: '#/components/schemas/TaalString'\n GeregistreerdPersoon:\n title: GeregistreerdPersoon\n x-stoplight:\n id: yf0e42cfm26wc\n type: object\n properties:\n '@type':\n type: string\n default: 'https://data.vlaanderen.be/ns/persoon#GeregistreerdPersoon'\n registratie:\n $ref: '#/components/schemas/Identificator'\n voornaam:\n type: array\n items:\n type: string\n gebruikteVoornaam:\n type: string\n achternaam:\n type: array\n items:\n type: string\n volledigeNaam:\n type: string\n heeftGeboorte:\n $ref: '#/components/schemas/Geboorte'\n geslacht:\n type: array\n items:\n $ref: '#/components/schemas/TaalString'\n heeftNationaliteit:\n type: array\n items:\n $ref: '#/components/schemas/Nationaliteit'\n Identificator:\n title: Identificator\n x-stoplight:\n id: bipk6o53h7iof\n type: object\n properties:\n '@type':\n type: string\n default: Identificator\n identificator:\n type: string\n description: |\n Insznummer\n Response:\n title: Response\n x-stoplight:\n id: u18uoyp5urpwd\n type: object\n properties:\n '@context':\n type: string\n items:\n type: array\n items:\n $ref: '#/components/schemas/WoningBezetting'\n RelatieType:\n title: RelatieType\n type: object\n properties:\n '@type':\n type: string\n default: RelatieType\n spelling:\n type: string\n enum:\n - Onbekend\n - Gezinshoofd\n - Echtgenoot of Echtgenote\n - Zoon of Dochter\n - Schoonzoon of Schoondochter\n - Kleinzoon of Kleindochter\n - Vader of Moeder\n - Schoonvader of Schoonmoeder\n - Grootvader of Grootmoeder\n - Broer of Zuster\n - Schoonbroer of Schoonzuster\n - Verwant of Verwante\n - Zonder familieband\n - Stiefzoon of Stiefdochter\n - Achterkleinzoon of Achterkleindochter\n - Oom of Tante\n - Neef of Nicht (verwantschap 3de graad)\n - Neef of Nicht (verwantschap 4de graad)\n - Gemeenschappen of Tehuizen\n taal:\n type: string\n default: nl-BE\n Plaats:\n title: Plaats\n x-stoplight:\n id: wv6bi8bdfuxu3\n type: object\n properties:\n '@type':\n type: string\n description: 'http://purl.org/dc/terms/Location'\n plaatsnaam:\n type: array\n items:\n $ref: '#/components/schemas/TaalString'\n WoningBezettingsType:\n type: object\n title: WoningBezettingsType\n x-stoplight:\n id: rb7gf278qcyrv\n enum:\n - Verhuring\n - Leegstand\n properties:\n '@type':\n type: string\n default: WoningBezettingsType\n spelling:\n type: string\n taal:\n type: string\n AgentType:\n title: AgentType\n x-stoplight:\n id: b3iwm5jjn8pft\n type: object\n properties:\n '@type':\n type: string\n default: AgentType\n spelling:\n type: string\n lang:\n type: string\n description: Persoon of organisatie die de woning zal huren\n PersoonRegistratie:\n title: PersoonRegistratie\n x-stoplight:\n id: 6fojgqsqwox32\n type: object\n properties:\n '@type':\n type: string\n default: 'Huurder'\n registratie:\n $ref: '#/components/schemas/Identificator'\n inkomen:\n type: string\n format: double\n pattern: '[0-9]+\\.?[0-9]*'\n inkomensjaar:\n type: integer\n inkomenFictief:\n type: boolean\n OrganisatieRegistratie:\n title: OrganisatieRegistratie\n x-stoplight:\n id: ozefub6q99za5\n type: object\n properties:\n '@type':\n type: string\n default: 'https://data.vlaanderen.be/ns/organisatie'\n registratie:\n $ref: '#/components/schemas/Identificator'\n wettelijkeNaam:\n type: string\n #----------------------- END CWR Woningbezetting payloads -------------------------------\n\n #----------------------- START Notifications payloads -------------------------------\n\n AsynchroonBerichtResponse:\n type: object\n properties:\n version:\n type: string\n nullable: true\n sender:\n type: string\n nullable: true\n resource:\n type: string\n nullable: true\n magdaResource:\n type: string\n nullable: true\n description: Resource to be used on the MAGDA platform. This element is not present if the VMSW resource can not be parsed.\n identification:\n type: string\n nullable: true\n magdaIdentification:\n type: string\n nullable: true\n description: Identification to be used on the MAGDA platform. This element is not present if the VMSW identification can not be parsed.\n timeStamp:\n type: string\n format: date-time\n changeType:\n enum:\n - C\n - U\n - D\n type: string\n description: Oplijsting mogelijke acties die via berichtenflow kan gebeuren.\n changeReasonCode:\n type: string\n nullable: true\n changeReasonComment:\n type: string\n nullable: true\n receiver:\n type: string\n nullable: true\n additionalProperties: false\n\n #----------------------- END Notifications payloads -------------------------------\n\n\n #----------------------- START Markthuurwaarden payloads --------------------------\n Huurschatting:\n type: object\n properties:\n woningKenmerkScores:\n type: array\n items:\n $ref: '#/components/schemas/WoningKenmerkScore'\n nullable: true\n markthuurwaardePerSchattingsmodel:\n type: array\n items:\n $ref: '#/components/schemas/MarkthuurwaardeSchattingsmodel'\n nullable: true\n additionalProperties: false\n HuurschattingSimulatie:\n type: object\n properties:\n woningKenmerkScores:\n type: array\n items:\n $ref: '#/components/schemas/WoningKenmerkScore'\n nullable: true\n markthuurwaardePerSchattingsmodel:\n type: array\n items:\n $ref: '#/components/schemas/MarkthuurwaardeSimulatieSchattingsmodel'\n nullable: true\n additionalProperties: false\n Markthuurwaarde:\n type: object\n properties:\n voorWoning:\n type: string\n format: uri\n example: >-\n https://cwr.vmsw.vonet.be/api/v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}\n nullable: true\n magdaVoorWoning:\n type: string\n format: uri\n nullable: true\n description: Resource to be used on the MAGDA platform. This element is not present if the VMSW resource can not be parsed.\n opReferentieDatum:\n $ref: '#/components/schemas/Huurschatting'\n opHuidigeStaat:\n $ref: '#/components/schemas/Huurschatting'\n additionalProperties: false\n MarkthuurwaardeResponse:\n type: object\n properties:\n '@context':\n type: string\n nullable: true\n '@id':\n type: string\n format: uri\n example: >-\n https://cwr.vmsw.vonet.be/api/v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}/markthuurwaarden\n nullable: true\n '@magdaId':\n type: string\n format: uri\n nullable: true\n '@type':\n type: string\n default: MarkthuurwaardeResource\n nullable: true\n value:\n $ref: '#/components/schemas/Markthuurwaarde'\n additionalProperties: false\n MarkthuurwaardeSchattingsmodel:\n type: object\n properties:\n '@type':\n type: string\n default: MarkthuurwaardeSchattingsmodelResource\n nullable: true\n bedragInclusiefAfwijkingEnAfronding:\n type: integer\n format: int32\n toegestaneAfwijkingPercentage:\n type: number\n format: double\n foutmelding:\n type: string\n nullable: true\n jaar:\n type: integer\n format: int32\n bedrag:\n type: number\n format: double\n berekendOp:\n type: string\n format: date-time\n additionalProperties: false\n MarkthuurwaardeSimulatieResponse:\n type: object\n properties:\n '@context':\n type: string\n nullable: true\n '@id':\n type: string\n format: uri\n nullable: true\n '@magdaId':\n type: string\n format: uri\n nullable: true\n '@type':\n type: string\n default: MarkthuurwaardeSimulatieResource\n nullable: true\n value:\n $ref: '#/components/schemas/HuurschattingSimulatie'\n additionalProperties: false\n MarkthuurwaardeSimulatieSchattingsmodel:\n type: object\n properties:\n '@type':\n type: string\n default: MarkthuurwaardeSimulatieSchattingsmodelResource\n nullable: true\n jaar:\n type: integer\n format: int32\n bedrag:\n type: number\n format: double\n berekendOp:\n type: string\n format: date-time\n additionalProperties: false\n ProblemDetail:\n type: object\n properties:\n type:\n type: string\n default: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/{Status}\n nullable: true\n title:\n type: string\n nullable: true\n status:\n type: integer\n format: int32\n detail:\n type: string\n nullable: true\n instance:\n type: string\n nullable: true\n additionalProperties: false\n WoningKenmerkDefinitie:\n type: object\n properties:\n '@id':\n type: string\n format: uri\n example: /v1/woningkenmerken/{code}\n nullable: true\n '@magdaId':\n type: string\n format: uri\n nullable: true\n '@type':\n type: string\n default: WoningKenmerkDefinitieResource\n nullable: true\n label:\n type: string\n nullable: true\n code:\n type: string\n nullable: true\n additionalProperties: false\n WoningKenmerkScore:\n type: object\n properties:\n '@type':\n type: string\n default: WoningKenmerkScoreResource\n nullable: true\n woningKenmerk:\n $ref: '#/components/schemas/WoningKenmerkDefinitie'\n score:\n type: string\n description: >-\n Waarde (score) voor het kenmerk. De waarde moet voldoen aan de\n schaal die gekoppeld is aan het kenmerk.\n nullable: true\n additionalProperties: false\n WoningKenmerkScoreLijst:\n type: object\n properties:\n woningKenmerkSimulatieScores:\n type: array\n items:\n $ref: '#/components/schemas/WoningKenmerkScoreWijziging'\n nullable: true\n additionalProperties: false\n WoningKenmerkScoreWijziging:\n type: object\n properties:\n code:\n type: string\n description: Code om het woningkenmerk uniek te identificeren\n nullable: true\n score:\n type: string\n description: >-\n Score voor het kenmerk. De score moet voldoen aan de schaal die\n gekoppeld is aan het kenmerk.\n nullable: true\n additionalProperties: false\n #----------------------- END Markthuurwaarden payloads ----------------------------\n\n #----------------------- START Conditiescore payloads ----------------------------\n\n ConditiescoreWoningKenmerkScore:\n type: object\n properties:\n '@type':\n type: string\n default: ConditiescoreWoningKenmerkScoreResource\n nullable: true\n readOnly: true\n woningKenmerk:\n $ref: '#/components/schemas/WoningKenmerkDefinitie'\n score:\n type: string\n description: Score voor het kenmerk. De score moet voldoen aan de schaal die gekoppeld is aan het kenmerk.\n nullable: true\n readOnly: true\n scoreLabel:\n type: string\n nullable: true\n readOnly: true\n wegingsfactorProcent:\n type: number\n format: double\n totaalProcent:\n type: number\n format: double\n additionalProperties: false\n\n ConditiescoreGroep:\n type: object\n properties:\n naam:\n type: string\n nullable: true\n scores:\n type: array\n items:\n $ref: '#/components/schemas/ConditiescoreWoningKenmerkScore'\n nullable: true\n wegingsfactorProcent:\n type: number\n format: double\n totaalProcent:\n type: number\n format: double\n additionalProperties: false\n ConditiescoreCategorie:\n type: object\n properties:\n naam:\n type: string\n nullable: true\n groepen:\n type: array\n items:\n $ref: '#/components/schemas/ConditiescoreGroep'\n nullable: true\n additionalProperties: false\n\n Conditiescore:\n type: object\n properties:\n voorWoning:\n type: string\n format: uri\n example: >-\n https://cwr.vmsw.vonet.be/api/v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}\n nullable: true\n magdaVoorWoning:\n type: string\n format: uri\n nullable: true\n description: Resource to be used on the MAGDA platform. This element is not present if the VMSW resource can not be parsed.\n gebouwstaat:\n $ref: '#/components/schemas/ConditiescoreCategorie'\n veiligheidEnGezondheid:\n $ref: '#/components/schemas/ConditiescoreCategorie'\n gebouwstaatScoreProcent:\n type: number\n format: double\n gebouwstaatWegingsfactorProcent:\n type: number\n format: double\n veiligheidEnGezondheidScoreProcent:\n type: number\n format: double\n veiligheidEnGezondheidWegingsfactorProcent:\n type: number\n format: double\n totaalScoreProcent:\n type: number\n format: double\n \n ConditiescoreResponse:\n type: object\n properties:\n '@context':\n type: string\n nullable: true\n '@id':\n type: string\n format: uri\n example: >-\n https://cwr.vmsw.vonet.be/api/v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}/conditiescore\n nullable: true\n '@magdaId':\n type: string\n format: uri\n nullable: true\n '@type':\n type: string\n default: ConditiescoreVoorWoningResource\n nullable: true\n value:\n $ref: '#/components/schemas/Conditiescore'\n\n ConditiescoreSimulatie:\n type: object\n properties:\n gebouwstaat:\n $ref: '#/components/schemas/ConditiescoreCategorie'\n veiligheidEnGezondheid:\n $ref: '#/components/schemas/ConditiescoreCategorie'\n gebouwstaatScoreProcent:\n type: number\n format: double\n gebouwstaatWegingsfactorProcent:\n type: number\n format: double\n veiligheidEnGezondheidScoreProcent:\n type: number\n format: double\n veiligheidEnGezondheidWegingsfactorProcent:\n type: number\n format: double\n totaalScoreProcent:\n type: number\n format: double\n additionalProperties: false\n\n ConditiescoreSimulatieResponse:\n type: object\n properties:\n '@context':\n type: string\n nullable: true\n '@id':\n type: string\n format: uri\n example: >-\n https://cwr.vmsw.vonet.be/api/v1/woonmaatschappijen/{organisatieId}/markthuurwaarden/simulatie#2023-04-13T16:15\n nullable: true\n '@type':\n type: string\n default: ConditiescoreSimulatieResource\n nullable: true\n value:\n $ref: '#/components/schemas/ConditiescoreSimulatie'\n additionalProperties: false\n\n #----------------------- END Conditiescore payloads ----------------------------\n\n #----------------------- START WoningKenmerken payloads -------------------------------\n WoningKenmerkScoreWijzigen:\n type: object\n properties:\n woningKenmerkScores:\n type: array\n items:\n $ref: '#/components/schemas/WoningKenmerkScoreWijziging'\n nullable: true\n additionalProperties: false\n WoningKenmerkScoresMetWoning:\n type: object\n properties:\n voorWoning:\n type: string\n format: uri\n example: /v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}\n nullable: true\n magdaVoorWoning:\n type: string\n format: uri\n nullable: true\n description: Resource to be used on the MAGDA platform. This element is not present if the VMSW resource can not be parsed.\n scores:\n type: array\n items:\n $ref: '#/components/schemas/WoningKenmerkScore'\n nullable: true\n additionalProperties: false\n WoningKenmerkScoresResponse:\n type: object\n properties:\n '@context':\n type: string\n nullable: true\n '@id':\n type: string\n format: uri\n example: /v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}/woningkenmerkscores\n nullable: true\n '@magdaId':\n type: string\n format: uri\n nullable: true\n '@type':\n type: string\n default: WoningKenmerkScoresMetWoningResource\n nullable: true\n value:\n $ref: '#/components/schemas/WoningKenmerkScoresMetWoning'\n additionalProperties: false\n WoningKenmerkCategorie:\n type: string\n enum:\n - Alles\n - Huurschatting\n - Energiecorrectie\n - Conditiemeting\n - ERP\n - PV forfait\n #----------------------- END WoningKenmerken payloads -------------------------------\n\n #----------------------- START Energiecorrectie payloads ----------------------------\n\n WoningEnergiecorrectieResponse:\n type: object\n properties:\n '@context':\n type: string\n nullable: true\n '@id':\n type: string\n format: uri\n example: '{requestUrl}'\n nullable: true\n '@magdaId':\n type: string\n format: uri\n nullable: true\n '@type':\n type: string\n default: WoningEnergiecorrectieResource\n nullable: true\n value:\n $ref: '#/components/schemas/WoningEnergiecorrectieResource'\n additionalProperties: false\n WoningEnergiecorrectieResource:\n type: object\n properties:\n voorWoning:\n type: string\n format: uri\n example: /v1/woonmaatschappijen/{organisatieId}/woningen/{vmswWoningId}\n nullable: true\n magdaVoorWoning:\n type: string\n format: uri\n nullable: true\n referentieDatumHuur:\n type: string\n format: date\n epcGegevens:\n $ref: '#/components/schemas/EpcGegevensResource'\n woningKenmerkScores:\n $ref: '#/components/schemas/EnergiecorrectieWoningKenmerkScoresResource'\n voorPeriode:\n $ref: '#/components/schemas/EnergiecorrectieVoorPeriodeResource'\n additionalProperties: false\n EpcGegevensResource:\n type: object\n properties:\n certificaatNummer:\n type: string\n nullable: true\n epcType:\n enum:\n - EpcBestaand\n - EpcBouw\n type: string\n epcKengetal:\n type: number\n format: double\n ePeil:\n type: number\n format: double\n kPeil:\n type: number\n format: double\n datumEpc:\n type: string\n format: date\n beschermdVolume:\n type: number\n format: double\n totaleVerliesoppervlakte:\n type: number\n format: double\n gemiddeldeUWaardeSchil:\n type: number\n format: double\n energieVerbruikRuimteVerwarming:\n type: number\n format: double\n energieVerbruikSanitairWarmWater:\n type: number\n format: double\n brutoBruikbareVloerOppervlakte:\n type: number\n format: double\n totaleOppervlakteVensters:\n type: number\n format: double\n additionalProperties: false\n EnergiecorrectieWoningKenmerkScoresResource:\n type: object\n properties:\n energieDragerRuimteVerwarming:\n $ref: '#/components/schemas/WoningKenmerkScore'\n energieDragerSanitairWarmWater:\n $ref: '#/components/schemas/WoningKenmerkScore'\n additionalProperties: false\n EnergiecorrectieVoorPeriodeResource:\n type: object\n properties:\n datumVanaf:\n type: string\n format: date\n datumTot:\n type: string\n format: date\n dagenInPeriode:\n type: number\n format: double\n maandenInPeriode:\n type: number\n format: double\n bedragSanitairWarmWater:\n type: number\n format: double\n bedragRuimteVerwarming:\n type: number\n format: double\n bedragTotaalPeriode:\n type: number\n format: double\n bedragTotaalPerMaand:\n type: number\n format: double\n additionalProperties: false\n EpcVersie:\n type: string\n enum:\n - Huidig\n - Referentie\n #----------------------- END Energiecorrectie payloads ----------------------------\n\n #----------------------- START EPCWaarden payloads ----------------------------\n\n EpcVersiesResponse:\n type: object\n properties:\n '@context':\n type: string\n nullable: true\n '@id':\n type: string\n format: uri\n nullable: true\n '@magdaId':\n type: string\n format: uri\n nullable: true\n '@type':\n type: string\n nullable: true\n value:\n $ref: '#/components/schemas/EpcVersiesVoorWoningResource'\n additionalProperties: false\n EpcVersiesVoorWoningResource:\n type: object\n properties:\n '@type':\n type: string\n default: EpcVersiesVoorWoningResource\n nullable: true\n voorWoning:\n type: string\n nullable: true\n epcVersies:\n type: array\n items:\n $ref: '#/components/schemas/EpcVersieResource'\n nullable: true\n additionalProperties: false\n EpcVersieResource:\n type: object\n properties:\n '@type':\n type: string\n default: EpcVersieResource\n nullable: true\n id:\n type: integer\n format: int32\n status:\n type: string\n nullable: true\n isReferentieVersie:\n type: boolean\n epcWaarden:\n type: array\n items:\n $ref: '#/components/schemas/EpcWaardeResource'\n nullable: true\n epcWaardenBronDataReferentie:\n $ref: '#/components/schemas/EpcDocumentReferentieResource'\n epcWaardenDocumentReferenties:\n type: array\n items:\n $ref: '#/components/schemas/EpcDocumentReferentieResource'\n nullable: true\n opmerkingen:\n type: array\n items:\n $ref: '#/components/schemas/Opmerking'\n nullable: true\n additionalProperties: false\n EpcWaardeResource:\n type: object\n properties:\n '@type':\n type: string\n default: EpcWaardeResource\n nullable: true\n epcWaardeDefinitie:\n $ref: '#/components/schemas/EpcWaardeDefinitieResource'\n waarde:\n type: string\n nullable: true\n additionalProperties: false\n EpcDocumentReferentieResource:\n type: object\n properties:\n '@type':\n type: string\n nullable: true\n epcEenheidType:\n type: string\n nullable: true\n epcBestandsType:\n type: string\n nullable: true\n url:\n type: string\n nullable: true\n magdaUrl:\n type: string\n nullable: true\n additionalProperties: false\n Opmerking:\n type: object\n properties:\n '@type':\n type: string\n nullable: true\n typeOpmerking:\n type: string\n nullable: true\n bericht:\n type: string\n nullable: true\n additionalProperties: false\n EpcWaardeDefinitieResource:\n type: object\n properties:\n '@type':\n type: string\n default: EpcWaardeDefinitieResource\n nullable: true\n label:\n type: string\n nullable: true\n code:\n type: string\n nullable: true\n additionalProperties: false\n VekaEpcRequest:\n type: object\n properties:\n certificaatnummer:\n type: string\n nullable: true\n additionalProperties: false\n EpcVersieResponse:\n type: object\n properties:\n '@context':\n type: string\n nullable: true\n '@id':\n type: string\n format: uri\n nullable: true\n '@magdaId':\n type: string\n format: uri\n nullable: true\n '@type':\n type: string\n nullable: true\n value:\n $ref: '#/components/schemas/EpcVersieVoorWoningResource'\n additionalProperties: false\n EpcVersieVoorWoningResource:\n type: object\n properties:\n voorWoning:\n type: string\n nullable: true\n epcVersie:\n $ref: '#/components/schemas/EpcVersieResource'\n additionalProperties: false\n EpcReferentieVersieZetten:\n required:\n - epcVersieId\n - status\n type: object\n properties:\n status:\n minLength: 1\n type: string\n epcVersieId:\n type: integer\n format: int32\n additionalProperties: false\n\n\n #----------------------- END EPCWaarden payloads ----------------------------\n\n\n\n ErrorMessage:\n required:\n - detail\n - title\n type: object\n properties:\n type:\n type: string\n description: A URI reference that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be \"about:blank\".\n title:\n type: string\n description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.\n status:\n type: string\n description: The HTTP status code generated by the origin server for this occurrence of the problem.\n detail:\n type: string\n description: A human-readable explanation specific to this occurrence of the problem.\n instance:\n type: string\n description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n description: A representation of a generic error message\n\n securitySchemes:\n oauth2:\n type: apiKey\n description: \"Standard Authorization header using the Bearer scheme. Example: \\\"bearer {token}\\\"\"\n name: Authorization\n in: header\n"},"username":{"value":""},"order":{"value":""}},"macroMetadata":{"macroId":{"value":"08ffd50f-1a15-4366-83fc-8e5df2f8bc1a"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://swagger-open-api.dutchbeginners.com/img/openapi-swagger-icon.png"}}],"title":"OpenAPI (Swagger) documentation integration"}},"localId":"2d3a78de-3eb3-403a-a521-ccacce43170b"}}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Werk","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Verrichtingen","type":"text"}]},{"type":"mediaGroup","content":[{"type":"media","attrs":{"id":"1c7c558d-65da-4c19-b799-adfd9e75fd23","collection":"contentId-6118410708","type":"file"}}]},{"type":"paragraph"},{"type":"expand","attrs":{"title":"Klik hier om de inhoud te bekijken"},"content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"swagger-open-api-macro","parameters":{"macroParams":{"displayOperationId":{"value":"false"},"methods":{"value":"none,get,put,post,delete,options,head,patch,trace"},"validator":{"value":""},"defaultModelsExpandDepth":{"value":"1"},"url":{"value":""},"token":{"value":""},"defaultModelRendering":{"value":"example"},"filter":{"value":""},"password":{"value":""},"expand":{"value":"list"},"showCommonExtensions":{"value":"false"},"filename":{"value":""},"operations":{"value":""},"maxDisplayedTags":{"value":""},"attach":{"value":"false"},"showExtensions":{"value":"false"},"displayRequestDuration":{"value":"false"},"__bodyContent":{"value":"openapi: 3.0.3\ninfo:\n title: werk.verrichtingen Service\n description: ''\n contact:\n name: werk.verrichtingenAPI\n email: helpdesk.magda@vlaanderen.be\n license:\n name: werk.verrichtingenAPI\n url: 'https://overheid.vlaanderen.be/magda'\n version: '1.0'\nservers:\n - url: /api/v1/werk\ntags:\n - name: verrichtingen\npaths:\n /verrichtingen:\n get:\n tags:\n - verrichtingen\n summary: opvragen verrichtingen voor een persoon/maatregel/fiscaal jaar\n description: Jobbonus plus voor zelfstandigen is een maatregel die door DWSE in samenwerking met Digitaal Vlaanderen\n operationId: verrichtingen\n parameters:\n - name: x-correlation-id\n in: header\n required: true\n schema:\n $ref: '#/components/schemas/Correlation-Id'\n - in: header\n name: x-insz\n schema:\n $ref: '#/components/schemas/InsznummerHeader'\n description: het insznummer waarvoor de verrichting informatie bevraagd wordt\n required: true\n - in: query\n name: maatregel\n schema:\n $ref: '#/components/schemas/Maatregel'\n required: false\n description: de maatregel waarvoor de verrichting informatie bevraagd wordt\n - in: query\n name: fiscaalJaar\n schema:\n $ref: '#/components/schemas/FiscaalJaar'\n description: Het fiscale jaar waarvoor de verrichtingen moeten opgehaald worden\n required: false\n\n responses:\n \"200\":\n description: Lijst van de verrichtingen voor een persoon per fiscaal jaar\n content:\n application/json:\n schema:\n $ref: '#/components/schemas/GetVerrichtingDto'\n '400':\n $ref: '#/components/responses/BadRequest'\n '401':\n $ref: '#/components/responses/InvalidAuthorization'\n '403':\n $ref: '#/components/responses/NoAttestationAuthorization'\

Browser not supported