{
  "openapi": "3.0.0",
  "info": {
    "contact": {
      "name": "Logius",
      "email": "servicecentrum@logius.nl",
      "url": "https://www.logius.nl/diensten/digikoppeling/"
    },
    "version": "1.2.111",
    "title": "COR API"
  },
  "servers": [
    {
      "url": "https://acc.portaal.digikoppeling.nl/registers/api/v1"
    },
    {
      "url": "https://preprod.portaal.digikoppeling.nl/registers/api/v1"
    },
    {
      "url": "https://portaal.digikoppeling.nl/registers/api/v1"
    }
  ],
  "paths": {
    "/organisaties": {
      "get": {
        "parameters": [
          {
            "$ref": "#/components/parameters/kvkNummer"
          },
          {
            "$ref": "#/components/parameters/naam"
          },
          {
            "$ref": "#/components/parameters/oin"
          },
          {
            "$ref": "#/components/parameters/status"
          },
          {
            "$ref": "#/components/parameters/organisatieCode"
          },
          {
            "$ref": "#/components/parameters/organisatieType"
          },
          {
            "$ref": "#/components/parameters/zoek"
          },
          {
            "$ref": "#/components/parameters/expand"
          },
          {
            "$ref": "#/components/parameters/pagina"
          },
          {
            "$ref": "#/components/parameters/fields"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/OrganisatiesMetHALPagination"
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "404": {
            "$ref": "#/components/responses/Error"
          },
          "405": {
            "$ref": "#/components/responses/Error"
          },
          "406": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "503": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Organisaties collectie"
      }
    },
    "/organisaties/{oin_path}": {
      "get": {
        "parameters": [
          {
            "$ref": "#/components/parameters/oin_path"
          },
          {
            "$ref": "#/components/parameters/expand"
          },
          {
            "$ref": "#/components/parameters/fields"
          },
          {
            "$ref": "#/components/parameters/geldigOp"
          },
          {
            "$ref": "#/components/parameters/beschikbaarOp"
          }

        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/OrganisatieMetHALInfo"
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "404": {
            "$ref": "#/components/responses/Error"
          },
          "405": {
            "$ref": "#/components/responses/Error"
          },
          "406": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "503": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Organisatie resource"
      }
    },
    "/laatsteWijziging": {
      "get": {
        "responses": {
          "200": {
            "$ref": "#/components/responses/LaatsteWijzigingDatumMetHALInfo"
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "404": {
            "$ref": "#/components/responses/Error"
          },
          "405": {
            "$ref": "#/components/responses/Error"
          },
          "406": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "503": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Organisatie resource"
      }
    }
  },
  "components": {
    "parameters": {
      "kvkNummer": {
        "name": "kvkNummer",
        "in": "query",
        "description": "kvkNummer",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int64"
        }
      },
      "naam": {
        "name": "naam",
        "in": "query",
        "description": "Naam van de organisatie",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "oin": {
        "name": "oin",
        "in": "query",
        "description": "Organisatie Identificatienummer",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int64"
        }
      },
      "oin_path": {
        "name": "oin_path",
        "in": "path",
        "description": "Organisatie Identificatienummer",
        "required": true,
        "schema": {
          "type": "integer",
          "format": "int64"
        }
      },
      "status": {
        "name": "status",
        "in": "query",
        "description": "Status van de OIN in the COR. Deze kan 'Actief' of 'Ingetrokken' zijn",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "Actief",
            "Ingetrokken"
          ]
        }
      },
      "organisatieCode": {
        "name": "organisatieCode",
        "in": "query",
        "description": "Code van de organisatie",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "organisatieType": {
        "name": "organisatieType",
        "in": "query",
        "description": "Type van de organisatie",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "GM",
            "PV",
            "WS",
            "MNRE",
            "GS",
            "GR"
          ]
        }
      },
      "zoek": {
        "name": "zoek",
        "in": "query",
        "required": false,
        "description": "Vrije-tekst zoeken op `oin` of `naam` of `afkorting`",
        "schema": {
          "type": "string"
        }
      },
      "expand": {
        "name": "expand",
        "in": "query",
        "required": false,
        "description": "Deze parameter kan worden gebruikt om alle details van geassocieerde subOins of het hoofdOin van de Organisatie op te vragen. Als de waarde `false` is worden alleen de OIN nummers voor de betreffende organisaties opgehaald. Als de waarde `true` is worden alle details opgehaald.",
        "schema": {
          "type": "boolean",
          "default": false
        }
      },
      "pagina": {
        "name": "pagina",
        "in": "query",
        "required": false,
        "description": "De vereiste pagina met de opgehaalde resultaten",
        "schema": {
          "type": "number"
        }
      },
      "fields": {
        "name": "fields",
        "in" : "query",
        "required": false,
        "description" : "Deze parameter geeft via een kommagescheiden lijst aan welke specifieke velden worden opgehaald",
        "schema" : {
          "type" : "string",
          "example" : "oin,naam"
        }
      },
      "geldigOp": {
        "name": "geldigOp",
        "in": "query",
        "description": "Tijdreizen organisatie voor de geldig op datum. Deze parameter kan alleen worden gecombineerd met de parameter beschikbaarOp.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "yyyy-MM-dd"
        }
      },
      "beschikbaarOp": {
        "name": "beschikbaarOp",
        "in": "query",
        "description": "Tijdreizen organisatie voor de beschikbaar op datum. Deze parameter kan alleen worden gecombineerd met de parameter geldigOp.",
        "required": false,
        "schema": {
          "type": "string",
          "format": "yyyy-MM-dd"
        }
      }
    },
    "responses": {
      "OrganisatiesMetHALPagination": {
        "description": "Organisaties met HAL pagination info response object",
        "content": {
          "application/hal+json": {
            "schema": {
              "$ref": "#/components/schemas/OrganisatiesMetHALPaginationInfo"
            }
          }
        },
        "headers": {
          "X-API-Version": {
            "description": "De huidige versie van de applicatie",
            "schema": {
              "type": "string"
            }
          },
          "X-Total-Count": {
            "description": "The total count of results obtained for the request provided",
            "schema": {
              "type": "number"
            }
          },
          "X-Pagination-Count": {
            "description": "The total number of pages obtained containing the results for the request provided",
            "schema": {
              "type": "number"
            }
          },
          "X_Pagination-Page": {
            "description": "The current page of the results obtained for the request provided",
            "schema": {
              "type": "number"
            }
          },
          "X-Pagination-Limit": {
            "description": "The total number of results defined per page",
            "schema": {
              "type": "number"
            }
          }
        }
      },
      "OrganisatieMetHALInfo": {
        "description": "Organisatie response Object",
        "content": {
          "application/hal+json": {
            "schema": {
              "$ref": "#/components/schemas/OrganisatieMetHALInfo"
            }
          }
        },
        "headers": {
          "X-API-Version": {
            "description": "De huidige versie van de applicatie",
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "LaatsteWijzigingDatumMetHALInfo": {
        "description": "Laatste wijzigingsdatum response Object",
        "content": {
          "application/hal+json": {
            "schema": {
              "$ref": "#/components/schemas/LaatsteWijzigingDatumMetHALInfo"
            }
          }
        },
        "headers": {
          "X-API-Version": {
            "description": "De huidige versie van de applicatie",
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "TijdreizenOrganisatiesMetHALInfo": {
        "description": "Organisatie tijdreizen response Object",
        "content": {
          "application/hal+json": {
            "schema": {
              "$ref": "#/components/schemas/TijdreizenOrganisatiesMetHALInfo"
            }
          }
        },
        "headers": {
          "X-API-Version": {
            "description": "De huidige versie van de applicatie",
            "schema": {
              "type": "string"
            }
          }
        }
      },
      "Error": {
        "description": "Error beschrijving",
        "content": {
          "application+problem/json": {
            "schema": {
              "type": "object",
              "description": "Beschrijving van het Error Object",
              "required": [
                "type",
                "title",
                "status",
                "detail",
                "instance"
              ],
              "properties": {
                "type": {
                  "type": "string",
                  "description": "https://portaal.digikoppeling.nl/registers/api/foutDetails.html",
                  "example": "https://portaal.digikoppeling.nl/registers/api/foutDetails.html#ErrorMessage"
                },
                "title": {
                  "type": "string",
                  "example": "Titel van de foutmelding"
                },
                "status": {
                  "type": "integer",
                  "example": "Http status code"
                },
                "detail": {
                  "type": "string",
                  "example": "Beschrijving van de foutmelding"
                },
                "instance": {
                  "type": "string",
                  "example": "urn:uuid:60f42ea0-1dea-406c-834c-c2dc71f23ba1"
                }
              }
            }
          }
        },
        "headers": {
          "X-API-Version": {
            "description": "De huidige versie van de applicatie",
            "schema": {
              "type": "string"
            }
          }
        }
      }
    },
    "schemas": {
      "OrganisatiesMetHALPaginationInfo": {
        "type": "object",
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/HALPaginationInfo"
          },
          "organisaties": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Organisatie"
            }
          }
        }
      },
      "HALPaginationInfo": {
        "type": "object",
        "properties": {
          "self": {
            "type": "object",
            "properties": {
              "href": {
                "type": "string",
                "description": "A link to the resource which the parent is currently defining",
                "example": "https://portaal.digikoppeling.nl/registers/api/v1/organisaties"
              },
              "type": {
                "type": "string",
                "description": "The mime-type of the resource the parent is currently describing",
                "example": "application/hal+json"
              }
            }
          },
          "first": {
            "type": "object",
            "properties": {
              "href": {
                "type": "string",
                "description": "A link to the first page of the requested results",
                "example": "https://portaal.digikoppeling.nl/registers/api/v1/organisaties?pagina=1"
              },
              "type": {
                "type": "string",
                "description": "The mime-type of the resource the parent is currently describing",
                "example": "application/hal+json"
              }
            }
          },
          "prev": {
            "type": "object",
            "properties": {
              "href": {
                "type": "string",
                "description": "A link to the previous page of the requested results",
                "example": "https://portaal.digikoppeling.nl/registers/api/v1/organisaties?pagina=2"
              },
              "type": {
                "type": "string",
                "description": "The mime-type of the resource the parent is currently describing",
                "example": "application/hal+json"
              }
            }
          },
          "next": {
            "type": "object",
            "properties": {
              "href": {
                "type": "string",
                "description": "A link to the next page of the requested results",
                "example": "https://portaal.digikoppeling.nl/registers/api/v1/organisaties?pagina=4"
              },
              "type": {
                "type": "string",
                "description": "The mime-type of the resource the parent is currently describing",
                "example": "application/hal+json"
              }
            }
          },
          "last": {
            "type": "object",
            "properties": {
              "href": {
                "type": "string",
                "description": "A link to the last page of the requested results",
                "example": "https://portaal.digikoppeling.nl/registers/api/v1/organisaties?pagina=5"
              },
              "type": {
                "type": "string",
                "description": "The mime-type of the resource the parent is currently describing",
                "example": "application/hal+json"
              }
            }
          }
        }
      },
      "OrganisatieMetHALInfo": {
        "type": "object",
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/HALInfo"
          },
          "organisaties": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Organisatie"
            }
          }
        }
      },
      "TijdreizenOrganisatiesMetHALInfo": {
        "type": "object",
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/HALInfo"
          },
          "geldigOp": {
            "$ref": "#/components/schemas/Organisatie"
          },
          "beschikbaarOp": {
            "$ref": "#/components/schemas/Organisatie"
          }
        }
      },
      "HALInfo": {
        "type": "object",
        "properties": {
          "self": {
            "type": "object",
            "properties": {
              "href": {
                "type": "string",
                "description": "A link to the resource which the parent is currently defining",
                "example": "https://portaal.digikoppeling.nl/registers/api/v1/organisaties/00000001123456789000"
              },
              "type": {
                "type": "string",
                "description": "The mime-type of the resource the parent is currently describing",
                "example": "application/hal+json"
              }
            }
          }
        }
      },
      "Organisatie": {
        "type": "object",
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/HALInfo"
          },
          "kvkNummer": {
            "type": "number",
            "description": "KvK nummer",
            "example": 12345678
          },
          "naam": {
            "type": "string",
            "description": "Naam van de organisatie",
            "example": "Organisatie ABC"
          },
          "oin": {
            "type": "number",
            "example": "00000001123456789000"
          },
          "status": {
            "type": "string",
            "description": "Status van de OIN in the COR. Deze kan 'Actief' of 'Ingetrokken' zijn",
            "enum": [
              "Actief",
              "Ingetrokken"
            ],
            "example": "Actief of Ingetrokken"
          },
          "afgifteDatum": {
            "type": "string",
            "description": "Afgiftedatum van de OIN",
            "format": "date-time",
            "example": "2012-07-18 22:00:00 UTC"
          },
          "laatstAangepastDatum": {
            "type": "string",
            "description": "Datum van wanneer er voor het laatst een aanpassing is geweest op een van de OIN gegevens",
            "format": "date-time",
            "example": "2018-09-05 13:09:40 UTC"
          },
         "intrekDatum": {
            "type": "string",
            "description": "Intrekdatum van de OIN",
            "format": "date-time",
            "example": "2012-07-18 22:00:00 UTC"
          },
          "organisatieCode": {
            "type": "string",
            "description": "Code van de organisatie",
            "example": 1234
          },
          "organisatieType": {
            "type": "string",
            "description": "Type van de organisatie",
            "example": "GM, PV, WS, MNRE, GS of GR"
          },
          "hoofdOIN": {
            "type": "object",
            "description": "Indien het een subOIN betreft, wordt hier de hoofdOIN getoond",
            "properties": {
              "organisatie": {
                "$ref": "#/components/schemas/Organisatie_core"
              }
            }
          },
          "subOINs": {
            "type": "array",
            "description": "Indien het een hoofdOIN betreft, worden hier indien aanwezig de subOIN's getoond",
            "items": {
              "$ref": "#/components/schemas/Organisatie_core"
            }
          }
        }
      },
      "Organisatie_core": {
        "type": "object",
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/HALInfo"
          },
          "kvkNummer": {
            "type": "number",
            "description": "KvK nummer",
            "example": 12345678
          },
          "naam": {
            "type": "string",
            "description": "Naam van de organisatie",
            "example": "Organisatie ABC"
          },
          "oin": {
            "type": "number",
            "description": "Organisatie Identificatienummer",
            "example": "00000001123456789000"
          },
          "status": {
            "type": "string",
            "description": "Status van de OIN in the COR. Deze kan 'Actief' of 'Ingetrokken' zijn",
            "enum": [
              "Actief",
              "Ingetrokken"
            ],
            "example": "Actief of Ingetrokken"
          },
          "afgifteDatum": {
            "type": "string",
            "description": "Afgiftedatum van de OIN",
            "format": "date-time",
            "example": "2012-07-18 22:00:00 UTC"
          },
          "laatstAangepastDatum": {
            "type": "string",
            "description": "Datum van wanneer er voor het laatst een aanpassing is geweest op een van de OIN gegevens",
            "format": "date-time",
            "example": "2018-09-05 13:09:40 UTC"
          },
          "intrekDatum": {
            "type": "string",
            "description": "Intrekdatum van de OIN",
            "format": "date-time",
            "example": "2012-07-18 22:00:00 UTC"
          },
          "organisatieCode": {
            "type": "string",
            "description": "Code van de organisatie",
            "example": 1234
          },
          "organisatieType": {
            "type": "string",
            "description": "Type van de organisatie",
            "example": "GM, PV, WS, MNRE, GS of GR"
          }
        }
      },
      "LaatsteWijzigingDatumMetHALInfo": {
        "type": "object",
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/LaatsteWijzigingDatumHALInfo"
          },
          "laatsteWijziging": {
            "type": "string",
            "format": "date time",
            "example": "2019-01-19T08:15:56Z"
          }
        }
      },
      "LaatsteWijzigingDatumHALInfo": {
        "type": "object",
        "properties": {
          "self": {
            "type": "object",
            "properties": {
              "href": {
                "type": "string",
                "description": "A link to the URL",
                "example": "https://portaal.digikoppeling.nl/registers/api/v1/laatsteWijziging"
              },
              "type": {
                "type": "string",
                "description": "The mime-type of the resource the parent is currently describing",
                "example": "application/hal+json"
              }
            }
          }
        }
      }
    }
  }
}