Open Source Register

Nederland Wereldwijd - API specificatie

Buitenlandse Zaken

Originele specificatie (YAML)

API documentatie

API docs by Redocly

Nederland Wereldwijd (2.0.0)

Download OpenAPI specification:Download

License: Apache 2.0

Open data. De informatie van Nederland Wereldwijd is openbaar. Open data zijn gegevens die iedereen mag gebruiken en verspreiden. Ontwikkelaars kunnen open data bijvoorbeeld gebruiken om een app te ontwikkelen of om informatie op hun eigen website te plaatsen.

ConsularData

Retrieve contact information for all representations abroad

getOverview

Returns an overview list of consular data for all countries

query Parameters
lang
string
Default: "nl"
Enum: "nl" "en"

Language code, e.g. 'nl', 'en'. Default is 'nl'

output
string
Default: "xml"
Enum: "xml" "json"

Output format. Either 'json' or 'xml'. Default is 'xml'

rows
integer <int64>
Default: 25

Number of rows to return

offset
integer <int64>
Default: 0

Offset

modifiedsince
string <date> ([12]\d{3}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]...
Example: modifiedsince=20231201231101123

Date and time in the format yyyyMMddHHmmssSSS

Responses

Response samples

Content type
[
  • {
    }
]

getCountryRepresentationDetailById

Returns detailed country representation by shortId

path Parameters
country
required
string

Three-letter ISO 3166-1 alpha-3 country code (e.g., 'khm' for Cambodia or 'grl' for Greenland). Alternatively, a 'location key' (e.g. 'nederland') is also accepted, though not preferred.

id
required
string
Example: embassy-yangon

Short ID for the representation

query Parameters
lang
string
Default: "nl"
Enum: "nl" "en"

Language code, e.g. 'nl', 'en'. Default is 'nl'

output
string
Default: "xml"
Enum: "json" "xml"

Output format. Either 'json' or 'xml'. Default is 'xml'

header Parameters
If-Modified-Since
string <date-time> (Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s(Jan|F...
Example: Tue, 28 Feb 2023 19:25:15 GMT

Date and time in the format <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT, for more information https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Modified-Since

Responses

Response samples

Content type
{
  • "id": "string",
  • "type": "string",
  • "canonical": "string",
  • "dataurl": "string",
  • "title": "string",
  • "function": "string",
  • "embassy": true,
  • "agencyhead": "string",
  • "address": [
    ],
  • "servicelocations": [
    ],
  • "openingtimes": "string",
  • "register": "string",
  • "telephonenumbers": [
    ],
  • "phonenumbers": [
    ],
  • "emergencyinfo": "string",
  • "emergencynumber": "string",
  • "faxnumber": "string",
  • "emailaddress": "string",
  • "emailaddresses": {
    },
  • "consularopeningtimes": "string",
  • "contactoptions": [
    ],
  • "additionalinformation": "string",
  • "practicalinformation": [
    ],
  • "faq": [
    ],
  • "consulartelephonenumbers": [
    ],
  • "consularfaxnumber": "string",
  • "consularemailaddress": "string",
  • "timedifferencewithnl": "string",
  • "map": [
    ],
  • "authorities": [
    ],
  • "creators": [
    ],
  • "rightsholders": [
    ],
  • "license": "string",
  • "languages": [
    ],
  • "location": "string",
  • "lastmodified": "2019-08-24T14:15:22Z"
}

getCountryRepresentation

Returns a country's consular data

path Parameters
country
required
string

Three-letter ISO 3166-1 alpha-3 country code (e.g., 'khm' for Cambodia or 'grl' for Greenland). Alternatively, a 'location key' (e.g. 'nederland') is also accepted, though not preferred.

query Parameters
lang
string
Default: "nl"
Enum: "nl" "en"

Language code, e.g. 'nl', 'en'. Default is 'nl'

output
string
Default: "xml"
Enum: "xml" "json"

Output format. Either 'json' or 'xml'. Default is 'xml'

rows
integer <int64>
Default: 25

Number of rows to return

offset
integer <int64>
Default: 0

Offset

modifiedsince
string <date> ([12]\d{3}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]...
Example: modifiedsince=20231201231101123

Date and time in the format yyyyMMddHHmmssSSS

Responses

Response samples

Content type
[
  • {
    }
]

Countries

Countries summary for available infotypes

getCountriesList

Get a list of countries

query Parameters
output
string
Default: "xml"
Enum: "json" "xml"

Output format. Either 'json' or 'xml'. Default is 'xml'

rows
integer <int64>
Default: 25

Number of rows to return

offset
integer <int64>
Default: 0

Offset

sort
string
Default: "asc"
Enum: "asc" "desc"

Sort order

Responses

Response samples

Content type
{}

getCountry

Get a country

path Parameters
location
required
string
Example: khm

Three-letter ISO 3166-1 alpha-3 country code (e.g., 'khm' for Cambodia or 'grl' for Greenland). Alternatively, a 'location key' (e.g. 'nederland') is also accepted, though not preferred.

query Parameters
output
string
Default: "xml"
Enum: "xml" "json"

Output format. Either 'json' or 'xml'. Default is 'xml'

Responses

Response samples

Content type
{}

Noodhulp

FAQ. What to do in case of an emergency

getNoodhulpList

Returns a list of 'noodhulp' FAQ items

query Parameters
output
string
Default: "xml"
Enum: "xml" "json"

Output format. Either 'json' or 'xml'. Default is 'xml'

rows
integer <int64>
Default: 25

Number of rows to return

offset
integer <int64>
Default: 0

Offset

modifiedsince
string <date> ([12]\d{3}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]...
Example: modifiedsince=20231201231101123

Date and time in the format yyyyMMddHHmmssSSS

Responses

Response samples

Content type
[
  • {
    }
]

getNoodhulpBySubjectId

Returns noodhulp for a given subjectid

path Parameters
id
required
string <uuid>
Example: 3d99a2a4-7483-4590-ada9-50d2ed136462

Unique identifier of the 'noodhulp' (urgent assistance)

query Parameters
output
string
Default: "xml"
Enum: "json" "xml"

Output format. Either 'json' or 'xml'. Default is 'xml'

header Parameters
If-Modified-Since
string <date-time> (Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s(Jan|F...
Example: Tue, 28 Feb 2023 19:25:15 GMT

Date and time in the format <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT, for more information https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Modified-Since

Responses

Response samples

Content type
{
  • "id": "string",
  • "type": "string",
  • "canonical": "string",
  • "dataurl": "string",
  • "title": "string",
  • "introduction": "string",
  • "content": [
    ],
  • "authorities": [
    ],
  • "creators": [
    ],
  • "lastmodified": "2019-08-24T14:15:22Z",
  • "issued": "2019-08-24T14:15:22Z",
  • "available": "2019-08-24T14:15:22Z",
  • "license": "string",
  • "rightsholders": [
    ],
  • "languages": [
    ],
  • "locations": [
    ],
  • "parent": "string",
  • "order": "string"
}

TravelAdvice

Retrieve the most up to date traveladvice for countries worldwide

getTraveladviceList

Returns travel advice list

query Parameters
output
string
Default: "xml"
Enum: "xml" "json"

Output format. Either 'json' or 'xml'. Default is 'xml'

rows
integer <int64> <= 200
Default: 25
Example: rows=25

Number of rows to return

offset
integer <int64>
Default: 0
Example: offset=0

offset

modifiedsince
string <date> ([12]\d{3}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]...
Example: modifiedsince=20231201231101123

Date and time in the format yyyyMMddHHmmssSSS

Responses

Response samples

Content type
[
  • {
    }
]

getTravelAdviceByLocation

Returns traveladvice for a given country (location)

path Parameters
location
required
string^[a-z-]+$
Example: khm

Three-letter ISO 3166-1 alpha-3 country code (e.g., 'khm' for Cambodia or 'grl' for Greenland). Alternatively, a 'location key' (e.g. 'nederland') is also accepted, though not preferred.

query Parameters
output
string
Default: "xml"
Enum: "xml" "json"

Output format. Either 'json' or 'xml'. Default is 'xml'

header Parameters
If-Modified-Since
string <date-time> (Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s(Jan|F...
Example: Tue, 28 Feb 2023 19:25:15 GMT

Date and time in the format <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT, for more information https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Modified-Since

Responses

Response samples

Content type
{
  • "id": "string",
  • "type": "string",
  • "canonical": "string",
  • "dataurl": "string",
  • "title": "string",
  • "introduction": "string",
  • "location": "string",
  • "modificationdate": "string",
  • "modifications": "string",
  • "content": [
    ],
  • "files": [
    ],
  • "authorities": [
    ],
  • "creators": [
    ],
  • "lastmodified": "2019-08-24T14:15:22Z",
  • "issued": "2019-08-24T14:15:22Z",
  • "available": "2019-08-24T14:15:22Z",
  • "license": "string",
  • "rightsholders": [
    ],
  • "language": "string",
  • "additionalinformation": "string"
}

getTraveladviceListLastmodifiedSince

Returns list of traveladvices that were modified since {date}

path Parameters
date
required
string <date> ([12]\d{3}(0[1-9]|1[0-2])(0[1-9]|[12]\d|3[01]...
Example: 20231201

Date and time in the format yyyyMMdd

query Parameters
output
string
Default: "xml"
Enum: "xml" "json"

Output format. Either 'json' or 'xml'. Default is 'xml'

rows
integer <int64> <= 200
Default: 25
Example: rows=25

Number of rows to return

offset
integer <int64>
Default: 0
Example: offset=0

Offset

Responses

Response samples

Content type
[
  • {
    }
]

getWorldMap

Retrieve TravelAdvice world Map

header Parameters
If-Modified-Since
string <date-time> (Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s(Jan|F...
Example: Tue, 28 Feb 2023 19:25:15 GMT

Date and time in the format <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT, for more information https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Modified-Since

If-Modified-Since
string

Responses

Response samples

Content type
No sample

getTravelAdviceMapByLocation

Returns travel advice map for a given country(location)

path Parameters
location
required
string^[a-z-]+$
Example: khm

Three-letter ISO 3166-1 alpha-3 country code (e.g., 'khm' for Cambodia or 'grl' for Greenland). Alternatively, a 'location key' (e.g. 'nederland') is also accepted, though not preferred.

query Parameters
type
string
Default: "standard"
Enum: "standard" "legend"

Type map (standard or legend)

header Parameters
If-Modified-Since
string <date-time> (Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s(Jan|F...
Example: Tue, 28 Feb 2023 19:25:15 GMT

Date and time in the format <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT, for more information https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Modified-Since

Responses

Response samples

Content type
No sample

OpenAPI Specification

getOpenAPI

Returns the open API specification in the requested format (type)

path Parameters
type
required
string
Default: "json"
Enum: "json" "yaml"
Example: json

The type of the OpenAPI document

Responses

Default handler serves OAS in json

getOpenAPIDefault

Returns the open API specification in JSON format

Responses