components:
  schemas:
    ErrorResponse:
      description: Foutmeldinggegevens
      properties:
        detail:
          description: Het detail van de foutmelding
          type: string
        instance:
          description: Het UUID waarmee een beheerder de foutmelding eenvoudig terug
            kan vinden in de log
          type: string
        parameterDetail:
          description: Een lijst met foutdetails over de gebruikte parameters
          items:
            $ref: '#/components/schemas/ErrorResponseParameter'
          type: array
        status:
          description: De HTTP status code
          format: int32
          type: integer
        title:
          description: De titel van het fouttype
          type: string
        type:
          description: De link naar het fouttype
          type: string
      type: object
    ErrorResponseParameter:
      description: Foutdetail over de gebruikte parameter
      properties:
        name:
          description: Naam van het veld met de fout
          type: string
        reason:
          description: Foutomschrijving
          type: string
        type:
          description: Fouttype van de parameter
          type: string
      type: object
    HalInfo:
      description: Een HAL-referentie
      properties:
        href:
          description: De link naar de bron
          type: string
        type:
          description: Het mime-type van de bron
          type: string
      type: object
    HalPaginationInfo:
      description: De HAL paginering referentie
      properties:
        first:
          allOf:
          - $ref: '#/components/schemas/HalInfo'
          description: De link naar de eerste pagina van de lijst met gegevens
          type: object
        last:
          allOf:
          - $ref: '#/components/schemas/HalInfo'
          description: De link naar de laatste pagina van de lijst met gegevens
          type: object
        next:
          allOf:
          - $ref: '#/components/schemas/HalInfo'
          description: De link naar de volgende pagina van de lijst met gegevens
          type: object
        prev:
          allOf:
          - $ref: '#/components/schemas/HalInfo'
          description: De link naar de vorige pagina van de lijst met gegevens
          type: object
        self:
          allOf:
          - $ref: '#/components/schemas/HalInfo'
          description: De link naar zichzelf
          type: object
      type: object
    HalSelfInfo:
      description: De HAL paginering referentie
      properties:
        self:
          allOf:
          - $ref: '#/components/schemas/HalInfo'
          description: De link naar zichzelf
          type: object
      type: object
    HealthCheckListItem:
      properties:
        data:
          nullable: true
          properties:
            exceptionClass:
              type: object
            exceptionMessage:
              type: object
            rootCause:
              type: object
          type: object
        name:
          nullable: true
          type: string
        status:
          $ref: '#/components/schemas/HealthCheckStatus'
      type: object
    HealthCheckResponse:
      properties:
        checks:
          items:
            $ref: '#/components/schemas/HealthCheckListItem'
          nullable: true
          type: array
        status:
          $ref: '#/components/schemas/HealthCheckStatus'
      type: object
    HealthCheckStatus:
      enum:
      - UP
      - DOWN
      type: string
    LaatsteWijzigingsDatum:
      description: Modificatiedatum laatst aangepaste organisatie
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/HalSelfInfo'
          description: De HAL paginering referentie
          type: object
        laatsteWijziging:
          allOf:
          - $ref: '#/components/schemas/LocalDateTime'
          description: Modificatiedatum laatst aangepaste organisatie
          type: string
      type: object
    LocalDateTime:
      example: 2022-03-10T12:15:50
      format: date-time
      type: string
    OrganisatieListResponse:
      description: Lijst met organisatiegegevens
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/HalPaginationInfo'
          description: De HAL paginering referentie
          type: object
        organisaties:
          description: De lijst met organisaties
          items:
            $ref: '#/components/schemas/OrganisatieResponse'
          type: array
      type: object
    OrganisatieResponse:
      description: Organisatiegegevens
      properties:
        _links:
          allOf:
          - $ref: '#/components/schemas/HalSelfInfo'
          description: De HAL paginering referentie
          type: object
        afgifteDatum:
          allOf:
          - $ref: '#/components/schemas/LocalDateTime'
          description: De afgiftedatum van de organisatie
          type: string
        hoofdOIN:
          allOf:
          - $ref: '#/components/schemas/OrganisatieResponse'
          description: De oinhouder van de organisatie
          type: object
        intrekDatum:
          allOf:
          - $ref: '#/components/schemas/LocalDateTime'
          description: De intrekdatum van de organisatie
          type: string
        kvkNummer:
          description: Het Kvk Nummer van de organisatie
          maxLength: 8
          minLength: 8
          type: string
        laatstAangepastDatum:
          allOf:
          - $ref: '#/components/schemas/LocalDateTime'
          description: De laatstaangepastdatum van de organisatie
          type: string
        naam:
          description: De naam van de organisatie
          type: string
        oin:
          description: Het organisatie Identificatienummer
          type: string
        organisatieCode:
          description: De organisatiecode van de organisatie
          maxLength: 4
          type: string
        organisatieType:
          allOf:
          - $ref: '#/components/schemas/OrganisationType'
          description: Het organisatietype van de organisatie
          type: string
        rooId:
          description: Het ID zoals in het register Overheidsorganisaties bekend
          type: string
        status:
          description: De status van de organisatie binnen het OIN-register
          oneOf:
          - $ref: '#/components/schemas/OrganisationStatus'
          type: string
        subOINs:
          description: De lijst met suboins van de organisatie
          items:
            $ref: '#/components/schemas/OrganisatieResponse'
          type: array
      type: object
    OrganisationStatus:
      description: De status van de organisatie binnen het OIN-register
      enum:
      - In Behandeling
      - Actief
      - Ingetrokken
      type: string
    OrganisationType:
      description: Het organisatietype van de organisatie
      enum:
      - GM
      - PV
      - WS
      - MNRE
      - GS
      - GR
      - OORG
      type: string
  securitySchemes:
    default:
      flows:
        implicit:
          authorizationUrl: https://test.com
          scopes: {}
      type: oauth2
info:
  contact:
    email: servicecentrum@logius.nl
    name: Logius
    url: https://www.logius.nl/diensten/digikoppeling/
  description: Deze Logius REST API's bieden de openbare informatie voor organisaties
  title: COR API Services
  version: 1.2.8
openapi: 3.1.0
paths:
  /heartbeat:
    description: Health - Readiness
    get:
      description: Controleer of de API gereed is
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
          description: OK
        "429":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
          description: Too Many Requests
        "503":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
          description: Service Unavailable
      security:
      - default: []
      summary: Readiness check van deze API
      x-auth-type: None
      x-throttling-tier: Unlimited
      x-wso2-application-security:
        optional: false
        security-types:
        - oauth2
        - api_key
    summary: Readiness checks worden gebruikt om aan te geven of de API in staat is
      om requests te verwerken
  /laatsteWijziging:
    get:
      description: Dit eindpunt geeft het tijdstempel van de laatst gewijzigde organisatie
        in het systeem
      responses:
        "200":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/LaatsteWijzigingsDatum'
          description: Tijdstempel laatst gewijzigde organisatie
          headers:
            API-Version:
              description: De huidige versie van de applicatie
              schema:
                type: string
              style: simple
        "400":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: De opgegeven parameters zijn onjuist
        "404":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Het gevraagde gegeven is niet gevonden
        "405":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Het verzoek is niet toegestaan voor dit eindpunt
        "406":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: De opgegeven Accept Header is onjuist
        "429":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Maximaal aantal verzoeken per seconds is overschreden
        "500":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: De server heeft een interne fout
        "503":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: De dienst is niet beschikbaar
      security:
      - default: []
      summary: Laatste wijziging
      x-auth-type: None
      x-throttling-tier: Unlimited
      x-wso2-application-security:
        optional: false
        security-types:
        - oauth2
        - api_key
  /openapi:
    get:
      responses:
        "200":
          description: OK
      security:
      - default: []
      x-auth-type: None
      x-throttling-tier: Unlimited
      x-wso2-application-security:
        optional: false
        security-types:
        - oauth2
        - api_key
  /openapi.json:
    get:
      responses:
        "200":
          description: OK
      security:
      - default: []
      x-auth-type: None
      x-throttling-tier: Unlimited
      x-wso2-application-security:
        optional: false
        security-types:
        - oauth2
        - api_key
  /organisaties:
    get:
      description: Dit eindpunt geeft een lijst van alle openbare organisaties in
        het systeem
      parameters:
      - description: Schakelaar om details van gekoppelde organisaties (subOIN of
          OINhouder) op te vragen (default false = geen details)
        explode: true
        in: query
        name: expand
        schema:
          type: boolean
        style: form
      - description: Een kommagescheiden string met namen van velden waarvan de waarde
          opgehaald dient te worden
        explode: true
        in: query
        name: fields
        schema:
          type: string
        style: form
      - description: Het Kvk Nummer van de organisatie
        explode: true
        in: query
        name: kvkNummer
        schema:
          maxLength: 8
          minLength: 8
          type: string
        style: form
      - description: De naam van de organisatie
        explode: true
        in: query
        name: naam
        schema:
          type: string
        style: form
      - description: Het organisatie Identificatienummer
        explode: true
        in: query
        name: oin
        schema:
          maxLength: 20
          minLength: 20
          type: string
        style: form
      - description: De organisatiecode van de organisatie
        explode: true
        in: query
        name: organisatieCode
        schema:
          maxLength: 4
          type: string
        style: form
      - description: Het organisatietype van de organisatie
        explode: true
        in: query
        name: organisatieType
        schema:
          oneOf:
          - $ref: '#/components/schemas/OrganisationType'
        style: form
      - description: De opgevraagde pagina
        explode: true
        in: query
        name: pagina
        schema:
          format: int32
          type: integer
        style: form
      - description: Het aantal organisaties per pagina (-1 voor alle organisaties
          op 1 pagina)
        explode: true
        in: query
        name: resultatenPerPagina
        schema:
          format: int32
          type: integer
        style: form
      - description: Het ID zoals in het register Overheidsorganisaties bekend
        explode: true
        in: query
        name: rooId
        schema:
          maxLength: 255
          type: string
        style: form
      - description: De status van de organisatie binnen het OIN-register
        explode: true
        in: query
        name: status
        schema:
          oneOf:
          - $ref: '#/components/schemas/OrganisationStatus'
        style: form
      - description: 'Vrije tekst voor het zoeken in de volgende velden: oin, naam,
          afkorting'
        explode: true
        in: query
        name: zoek
        schema:
          type: string
        style: form
      - description: De sleutel om toegang te krijgen tot testgegevens
        explode: false
        in: header
        name: X-Test-Data-Key
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/OrganisatieListResponse'
          description: Lijst met organisaties
          headers:
            API-Version:
              description: De huidige versie van de applicatie
              schema:
                type: string
              style: simple
            X-Pagination-Count:
              description: Het totale aantal beschikbare pagina's
              schema:
                format: int32
                type: integer
              style: simple
            X-Pagination-Limit:
              description: Het totale aantal resultaten per pagina
              schema:
                format: int32
                type: integer
              style: simple
            X-Pagination-Page:
              description: De geretourneerde pagina
              schema:
                format: int32
                type: integer
              style: simple
            X-Total-Count:
              description: Het totale aantal resultaten
              schema:
                format: int32
                type: integer
              style: simple
        "400":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: De opgegeven parameters zijn onjuist
        "404":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Het gevraagde gegeven is niet gevonden
        "405":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Het verzoek is niet toegestaan voor dit eindpunt
        "406":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: De opgegeven Accept Header is onjuist
        "429":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Maximaal aantal verzoeken per seconds is overschreden
        "500":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: De server heeft een interne fout
        "503":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: De dienst is niet beschikbaar
      security:
      - default: []
      summary: Organisaties Collectie
      x-auth-type: None
      x-throttling-tier: Unlimited
      x-wso2-application-security:
        optional: false
        security-types:
        - oauth2
        - api_key
  /organisaties/{oin}:
    get:
      description: Dit eindpunt levert de openbare informatie van de organisatie
      parameters:
      - description: Het organisatie Identificatienummer
        explode: false
        in: path
        name: oin
        required: true
        schema:
          type: string
        style: simple
      - description: De datum waarop de organisatiegegevens beschikbaar werden in
          het systeem
        explode: true
        in: query
        name: beschikbaarOp
        schema:
          type: string
        style: form
      - description: Schakelaar om details van gekoppelde organisaties (subOIN of
          OINhouder) op te vragen (default false = geen details)
        explode: true
        in: query
        name: expand
        schema:
          type: boolean
        style: form
      - description: Een kommagescheiden string met namen van velden waarvan de waarde
          opgehaald dient te worden
        explode: true
        in: query
        name: fields
        schema:
          type: string
        style: form
      - description: De datum waarop de organisatiegegevens geldig zijn/worden
        explode: true
        in: query
        name: geldigOp
        schema:
          type: string
        style: form
      - description: De sleutel om toegang te krijgen tot testgegevens
        explode: false
        in: header
        name: X-Test-Data-Key
        schema:
          type: string
        style: simple
      responses:
        "200":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/OrganisatieResponse'
          description: Organisatie informatie
          headers:
            API-Version:
              description: De huidige versie van de applicatie
              schema:
                type: string
              style: simple
        "400":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: De opgegeven parameters zijn onjuist
        "404":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Het gevraagde gegeven is niet gevonden
        "405":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Het verzoek is niet toegestaan voor dit eindpunt
        "406":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: De opgegeven Accept Header is onjuist
        "429":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Maximaal aantal verzoeken per seconds is overschreden
        "500":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: De server heeft een interne fout
        "503":
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: De dienst is niet beschikbaar
      security:
      - default: []
      summary: Openbare organisatie Informatie
      x-auth-type: None
      x-throttling-tier: Unlimited
      x-wso2-application-security:
        optional: false
        security-types:
        - oauth2
        - api_key
security:
- default: []
servers:
- url: https://oinregister.logius.nl/api/v1
x-wso2-application-security:
  optional: false
  security-types:
  - oauth2
  - api_key
x-wso2-basePath: /cor/1.2
x-wso2-cors:
  accessControlAllowCredentials: false
  accessControlAllowHeaders:
  - authorization
  - Access-Control-Allow-Origin
  - Content-Type
  - SOAPAction
  - apikey
  - Internal-Key
  accessControlAllowMethods:
  - GET
  - PUT
  - POST
  - DELETE
  - PATCH
  - OPTIONS
  accessControlAllowOrigins:
  - '*'
  corsConfigurationEnabled: false
x-wso2-production-endpoints:
  type: http
  urls:
  - http://onloading-proxy-team-interfaces-cor-v1-2/
x-wso2-response-cache:
  cacheTimeoutInSeconds: 300
  enabled: false
x-wso2-transports:
- http
- https
