Page Comparison

openapi: "3.0.2"
info:
  title: "Asbestattesten"
  description: "Deze dienst maakt het mogelijk om asbestattesten op te vragen uit het asbestinventatris bij OVAM"
  contact:
    name: "Magda helpdesk"
    url: "https://overheid.vlaanderen.be/magda"
  license:
    name: "Asbestinventaris"
    url: "https://overheid.vlaanderen.be/magda"
  version: "1.0.0"
servers:
  - url: "api/v1/milieu"
paths:
  /attesten/asbestattesten/gebouweenheden/{gebouweenheidId}:
    get:
      tags:
        - "asbestattesten"
      summary: "Het asbestId opbragen op basis van de gebouweenheidsId"
      parameters:
        - name: gebouweenheidId
          in: path
          required: true
          description: "Id van de gebouweenheid waarvoor gegevens opgevraagd worden"
          schema:
            type: string
        - name: x-correlation-id
          in: header
          required: true
          schema:
            $ref: '#/components/schemas/Correlation-Id'
      responses:
        200:
          description: "Response met inhoud"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GebouwEenheidSummary"
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/InvalidAuthorization'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/UnexpectedServerError'
        502:
          $ref: '#/components/responses/BadGateway'
        503:
          $ref: '#/components/responses/ServiceUnavailable'
        504:
          $ref: '#/components/responses/GatewayTimeout'

  /attesten/asbestattesten/{asbestinventarisId}:
    get:
      tags:
        - "asbestattesten"
      summary: "details van een attest opvragen in JSON formaat"
      parameters:
        - name: asbestinventarisId
          in: path
          required: true
          description: "Id van de asbestinventaris waarvoor gegevens opgevraagd worden"
          schema:
            type: string
            format: uuid
        - name: x-correlation-id
          in: header
          required: true
          schema:
            $ref: '#/components/schemas/Correlation-Id'
      responses:
        200:
          description: "Response met inhoud in JSON formaat van een asbestattest"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Asbestinventaris"
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/InvalidAuthorization'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/UnexpectedServerError'
        502:
          $ref: '#/components/responses/BadGateway'
        503:
          $ref: '#/components/responses/ServiceUnavailable'
        504:
          $ref: '#/components/responses/GatewayTimeout'

  /attesten/asbestattesten/{asbestinventarisId}/attest:
    get:
      tags:
        - "asbestattesten"
      summary: "het attest opvragen in PDF formaat"
      parameters:
        - name: asbestinventarisId
          in: path
          required: true
          description: "Id van de asbestinventaris waarvoor het attest opgevraagd wordt"
          schema:
            type: string
            format: uuid
        - name: x-correlation-id
          in: header
          required: true
          schema:
            $ref: '#/components/schemas/Correlation-Id'
      responses:
        200:
          description: "Het pdf attest horende bij de asbestinventaris"
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/InvalidAuthorization'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/UnexpectedServerError'
        502:
          $ref: '#/components/responses/BadGateway'
        503:
          $ref: '#/components/responses/ServiceUnavailable'
        504:
          $ref: '#/components/responses/GatewayTimeout'
  
  /attesten/asbestattesten:
    get:
      tags:
        - "asbestattesten"
      summary: "Zoek inventarissen"
      parameters:
        - name: x-correlation-id
          in: header
          required: true
          schema:
            $ref: '#/components/schemas/Correlation-Id'
        - name: geowkt
          in: query
          description: "Geometrie waarbinnen asbestinventarissen worden gezocht. Geeft alle resultaten die voor meer dan 5% binnen de geometrie liggen. Coördinatensysteem (`crs`) is verplicht."
          schema:
            type: string
          example: POLYGON((154986.030215235 190913.00871922178,154987.5279744013 190914.9131133676,154989.21246565756 190913.72696459584,154987.87177998378 190911.86510712252,154986.030215235 190913.00871922178))
        - name: crs
          in: query
          description: "Coördinatensysteem van `geowkt` waarbinnen asbestinventarissen worden gezocht"
          schema:
            type: string
          example: "EPSG:31370"
        - name: gemeentecode
          in: query
          description: "Gemeentecode van het perceel van de asbestinventaris. `afdelingscode`, `sectiecode`, `perceelnummer` zijn ook vereist."
          schema:
            type: string
          example: "44040"
        - name: afdelingcode
          in: query
          description: "Afdelingscode van het perceel van de asbestinventaris. `gemeentecode`, `sectiecode`, `perceelnummer` zijn ook vereist."
          schema:
            type: string
          example: "44040"
        - name: sectiecode
          in: query
          description: "Sectiecode van het perceel van de asbestinventaris. `gemeentecode`, `afdelingscode`, `perceelnummer` zijn ook vereist."
          schema:
            type: string
          example: "A"
        - name: perceelnummer
          in: query
          description: "Perceelnummer van het perceel van de asbestinventaris.`gemeentecode`, `afdelingscode`, `sectiecode` zijn ook vereist."
          schema:
            type: string
          example: "0297/00K000"
        - name: gemeentenaam
          in: query
          description: "Gemeentenaam van het adres van de asbestinventaris. `postcode`, `straatnaam`, `huisnummer` zijn ook vereist."
          schema:
            type: string
        - name: postcode
          in: query
          description: "Postcode van het adres van de asbestinventaris. `gemeentenaam`, `straatnaam`, `huisnummer` zijn ook vereist."
          schema:
            type: string
        - name: straatnaam
          in: query
          description: "Straatnaam van het adres van de asbestinventaris. `gemeentenaam`, `postcode`, `huisnummer` zijn ook vereist."
          schema:
            type: string
        - name: huisnummer
          in: query
          description: "Huisnummer van het adres van de asbestinventaris. `gemeentenaam`, `postcode`, `straatnaam` zijn ook vereist."
          schema:
            type: string
        - name: busnummer
          in: query
          description: "Busnummers van het adres van de asbestinventaris. Optionele parameter. Als het ingevuld is, zijn `gemeentenaam`,`postcode`, `straatnaam`, `huisnummer` ook vereist."
          schema:
            type: array
            items:
              type: string
            example:
              - "001"
              - "002"
              - "003"
        - name: vbradresid
          in: query
          description: "VBR adres ID van de asbestinventaris"
          schema:
            type: string
          example: "https://data.vlaanderen.be/id/adres/16256079"
      responses:
        200:
          description: "Alle overeenkomstige inventarissen."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Asbestinventarissen"
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/InvalidAuthorization'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/UnexpectedServerError'
        502:
          $ref: '#/components/responses/BadGateway'
        503:
          $ref: '#/components/responses/ServiceUnavailable'
        504:
          $ref: '#/components/responses/GatewayTimeout'

  /attesten/asbestattesten/analyserapport/{analyseRapportId}:
    get:
      tags:
        - "asbestattesten"
      summary: "Download een analyserapport"
      parameters:
        - name: x-correlation-id
          in: header
          required: true
          schema:
            $ref: '#/components/schemas/Correlation-Id'
        - name: analyseRapportId
          in: path
          required: true
          description: "Id van het analyserapport"
          schema:
            type: string
            format: uuid
      responses:
        200:
          description: "Een analyserapport in pdf dat geüpload werd door de deskundige"
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/InvalidAuthorization'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/UnexpectedServerError'
        502:
          $ref: '#/components/responses/BadGateway'
        503:
          $ref: '#/components/responses/ServiceUnavailable'
        504:
          $ref: '#/components/responses/GatewayTimeout'

components:
  parameters:
    CorrelationId:
      name: x-correlation-id
      in: header
      required: true
      schema:
        $ref: '#/components/schemas/Correlation-Id'
  responses:
    #HTTP Status 400
    BadRequest:
      description: "Invalid data supplied"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 401
    InvalidAuthorization:
      description: "Invalid authorization"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 403
    Forbidden:
      description: "Authentication failed"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 404
    NotFound:
      description: "Resource not found"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 412
    PreConditionFailed:
      description: Precondition Failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 500
    UnexpectedServerError:
      description: "Unexpected Server Error"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 502
    BadGateway:
      description: "Bad Gateway"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 503
    ServiceUnavailable:
      description: "Service unavailable"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
    #HTTP Status 504
    GatewayTimeout:
      description: "Gateway Timeout"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorMessage'
  schemas:
    Correlation-Id:
      description: "ID of the transaction. Use this ID for log tracing and incident handling"
      type: string
      minLength: 10
      maxLength: 36

    GebouwEenheidSummary:
      description: "Beschrijving van de gebouweenheid zoals gekend binnen de asbestinventaris applicatie"
      properties:
        inventarissen:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid

    Asbestinventarissen:
      description: "Overzicht van de overeenkomstige asbestinventarissen zoals gekend binnen de asbestinventaris applicatie"
      properties:
        inventarissen:
          $ref: '#/components/schemas/Inventarissen'

    Inventarissen:
      type: array
      items:
        type: object
        properties:
          id:
            type: string
            format: uuid

    Asbestinventaris:
      description: "Details van een inventaris"
      type: object
      properties:
        id:
          type: string
          format: uuid
        attestNummer:
          type: string
        locatieBeschrijving:
          type: string
          description: "Betreft slechts een indicatie van de locatie. Het bevat niet de officiële locatiegegevens van de overheid"
        resultaat:
          type: string
        aanleiding:
          type: string
        gemeenschappelijkDeel:
          type: boolean
        gemeenschappelijkeDelen:
          type: array
          items:
            $ref: '#/components/schemas/GemeenschappelijkDeel'
        analyseRapporten:
          type: array
          items:
            $ref: '#/components/schemas/AnalyseRapport'
        uitgegevenOp:
          type: string
          format: date
        geldigTot:
          type: string
          format: date
        attest:
          type: object
          properties:
            id:
              type: string
              format: uuid
        aantalAsbestmaterialen:
          type: integer
        aantalBeperkingen:
          type: integer
        aantalUitsluitingen:
          type: integer
        asbestmaterialen:
          type: array
          items:
            $ref: '#/components/schemas/Asbestmateriaal'

    GemeenschappelijkDeel:
      description: 'Identificator naar het gemeenschappelijk deel'
      type: object
      properties:
        type:
          type: string
        id:
          type: string
          format: uuid

    AnalyseRapport:
      description: 'Identificator naar het analyse rapport'
      type: object
      properties:
        type:
          type: string
        id:
          type: string
          format: uuid

    Asbestmateriaal:
      description: 'Identificator naar het asbestmateriaal'
      type: object
      properties:
        type:
          type: string
        id:
          type: string
          format: uuid

    ErrorMessage:
      required:
        - detail
        - title
      type: object
      properties:
        type:
          type: string
          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."
        title:
          type: string
          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."
        status:
          type: string
          description: "The HTTP status code generated by the origin server for this occurrence of the problem."
        detail:
          type: string
          description: "A human-readable explanation specific to this occurrence of the problem."
        instance:
          type: string
          description: "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if de-referenced."
      description: "A representation of a generic error message."

openapi: "3.0.2"
info:
  title: "Verenigingen"
  description: "Een api voor het beheer van een (feitelijke) verenigingen voor verenigingsregister"
  contact:
    name: "Magda helpdesk"
    url: "https://overheid.vlaanderen.be/magda"
  license:
    name: "Verenigingen"
    url: "https://overheid.vlaanderen.be/magda"
  version: "1.0.0"
servers:
  - url: "api/v1/organisaties"

paths:
  /verenigingen/verenigingen/{vCode}:
    get:
      tags:
        - Opvragen van verenigingen
      summary: Vraag het detail van een vereniging op.
      parameters:
        - name: vCode
          in: path
          description: De vCode van de vereniging
          required: true
          schema:
            type: string
        - name: expectedSequence
          in: query
          description: Sequentiewaarde verkregen bij creatie of aanpassing vereniging.
          schema:
            type: integer
            format: int64
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        200:
          description: Het detail van een vereniging
          headers:
            ETag:
              description: De versie van de aangepaste vereniging.
              schema:
                type: string
                description: De versie van de aangepaste vereniging.
                format: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.DetailVerenigingResponse
        400:
          $ref: "#/components/responses/BadRequest"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"

    patch:
      tags:
        - Decentraal beheer van verenigingen
      summary: Wijzig de basisgegevens van een vereniging.
      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."
      parameters:
        - name: vCode
          in: path
          description: De vCode van de vereniging
          required: true
          schema:
            type: string
        - name: If-Match
          in: header
          description: >-
            If-Match header met ETag van de laatst gekende versie van de
            vereniging.
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.WijzigBasisgegevens.FeitelijkeVereniging.RequestModels.WijzigBasisgegevensRequest
      responses:
        200:
          description: Er waren geen wijzigingen
        202:
          description: De basisgegevens van de vereniging werden gewijzigd
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de aangepaste vereniging.
              schema:
                type: string
                description: De versie van de aangepaste vereniging.
                format: ''
            Location:
              description: De locatie van de aangepaste vereniging.
              schema:
                type: string
                description: De locatie van de aangepaste vereniging.
                format: ''
        400:
          $ref: "#/components/responses/BadRequestValidation"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"

  /verenigingen/verenigingen/{vCode}/contactgegevens:
    post:
      tags:
        - Decentraal beheer van verenigingen
      summary: Voeg een contactgegeven toe.
      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."
      parameters:
        - name: vCode
          in: path
          description: De VCode van de vereniging
          required: true
          schema:
            type: string
        - name: If-Match
          in: header
          description: >-
            If-Match header met ETag van de laatst gekende versie van de
            vereniging.
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: Het toe te voegen contactgegeven
        content:
          application/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.FeitelijkeVereniging.VoegContactGegevenToe.RequestsModels.VoegContactgegevenToeRequest
      responses:
        202:
          description: Het contactgegeven werd goedgekeurd.
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de geregistreerde vereniging.
              schema:
                type: string
                description: De versie van de geregistreerde vereniging.
                format: ''
            Location:
              description: De locatie van de toegevoegde contactgegeven.
              schema:
                type: string
                description: De locatie van de toegevoegde contactgegeven.
                format: ''
        400:
          $ref: "#/components/responses/BadRequestValidation"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"

  /verenigingen/verenigingen/{vCode}/contactgegevens/{contactgegevenId}:
    delete:
      tags:
        - Decentraal beheer van verenigingen
      summary: Verwijder een contactgegeven.
      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."
      parameters:
        - name: vCode
          in: path
          description: De unieke identificatie code van deze vereniging
          required: true
          schema:
            type: string
        - name: contactgegevenId
          in: path
          description: >-
            De unieke identificatie code van dit contactgegeven binnen de
            vereniging
          required: true
          schema:
            type: integer
            format: int32
        - name: If-Match
          in: header
          description: >-
            If-Match header met ETag van de laatst gekende versie van de
            vereniging.
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '202':
          description: Het contactgegeven werd verwijderd.
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de geregistreerde vereniging.
              schema:
                type: string
                description: De versie van de geregistreerde vereniging.
                format: ''
        400:
          $ref: "#/components/responses/BadRequestValidation"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"

    patch:
      tags:
        - Decentraal beheer van verenigingen
      summary: Wijzig een contactgegeven.
      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."
      parameters:
        - name: vCode
          in: path
          description: De unieke identificatie code van deze vereniging
          required: true
          schema:
            type: string
        - name: contactgegevenId
          in: path
          description: >-
            De unieke identificatie code van dit contactgegeven binnen de
            vereniging
          required: true
          schema:
            type: integer
            format: int32
        - name: If-Match
          in: header
          description: >-
            If-Match header met ETag van de laatst gekende versie van de
            vereniging.
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: Het te wijzigen contactgegeven
        content:
          application/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.FeitelijkeVereniging.WijzigContactgegeven.RequestModels.WijzigContactgegevenRequest
      responses:
        '200':
          description: Er waren geen wijzigingen.
        '202':
          description: De wijziging werd aanvaard.
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de geregistreerde vereniging.
              schema:
                type: string
                description: De versie van de geregistreerde vereniging.
                format: ''
        400:
          $ref: "#/components/responses/BadRequestValidation"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"

  /verenigingen/verenigingen/{vCode}/historiek:
    get:
      tags:
        - Opvragen van verenigingen
      summary: Vraag de historiek van een vereniging op.
      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”."
      parameters:
        - name: vCode
          in: path
          description: De vCode van de vereniging
          required: true
          schema:
            type: string
        - name: expectedSequence
          in: query
          description: Sequentiewaarde verkregen bij creatie of aanpassing vereniging.
          schema:
            type: integer
            format: int64
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: De historiek van een vereniging
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Historiek.ResponseModels.HistoriekResponse
        400:
          $ref: "#/components/responses/BadRequest"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"
  /verenigingen/verenigingen/{vCode}/kbo:
    patch:
      tags:
        - Wijzigen van gegevens uit KBO
      summary: Wijzig de basisgegevens.
      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."
      parameters:
        - name: vCode
          in: path
          description: De vCode van de vereniging
          required: true
          schema:
            type: string
        - name: If-Match
          in: header
          description: >-
            If-Match header met ETag van de laatst gekende versie van de
            vereniging.
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.WijzigBasisgegevens.MetRechtspersoonlijkheid.RequestModels.WijzigBasisgegevensRequest
      responses:
        '200':
          description: Er waren geen wijzigingen
        '202':
          description: De basisgegevens van de vereniging werden gewijzigd
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de aangepaste vereniging.
              schema:
                type: string
                description: De versie van de aangepaste vereniging.
                format: ''
            Location:
              description: De locatie van de aangepaste vereniging.
              schema:
                type: string
                description: De locatie van de aangepaste vereniging.
                format: ''
        400:
          $ref: "#/components/responses/BadRequest"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"
  /verenigingen/verenigingen/{vCode}/kbo/contactgegevens/{contactgegevenId}:
    patch:
      tags:
        - Wijzigen van gegevens uit KBO
      summary: Wijzig een contactgegeven uit KBO.
      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."
      parameters:
        - name: vCode
          in: path
          description: De unieke identificatie code van deze vereniging
          required: true
          schema:
            type: string
        - name: contactgegevenId
          in: path
          description: >-
            De unieke identificatie code van dit contactgegeven binnen de
            vereniging
          required: true
          schema:
            type: integer
            format: int32
        - name: If-Match
          in: header
          description: >-
            If-Match header met ETag van de laatst gekende versie van de
            vereniging.
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: Het te wijzigen contactgegeven
        content:
          application/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.VerenigingMetRechtspersoonlijkheid.WijzigContactgegeven.RequestModels.WijzigContactgegevenRequest
      responses:
        '200':
          description: Er waren geen wijzigingen.
        '202':
          description: De wijziging werd aanvaard.
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de geregistreerde vereniging.
              schema:
                type: string
                description: De versie van de geregistreerde vereniging.
                format: ''
        400:
          $ref: "#/components/responses/BadRequest"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"
  /verenigingen/verenigingen/{vCode}/kbo/locaties/{locatieId}:
    patch:
      tags:
        - Wijzigen van gegevens uit KBO
      summary: Wijzig de maatschappelijke zetel volgens KBO.
      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."
      parameters:
        - name: vCode
          in: path
          description: De VCode van de vereniging
          required: true
          schema:
            type: string
        - name: locatieId
          in: path
          description: >-
            De unieke identificatie code van de maatschappelijke zetel volgens
            KBO binnen de vereniging.
          required: true
          schema:
            type: integer
            format: int32
        - name: If-Match
          in: header
          description: >-
            If-Match header met ETag van de laatst gekende versie van de
            vereniging.
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: De te wijzigen gegevens
        content:
          application/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Locaties.VerenigingMetRechtspersoonlijkheid.WijzigMaatschappelijkeZetel.RequestModels.WijzigMaatschappelijkeZetelRequest
            example:
              locatie:
                isPrimair: true
                naam: Naam locatie
      responses:
        '200':
          description: Er waren geen wijzigingen.
        '202':
          description: De locatie werd gewijzigd.
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de geregistreerde vereniging.
              schema:
                type: string
                description: De versie van de geregistreerde vereniging.
                format: ''
        400:
          $ref: "#/components/responses/BadRequest"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"

  /verenigingen/verenigingen/{vCode}/locaties:
    post:
      tags:
        - Decentraal beheer van verenigingen
      summary: Voeg een locatie toe.
      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."
      parameters:
        - name: vCode
          in: path
          description: De VCode van de vereniging
          required: true
          schema:
            type: string
        - name: If-Match
          in: header
          description: >-
            If-Match header met ETag van de laatst gekende versie van de
            vereniging.
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: De toe te voegen locatie
        content:
          application/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Locaties.FeitelijkeVereniging.VoegLocatieToe.RequestModels.VoegLocatieToeRequest
      responses:
        '202':
          description: De locatie werd goedgekeurd.
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de geregistreerde vereniging.
              schema:
                type: string
                description: De versie van de geregistreerde vereniging.
                format: ''
            Location:
              description: De locatie van de toegevoegde locatie.
              schema:
                type: string
                description: De locatie van de toegevoegde locatie.
                format: ''
        400:
          $ref: "#/components/responses/BadRequestValidation"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"

  /verenigingen/verenigingen/{vCode}/locaties/{locatieId}:
    delete:
      tags:
        - Decentraal beheer van verenigingen
      summary: Verwijder een locatie.
      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."
      parameters:
        - name: vCode
          in: path
          description: De unieke identificatie code van deze vereniging
          required: true
          schema:
            type: string
        - name: locatieId
          in: path
          description: >-
            De unieke identificatie code van deze locatie die verwijderd moet
            worden
          required: true
          schema:
            type: integer
            format: int32
        - name: If-Match
          in: header
          description: >-
            If-Match header met ETag van de laatst gekende versie van de
            vereniging.
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '202':
          description: De vertegenwoordiger werd verwijderd van deze vereniging.
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de geregistreerde vereniging.
              schema:
                type: string
                description: De versie van de geregistreerde vereniging.
                format: ''
        400:
          $ref: "#/components/responses/BadRequestValidation"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"

    patch:
      tags:
        - Decentraal beheer van verenigingen
      summary: Wijzig een locatie.
      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."
      parameters:
        - name: vCode
          in: path
          description: De VCode van de vereniging
          required: true
          schema:
            type: string
        - name: locatieId
          in: path
          description: De unieke identificatie code van deze locatie binnen de vereniging.
          required: true
          schema:
            type: integer
            format: int32
        - name: If-Match
          in: header
          description: >-
            If-Match header met ETag van de laatst gekende versie van de
            vereniging.
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: De te wijzigen locatie
        content:
          application/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Locaties.FeitelijkeVereniging.WijzigLocatie.RequestModels.WijzigLocatieRequest
      responses:
        '200':
          description: Er waren geen wijzigingen.
        '202':
          description: De locatie werd goedgekeurd.
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de geregistreerde vereniging.
              schema:
                type: string
                description: De versie van de geregistreerde vereniging.
                format: ''
        400:
          $ref: "#/components/responses/BadRequestValidation"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"
  /verenigingen/verenigingen/{vCode}/stop:
    post:
      tags:
        - Decentraal beheer van verenigingen
      summary: Stoppen van een vereniging.
      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."
      parameters:
        - name: vCode
          in: path
          description: De vCode van de vereniging
          required: true
          schema:
            type: string
        - name: If-Match
          in: header
          description: >-
            If-Match header met ETag van de laatst gekende versie van de
            vereniging.
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Stop.RequestModels.StopVerenigingRequest
      responses:
        '200':
          description: Er waren geen wijzigingen
        '202':
          description: De vereniging werd gestopt
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de aangepaste vereniging.
              schema:
                type: string
                description: De versie van de aangepaste vereniging.
                format: ''
            Location:
              description: De locatie van de aangepaste vereniging.
              schema:
                type: string
                description: De locatie van de aangepaste vereniging.
                format: ''
        400:
          $ref: "#/components/responses/BadRequestValidation"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"

  /verenigingen/verenigingen/{vCode}/vertegenwoordigers:
    post:
      tags:
        - Decentraal beheer van verenigingen
      summary: Voeg een vertegenwoordiger toe.
      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."
      parameters:
        - name: vCode
          in: path
          description: De vCode van de vereniging
          required: true
          schema:
            type: string
        - name: If-Match
          in: header
          description: >-
            If-Match header met ETag van de laatst gekende versie van de
            vereniging.
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: De gegevens van de toe te voegen vertegenwoordiger
        content:
          application/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Vertegenwoordigers.FeitelijkeVereniging.VoegVertegenwoordigerToe.RequestModels.VoegVertegenwoordigerToeRequest
      responses:
        '202':
          description: De vertegenwoordiger werd toegevoegd.
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de geregistreerde vereniging.
              schema:
                type: string
                description: De versie van de geregistreerde vereniging.
                format: ''
            Location:
              description: De locatie van de toegevoegde vertegenwoordiger.
              schema:
                type: string
                description: De locatie van de toegevoegde vertegenwoordiger.
                format: ''
        400:
          $ref: "#/components/responses/BadRequestValidation"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"

  /verenigingen/verenigingen/{vCode}/vertegenwoordigers/{vertegenwoordigerId}:
    delete:
      tags:
        - Decentraal beheer van verenigingen
      summary: Verwijder een vertegenwoordiger.
      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."
      parameters:
        - name: vCode
          in: path
          description: De unieke identificatie code van deze vereniging
          required: true
          schema:
            type: string
        - name: vertegenwoordigerId
          in: path
          description: >-
            De unieke identificatie code van deze vertegenwoordiger die
            verwijderd moet worden
          required: true
          schema:
            type: integer
            format: int32
        - name: If-Match
          in: header
          description: >-
            If-Match header met ETag van de laatst gekende versie van de
            vereniging.
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '202':
          description: De vertegenwoordiger werd verwijderd van deze vereniging.
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de geregistreerde vereniging.
              schema:
                type: string
                description: De versie van de geregistreerde vereniging.
                format: ''
        400:
          $ref: "#/components/responses/BadRequestValidation"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"

    patch:
      tags:
        - Decentraal beheer van verenigingen
      summary: Wijzig een vertegenwoordiger.
      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."
      parameters:
        - name: vCode
          in: path
          description: De unieke identificatie code van deze vereniging
          required: true
          schema:
            type: string
        - name: vertegenwoordigerId
          in: path
          description: >-
            De unieke identificatie code van deze vertegenwoordiger binnen de
            vereniging
          required: true
          schema:
            type: integer
            format: int32
        - name: If-Match
          in: header
          description: >-
            If-Match header met ETag van de laatst gekende versie van de
            vereniging.
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: De gegevens van de vertegenwoordiger die gewijzigd moeten worden
        content:
          application/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Vertegenwoordigers.FeitelijkeVereniging.WijzigVertegenwoordiger.RequestModels.WijzigVertegenwoordigerRequest
      responses:
        '200':
          description: Er waren geen wijzigingen.
        '202':
          description: De vertegenwoordiger werd gewijzigd.
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de geregistreerde vereniging.
              schema:
                type: string
                description: De versie van de geregistreerde vereniging.
                format: ''
        400:
          $ref: "#/components/responses/BadRequestValidation"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"

  /verenigingen/verenigingen/feitelijkeverenigingen:
    post:
      tags:
        - Registratie
      summary: Registreer een feitelijke vereniging.
      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."
      parameters:
        - name: VR-BevestigingsToken
          in: header
          description: "Dit token wordt gebruikt als bevestiging dat de vereniging uniek is,\r\n            ondanks de voorgestelde duplicaten."
          schema:
            type: string
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: De gegevens van de te registreren vereniging
        content:
          application/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.FeitelijkeVereniging.RequetsModels.RegistreerFeitelijkeVerenigingRequest
      responses:
        '202':
          description: De feitelijke vereniging werd geregistreerd.
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de geregistreerde vereniging.
              schema:
                type: string
                description: De versie van de geregistreerde vereniging.
                format: ''
            Location:
              description: De locatie van de geregistreerde vereniging.
              schema:
                type: string
                description: De locatie van de geregistreerde vereniging.
                format: ''
        400:
          $ref: "#/components/responses/BadRequestValidation"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        409:
          description: >-
            Er zijn één of meerdere mogelijke duplicaten van deze vereniging
            gevonden.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.PotentialDuplicatesResponse
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"
  /verenigingen/verenigingen/kbo:
    post:
      tags:
        - Registratie
      summary: Registreer een vereniging met rechtspersoonlijkheid vanuit de KBO.
      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."
      parameters:
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        description: De gegevens van de te registreren vereniging
        content:
          application/json:
            schema:
              allOf:
                - $ref: >-
                    #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.MetRechtspersoonlijkheid.RequestModels.RegistreerVerenigingUitKboRequest
      responses:
        '200':
          description: De vereniging was reeds geregistreerd in het register.
          headers:
            Location:
              description: De locatie van de geregistreerde vereniging.
              schema:
                type: string
                description: De locatie van de geregistreerde vereniging.
                format: ''
        '202':
          description: De vereniging met rechtspersoonlijkheid werd geregistreerd.
          headers:
            VR-Sequence:
              description: Het sequence nummer van deze request.
              schema:
                type: string
                description: Het sequence nummer van deze request.
                format: ''
            ETag:
              description: De versie van de geregistreerde vereniging.
              schema:
                type: string
                description: De versie van de geregistreerde vereniging.
                format: ''
            Location:
              description: De locatie van de geregistreerde vereniging.
              schema:
                type: string
                description: De locatie van de geregistreerde vereniging.
                format: ''
        400:
          $ref: "#/components/responses/BadRequestValidation"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"

  /verenigingen/verenigingen/zoeken:
    get:
      tags:
        - Opvragen van verenigingen
      summary: Zoek verenigingen op.
      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."
      parameters:
        - name: q
          in: query
          description: De querystring
          schema:
            type: string
        - name: sort
          in: query
          description: De velden om op te sorteren
          schema:
            type: string
        - name: offset
          in: query
          description: Het aantal items dat overgeslagen zal worden
          schema:
            type: integer
            format: int32
        - name: limit
          in: query
          description: Het aantal items dat (maximaal) zal worden opgehaald
          schema:
            type: integer
            format: int32
        - name: X-Correlation-Id
          in: header
          description: Deze id identificeert de request.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Indien de zoekopdracht succesvol was.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.SearchVerenigingenResponse
        400:
          $ref: "#/components/responses/BadRequestValidation"
        401:
          $ref: "#/components/responses/InvalidAuthorization"
        403:
          $ref: "#/components/responses/Forbidden"
        404:
          $ref: "#/components/responses/NotFound"
        412:
          $ref: "#/components/responses/PreConditionFailed"
        500:
          $ref: "#/components/responses/UnexpectedServerError"
        502:
          $ref: "#/components/responses/BadGateway"
        503:
          $ref: "#/components/responses/ServiceUnavailable"
        504:
          $ref: "#/components/responses/GatewayTimeout"
components:
  responses:
    #HTTP Status 400
    BadRequest:
      description: "Invalid data supplied"
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails

    BadRequestValidation:
      description: "Invalid data supplied"
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ValidationProblemDetails
    #HTTP Status 401
    InvalidAuthorization:
      description: "Invalid authorization"
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails
    #HTTP Status 403
    Forbidden:
      description: "Authentication failed"
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails
    #HTTP Status 404
    NotFound:
      description: "Resource not found"
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails
    #HTTP Status 412
    PreConditionFailed:
      description: "Precondition Failed"
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails
    #HTTP Status 500
    UnexpectedServerError:
      description: "Unexpected Server Error"
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails
    #HTTP Status 502
    BadGateway:
      description: "Bad Gateway"
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails
    #HTTP Status 503
    ServiceUnavailable:
      description: "Service unavailable"
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails
    #HTTP Status 504
    GatewayTimeout:
      description: "Gateway Timeout"
      content:
        application/json:
          schema:
            $ref: >-
              #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails
  schemas:
    AssociationRegistry.Admin.Api.Verenigingen.Common.Adres:
      type: object
      properties:
        straatnaam:
          type: string
          description: De straat van het adres
        huisnummer:
          type: string
          description: Het huisnummer van het adres
        busnummer:
          type: string
          description: Het busnummer van het adres
        postcode:
          type: string
          description: De postcode van het adres
        gemeente:
          type: string
          description: De gemeente van het adres
        land:
          type: string
          description: Het land van het adres
      additionalProperties: false
      description: Een adres van een locatie
    AssociationRegistry.Admin.Api.Verenigingen.Common.AdresId:
      type: object
      properties:
        broncode:
          type: string
          description: De code van de bron van het adres
        bronwaarde:
          type: string
          description: De unieke identificator volgens de bron
      additionalProperties: false
      description: De unieke identificator van het adres in een andere bron
    AssociationRegistry.Admin.Api.Verenigingen.Common.DoelgroepRequest:
      type: object
      properties:
        minimumleeftijd:
          maximum: 150
          minimum: 0
          type: integer
          description: De minimum leeftijd voor de doelgroep
          format: int32
          default: 0
        maximumleeftijd:
          maximum: 150
          minimum: 0
          type: integer
          description: De maximum leeftijd voor de doelgroep
          format: int32
          default: 150
      additionalProperties: false
      description: >-
        De doelgroep waar de activiteiten van deze vereniging zich op
        concentreert
    AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenContactgegeven:
      type: object
      properties:
        contactgegeventype:
          type: string
          description: "Het type contactgegeven\r\n\r\nMogelijke waarden:\r\n- E-mail\r\n- SocialMedia\r\n- Telefoon\r\n- Website"
          example: E-mail
        waarde:
          type: string
          description: De waarde van het contactgegeven
        beschrijving:
          maxLength: 128
          type: string
          description: >-
            Vrij veld die het het contactgegeven beschrijft (bijv: algemeen,
            administratie, ...)
        isPrimair:
          type: boolean
          description: Duidt het contactgegeven aan als primair contactgegeven
      additionalProperties: false
      description: Het toe te voegen contactgegeven
    AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenLocatie:
      type: object
      properties:
        locatietype:
          type: string
          description: "Het soort locatie dat beschreven wordt<br /><br />\r\nMogelijke waarden:<br />\r\n- Activiteiten<br />\r\n- Correspondentie - Slechtséén maal mogelijk<br />"
        isPrimair:
          type: boolean
          description: Duidt aan dat dit de primaire locatie is
        naam:
          maxLength: 128
          type: string
          description: Een beschrijvende naam voor de locatie
        adresId:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.AdresId
          description: De unieke identificator van het adres in een andere bron
        adres:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.Adres
          description: Het adres van de locatie
      additionalProperties: false
      description: Een locatie van een vereniging
    AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenVertegenwoordiger:
      type: object
      properties:
        insz:
          type: string
          description: >-
            Dit is de unieke identificatie van een vertegenwoordiger, dit kan
            een rijksregisternummer of bisnummer zijn
        voornaam:
          type: string
          description: De voornaam van de vertegenwoordiger
        achternaam:
          type: string
          description: De achternaam van de vertegenwoordiger
        rol:
          type: string
          description: Dit is de rol van de vertegenwoordiger binnen de vereniging
        roepnaam:
          type: string
          description: Dit is de roepnaam van de vertegenwoordiger
        isPrimair:
          type: boolean
          description: >-
            Dit duidt aan dat dit de unieke primaire contactpersoon is voor alle
            communicatie met overheidsinstanties
        e-mail:
          type: string
          description: Het e-mailadres van de vertegenwoordiger
        telefoon:
          type: string
          description: Het telefoonnummer van de vertegenwoordiger
        mobiel:
          type: string
          description: Het mobiel nummer van de vertegenwoordiger
        socialMedia:
          type: string
          description: Het socialmedia account van de vertegenwoordiger
      additionalProperties: false
      description: Een vertegenwoordiger van een vereniging
    AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.FeitelijkeVereniging.VoegContactGegevenToe.RequestsModels.VoegContactgegevenToeRequest:
      type: object
      properties:
        contactgegeven:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenContactgegeven
          description: Het toe te voegen contactgegeven
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.FeitelijkeVereniging.WijzigContactgegeven.RequestModels.TeWijzigenContactgegeven:
      type: object
      properties:
        waarde:
          type: string
          description: De waarde van het contactgegeven
        beschrijving:
          maxLength: 128
          type: string
          description: >-
            Vrij veld die het het contactgegeven beschrijft (bijv: algemeen,
            administratie, ...)
        isPrimair:
          type: boolean
          description: Duidt het contactgegeven aan als primair contactgegeven
      additionalProperties: false
      description: Het te wijzigen contactgegeven
    AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.FeitelijkeVereniging.WijzigContactgegeven.RequestModels.WijzigContactgegevenRequest:
      type: object
      properties:
        contactgegeven:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.FeitelijkeVereniging.WijzigContactgegeven.RequestModels.TeWijzigenContactgegeven
          description: Het te wijzigen contactgegeven
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.VerenigingMetRechtspersoonlijkheid.WijzigContactgegeven.RequestModels.TeWijzigenContactgegeven:
      type: object
      properties:
        beschrijving:
          maxLength: 128
          type: string
          description: >-
            Vrij veld die het het contactgegeven beschrijft (bijv: algemeen,
            administratie, ...)
        isPrimair:
          type: boolean
          description: Duidt het contactgegeven aan als primair contactgegeven
      additionalProperties: false
      description: Het te wijzigen contactgegeven
    AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.VerenigingMetRechtspersoonlijkheid.WijzigContactgegeven.RequestModels.WijzigContactgegevenRequest:
      type: object
      properties:
        contactgegeven:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Contactgegevens.VerenigingMetRechtspersoonlijkheid.WijzigContactgegeven.RequestModels.TeWijzigenContactgegeven
          description: Het te wijzigen contactgegeven
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Adres:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
        straatnaam:
          type: string
          description: De straat van de locatie
        huisnummer:
          type: string
          description: Het huisnummer van de locatie
        busnummer:
          type: string
          description: Het busnummer van de locatie
        postcode:
          type: string
          description: De postcode van de locatie
        gemeente:
          type: string
          description: De gemeente van de locatie
        land:
          type: string
          description: Het land van de locatie
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.AdresId:
      type: object
      properties:
        broncode:
          type: string
          description: De identificator voor dit adres bij de Adresbron
        bronwaarde:
          type: string
          description: De bron waar het AdresId naar verwijst
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.AdresVerwijzing:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Contactgegeven:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
        contactgegevenId:
          type: integer
          description: >-
            De unieke identificatie code van dit contactgegeven binnen de
            vereniging
          format: int32
        contactgegeventype:
          type: string
          description: Het type contactgegeven
        waarde:
          type: string
          description: De waarde van het contactgegeven
        beschrijving:
          maxLength: 128
          type: string
          description: >-
            Vrij veld die het het contactgegeven beschrijft (bijv: algemeen,
            administratie, ...)
        isPrimair:
          type: boolean
          description: Duidt het contactgegeven aan als primair contactgegeven
        bron:
          type: string
          description: "De bron die dit contactgegeven beheert\r\n           <br />\r\n               Mogelijke waarden:<br />\r\n               - Initiator<br />\r\n               - KBO"
      additionalProperties: false
      description: Een contactgegeven van een vereniging
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.DetailVerenigingResponse:
      type: object
      properties:
        '@context':
          type: string
          description: De JSON-LD open data context
        vereniging:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.VerenigingDetail
        metadata:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Metadata
          description: >-
            De metadata van de vereniging, deze bevat bv de datum van laatste
            aanpassing
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.DoelgroepResponse:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
        minimumleeftijd:
          type: integer
          description: De minimum leeftijd voor de doelgroep
          format: int32
        maximumleeftijd:
          type: integer
          description: De maximum leeftijd voor de doelgroep
          format: int32
      additionalProperties: false
      description: >-
        De doelgroep waar de activiteiten van deze vereniging zich op
        concentreert
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.GerelateerdeVereniging:
      type: object
      properties:
        kboNummer:
          type: string
          description: Het KBO nummer van de gerelateerde vereniging
        vCode:
          type: string
          description: >-
            De unieke identificator van de gerelateerde vereniging in het
            verenigingsregister
        naam:
          type: string
          description: De naam van de gerelateerde vereniging
        detail:
          type: string
          description: De link naar het beheer detail van de gerelateerde vereniging
        magdaDetail:
          type: string
          description: Magda naar het beheer detail van de gerelateerde vereniging
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.GestructureerdeIdentificator:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
        nummer:
          type: string
          description: De externe identificator van de vereniging in de bron
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.HoofdactiviteitVerenigingsloket:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
        code:
          type: string
          description: De code van de hoofdactivititeit
        naam:
          type: string
          description: De beschrijving van de hoofdactivititeit
      additionalProperties: false
      description: De hoofdactivititeit van een vereniging volgens het verenigingsloket
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Locatie:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
        locatieId:
          type: integer
          description: De unieke identificatie code van deze locatie binnen de vereniging
          format: int32
        locatietype:
          type: string
          description: "Het soort locatie dat beschreven wordt<br /><br />\r\nMogelijke waarden:<br />\r\n- Activiteiten<br />\r\n- Correspondentie - Slechts één maal mogelijk<br />\r\n- Maatschappelijke zetel volgens KBO - Enkel mogelijk voor verenigingen met rechtspersoonlijkheid<br />"
        isPrimair:
          type: boolean
          description: Duidt aan dat dit de primaire locatie is
        naam:
          type: string
          description: Een beschrijvende naam voor de locatie
        adres:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Adres
          description: De adrescomponenten van de locatie
        adresvoorstelling:
          type: string
          description: Een standaard geformatteerde weergave van het adres van de locatie
        adresId:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.AdresId
          description: De identifier van het adres op een externe bron
        verwijstNaar:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.AdresVerwijzing
          description: De verwijzing naar een adres in het adresregister
        bron:
          type: string
          description: "De bron die deze locatie beheert.\r\n            <br />\r\n                Mogelijke waarden:<br />\r\n                - Initiator<br />\r\n                - KBO"
      additionalProperties: false
      description: Een locatie van een vereniging
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Metadata:
      type: object
      properties:
        datumLaatsteAanpassing:
          type: string
          description: >-
            De datum waarop de laatste aanpassing uitgevoerd is op de gegevens
            van de vereniging
      additionalProperties: false
      description: >-
        De metadata van de vereniging, deze bevat bv de datum van laatste
        aanpassing
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Relatie:
      type: object
      properties:
        relatietype:
          type: string
          description: Het type relatie
        andereVereniging:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.GerelateerdeVereniging
          description: de gerelateerde vereniging
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Sleutel:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
        bron:
          type: string
          description: De bron van de sleutel
        waarde:
          type: string
          description: De externe identificator van de vereniging in de bron
        codeerSysteem:
          type: string
          description: het codeersysteem van de sleutel
        gestructureerdeIdentificator:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.GestructureerdeIdentificator
          description: De gestructureerde identificator
      additionalProperties: false
      description: >-
        Een uniek identificerende sleutel van deze vereniging in een externe
        bron
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.VerenigingDetail:
      type: object
      properties:
        '@type':
          type: string
          description: Het json-ld type
        vCode:
          type: string
          description: De unieke identificatie code van deze vereniging
        corresponderendeVCodes:
          type: array
          items:
            type: string
        verenigingstype:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.VerenigingsType
          description: Het type van deze vereniging
        naam:
          type: string
          description: Naam van de vereniging
        roepnaam:
          type: string
          description: >-
            Roepnaam van de vereniging. Dit veld is enkel aanwezig bij
            verenigingen met rechtspersoonlijkheid
          default: null
        korteNaam:
          type: string
          description: Korte naam van de vereniging
        korteBeschrijving:
          type: string
          description: Korte beschrijving van de vereniging
        startdatum:
          type: string
          description: Datum waarop de vereniging gestart is
        einddatum:
          type: string
          description: Datum waarop de vereniging gestopt is
        doelgroep:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.DoelgroepResponse
          description: >-
            De doelgroep waar de activiteiten van deze vereniging zich op
            concentreert
        status:
          type: string
          description: "Status van de vereniging<br /><br />\r\n                Mogelijke waarden:<br />\r\n                - Actief<br />\r\n                - Gestopt<br />"
        isUitgeschrevenUitPubliekeDatastroom:
          type: boolean
          description: Is deze vereniging uitgeschreven uit de publieke datastroom
        hoofdactiviteitenVerenigingsloket:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.HoofdactiviteitVerenigingsloket
          description: >-
            De hoofdactivititeiten van deze vereniging volgens het
            verenigingsloket
        contactgegevens:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Contactgegeven
          description: De contactgegevens van deze vereniging
        locaties:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Locatie
          description: Alle locaties waar deze vereniging actief is
        vertegenwoordigers:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Vertegenwoordiger
          description: Alle vertegenwoordigers van deze vereniging
        sleutels:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Sleutel
          description: De sleutels van deze vereniging
        relaties:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Relatie
          description: De relaties van deze vereniging
        bron:
          type: string
          description: "De bron die deze vereniging beheert.\r\n                 <br />\r\n                Mogelijke waarden:<br />\r\n                - Initiator<br />\r\n                - KBO"
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.VerenigingsType:
      type: object
      properties:
        code:
          type: string
          description: De code van het type vereniging
        naam:
          type: string
          description: De beschrijving van het type vereniging
      additionalProperties: false
      description: Het type van een vereniging
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.Vertegenwoordiger:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
        vertegenwoordigerId:
          type: integer
          description: >-
            De unieke identificatie code van deze vertegenwoordiger binnen de
            vereniging
          format: int32
        insz:
          type: string
          description: Het insz van deze vertegenwoordiger
        voornaam:
          type: string
          description: >-
            Dit is de voornaam van de vertegenwoordiger volgens het
            rijksregister
        achternaam:
          type: string
          description: >-
            Dit is de achternaam van de vertegenwoordiger volgens het
            rijksregister
        roepnaam:
          type: string
          description: Dit is de roepnaam van de vertegenwoordiger
        rol:
          type: string
          description: Dit is de rol van de vertegenwoordiger binnen de vereniging
        isPrimair:
          type: boolean
          description: >-
            Dit duidt aan dat dit de unieke primaire contactpersoon is voor alle
            communicatie met overheidsinstanties
        e-mail:
          type: string
          description: Het e-mailadres van de vertegenwoordiger
        telefoon:
          type: string
          description: Het telefoonnummer van de vertegenwoordiger
        mobiel:
          type: string
          description: Het mobiel nummer van de vertegenwoordiger
        socialMedia:
          type: string
          description: Het socialmedia account van de vertegenwoordiger
        vertegenwoordigerContactgegevens:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.VertegenwoordigerContactgegevens
          description: de contactgegevens van de vertegenwoordiger
        bron:
          type: string
          description: "De bron die deze vertegenwoordiger beheert.\r\n           <br />\r\n               Mogelijke waarden:<br />\r\n               - Initiator<br />\r\n               - KBO"
      additionalProperties: false
      description: Een vertegenwoordiger van een vereniging
    AssociationRegistry.Admin.Api.Verenigingen.Detail.ResponseModels.VertegenwoordigerContactgegevens:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
        isPrimair:
          type: boolean
          description: >-
            Dit duidt aan dat dit de unieke primaire contactpersoon is voor alle
            communicatie met overheidsinstanties
        e-mail:
          type: string
          description: Het e-mailadres van de vertegenwoordiger
        telefoon:
          type: string
          description: Het telefoonnummer van de vertegenwoordiger
        mobiel:
          type: string
          description: Het mobiel nummer van de vertegenwoordiger
        socialMedia:
          type: string
          description: Het socialmedia account van de vertegenwoordiger
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Historiek.ResponseModels.HistoriekGebeurtenisResponse:
      type: object
      properties:
        beschrijving:
          type: string
          description: De beschrijving van de gebeurtenis
        gebeurtenis:
          type: string
          description: Het type van de gebeurtenis
        data:
          description: De relevante data die hoort bij de gebeurtenis
        initiator:
          type: string
          description: Instantie die de vereniging heeft geregistreerd of gewijzigd
        tijdstip:
          type: string
          description: Het tijdstip waarop de gebeurtenis plaatsvond
      additionalProperties: false
      description: Een gebeurtenis van een vereniging
    AssociationRegistry.Admin.Api.Verenigingen.Historiek.ResponseModels.HistoriekResponse:
      type: object
      properties:
        '@context':
          type: string
          description: De JSON-LD open data context
        vCode:
          type: string
          description: De unieke identificatie code van deze vereniging
        gebeurtenissen:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Historiek.ResponseModels.HistoriekGebeurtenisResponse
          description: Alle gebeurtenissen van deze vereniging
      additionalProperties: false
      description: Alle gebeurtenissen van deze vereniging
    AssociationRegistry.Admin.Api.Verenigingen.Locaties.FeitelijkeVereniging.VoegLocatieToe.RequestModels.VoegLocatieToeRequest:
      type: object
      properties:
        locatie:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenLocatie
          description: Een locatie van een vereniging
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Locaties.FeitelijkeVereniging.WijzigLocatie.RequestModels.TeWijzigenLocatie:
      type: object
      properties:
        locatietype:
          type: string
          description: "Het soort locatie dat beschreven wordt<br /><br />\r\nMogelijke waarden:<br />\r\n- Activiteiten<br />\r\n- Correspondentie - Slechts één maal mogelijk<br />"
        isPrimair:
          type: boolean
          description: Duidt aan dat dit de primaire locatie is
        naam:
          maxLength: 128
          type: string
          description: Een beschrijvende naam voor de locatie
        adresId:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.AdresId
          description: De unieke identificator van het adres in een andere bron
        adres:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.Adres
          description: Het adres van de locatie
      additionalProperties: false
      description: Een locatie van een vereniging
    AssociationRegistry.Admin.Api.Verenigingen.Locaties.FeitelijkeVereniging.WijzigLocatie.RequestModels.WijzigLocatieRequest:
      type: object
      properties:
        locatie:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Locaties.FeitelijkeVereniging.WijzigLocatie.RequestModels.TeWijzigenLocatie
          description: Een locatie van een vereniging
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Locaties.VerenigingMetRechtspersoonlijkheid.WijzigMaatschappelijkeZetel.RequestModels.TeWijzigenMaatschappelijkeZetel:
      type: object
      properties:
        isPrimair:
          type: boolean
          description: Duidt aan dat dit de primaire locatie is
        naam:
          maxLength: 128
          type: string
          description: Een beschrijvende naam voor de locatie
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Locaties.VerenigingMetRechtspersoonlijkheid.WijzigMaatschappelijkeZetel.RequestModels.WijzigMaatschappelijkeZetelRequest:
      type: object
      properties:
        locatie:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Locaties.VerenigingMetRechtspersoonlijkheid.WijzigMaatschappelijkeZetel.RequestModels.TeWijzigenMaatschappelijkeZetel
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Registreer.DuplicaatVerenigingContract:
      type: object
      properties:
        vCode:
          type: string
          description: De unieke identificatie code van deze vereniging
        naam:
          type: string
          description: Naam van de vereniging
        korteNaam:
          type: string
          description: Korte naam van de vereniging
        verenigingstype:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.VerenigingsType
          description: Type van de vereniging
        hoofdactiviteitenVerenigingsloket:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.HoofdactiviteitVerenigingsloket
          description: >-
            De hoofdactivititeiten van deze vereniging volgens het
            verenigingsloket
        locaties:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.Locatie
          description: Alle locaties waar deze vereniging actief is
        links:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.VerenigingLinks
          description: Weblinks i.v.m. deze vereniging
      additionalProperties: false
      description: Een mogelijke duplicaat van de te registreren vereniging
    AssociationRegistry.Admin.Api.Verenigingen.Registreer.FeitelijkeVereniging.RequetsModels.RegistreerFeitelijkeVerenigingRequest:
      required:
        - naam
      type: object
      properties:
        naam:
          type: string
          description: Naam van de vereniging
        korteNaam:
          type: string
          description: Korte naam van de vereniging
        korteBeschrijving:
          type: string
          description: Korte beschrijving van de vereniging
        startdatum:
          type: string
          description: >-
            Datum waarop de vereniging gestart is. Deze datum mag niet later
            zijn dan vandaag
          format: date
        doelgroep:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.DoelgroepRequest
          description: >-
            De doelgroep waar de activiteiten van deze vereniging zich op
            concentreert
        isUitgeschrevenUitPubliekeDatastroom:
          type: boolean
          description: Is deze vereniging uitgeschreven uit de publieke datastroom
        contactgegevens:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenContactgegeven
          description: De contactgegevens van deze vereniging
        locaties:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenLocatie
          description: Alle locaties waar deze vereniging actief is
        vertegenwoordigers:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenVertegenwoordiger
          description: De vertegenwoordigers van deze vereniging
        hoofdactiviteitenVerenigingsloket:
          type: array
          items:
            type: string
          description: De codes van de hoofdactivititeiten volgens het verenigingsloket
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Registreer.HoofdactiviteitVerenigingsloket:
      type: object
      properties:
        code:
          type: string
          description: De code van de hoofdactivititeit
        naam:
          type: string
          description: De beschrijving van de hoofdactivititeit
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Registreer.Locatie:
      type: object
      properties:
        locatietype:
          type: string
          description: Het soort locatie dat beschreven wordt
        isPrimair:
          type: boolean
          description: Duidt aan dat dit de primaire locatie is
        adresvoorstelling:
          type: string
          description: Het samengestelde adres van de locatie
        naam:
          type: string
          description: Een beschrijvende naam voor de locatie
        postcode:
          type: string
          description: Het busnummer van de locatie
        gemeente:
          type: string
          description: De gemeente van de locatie
      additionalProperties: false
      description: Een locatie van een vereniging
    AssociationRegistry.Admin.Api.Verenigingen.Registreer.MetRechtspersoonlijkheid.RequestModels.RegistreerVerenigingUitKboRequest:
      required:
        - kboNummer
      type: object
      properties:
        kboNummer:
          type: string
          description: Kbo nummer van de vereniging
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Registreer.PotentialDuplicatesResponse:
      type: object
      properties:
        bevestigingsToken:
          type: string
          description: "Dit token wordt gebruikt als bevestiging dat de vereniging uniek is en geregistreerd mag worden,\r\n            ondanks de voorgestelde duplicaten."
          readOnly: true
        mogelijkeDuplicateVerenigingen:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Registreer.DuplicaatVerenigingContract
          description: "Een lijst van verenigingen die mogelijks een duplicaat zijn\r\n            van de vereniging uit de registreer aanvraag"
          readOnly: true
        instance:
          type: string
          description: URI naar de specifieke instantie van dit probleem.
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Registreer.VerenigingLinks:
      type: object
      properties:
        detail:
          type: string
          description: De link naar het beheer detail van de vereniging
          format: uri
        magdaDetail:
          type: string
          description: Magda link naar het beheer detail van de vereniging
          format: uri
      additionalProperties: false
      description: Weblinks i.v.m. deze vereniging
    AssociationRegistry.Admin.Api.Verenigingen.Registreer.VerenigingsType:
      type: object
      properties:
        code:
          type: string
          description: De code van het type van deze vereniging
        naam:
          type: string
          description: De beschrijving van het type van deze vereniging
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.DoelgroepResponse:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
        minimumleeftijd:
          type: integer
          description: De minimum leeftijd voor de doelgroep
          format: int32
        maximumleeftijd:
          type: integer
          description: De maximum leeftijd voor de doelgroep
          format: int32
      additionalProperties: false
      description: >-
        De doelgroep waar de activiteiten van deze vereniging zich op
        concentreert
    AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.GestructureerdeIdentificator:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
        nummer:
          type: string
          description: De externe identificator van de vereniging in de bron
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.HoofdactiviteitVerenigingsloket:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
        code:
          type: string
          description: De verkorte code van de hoofdactiviteit
        naam:
          type: string
          description: De volledige beschrijving van de hoofdactiviteit
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Locatie:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
        locatietype:
          type: string
          description: "Het soort locatie dat beschreven wordt<br /><br />\r\nMogelijke waarden:<br />\r\n- Activiteiten<br />\r\n- Correspondentie - Slechts één maal mogelijk<br />\r\n- Maatschappelijke zetel volgens KBO - Enkel mogelijk voor verenigingen met rechtspersoonlijkheid<br />"
        isPrimair:
          type: boolean
          description: Is dit de primaire locatie van deze vereniging
        adresvoorstelling:
          type: string
          description: De volledige adresvoorstelling van de locatie
        naam:
          type: string
          description: De naam van de locatie
        postcode:
          type: string
          description: De postcode van de locatie
        gemeente:
          type: string
          description: De gemeente waarin de locatie ligt
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Metadata:
      type: object
      properties:
        pagination:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Pagination
          description: De paginatie metaData
      additionalProperties: false
      description: >-
        In deze metadata plaatsen we alle relevante metadata voor de
        zoekopdracht, de paginering informatie
    AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Pagination:
      type: object
      properties:
        totalCount:
          type: integer
          description: Het totaal aantal verenigingen dat voldoet aan de zoekcriteria
          format: int64
        offset:
          type: integer
          description: Het aantal overgeslagen resultaten
          format: int32
        limit:
          type: integer
          description: Het maximum aantal teruggegeven resultaten
          format: int32
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.SearchVerenigingenResponse:
      type: object
      properties:
        '@context':
          type: string
          description: De JSON-LD open data context
        verenigingen:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Vereniging
          description: >-
            Dit is de lijst van verenigingen die het resultaat van de
            zoekopdracht zijn
        metadata:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Metadata
          description: >-
            In deze metadata plaatsen we alle relevante metadata voor de
            zoekopdracht, de paginering informatie
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Sleutel:
      type: object
      properties:
        '@id':
          type: string
          description: De json-ld id
        '@type':
          type: string
          description: Het json-ld type
        bron:
          type: string
          description: De bron van de sleutel
        waarde:
          type: string
          description: De externe identificator van de vereniging in de bron
        codeerSysteem:
          type: string
          description: het codeersysteem van de sleutel
        gestructureerdeIdentificator:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.GestructureerdeIdentificator
          description: De gestructureerde identificator
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Vereniging:
      type: object
      properties:
        '@type':
          type: string
          description: Het json-ld type
        vCode:
          type: string
          description: De vCode van de vereniging
        corresponderendeVCodes:
          type: array
          items:
            type: string
          description: De vCodes van de corresponderende verenigingen
        verenigingstype:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.VerenigingsType
          description: Het type van de vereniging
        naam:
          type: string
          description: De naam van de vereniging
        roepnaam:
          type: string
          description: >-
            Roepnaam van de vereniging. Dit veld is enkel aanwezig bij
            verenigingen met rechtspersoonlijkheid
          default: null
        korteNaam:
          type: string
          description: De korte naam van de vereniging
        status:
          type: string
          description: "Status van de vereniging<br /><br />\r\n                Mogelijke waarden:<br />\r\n                - Actief<br />\r\n                - Gestopt<br />"
        startdatum:
          type: string
          description: Datum waarop de vereniging gestart is
        einddatum:
          type: string
          description: Datum waarop de vereniging gestopt is        
        doelgroep:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.DoelgroepResponse
          description: >-
            De doelgroep waar de activiteiten van deze vereniging zich op
            concentreert
        hoofdactiviteitenVerenigingsloket:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.HoofdactiviteitVerenigingsloket
          description: De lijst van hoofdactiviteiten erkend door het vereningingsloket
        locaties:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Locatie
          description: De locaties waar de vereniging actief is
        sleutels:
          type: array
          items:
            $ref: >-
              #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.Sleutel
          description: De sleutels van deze vereniging
        links:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.VerenigingLinks
          description: Weblinks i.v.m. deze vereniging
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.VerenigingLinks:
      type: object
      properties:
        detail:
          type: string
          description: De link naar het beheer detail van de vereniging
          format: uri
        magdaDetail:
          type: string
          description: Magda link naar het beheer detail van de vereniging
          format: uri
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Search.ResponseModels.VerenigingsType:
      type: object
      properties:
        code:
          type: string
          description: De code van het type vereniging
        naam:
          type: string
          description: De beschrijving van het type vereniging
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Stop.RequestModels.StopVerenigingRequest:
      required:
        - einddatum
      type: object
      properties:
        einddatum:
          type: string
          description: De datum waarop de vereniging gestopt werd.
          format: date
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Vertegenwoordigers.FeitelijkeVereniging.VoegVertegenwoordigerToe.RequestModels.VoegVertegenwoordigerToeRequest:
      type: object
      properties:
        vertegenwoordiger:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.ToeTeVoegenVertegenwoordiger
          description: De toe te voegen vertegenwoordiger
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.Vertegenwoordigers.FeitelijkeVereniging.WijzigVertegenwoordiger.RequestModels.TeWijzigenVertegenwoordiger:
      type: object
      properties:
        rol:
          type: string
          description: Dit is de rol van de vertegenwoordiger binnen de vereniging
        roepnaam:
          type: string
          description: Dit is de roepnaam van de vertegenwoordiger
        isPrimair:
          type: boolean
          description: >-
            Dit duidt aan dat dit de unieke primaire contactpersoon is voor alle
            communicatie met overheidsinstanties
        e-mail:
          type: string
          description: Het e-mailadres van de vertegenwoordiger
        telefoon:
          type: string
          description: Het telefoonnummer van de vertegenwoordiger
        mobiel:
          type: string
          description: Het mobiel nummer van de vertegenwoordiger
        socialMedia:
          type: string
          description: Het socialmedia account van de vertegenwoordiger
      additionalProperties: false
      description: De te wijzigen vertegenwoordiger
    AssociationRegistry.Admin.Api.Verenigingen.Vertegenwoordigers.FeitelijkeVereniging.WijzigVertegenwoordiger.RequestModels.WijzigVertegenwoordigerRequest:
      type: object
      properties:
        vertegenwoordiger:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Vertegenwoordigers.FeitelijkeVereniging.WijzigVertegenwoordiger.RequestModels.TeWijzigenVertegenwoordiger
          description: De te wijzigen vertegenwoordiger
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.WijzigBasisgegevens.FeitelijkeVereniging.RequestModels.WijzigBasisgegevensRequest:
      type: object
      properties:
        naam:
          type: string
          description: Nieuwe naam van de vereniging
        korteNaam:
          type: string
          description: Nieuwe korte naam van de vereniging
        korteBeschrijving:
          type: string
          description: Nieuwe korte beschrijving van de vereniging
        startdatum:
          type: string
          description: >-
            Nieuwe startdatum (yyyy-MM-dd) van de vereniging. Deze datum mag
            niet later zijn dan vandaag
        doelgroep:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.DoelgroepRequest
          description: >-
            De doelgroep waar de activiteiten van deze vereniging zich op
            concentreert
        hoofdactiviteitenVerenigingsloket:
          type: array
          items:
            type: string
          description: >-
            De codes van de nieuwe hoofdactiviteiten volgens het
            verenigingsloket
        isUitgeschrevenUitPubliekeDatastroom:
          type: boolean
          description: >-
            Is deze vereniging uitgeschreven uit de publiek datastroom, dit kan
            enkel gewijzigd worden voor een feitelijke vereniging
      additionalProperties: false
    AssociationRegistry.Admin.Api.Verenigingen.WijzigBasisgegevens.MetRechtspersoonlijkheid.RequestModels.WijzigBasisgegevensRequest:
      type: object
      properties:
        korteBeschrijving:
          type: string
          description: Nieuwe korte beschrijving van de vereniging
        doelgroep:
          allOf:
            - $ref: >-
                #/components/schemas/AssociationRegistry.Admin.Api.Verenigingen.Common.DoelgroepRequest
          description: >-
            De doelgroep waar de activiteiten van deze vereniging zich op
            concentreert
        hoofdactiviteitenVerenigingsloket:
          type: array
          items:
            type: string
          description: >-
            De codes van de nieuwe hoofdactiviteiten volgens het
            verenigingsloket
        roepnaam:
          type: string
          description: De nieuwe roepnaam van de vereniging
      additionalProperties: false
    Be.Vlaanderen.Basisregisters.BasicApiProblem.ProblemDetails:
      type: object
      properties:
        type:
          type: string
          description: URI referentie die het probleem type bepaalt.
        title:
          type: string
          description: Korte omschrijving van het probleem.
        detail:
          type: string
          description: Specifieke details voor dit probleem.
        status:
          type: integer
          description: HTTP status code komende van de server voor dit probleem.
          format: int32
        instance:
          type: string
          description: URI naar de specifieke instantie van dit probleem.
      additionalProperties: false
    Be.Vlaanderen.Basisregisters.BasicApiProblem.ValidationError:
      type: object
      properties:
        code:
          type: string
        reason:
          type: string
      additionalProperties: false
    Be.Vlaanderen.Basisregisters.BasicApiProblem.ValidationProblemDetails:
      type: object
      properties:
        validationErrors:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: >-
                #/components/schemas/Be.Vlaanderen.Basisregisters.BasicApiProblem.ValidationError
          description: Validatie fouten.
        type:
          type: string
          description: URI referentie die het probleem type bepaalt.
        title:
          type: string
          description: Korte omschrijving van het probleem.
        detail:
          type: string
          description: Specifieke details voor dit probleem.
        status:
          type: integer
          description: HTTP status code komende van de server voor dit probleem.
          format: int32
        instance:
          type: string
          description: URI naar de specifieke instantie van dit probleem.
      additionalProperties: false