{ "openapi": "3.0.0", "info": { "title": "IIO API", "description": "Deze API (Application Programming Interface) van RVO biedt de mogelijkheid om data van het Informatiehuis Internationaal Ondernemen (IIO) op te vragen.\nOm ervoor te zorgen dat RVO zijn dienstverlening zo goed mogelijk aan kan bieden is de Informatie Internationaal Ondernemen (IIO) API momenteel alleen bruikbaar met behulp van een API-key. RVO gebruikt deze key om inzicht te krijgen in het gebruik van de API. Bijvoorbeeld om te meten welke endpoints en filtermogelijkheden het populairst zijn. We gebruiken de API-key ook om de gebruikers van de API in beeld te krijgen. Zo kunnen wij gebruikers tijdig informeren over incidenten (veroorzaakte piekbelasting, storingen, etc.) en backwards incompatible wijzigingen (versie updates, deprecation periods, etc.).\n\nEen IIO API-key kan verkregen worden door een e-mail te sturen naar informatiehuisIO@rvo.nl. Om onze dienstverlening in de toekomst te kunnen verbeteren en aan te laten sluiten bij onze gebruikers stellen wij het op prijs als je ook laat weten wie je bent en wat je motivatie is om deze API te gebruiken.\n\nDe loggings gegevens worden enkel gebruikt voor statische doeleinden, beheer en doorontwikkeling. Loggings gegevens worden niet gepubliceerd als dit herleidbaar kan zijn naar individuele gebruikers.\n\nEen compleet overzicht van alle technische wijzigingen is te vinden in de onderstaande changelog: [https://internationaal.ondernemen.overheid.nl/api/iio/v1/changelog.md](https://internationaal.ondernemen.overheid.nl/api/iio/v1/changelog.md)\n", "contact": { "name": "Rijksdienst voor Ondernemend Nederland", "url": "https://www.rvo.nl/onderwerpen/open-data/informatiehuis", "email": "InformatiehuisIO@rvo.nl" }, "version": "1.3.0" }, "servers": [ { "url": "https://acc-internationaal.ondernemen.overheid.nl/api/iio/v1", "description": "Acceptance environment" }, { "url": "https://internationaal.ondernemen.overheid.nl/api/iio/v1", "description": "Production environment" } ], "tags": [ { "name": "content-items", "description": "content-items" }, { "name": "landen", "description": "landen" }, { "name": "evenementen", "description": "evenementen" }, { "name": "financieringen", "description": "financieringen" }, { "name": "wet-en-regelgevingen", "description": "wet-en-regelgevingen" }, { "name": "sectoren", "description": "sectoren" } ], "paths": { "/content-items/{uuid}": { "get": { "tags": [ "content-items" ], "summary": "Endpoint for retrieving a single content item.", "description": "Return the image, body, source, country and link of a content item.", "operationId": "cb2563a65b97e3abd9c67d05be251ac3", "parameters": [ { "name": "uuid", "in": "path", "description": "A UUID parameter from a sector, country, content-item etc.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } } ], "responses": { "200": { "description": "OK", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "A content item.", "required": [ "id", "titel", "tekst", "link", "afbeelding", "gepubliceerdOp", "landen", "sectoren", "_links" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "titel": { "description": "The title of the content-item.", "type": "string", "example": "Doing Business in\n * Germany" }, "tekst": { "description": "Raw\n * HTML content of the content-item description. Clients must ensure to\n * properly escape this content when rendering to prevent XSS\n * vulnerabilities.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

" }, "link": { "description": "A URL to the\n * content-item's detail page.", "type": "string", "format": "uri", "example": "https://example.com/content/123" }, "afbeelding": { "description": "Main image for the content-item.", "type": "object", "example": { "url": "https://ih-static.rvo.nl/sites/default/files/fallback_images/2.svg", "alt-text": "Default image for the content-item" }, "allOf": [ { "description": "An image associated this item.", "properties": { "alt-text": { "description": "Alternative text for the image, can be null.", "type": "string", "example": "A beautiful sunset over the mountains", "nullable": true }, "url": { "description": "The URL of the image.", "type": "string", "format": "uri", "example": "https://example.com/images/sunset.jpg" } }, "type": "object" } ] }, "gepubliceerdOp": { "description": "The published date and time of the content-item in ISO 8601\n * format.", "type": "string", "format": "date-time", "example": "2024-02-10T09:00:06+01:00" }, "landen": { "description": "A list of countries associated with the content-item.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } }, "sectoren": { "description": "A list of industry sectors associated with the\n * content-item.", "type": "array", "items": { "description": "A list of industry sectors associated with this item.", "properties": { "sector": { "description": "The sector name.", "type": "string", "example": "Energy" }, "link": { "description": "A link to the sector detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/sectoren/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } }, "_links": { "properties": { "self": { "description": "Link to the content item.", "properties": { "href": { "description": "The URL for the content item.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/content-items/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "404": { "description": "The requested resource could not be found.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/content-items": { "get": { "tags": [ "content-items" ], "summary": "Endpoint for retrieving all available content items.", "description": "Return the ID's of all content-items together with the title, body, link, image, date and related sectors or countries.", "operationId": "41d02f605eb27c973e0bf1ef0916f0a4", "parameters": [ { "name": "sector", "in": "query", "description": "Filter items by one or more sector UUIDs. UUIDs should be comma-separated for multiple sectors.", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, { "name": "country", "in": "query", "description": "Filter items by one or more country UUIDs. UUIDs should be comma-separated for multiple countries.", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, { "name": "pageSize", "in": "query", "description": "Set the amount of items to retrieve per page.", "required": false, "schema": { "type": "integer", "default": 10, "enum": [ 10, 20, 50 ] } }, { "name": "page", "in": "query", "description": "Set the current page for the items to retrieve.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1 } } ], "responses": { "200": { "description": "OK", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "required": [ "_embedded", "_links" ], "properties": { "_embedded": { "description": "A collection schema for the ContentItem schema.", "properties": { "content-items": { "description": "A list of Content items.", "type": "array", "items": { "description": "A content item.", "required": [ "id", "titel", "tekst", "link", "afbeelding", "gepubliceerdOp", "landen", "sectoren", "_links" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "titel": { "description": "The title of the content-item.", "type": "string", "example": "Doing Business in\n * Germany" }, "tekst": { "description": "Raw\n * HTML content of the content-item description. Clients must ensure to\n * properly escape this content when rendering to prevent XSS\n * vulnerabilities.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

" }, "link": { "description": "A URL to the\n * content-item's detail page.", "type": "string", "format": "uri", "example": "https://example.com/content/123" }, "afbeelding": { "description": "Main image for the content-item.", "type": "object", "example": { "url": "https://ih-static.rvo.nl/sites/default/files/fallback_images/2.svg", "alt-text": "Default image for the content-item" }, "allOf": [ { "description": "An image associated this item.", "properties": { "alt-text": { "description": "Alternative text for the image, can be null.", "type": "string", "example": "A beautiful sunset over the mountains", "nullable": true }, "url": { "description": "The URL of the image.", "type": "string", "format": "uri", "example": "https://example.com/images/sunset.jpg" } }, "type": "object" } ] }, "gepubliceerdOp": { "description": "The published date and time of the content-item in ISO 8601\n * format.", "type": "string", "format": "date-time", "example": "2024-02-10T09:00:06+01:00" }, "landen": { "description": "A list of countries associated with the content-item.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } }, "sectoren": { "description": "A list of industry sectors associated with the\n * content-item.", "type": "array", "items": { "description": "A list of industry sectors associated with this item.", "properties": { "sector": { "description": "The sector name.", "type": "string", "example": "Energy" }, "link": { "description": "A link to the sector detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/sectoren/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } }, "_links": { "properties": { "self": { "description": "Link to the content item.", "properties": { "href": { "description": "The URL for the content item.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/content-items/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } }, "type": "object" }, "_links": { "description": "A collection of links for the current resource.", "properties": { "next": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=3", "nullable": true } }, "type": "object" }, "prev": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=1", "nullable": true } }, "type": "object" }, "self": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "The request contains an invalid parameter.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/landen": { "get": { "tags": [ "landen" ], "summary": "Endpoint for retrieving all available countries.", "description": "Return the ID's of all countries together with the country name, ISO codes, capital and time difference with The Netherlands.", "operationId": "55006505420b428e587677ec9438e862", "parameters": [ { "name": "code", "in": "query", "description": "A filter parameter for the country code.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 123 } }, { "name": "code_iso_alpha_2", "in": "query", "description": "A filter parameter for the ISO Alpha-2 code.", "required": false, "schema": { "type": "string", "example": "NL" } }, { "name": "code_iso_alpha_3", "in": "query", "description": "A filter parameter for the ISO Alpha-3 code.", "required": false, "schema": { "type": "string", "example": "NLD" } }, { "name": "code_iso_3166_2", "in": "query", "description": "A filter parameter for the ISO 3166-2 code.", "required": false, "schema": { "type": "string", "example": "ISO 3166-2:NR" } }, { "name": "pageSize", "in": "query", "description": "Set the amount of items to retrieve per page.", "required": false, "schema": { "type": "integer", "default": 10, "enum": [ 10, 20, 50 ] } }, { "name": "page", "in": "query", "description": "Set the current page for the items to retrieve.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1 } }, { "name": "sort", "in": "query", "description": "Controls the sorting order of countries based on specified fields. Use field names as keys.", "required": false, "style": "deepObject", "explode": true, "schema": { "properties": { "name": { "description": "Specifies the field to sort by and its direction.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ] } }, "type": "object", "additionalProperties": false } } ], "responses": { "200": { "description": "OK", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "required": [ "_embedded", "_links" ], "properties": { "_embedded": { "description": "A collection schema for the Country schema.", "properties": { "landen": { "description": "A list of countries.", "type": "array", "items": { "description": "An excerpt of the country.", "required": [ "id", "naam", "code", "code_iso_alpha_2", "code_iso_alpha_3", "code_iso_3166_2" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "naam": { "description": "The country name.", "type": "string", "example": "Netherlands" }, "code": { "description": "The country code.", "type": "string", "example": "528", "nullable": true }, "code_iso_alpha_2": { "description": "The country ISO alpha 2 code.", "type": "string", "example": "NL", "nullable": true }, "code_iso_alpha_3": { "description": "The country ISO alpha 3 code.", "type": "string", "example": "NLD", "nullable": true }, "code_iso_3166_2": { "description": "The country ISO 3166 2 code.", "type": "string", "example": "NL-NH", "nullable": true }, "handelsBelemmering": { "description": "A string indicating a trade barrier.", "type": "string", "example": "http://madb.europa.eu/madb/barriers_result.htm?isSps=false&countries=NL", "nullable": true }, "_embedded": { "properties": { "hoofdstad": { "oneOf": [ { "description": "A city is a geographic region and can be the capital of a country.", "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "tijdsverschil": { "description": "The time difference in UTC/GMT of the city compared to the Netherlands.", "type": "number", "format": "float", "example": 2 }, "naam": { "description": "The name of the city.", "type": "string", "example": "Amsterdam" } }, "type": "object" } ], "nullable": true, "description": "The country capital." } }, "type": "object" }, "_links": { "properties": { "self": { "description": "Link to the country item.", "properties": { "href": { "description": "The URL for the country.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } }, "type": "object" }, "_links": { "description": "A collection of links for the current resource.", "properties": { "next": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=3", "nullable": true } }, "type": "object" }, "prev": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=1", "nullable": true } }, "type": "object" }, "self": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "The request contains an invalid parameter.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/landen/{uuid}": { "get": { "tags": [ "landen" ], "summary": "Endpoint for retrieving a single country.", "description": "Return the links, observations and do's and don'ts of a\n * country. Also including oficial languages, currency, currency code, image\n * file of flag, country name, country code, residence name, capital, time\n * difference with The Netherlands, form of government and business\n * languages.", "operationId": "4be0a1830edd0d476703a4600fd0df98", "parameters": [ { "name": "uuid", "in": "path", "description": "A UUID parameter from a sector, country, content-item etc.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } } ], "responses": { "200": { "description": "OK", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "A country.", "type": "object", "allOf": [ { "description": "An excerpt of the country.", "required": [ "id", "naam", "code", "code_iso_alpha_2", "code_iso_alpha_3", "code_iso_3166_2" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "naam": { "description": "The country name.", "type": "string", "example": "Netherlands" }, "code": { "description": "The country code.", "type": "string", "example": "528", "nullable": true }, "code_iso_alpha_2": { "description": "The country ISO alpha 2 code.", "type": "string", "example": "NL", "nullable": true }, "code_iso_alpha_3": { "description": "The country ISO alpha 3 code.", "type": "string", "example": "NLD", "nullable": true }, "code_iso_3166_2": { "description": "The country ISO 3166 2 code.", "type": "string", "example": "NL-NH", "nullable": true }, "handelsBelemmering": { "description": "A string indicating a trade barrier.", "type": "string", "example": "http://madb.europa.eu/madb/barriers_result.htm?isSps=false&countries=NL", "nullable": true }, "_embedded": { "properties": { "hoofdstad": { "oneOf": [ { "description": "A city is a geographic region and can be the capital of a country.", "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "tijdsverschil": { "description": "The time difference in UTC/GMT of the city compared to the Netherlands.", "type": "number", "format": "float", "example": 2 }, "naam": { "description": "The name of the city.", "type": "string", "example": "Amsterdam" } }, "type": "object" } ], "nullable": true, "description": "The country capital." } }, "type": "object" }, "_links": { "properties": { "self": { "description": "Link to the country item.", "properties": { "href": { "description": "The URL for the country.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } }, "type": "object" }, { "properties": { "officieleTalen": { "description": "The official languages of the country.", "type": "array", "items": { "description": "An official language", "type": "string" }, "example": [ "Nederlands", "Engels" ] }, "handelsverdrag": { "description": "URL of the trade agreement", "type": "string", "format": "uri", "example": "https://example.com/trade-agreements/12345" }, "valuta": { "description": "The currency or currencies used, each represented by a code and a name.", "type": "array", "items": { "properties": { "code": { "description": "The ISO currency code (e.g., USD, EUR).", "type": "string", "example": "EUR" }, "naam": { "description": "The name of the currency.", "type": "string", "example": "Euro" } }, "type": "object" } }, "vlag": { "description": "URL of the flag image", "type": "string", "format": "uri", "example": "https://ih-static.rvo.nl/sites/default/files/2019-08/nl.png" }, "inwonerbenaming": { "description": "The country demonym.", "type": "string", "example": "Nederlander" }, "staatsvorm": { "description": "The country regime.", "type": "string", "example": "constitutionele monarchie", "nullable": true }, "sanitaireProblemen": { "description": "Has the country sanitary problems.", "type": "boolean", "nullable": true }, "zakelijkeTalen": { "description": "The business languages of the country.", "type": "array", "items": { "description": "A business language", "type": "string" }, "example": [ "English", "French" ] }, "_links": { "properties": { "dosAndDonts": { "description": "Link to the country dos-donts.", "properties": { "href": { "description": "The URL for the country dos-donts.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6/dos-donts" } }, "type": "object" }, "contentItems": { "description": "Link to the country content-items.", "properties": { "href": { "description": "The URL for the country content-items.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6/content-items" } }, "type": "object" }, "instanties": { "description": "Link to the country authorities.", "properties": { "href": { "description": "The URL for the country authorities.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6/instanties" } }, "type": "object" }, "observaties": { "description": "Link to the country observations.", "properties": { "href": { "description": "The URL for the country observations.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6/observaties" } }, "type": "object" }, "self": { "description": "Link to the country item.", "properties": { "href": { "description": "The current URL for the country.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] } } } }, "404": { "description": "The requested resource could not be found.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/landen/{uuid}/instanties": { "get": { "tags": [ "landen" ], "summary": "Endpoint for retrieving the contact details of organizations of a country.", "description": "Return the contact details of organizations belonging to a country.", "operationId": "7de4ad5f6f9c92a9f26bde4d605e3021", "parameters": [ { "name": "uuid", "in": "path", "description": "A UUID parameter from a sector, country, content-item etc.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, { "name": "pageSize", "in": "query", "description": "Set the amount of items to retrieve per page.", "required": false, "schema": { "type": "integer", "default": 10, "enum": [ 10, 20, 50 ] } }, { "name": "page", "in": "query", "description": "Set the current page for the items to retrieve.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1 } } ], "responses": { "200": { "description": "OK", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "required": [ "_embedded", "_links" ], "properties": { "_embedded": { "description": "A collection schema for the Contacts schema.", "properties": { "instanties": { "description": "A list of contacts.", "type": "array", "items": { "description": "Contact details of an organization.", "properties": { "contactpunten": { "description": "The points of contact.", "type": "array", "items": { "description": "Points of contact of a country organization.", "properties": { "twitter": { "description": "The twitter link of this organization.", "type": "string", "format": "uri", "example": "https://www.twitter.com/rvo", "nullable": true }, "telefoonnummer": { "description": "The telephone numbers of this organization.", "type": "array", "items": { "description": "A single telephone number", "type": "string", "example": "+31880424242" } }, "openingstijden": { "description": "The opening hours of this organization in HTML format.", "type": "string", "format": "html", "example": "

You can reach us on working days from 8:30 AM to 5:00 PM.

", "nullable": true }, "faxnummer": { "description": "The fax number of this organization.", "type": "string", "example": "+31880429527", "nullable": true }, "email": { "description": "The email address of this organization.", "type": "string", "example": "info@rvo.nl", "nullable": true } }, "type": "object" } }, "geometrie": { "description": "The coordinates of this organization.", "type": "array", "items": { "description": "The coordinates of a country organization.", "properties": { "type": { "description": "The type of this Geometry.", "type": "string", "example": "Point" }, "coordinates": { "description": "The Latitude and Longitude of this organization.", "type": "array", "items": { "description": "A coordinate value", "type": "number", "format": "float", "nullable": true }, "example": [ 12.34, 56.78 ], "nullable": true } }, "type": "object" } }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "naam": { "description": "The name of the contact.", "type": "string", "example": "RVO headquarters" }, "vestiging": { "properties": { "address": { "properties": { "volledigAdres": { "description": "The address of the contact.", "type": "string", "example": "Prinses Beatrixlaan 2 2595 AL Den Haag Zuid-Holland", "nullable": true } }, "type": "object" } }, "type": "object" }, "homepage": { "description": "The website of the contact.", "type": "string", "format": "uri", "example": "https://www.rvo.nl" }, "landen": { "description": "A list of countries related to the current contact.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" }, "_links": { "description": "A collection of links. For the current resource and a link to the owning country.", "type": "object", "allOf": [ { "description": "A collection of links for the current resource.", "properties": { "next": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=3", "nullable": true } }, "type": "object" }, "prev": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=1", "nullable": true } }, "type": "object" }, "self": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint" } }, "type": "object" } }, "type": "object" }, { "properties": { "land": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } ] } }, "type": "object" } } } }, "400": { "description": "The request contains an invalid parameter.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } }, "404": { "description": "The requested resource could not be found.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/landen/{uuid}/content-items": { "get": { "tags": [ "landen" ], "summary": "Endpoint for retrieving the content item details of a country.", "description": "Return the content items details belonging to a country.", "operationId": "57ec834dbfe206006cd4d2d9fde4d017", "parameters": [ { "name": "uuid", "in": "path", "description": "A UUID parameter from a sector, country, content-item etc.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, { "name": "pageSize", "in": "query", "description": "Set the amount of items to retrieve per page.", "required": false, "schema": { "type": "integer", "default": 10, "enum": [ 10, 20, 50 ] } }, { "name": "page", "in": "query", "description": "Set the current page for the items to retrieve.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1 } } ], "responses": { "200": { "description": "OK", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "required": [ "_embedded", "_links" ], "properties": { "_embedded": { "description": "A collection schema for the ContentItem schema.", "properties": { "content-items": { "description": "A list of Content items.", "type": "array", "items": { "description": "A content item.", "required": [ "id", "titel", "tekst", "link", "afbeelding", "gepubliceerdOp", "landen", "sectoren", "_links" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "titel": { "description": "The title of the content-item.", "type": "string", "example": "Doing Business in\n * Germany" }, "tekst": { "description": "Raw\n * HTML content of the content-item description. Clients must ensure to\n * properly escape this content when rendering to prevent XSS\n * vulnerabilities.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

" }, "link": { "description": "A URL to the\n * content-item's detail page.", "type": "string", "format": "uri", "example": "https://example.com/content/123" }, "afbeelding": { "description": "Main image for the content-item.", "type": "object", "example": { "url": "https://ih-static.rvo.nl/sites/default/files/fallback_images/2.svg", "alt-text": "Default image for the content-item" }, "allOf": [ { "description": "An image associated this item.", "properties": { "alt-text": { "description": "Alternative text for the image, can be null.", "type": "string", "example": "A beautiful sunset over the mountains", "nullable": true }, "url": { "description": "The URL of the image.", "type": "string", "format": "uri", "example": "https://example.com/images/sunset.jpg" } }, "type": "object" } ] }, "gepubliceerdOp": { "description": "The published date and time of the content-item in ISO 8601\n * format.", "type": "string", "format": "date-time", "example": "2024-02-10T09:00:06+01:00" }, "landen": { "description": "A list of countries associated with the content-item.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } }, "sectoren": { "description": "A list of industry sectors associated with the\n * content-item.", "type": "array", "items": { "description": "A list of industry sectors associated with this item.", "properties": { "sector": { "description": "The sector name.", "type": "string", "example": "Energy" }, "link": { "description": "A link to the sector detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/sectoren/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } }, "_links": { "properties": { "self": { "description": "Link to the content item.", "properties": { "href": { "description": "The URL for the content item.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/content-items/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } }, "type": "object" }, "_links": { "description": "A collection of links. For the current resource and a link to the owning country.", "type": "object", "allOf": [ { "description": "A collection of links for the current resource.", "properties": { "next": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=3", "nullable": true } }, "type": "object" }, "prev": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=1", "nullable": true } }, "type": "object" }, "self": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint" } }, "type": "object" } }, "type": "object" }, { "properties": { "land": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } ] } }, "type": "object" } } } }, "400": { "description": "The request contains an invalid parameter.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } }, "404": { "description": "The requested resource could not be found.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/landen/{uuid}/dos-donts": { "get": { "tags": [ "landen" ], "summary": "Endpoint for retrieving the do's and don'ts of a country.", "description": "Return the do's and don'ts of a country.", "operationId": "d356657ec8fd100a386f6213877af591", "parameters": [ { "name": "uuid", "in": "path", "description": "A UUID parameter from a sector, country, content-item etc.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, { "name": "pageSize", "in": "query", "description": "Set the amount of items to retrieve per page.", "required": false, "schema": { "type": "integer", "default": 10, "enum": [ 10, 20, 50 ] } }, { "name": "page", "in": "query", "description": "Set the current page for the items to retrieve.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1 } } ], "responses": { "200": { "description": "OK", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "required": [ "_embedded", "_links" ], "properties": { "_embedded": { "description": "A collection schema for the DoDont (do or don't) schema.", "properties": { "dos-donts": { "description": "A list of do's and don'ts.", "type": "array", "items": { "description": "Do or Don't of a country.", "properties": { "categorieen": { "description": "The categories this do or don't belongs to.", "type": "array", "items": { "description": "A category name", "type": "string" }, "example": [ "Presentatie" ] }, "titel": { "description": "The name of the contact.", "type": "string", "example": "Choose elaborate clothing" }, "isDo": { "description": "Is it a do or a don't.", "type": "boolean" }, "tekst": { "description": "The name of the contact.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

" }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "landen": { "description": "A list of countries related to the current do or don't.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" }, "_links": { "description": "A collection of links. For the current resource and a link to the owning country.", "type": "object", "allOf": [ { "description": "A collection of links for the current resource.", "properties": { "next": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=3", "nullable": true } }, "type": "object" }, "prev": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=1", "nullable": true } }, "type": "object" }, "self": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint" } }, "type": "object" } }, "type": "object" }, { "properties": { "land": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } ] } }, "type": "object" } } } }, "400": { "description": "The request contains an invalid parameter.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } }, "404": { "description": "The requested resource could not be found.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/landen/{uuid}/observaties": { "get": { "tags": [ "landen" ], "summary": "Endpoint for retrieving all observations of a country.", "description": "Retrieve observations for a specific country using a valid country UUID.", "operationId": "83b2b74391c8ad884456ce4700840423", "parameters": [ { "name": "uuid", "in": "path", "description": "A UUID parameter from a sector, country, content-item etc.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, { "name": "type", "in": "query", "description": "Specifies the type of observation to filter by.", "required": false, "schema": { "description": "Enumerated list of available observation types for filtering.", "type": "string", "enum": [ "bigMacIndex", "economischeGroei", "easeOfDoingBusinessIndex", "uitvoerwaarde", "corruptieIndex", "bbp", "koopkracht", "globalCompetitivenessIndex", "globalInnovationIndex", "invoerWaarde", "inflatie", "logisticPerformanceIndex", "inwoneraantal", "oppervlakte", "werkloosheid" ] } }, { "name": "year", "in": "query", "description": "Filter results on a specific year.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 2024 } }, { "name": "jaartal", "in": "query", "description": "Filter results on a specific year with a dutch parameter.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 2024 } }, { "name": "pageSize", "in": "query", "description": "Set the amount of items to retrieve per page.", "required": false, "schema": { "type": "integer", "default": 10, "enum": [ 10, 20, 50 ] } }, { "name": "page", "in": "query", "description": "Set the current page for the items to retrieve.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1 } } ], "responses": { "200": { "description": "OK", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "required": [ "_embedded", "_links" ], "properties": { "_embedded": { "description": "A collection schema for the Observation schema.", "properties": { "observaties": { "description": "A list of countries.", "type": "array", "items": { "description": "An observation (measurement) of a country.", "required": [ "id", "type", "meeteenheid", "waarde", "jaartal", "ranking", "schatting", "schaal", "herkomst" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "type": { "description": "The type of the observation.", "type": "string", "enum": [ "bigMacIndex", "economischeGroei", "easeOfDoingBusinessIndex", "uitvoerwaarde", "corruptieIndex", "bbp", "koopkracht", "globalCompetitivenessIndex", "globalInnovationIndex", "invoerWaarde", "inflatie", "logisticPerformanceIndex", "inwoneraantal", "oppervlakte", "werkloosheid" ], "example": "oppervlakte" }, "meeteenheid": { "required": [ "naam", "afkorting" ], "properties": { "naam": { "description": "The measuring unit.", "type": "string", "example": "Vierkante kilometer", "nullable": true }, "afkorting": { "type": "string", "example": "

In km²

", "nullable": true } }, "type": "object", "nullable": true }, "waarde": { "description": "The amount of the observation.", "type": "string", "example": "1671000", "nullable": true }, "jaartal": { "description": "The year of the observation.", "type": "string", "example": "2016", "nullable": true }, "ranking": { "description": "The ranking of the observation.", "type": "integer", "example": 5, "nullable": true }, "schatting": { "description": "If this observation is an estimation.", "type": "boolean", "example": false, "nullable": true }, "schaal": { "description": "The scale of the observation.", "type": "string", "example": "km²", "nullable": true }, "herkomst": { "required": [ "bron", "datum" ], "properties": { "bron": { "required": [ "naam" ], "properties": { "naam": { "description": "The origin of the observation.", "type": "string", "example": "Wereldbank", "nullable": true } }, "type": "object", "nullable": true }, "datum": { "type": "string", "format": "date", "example": "2022-12-01", "nullable": true } }, "type": "object", "nullable": true }, "landen": { "description": "A list of countries related to the current country observation.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object", "nullable": true } } }, "type": "object" }, "_links": { "description": "A collection of links. For the current resource and a link to the owning country.", "type": "object", "allOf": [ { "description": "A collection of links for the current resource.", "properties": { "next": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=3", "nullable": true } }, "type": "object" }, "prev": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=1", "nullable": true } }, "type": "object" }, "self": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint" } }, "type": "object" } }, "type": "object" }, { "properties": { "land": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } ] } }, "type": "object" } } } }, "400": { "description": "The request contains an invalid parameter.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } }, "404": { "description": "The requested resource could not be found.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/evenementen": { "get": { "tags": [ "evenementen" ], "summary": "Endpoint for retrieving all available \"event\" content items.", "description": "Return the ID's of all events together with the event title, body, link, image, dates and related sectors or countries.", "operationId": "e9874c5e74eaf5c66c5173738747d2e1", "parameters": [ { "name": "sector", "in": "query", "description": "Filter items by one or more sector UUIDs. UUIDs should be comma-separated for multiple sectors.", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, { "name": "country", "in": "query", "description": "Filter items by one or more country UUIDs. UUIDs should be comma-separated for multiple countries.", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, { "name": "pageSize", "in": "query", "description": "Set the amount of items to retrieve per page.", "required": false, "schema": { "type": "integer", "default": 10, "enum": [ 10, 20, 50 ] } }, { "name": "page", "in": "query", "description": "Set the current page for the items to retrieve.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1 } } ], "responses": { "200": { "description": "OK", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "required": [ "_embedded", "_links" ], "properties": { "_embedded": { "description": "A collection schema for the Event schema.", "properties": { "evenementen": { "description": "A list of Content items.", "type": "array", "items": { "description": "A Event.", "required": [ "id", "titel", "tekst", "link", "afbeelding", "startdatum", "einddatum", "sectoren", "landen" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "titel": { "description": "The title of\n * the event.", "type": "string", "example": "Germany MEDICA 2024" }, "tekst": { "description": "Raw\n * HTML content of the event description. Clients must ensure to properly\n * escape this content when rendering to prevent XSS vulnerabilities.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

" }, "link": { "description": "A\n * URL to the event's detail page.", "type": "string", "format": "uri", "example": "https://www.rvo.nl/evenementen/duitsland-healthholland-paviljoen-medica-2024", "nullable": true }, "afbeelding": { "description": "Main image for the event.", "type": "object", "example": { "url": "https://ih-static.rvo.nl/sites/default/files/fallback_images/5.svg", "alt-text": "Default image for the event" }, "allOf": [ { "description": "An image associated this item.", "properties": { "alt-text": { "description": "Alternative text for the image, can be null.", "type": "string", "example": "A beautiful sunset over the mountains", "nullable": true }, "url": { "description": "The URL of the image.", "type": "string", "format": "uri", "example": "https://example.com/images/sunset.jpg" } }, "type": "object" } ] }, "startdatum": { "description": "The start date and time of the event in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2024-02-10T09:00:06+01:00" }, "einddatum": { "description": "The end date and time of the event in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2024-02-10T09:00:06+01:00" }, "landen": { "description": "A list of countries associated with the event.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } }, "sectoren": { "description": "A list of industry sectors associated with the event.", "type": "array", "items": { "description": "A list of industry sectors associated with this item.", "properties": { "sector": { "description": "The sector name.", "type": "string", "example": "Energy" }, "link": { "description": "A link to the sector detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/sectoren/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" }, "_links": { "description": "A collection of links for the current resource.", "properties": { "next": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=3", "nullable": true } }, "type": "object" }, "prev": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=1", "nullable": true } }, "type": "object" }, "self": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "The request contains an invalid parameter.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/financieringen": { "get": { "tags": [ "financieringen" ], "summary": "Endpoint for retrieving all available finances and subsidy from countries.", "description": "Return the title, body and link of all finances and subsidies\n * together with the related country along with associated country names,\n * links, and IDs. Supports filtering by multiple country IDs using the\n * 'country' query parameter.", "operationId": "f7654c4e9f8c90aaf51780e68af65c10", "parameters": [ { "name": "country", "in": "query", "description": "Filter items by one or more country UUIDs. UUIDs should be comma-separated for multiple countries.", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, { "name": "pageSize", "in": "query", "description": "Set the amount of items to retrieve per page.", "required": false, "schema": { "type": "integer", "default": 10, "enum": [ 10, 20, 50 ] } }, { "name": "page", "in": "query", "description": "Set the current page for the items to retrieve.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1 } } ], "responses": { "200": { "description": "OK", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "required": [ "_embedded", "_links" ], "properties": { "_embedded": { "description": "A collection schema for the Finance schema.", "properties": { "financieringen": { "description": "A list of finances and subsidies.", "type": "array", "items": { "description": "Finance and subsidy of a country.", "required": [ "titel", "tekst", "landen", "link" ], "properties": { "titel": { "description": "The title of the finance and subsidy.", "type": "string", "example": "Canada subsidy guide", "nullable": true }, "tekst": { "description": "Raw HTML content of the finance and subsidy. Clients must ensure to properly escape this content when rendering to prevent XSS vulnerabilities.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

", "nullable": true }, "link": { "description": "A URL to a related finance and subsidy page.", "type": "string", "format": "uri", "example": "https://www.rvo.nl/subsidies-financiering?countries=401&status=3294%2C3295", "nullable": true }, "landen": { "description": "A list of countries associated with this finance and subsidy.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object", "nullable": true } } }, "type": "object" }, "_links": { "description": "A collection of links for the current resource.", "properties": { "next": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=3", "nullable": true } }, "type": "object" }, "prev": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=1", "nullable": true } }, "type": "object" }, "self": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "The request contains an invalid parameter.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/wet-en-regelgevingen": { "get": { "tags": [ "wet-en-regelgevingen" ], "summary": "Endpoint for retrieving all available laws and regulations from countries.", "description": "Return the title, body and link of all laws and regulations\n * together with the related country along with associated country names,\n * links, and IDs. Supports filtering by multiple country IDs using the\n * 'country' query parameter.", "operationId": "dc4e5822216cdd28048fbc795e368e72", "parameters": [ { "name": "country", "in": "query", "description": "Filter items by one or more country UUIDs. UUIDs should be comma-separated for multiple countries.", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, { "name": "pageSize", "in": "query", "description": "Set the amount of items to retrieve per page.", "required": false, "schema": { "type": "integer", "default": 10, "enum": [ 10, 20, 50 ] } }, { "name": "page", "in": "query", "description": "Set the current page for the items to retrieve.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1 } } ], "responses": { "200": { "description": "OK", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "required": [ "_embedded", "_links" ], "properties": { "_embedded": { "description": "A collection schema for the Laws and Regulations schema.", "properties": { "wet-en-regelgevingen": { "description": "A list of laws and regulations.", "type": "array", "items": { "description": "The laws and regulations of a country.", "required": [ "titel", "tekst", "landen", "link" ], "properties": { "titel": { "description": "The title of the laws and regulations.", "type": "string", "example": "Laws and regulations in Afghanistan", "nullable": true }, "tekst": { "description": "Raw HTML content of the laws and regulations. Clients must ensure to properly escape this content when rendering to prevent XSS vulnerabilities.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

", "nullable": true }, "link": { "description": "A URL to a related laws and regulations page.", "type": "string", "format": "uri", "example": "https://www.rvo.nl/afghanistan", "nullable": true }, "landen": { "description": "A list of countries associated with this laws and regulations.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object", "nullable": true } } }, "type": "object" }, "_links": { "description": "A collection of links for the current resource.", "properties": { "next": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=3", "nullable": true } }, "type": "object" }, "prev": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=1", "nullable": true } }, "type": "object" }, "self": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "The request contains an invalid parameter.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/sectoren": { "get": { "tags": [ "sectoren" ], "summary": "Endpoint for retrieving all available sectors.", "description": "Return the ID's and names of all sectors together.", "operationId": "75b238f0a52f5fb90215a3b70981646b", "parameters": [ { "name": "pageSize", "in": "query", "description": "Set the amount of items to retrieve per page.", "required": false, "schema": { "type": "integer", "default": 10, "enum": [ 10, 20, 50 ] } }, { "name": "page", "in": "query", "description": "Set the current page for the items to retrieve.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1 } } ], "responses": { "200": { "description": "OK", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "required": [ "_embedded", "_links" ], "properties": { "_embedded": { "description": "A collection schema for the Sector schema.", "properties": { "sectoren": { "description": "A list of sectors.", "type": "array", "items": { "description": "An excerpt of the sector.", "required": [ "id", "naam" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "naam": { "description": "The name of the sector.", "type": "string", "example": "Creatieve industrie" } }, "type": "object" } } }, "type": "object" }, "_links": { "description": "A collection of links for the current resource.", "properties": { "next": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=3", "nullable": true } }, "type": "object" }, "prev": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=1", "nullable": true } }, "type": "object" }, "self": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "The request contains an invalid parameter.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } } }, "components": { "schemas": { "City": { "description": "A city is a geographic region and can be the capital of a country.", "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "tijdsverschil": { "description": "The time difference in UTC/GMT of the city compared to the Netherlands.", "type": "number", "format": "float", "example": 2 }, "naam": { "description": "The name of the city.", "type": "string", "example": "Amsterdam" } }, "type": "object" }, "Contact": { "description": "Contact details of an organization.", "properties": { "contactpunten": { "description": "The points of contact.", "type": "array", "items": { "description": "Points of contact of a country organization.", "properties": { "twitter": { "description": "The twitter link of this organization.", "type": "string", "format": "uri", "example": "https://www.twitter.com/rvo", "nullable": true }, "telefoonnummer": { "description": "The telephone numbers of this organization.", "type": "array", "items": { "description": "A single telephone number", "type": "string", "example": "+31880424242" } }, "openingstijden": { "description": "The opening hours of this organization in HTML format.", "type": "string", "format": "html", "example": "

You can reach us on working days from 8:30 AM to 5:00 PM.

", "nullable": true }, "faxnummer": { "description": "The fax number of this organization.", "type": "string", "example": "+31880429527", "nullable": true }, "email": { "description": "The email address of this organization.", "type": "string", "example": "info@rvo.nl", "nullable": true } }, "type": "object" } }, "geometrie": { "description": "The coordinates of this organization.", "type": "array", "items": { "description": "The coordinates of a country organization.", "properties": { "type": { "description": "The type of this Geometry.", "type": "string", "example": "Point" }, "coordinates": { "description": "The Latitude and Longitude of this organization.", "type": "array", "items": { "description": "A coordinate value", "type": "number", "format": "float", "nullable": true }, "example": [ 12.34, 56.78 ], "nullable": true } }, "type": "object" } }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "naam": { "description": "The name of the contact.", "type": "string", "example": "RVO headquarters" }, "vestiging": { "properties": { "address": { "properties": { "volledigAdres": { "description": "The address of the contact.", "type": "string", "example": "Prinses Beatrixlaan 2 2595 AL Den Haag Zuid-Holland", "nullable": true } }, "type": "object" } }, "type": "object" }, "homepage": { "description": "The website of the contact.", "type": "string", "format": "uri", "example": "https://www.rvo.nl" }, "landen": { "description": "A list of countries related to the current contact.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" }, "ContactCollection": { "description": "A collection schema for the Contacts schema.", "properties": { "instanties": { "description": "A list of contacts.", "type": "array", "items": { "description": "Contact details of an organization.", "properties": { "contactpunten": { "description": "The points of contact.", "type": "array", "items": { "description": "Points of contact of a country organization.", "properties": { "twitter": { "description": "The twitter link of this organization.", "type": "string", "format": "uri", "example": "https://www.twitter.com/rvo", "nullable": true }, "telefoonnummer": { "description": "The telephone numbers of this organization.", "type": "array", "items": { "description": "A single telephone number", "type": "string", "example": "+31880424242" } }, "openingstijden": { "description": "The opening hours of this organization in HTML format.", "type": "string", "format": "html", "example": "

You can reach us on working days from 8:30 AM to 5:00 PM.

", "nullable": true }, "faxnummer": { "description": "The fax number of this organization.", "type": "string", "example": "+31880429527", "nullable": true }, "email": { "description": "The email address of this organization.", "type": "string", "example": "info@rvo.nl", "nullable": true } }, "type": "object" } }, "geometrie": { "description": "The coordinates of this organization.", "type": "array", "items": { "description": "The coordinates of a country organization.", "properties": { "type": { "description": "The type of this Geometry.", "type": "string", "example": "Point" }, "coordinates": { "description": "The Latitude and Longitude of this organization.", "type": "array", "items": { "description": "A coordinate value", "type": "number", "format": "float", "nullable": true }, "example": [ 12.34, 56.78 ], "nullable": true } }, "type": "object" } }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "naam": { "description": "The name of the contact.", "type": "string", "example": "RVO headquarters" }, "vestiging": { "properties": { "address": { "properties": { "volledigAdres": { "description": "The address of the contact.", "type": "string", "example": "Prinses Beatrixlaan 2 2595 AL Den Haag Zuid-Holland", "nullable": true } }, "type": "object" } }, "type": "object" }, "homepage": { "description": "The website of the contact.", "type": "string", "format": "uri", "example": "https://www.rvo.nl" }, "landen": { "description": "A list of countries related to the current contact.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" }, "ContentItemCollection": { "description": "A collection schema for the ContentItem schema.", "properties": { "content-items": { "description": "A list of Content items.", "type": "array", "items": { "description": "A content item.", "required": [ "id", "titel", "tekst", "link", "afbeelding", "gepubliceerdOp", "landen", "sectoren", "_links" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "titel": { "description": "The title of the content-item.", "type": "string", "example": "Doing Business in\n * Germany" }, "tekst": { "description": "Raw\n * HTML content of the content-item description. Clients must ensure to\n * properly escape this content when rendering to prevent XSS\n * vulnerabilities.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

" }, "link": { "description": "A URL to the\n * content-item's detail page.", "type": "string", "format": "uri", "example": "https://example.com/content/123" }, "afbeelding": { "description": "Main image for the content-item.", "type": "object", "example": { "url": "https://ih-static.rvo.nl/sites/default/files/fallback_images/2.svg", "alt-text": "Default image for the content-item" }, "allOf": [ { "description": "An image associated this item.", "properties": { "alt-text": { "description": "Alternative text for the image, can be null.", "type": "string", "example": "A beautiful sunset over the mountains", "nullable": true }, "url": { "description": "The URL of the image.", "type": "string", "format": "uri", "example": "https://example.com/images/sunset.jpg" } }, "type": "object" } ] }, "gepubliceerdOp": { "description": "The published date and time of the content-item in ISO 8601\n * format.", "type": "string", "format": "date-time", "example": "2024-02-10T09:00:06+01:00" }, "landen": { "description": "A list of countries associated with the content-item.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } }, "sectoren": { "description": "A list of industry sectors associated with the\n * content-item.", "type": "array", "items": { "description": "A list of industry sectors associated with this item.", "properties": { "sector": { "description": "The sector name.", "type": "string", "example": "Energy" }, "link": { "description": "A link to the sector detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/sectoren/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } }, "_links": { "properties": { "self": { "description": "Link to the content item.", "properties": { "href": { "description": "The URL for the content item.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/content-items/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } }, "type": "object" }, "ContentItemFull": { "description": "A content item.", "required": [ "id", "titel", "tekst", "link", "afbeelding", "gepubliceerdOp", "landen", "sectoren", "_links" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "titel": { "description": "The title of the content-item.", "type": "string", "example": "Doing Business in\n * Germany" }, "tekst": { "description": "Raw\n * HTML content of the content-item description. Clients must ensure to\n * properly escape this content when rendering to prevent XSS\n * vulnerabilities.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

" }, "link": { "description": "A URL to the\n * content-item's detail page.", "type": "string", "format": "uri", "example": "https://example.com/content/123" }, "afbeelding": { "description": "Main image for the content-item.", "type": "object", "example": { "url": "https://ih-static.rvo.nl/sites/default/files/fallback_images/2.svg", "alt-text": "Default image for the content-item" }, "allOf": [ { "description": "An image associated this item.", "properties": { "alt-text": { "description": "Alternative text for the image, can be null.", "type": "string", "example": "A beautiful sunset over the mountains", "nullable": true }, "url": { "description": "The URL of the image.", "type": "string", "format": "uri", "example": "https://example.com/images/sunset.jpg" } }, "type": "object" } ] }, "gepubliceerdOp": { "description": "The published date and time of the content-item in ISO 8601\n * format.", "type": "string", "format": "date-time", "example": "2024-02-10T09:00:06+01:00" }, "landen": { "description": "A list of countries associated with the content-item.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } }, "sectoren": { "description": "A list of industry sectors associated with the\n * content-item.", "type": "array", "items": { "description": "A list of industry sectors associated with this item.", "properties": { "sector": { "description": "The sector name.", "type": "string", "example": "Energy" }, "link": { "description": "A link to the sector detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/sectoren/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } }, "_links": { "properties": { "self": { "description": "Link to the content item.", "properties": { "href": { "description": "The URL for the content item.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/content-items/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "Country": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" }, "CountryCollection": { "description": "A collection schema for the Country schema.", "properties": { "landen": { "description": "A list of countries.", "type": "array", "items": { "description": "An excerpt of the country.", "required": [ "id", "naam", "code", "code_iso_alpha_2", "code_iso_alpha_3", "code_iso_3166_2" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "naam": { "description": "The country name.", "type": "string", "example": "Netherlands" }, "code": { "description": "The country code.", "type": "string", "example": "528", "nullable": true }, "code_iso_alpha_2": { "description": "The country ISO alpha 2 code.", "type": "string", "example": "NL", "nullable": true }, "code_iso_alpha_3": { "description": "The country ISO alpha 3 code.", "type": "string", "example": "NLD", "nullable": true }, "code_iso_3166_2": { "description": "The country ISO 3166 2 code.", "type": "string", "example": "NL-NH", "nullable": true }, "handelsBelemmering": { "description": "A string indicating a trade barrier.", "type": "string", "example": "http://madb.europa.eu/madb/barriers_result.htm?isSps=false&countries=NL", "nullable": true }, "_embedded": { "properties": { "hoofdstad": { "oneOf": [ { "description": "A city is a geographic region and can be the capital of a country.", "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "tijdsverschil": { "description": "The time difference in UTC/GMT of the city compared to the Netherlands.", "type": "number", "format": "float", "example": 2 }, "naam": { "description": "The name of the city.", "type": "string", "example": "Amsterdam" } }, "type": "object" } ], "nullable": true, "description": "The country capital." } }, "type": "object" }, "_links": { "properties": { "self": { "description": "Link to the country item.", "properties": { "href": { "description": "The URL for the country.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } }, "type": "object" }, "CountryExcerpt": { "description": "An excerpt of the country.", "required": [ "id", "naam", "code", "code_iso_alpha_2", "code_iso_alpha_3", "code_iso_3166_2" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "naam": { "description": "The country name.", "type": "string", "example": "Netherlands" }, "code": { "description": "The country code.", "type": "string", "example": "528", "nullable": true }, "code_iso_alpha_2": { "description": "The country ISO alpha 2 code.", "type": "string", "example": "NL", "nullable": true }, "code_iso_alpha_3": { "description": "The country ISO alpha 3 code.", "type": "string", "example": "NLD", "nullable": true }, "code_iso_3166_2": { "description": "The country ISO 3166 2 code.", "type": "string", "example": "NL-NH", "nullable": true }, "handelsBelemmering": { "description": "A string indicating a trade barrier.", "type": "string", "example": "http://madb.europa.eu/madb/barriers_result.htm?isSps=false&countries=NL", "nullable": true }, "_embedded": { "properties": { "hoofdstad": { "oneOf": [ { "description": "A city is a geographic region and can be the capital of a country.", "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "tijdsverschil": { "description": "The time difference in UTC/GMT of the city compared to the Netherlands.", "type": "number", "format": "float", "example": 2 }, "naam": { "description": "The name of the city.", "type": "string", "example": "Amsterdam" } }, "type": "object" } ], "nullable": true, "description": "The country capital." } }, "type": "object" }, "_links": { "properties": { "self": { "description": "Link to the country item.", "properties": { "href": { "description": "The URL for the country.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "CountryFull": { "description": "A country.", "type": "object", "allOf": [ { "description": "An excerpt of the country.", "required": [ "id", "naam", "code", "code_iso_alpha_2", "code_iso_alpha_3", "code_iso_3166_2" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "naam": { "description": "The country name.", "type": "string", "example": "Netherlands" }, "code": { "description": "The country code.", "type": "string", "example": "528", "nullable": true }, "code_iso_alpha_2": { "description": "The country ISO alpha 2 code.", "type": "string", "example": "NL", "nullable": true }, "code_iso_alpha_3": { "description": "The country ISO alpha 3 code.", "type": "string", "example": "NLD", "nullable": true }, "code_iso_3166_2": { "description": "The country ISO 3166 2 code.", "type": "string", "example": "NL-NH", "nullable": true }, "handelsBelemmering": { "description": "A string indicating a trade barrier.", "type": "string", "example": "http://madb.europa.eu/madb/barriers_result.htm?isSps=false&countries=NL", "nullable": true }, "_embedded": { "properties": { "hoofdstad": { "oneOf": [ { "description": "A city is a geographic region and can be the capital of a country.", "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "tijdsverschil": { "description": "The time difference in UTC/GMT of the city compared to the Netherlands.", "type": "number", "format": "float", "example": 2 }, "naam": { "description": "The name of the city.", "type": "string", "example": "Amsterdam" } }, "type": "object" } ], "nullable": true, "description": "The country capital." } }, "type": "object" }, "_links": { "properties": { "self": { "description": "Link to the country item.", "properties": { "href": { "description": "The URL for the country.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } }, "type": "object" }, { "properties": { "officieleTalen": { "description": "The official languages of the country.", "type": "array", "items": { "description": "An official language", "type": "string" }, "example": [ "Nederlands", "Engels" ] }, "handelsverdrag": { "description": "URL of the trade agreement", "type": "string", "format": "uri", "example": "https://example.com/trade-agreements/12345" }, "valuta": { "description": "The currency or currencies used, each represented by a code and a name.", "type": "array", "items": { "properties": { "code": { "description": "The ISO currency code (e.g., USD, EUR).", "type": "string", "example": "EUR" }, "naam": { "description": "The name of the currency.", "type": "string", "example": "Euro" } }, "type": "object" } }, "vlag": { "description": "URL of the flag image", "type": "string", "format": "uri", "example": "https://ih-static.rvo.nl/sites/default/files/2019-08/nl.png" }, "inwonerbenaming": { "description": "The country demonym.", "type": "string", "example": "Nederlander" }, "staatsvorm": { "description": "The country regime.", "type": "string", "example": "constitutionele monarchie", "nullable": true }, "sanitaireProblemen": { "description": "Has the country sanitary problems.", "type": "boolean", "nullable": true }, "zakelijkeTalen": { "description": "The business languages of the country.", "type": "array", "items": { "description": "A business language", "type": "string" }, "example": [ "English", "French" ] }, "_links": { "properties": { "dosAndDonts": { "description": "Link to the country dos-donts.", "properties": { "href": { "description": "The URL for the country dos-donts.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6/dos-donts" } }, "type": "object" }, "contentItems": { "description": "Link to the country content-items.", "properties": { "href": { "description": "The URL for the country content-items.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6/content-items" } }, "type": "object" }, "instanties": { "description": "Link to the country authorities.", "properties": { "href": { "description": "The URL for the country authorities.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6/instanties" } }, "type": "object" }, "observaties": { "description": "Link to the country observations.", "properties": { "href": { "description": "The URL for the country observations.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6/observaties" } }, "type": "object" }, "self": { "description": "Link to the country item.", "properties": { "href": { "description": "The current URL for the country.", "type": "string", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } }, "type": "object" } ] }, "DoDont": { "description": "Do or Don't of a country.", "properties": { "categorieen": { "description": "The categories this do or don't belongs to.", "type": "array", "items": { "description": "A category name", "type": "string" }, "example": [ "Presentatie" ] }, "titel": { "description": "The name of the contact.", "type": "string", "example": "Choose elaborate clothing" }, "isDo": { "description": "Is it a do or a don't.", "type": "boolean" }, "tekst": { "description": "The name of the contact.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

" }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "landen": { "description": "A list of countries related to the current do or don't.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" }, "DoDontCollection": { "description": "A collection schema for the DoDont (do or don't) schema.", "properties": { "dos-donts": { "description": "A list of do's and don'ts.", "type": "array", "items": { "description": "Do or Don't of a country.", "properties": { "categorieen": { "description": "The categories this do or don't belongs to.", "type": "array", "items": { "description": "A category name", "type": "string" }, "example": [ "Presentatie" ] }, "titel": { "description": "The name of the contact.", "type": "string", "example": "Choose elaborate clothing" }, "isDo": { "description": "Is it a do or a don't.", "type": "boolean" }, "tekst": { "description": "The name of the contact.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

" }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "landen": { "description": "A list of countries related to the current do or don't.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" }, "Error": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" }, "EventCollection": { "description": "A collection schema for the Event schema.", "properties": { "evenementen": { "description": "A list of Content items.", "type": "array", "items": { "description": "A Event.", "required": [ "id", "titel", "tekst", "link", "afbeelding", "startdatum", "einddatum", "sectoren", "landen" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "titel": { "description": "The title of\n * the event.", "type": "string", "example": "Germany MEDICA 2024" }, "tekst": { "description": "Raw\n * HTML content of the event description. Clients must ensure to properly\n * escape this content when rendering to prevent XSS vulnerabilities.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

" }, "link": { "description": "A\n * URL to the event's detail page.", "type": "string", "format": "uri", "example": "https://www.rvo.nl/evenementen/duitsland-healthholland-paviljoen-medica-2024", "nullable": true }, "afbeelding": { "description": "Main image for the event.", "type": "object", "example": { "url": "https://ih-static.rvo.nl/sites/default/files/fallback_images/5.svg", "alt-text": "Default image for the event" }, "allOf": [ { "description": "An image associated this item.", "properties": { "alt-text": { "description": "Alternative text for the image, can be null.", "type": "string", "example": "A beautiful sunset over the mountains", "nullable": true }, "url": { "description": "The URL of the image.", "type": "string", "format": "uri", "example": "https://example.com/images/sunset.jpg" } }, "type": "object" } ] }, "startdatum": { "description": "The start date and time of the event in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2024-02-10T09:00:06+01:00" }, "einddatum": { "description": "The end date and time of the event in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2024-02-10T09:00:06+01:00" }, "landen": { "description": "A list of countries associated with the event.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } }, "sectoren": { "description": "A list of industry sectors associated with the event.", "type": "array", "items": { "description": "A list of industry sectors associated with this item.", "properties": { "sector": { "description": "The sector name.", "type": "string", "example": "Energy" }, "link": { "description": "A link to the sector detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/sectoren/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" } } }, "type": "object" }, "EventFull": { "description": "A Event.", "required": [ "id", "titel", "tekst", "link", "afbeelding", "startdatum", "einddatum", "sectoren", "landen" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "titel": { "description": "The title of\n * the event.", "type": "string", "example": "Germany MEDICA 2024" }, "tekst": { "description": "Raw\n * HTML content of the event description. Clients must ensure to properly\n * escape this content when rendering to prevent XSS vulnerabilities.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

" }, "link": { "description": "A\n * URL to the event's detail page.", "type": "string", "format": "uri", "example": "https://www.rvo.nl/evenementen/duitsland-healthholland-paviljoen-medica-2024", "nullable": true }, "afbeelding": { "description": "Main image for the event.", "type": "object", "example": { "url": "https://ih-static.rvo.nl/sites/default/files/fallback_images/5.svg", "alt-text": "Default image for the event" }, "allOf": [ { "description": "An image associated this item.", "properties": { "alt-text": { "description": "Alternative text for the image, can be null.", "type": "string", "example": "A beautiful sunset over the mountains", "nullable": true }, "url": { "description": "The URL of the image.", "type": "string", "format": "uri", "example": "https://example.com/images/sunset.jpg" } }, "type": "object" } ] }, "startdatum": { "description": "The start date and time of the event in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2024-02-10T09:00:06+01:00" }, "einddatum": { "description": "The end date and time of the event in ISO 8601 format.", "type": "string", "format": "date-time", "example": "2024-02-10T09:00:06+01:00" }, "landen": { "description": "A list of countries associated with the event.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } }, "sectoren": { "description": "A list of industry sectors associated with the event.", "type": "array", "items": { "description": "A list of industry sectors associated with this item.", "properties": { "sector": { "description": "The sector name.", "type": "string", "example": "Energy" }, "link": { "description": "A link to the sector detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/sectoren/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object" }, "Finance": { "description": "Finance and subsidy of a country.", "required": [ "titel", "tekst", "landen", "link" ], "properties": { "titel": { "description": "The title of the finance and subsidy.", "type": "string", "example": "Canada subsidy guide", "nullable": true }, "tekst": { "description": "Raw HTML content of the finance and subsidy. Clients must ensure to properly escape this content when rendering to prevent XSS vulnerabilities.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

", "nullable": true }, "link": { "description": "A URL to a related finance and subsidy page.", "type": "string", "format": "uri", "example": "https://www.rvo.nl/subsidies-financiering?countries=401&status=3294%2C3295", "nullable": true }, "landen": { "description": "A list of countries associated with this finance and subsidy.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object", "nullable": true }, "FinanceCollection": { "description": "A collection schema for the Finance schema.", "properties": { "financieringen": { "description": "A list of finances and subsidies.", "type": "array", "items": { "description": "Finance and subsidy of a country.", "required": [ "titel", "tekst", "landen", "link" ], "properties": { "titel": { "description": "The title of the finance and subsidy.", "type": "string", "example": "Canada subsidy guide", "nullable": true }, "tekst": { "description": "Raw HTML content of the finance and subsidy. Clients must ensure to properly escape this content when rendering to prevent XSS vulnerabilities.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

", "nullable": true }, "link": { "description": "A URL to a related finance and subsidy page.", "type": "string", "format": "uri", "example": "https://www.rvo.nl/subsidies-financiering?countries=401&status=3294%2C3295", "nullable": true }, "landen": { "description": "A list of countries associated with this finance and subsidy.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object", "nullable": true } } }, "type": "object" }, "Geometry": { "description": "The coordinates of a country organization.", "properties": { "type": { "description": "The type of this Geometry.", "type": "string", "example": "Point" }, "coordinates": { "description": "The Latitude and Longitude of this organization.", "type": "array", "items": { "description": "A coordinate value", "type": "number", "format": "float", "nullable": true }, "example": [ 12.34, 56.78 ], "nullable": true } }, "type": "object" }, "Image": { "description": "An image associated this item.", "properties": { "alt-text": { "description": "Alternative text for the image, can be null.", "type": "string", "example": "A beautiful sunset over the mountains", "nullable": true }, "url": { "description": "The URL of the image.", "type": "string", "format": "uri", "example": "https://example.com/images/sunset.jpg" } }, "type": "object" }, "LawsRegulations": { "description": "The laws and regulations of a country.", "required": [ "titel", "tekst", "landen", "link" ], "properties": { "titel": { "description": "The title of the laws and regulations.", "type": "string", "example": "Laws and regulations in Afghanistan", "nullable": true }, "tekst": { "description": "Raw HTML content of the laws and regulations. Clients must ensure to properly escape this content when rendering to prevent XSS vulnerabilities.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

", "nullable": true }, "link": { "description": "A URL to a related laws and regulations page.", "type": "string", "format": "uri", "example": "https://www.rvo.nl/afghanistan", "nullable": true }, "landen": { "description": "A list of countries associated with this laws and regulations.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object", "nullable": true }, "LawsRegulationsCollection": { "description": "A collection schema for the Laws and Regulations schema.", "properties": { "wet-en-regelgevingen": { "description": "A list of laws and regulations.", "type": "array", "items": { "description": "The laws and regulations of a country.", "required": [ "titel", "tekst", "landen", "link" ], "properties": { "titel": { "description": "The title of the laws and regulations.", "type": "string", "example": "Laws and regulations in Afghanistan", "nullable": true }, "tekst": { "description": "Raw HTML content of the laws and regulations. Clients must ensure to properly escape this content when rendering to prevent XSS vulnerabilities.", "type": "string", "format": "html", "example": "

This is an example of HTML content.

", "nullable": true }, "link": { "description": "A URL to a related laws and regulations page.", "type": "string", "format": "uri", "example": "https://www.rvo.nl/afghanistan", "nullable": true }, "landen": { "description": "A list of countries associated with this laws and regulations.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object", "nullable": true } } }, "type": "object" }, "LinkCollection": { "description": "A collection of links for the current resource.", "properties": { "next": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=3", "nullable": true } }, "type": "object" }, "prev": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=1", "nullable": true } }, "type": "object" }, "self": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint" } }, "type": "object" } }, "type": "object" }, "LinkWithCountryCollection": { "description": "A collection of links. For the current resource and a link to the owning country.", "type": "object", "allOf": [ { "description": "A collection of links for the current resource.", "properties": { "next": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=3", "nullable": true } }, "type": "object" }, "prev": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint&page=1", "nullable": true } }, "type": "object" }, "self": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/endpoint" } }, "type": "object" } }, "type": "object" }, { "properties": { "land": { "properties": { "href": { "description": "URL of the link", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "type": "object" } }, "type": "object" } ] }, "Observation": { "description": "An observation (measurement) of a country.", "required": [ "id", "type", "meeteenheid", "waarde", "jaartal", "ranking", "schatting", "schaal", "herkomst" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "type": { "description": "The type of the observation.", "type": "string", "enum": [ "bigMacIndex", "economischeGroei", "easeOfDoingBusinessIndex", "uitvoerwaarde", "corruptieIndex", "bbp", "koopkracht", "globalCompetitivenessIndex", "globalInnovationIndex", "invoerWaarde", "inflatie", "logisticPerformanceIndex", "inwoneraantal", "oppervlakte", "werkloosheid" ], "example": "oppervlakte" }, "meeteenheid": { "required": [ "naam", "afkorting" ], "properties": { "naam": { "description": "The measuring unit.", "type": "string", "example": "Vierkante kilometer", "nullable": true }, "afkorting": { "type": "string", "example": "

In km²

", "nullable": true } }, "type": "object", "nullable": true }, "waarde": { "description": "The amount of the observation.", "type": "string", "example": "1671000", "nullable": true }, "jaartal": { "description": "The year of the observation.", "type": "string", "example": "2016", "nullable": true }, "ranking": { "description": "The ranking of the observation.", "type": "integer", "example": 5, "nullable": true }, "schatting": { "description": "If this observation is an estimation.", "type": "boolean", "example": false, "nullable": true }, "schaal": { "description": "The scale of the observation.", "type": "string", "example": "km²", "nullable": true }, "herkomst": { "required": [ "bron", "datum" ], "properties": { "bron": { "required": [ "naam" ], "properties": { "naam": { "description": "The origin of the observation.", "type": "string", "example": "Wereldbank", "nullable": true } }, "type": "object", "nullable": true }, "datum": { "type": "string", "format": "date", "example": "2022-12-01", "nullable": true } }, "type": "object", "nullable": true }, "landen": { "description": "A list of countries related to the current country observation.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object", "nullable": true }, "ObservationCollection": { "description": "A collection schema for the Observation schema.", "properties": { "observaties": { "description": "A list of countries.", "type": "array", "items": { "description": "An observation (measurement) of a country.", "required": [ "id", "type", "meeteenheid", "waarde", "jaartal", "ranking", "schatting", "schaal", "herkomst" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "type": { "description": "The type of the observation.", "type": "string", "enum": [ "bigMacIndex", "economischeGroei", "easeOfDoingBusinessIndex", "uitvoerwaarde", "corruptieIndex", "bbp", "koopkracht", "globalCompetitivenessIndex", "globalInnovationIndex", "invoerWaarde", "inflatie", "logisticPerformanceIndex", "inwoneraantal", "oppervlakte", "werkloosheid" ], "example": "oppervlakte" }, "meeteenheid": { "required": [ "naam", "afkorting" ], "properties": { "naam": { "description": "The measuring unit.", "type": "string", "example": "Vierkante kilometer", "nullable": true }, "afkorting": { "type": "string", "example": "

In km²

", "nullable": true } }, "type": "object", "nullable": true }, "waarde": { "description": "The amount of the observation.", "type": "string", "example": "1671000", "nullable": true }, "jaartal": { "description": "The year of the observation.", "type": "string", "example": "2016", "nullable": true }, "ranking": { "description": "The ranking of the observation.", "type": "integer", "example": 5, "nullable": true }, "schatting": { "description": "If this observation is an estimation.", "type": "boolean", "example": false, "nullable": true }, "schaal": { "description": "The scale of the observation.", "type": "string", "example": "km²", "nullable": true }, "herkomst": { "required": [ "bron", "datum" ], "properties": { "bron": { "required": [ "naam" ], "properties": { "naam": { "description": "The origin of the observation.", "type": "string", "example": "Wereldbank", "nullable": true } }, "type": "object", "nullable": true }, "datum": { "type": "string", "format": "date", "example": "2022-12-01", "nullable": true } }, "type": "object", "nullable": true }, "landen": { "description": "A list of countries related to the current country observation.", "type": "array", "items": { "description": "A list of countries associated with this item.", "properties": { "land": { "description": "The name of the country.", "type": "string", "example": "Netherlands" }, "link": { "description": "A link to the country's detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/landen/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" } } }, "type": "object", "nullable": true } } }, "type": "object" }, "PointsOfContact": { "description": "Points of contact of a country organization.", "properties": { "twitter": { "description": "The twitter link of this organization.", "type": "string", "format": "uri", "example": "https://www.twitter.com/rvo", "nullable": true }, "telefoonnummer": { "description": "The telephone numbers of this organization.", "type": "array", "items": { "description": "A single telephone number", "type": "string", "example": "+31880424242" } }, "openingstijden": { "description": "The opening hours of this organization in HTML format.", "type": "string", "format": "html", "example": "

You can reach us on working days from 8:30 AM to 5:00 PM.

", "nullable": true }, "faxnummer": { "description": "The fax number of this organization.", "type": "string", "example": "+31880429527", "nullable": true }, "email": { "description": "The email address of this organization.", "type": "string", "example": "info@rvo.nl", "nullable": true } }, "type": "object" }, "Sector": { "description": "A list of industry sectors associated with this item.", "properties": { "sector": { "description": "The sector name.", "type": "string", "example": "Energy" }, "link": { "description": "A link to the sector detailed page, can be null if not available.", "type": "string", "format": "uri", "example": "https://internationaal.ondernemen.overheid.nl/api/iio/v1/sectoren/3fa85f64-5717-4562-b3fc-2c963f66afa6", "nullable": true }, "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "type": "object" }, "SectorCollection": { "description": "A collection schema for the Sector schema.", "properties": { "sectoren": { "description": "A list of sectors.", "type": "array", "items": { "description": "An excerpt of the sector.", "required": [ "id", "naam" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "naam": { "description": "The name of the sector.", "type": "string", "example": "Creatieve industrie" } }, "type": "object" } } }, "type": "object" }, "SectorExcerpt": { "description": "An excerpt of the sector.", "required": [ "id", "naam" ], "properties": { "id": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" }, "naam": { "description": "The name of the sector.", "type": "string", "example": "Creatieve industrie" } }, "type": "object" }, "Uuid": { "description": "A unique identifier in UUID format from a sector, country, content-item etc.", "type": "string", "format": "uuid" } }, "responses": { "400": { "description": "The request contains an invalid parameter.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } }, "403": { "description": "Insufficient permissions to access the current resource.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } }, "404": { "description": "The requested resource could not be found.", "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "content": { "application/json": { "schema": { "description": "An error response schema.", "required": [ "status", "title", "detail" ], "properties": { "status": { "description": "The HTTP status code of the error.", "type": "integer", "example": 404 }, "title": { "description": "The title of the error.", "type": "string", "example": "Not Found" }, "detail": { "description": "The details of the error.", "type": "string", "example": "The resource with UUID 3fa85f64-5717-4562-b3fc-2c963f66afa6 could not be found." } }, "type": "object" } } } } }, "parameters": { "code": { "name": "code", "in": "query", "description": "A filter parameter for the country code.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 123 } }, "codeIso3166_2": { "name": "code_iso_3166_2", "in": "query", "description": "A filter parameter for the ISO 3166-2 code.", "required": false, "schema": { "type": "string", "example": "ISO 3166-2:NR" } }, "codeIsoAlpha_2": { "name": "code_iso_alpha_2", "in": "query", "description": "A filter parameter for the ISO Alpha-2 code.", "required": false, "schema": { "type": "string", "example": "NL" } }, "codeIsoAlpha_3": { "name": "code_iso_alpha_3", "in": "query", "description": "A filter parameter for the ISO Alpha-3 code.", "required": false, "schema": { "type": "string", "example": "NLD" } }, "country": { "name": "country", "in": "query", "description": "Filter items by one or more country UUIDs. UUIDs should be comma-separated for multiple countries.", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, "countrySort": { "name": "sort", "in": "query", "description": "Controls the sorting order of countries based on specified fields. Use field names as keys.", "required": false, "style": "deepObject", "explode": true, "schema": { "properties": { "name": { "description": "Specifies the field to sort by and its direction.", "type": "string", "default": "asc", "enum": [ "asc", "desc" ] } }, "type": "object", "additionalProperties": false } }, "observationType": { "name": "type", "in": "query", "description": "Specifies the type of observation to filter by.", "required": false, "schema": { "description": "Enumerated list of available observation types for filtering.", "type": "string", "enum": [ "bigMacIndex", "economischeGroei", "easeOfDoingBusinessIndex", "uitvoerwaarde", "corruptieIndex", "bbp", "koopkracht", "globalCompetitivenessIndex", "globalInnovationIndex", "invoerWaarde", "inflatie", "logisticPerformanceIndex", "inwoneraantal", "oppervlakte", "werkloosheid" ] } }, "page": { "name": "page", "in": "query", "description": "Set the current page for the items to retrieve.", "required": false, "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1 } }, "pageSize": { "name": "pageSize", "in": "query", "description": "Set the amount of items to retrieve per page.", "required": false, "schema": { "type": "integer", "default": 10, "enum": [ 10, 20, 50 ] } }, "sector": { "name": "sector", "in": "query", "description": "Filter items by one or more sector UUIDs. UUIDs should be comma-separated for multiple sectors.", "required": false, "style": "form", "explode": false, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, "uuid": { "name": "uuid", "in": "path", "description": "A UUID parameter from a sector, country, content-item etc.", "required": true, "schema": { "type": "string", "format": "uuid", "example": "123e4567-e89b-12d3-a456-426614174000" } }, "year": { "name": "year", "in": "query", "description": "Filter results on a specific year.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 2024 } }, "yearDutch": { "name": "jaartal", "in": "query", "description": "Filter results on a specific year with a dutch parameter.", "required": false, "schema": { "type": "integer", "format": "int32", "example": 2024 } } }, "headers": { "API-Version": { "description": "The version of the API", "required": true, "schema": { "description": "API version schema", "type": "string", "example": "1.2.0" } } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "description": "API key required for authentication", "name": "X-API-Key", "in": "header" } } } }