Ga naar hoofdinhoud

Open Source Register

CBS Content Open Data - API specificatie

Centraal Bureau voor de Statistiek

Originele specificatie (JSON)

API documentatie

OData Service for namespace CBS.Website.ODataApi.Models (1.1.1)

Download OpenAPI specification:Download

This OData service is located at https://www.cbs.nl/odata/v1

Articles.Article

Get entities from Articles

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get entity from Articles by key

path Parameters
UniqueId
required
string

The unique identifier of Article

query Parameters
$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "UniqueId": "string",
  • "ArticleType": "Any",
  • "ArticleTypeInt": -2147483648,
  • "Title": "string",
  • "ReleaseTime": "2019-08-24T14:15:22Z",
  • "Url": "string",
  • "MetaDescription": "string",
  • "Image": "string",
  • "ImageAlt": "string",
  • "Category": "string",
  • "Photographer": "string",
  • "LeadText": "string",
  • "Body": "string",
  • "Footnote": "string",
  • "Errata": {
    },
  • "Authors": "string",
  • "Location": "string",
  • "ISSN": "string",
  • "ISBN": "string",
  • "TaxonomyTags": [
    ],
  • "Themes": [
    ],
  • "Series": [
    ],
  • "References": {
    },
  • "Downloads": {
    },
  • "Links": {
    },
  • "Language": "string",
  • "Version": -2147483648,
  • "SortOrder": -2147483648,
  • "ItemNameLowerCase": "string",
  • "Updated": "2019-08-24T14:15:22Z",
  • "Created": "2019-08-24T14:15:22Z",
  • "Permalink": "string"
}

Definitions.Definition

Get entities from Definitions

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get entity from Definitions by key

path Parameters
UniqueId
required
string

The unique identifier of Definition

query Parameters
$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "UniqueId": "string",
  • "Title": "string",
  • "DefinitionType": "Any",
  • "DefinitionTypeInt": -2147483648,
  • "Description": "string",
  • "LeadText": "string",
  • "Url": "string",
  • "MetaDescription": "string",
  • "TaxonomyTags": [
    ],
  • "Themes": [
    ],
  • "Series": [
    ],
  • "Language": "string",
  • "Version": -2147483648,
  • "Updated": "2019-08-24T14:15:22Z",
  • "Created": "2019-08-24T14:15:22Z",
  • "Permalink": "string",
  • "References": {
    },
  • "Links": {
    }
}

Events.CalendarEvent

Get entities from Events

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get entity from Events by key

path Parameters
UniqueId
required
string

The unique identifier of CalendarEvent

query Parameters
$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "UniqueId": "string",
  • "Title": "string",
  • "Url": "string",
  • "MetaDescription": "string",
  • "Image": "string",
  • "ImageAlt": "string",
  • "Description": "string",
  • "PlannedPublicationTime": "2019-08-24T14:15:22Z",
  • "ReportingPeriod": "string",
  • "Priority": -2147483648,
  • "UnderEmbargo": true,
  • "PublishTimeUnknown": true,
  • "RegionalClassification": "string",
  • "Themes": [
    ],
  • "Language": "string",
  • "Version": -2147483648,
  • "SortOrder": -2147483648,
  • "ItemNameLowerCase": "string",
  • "Updated": "2019-08-24T14:15:22Z",
  • "Created": "2019-08-24T14:15:22Z",
  • "Permalink": "string"
}

Flash.Flash

Get entities from Flash

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get entity from Flash by key

path Parameters
UniqueId
required
string

The unique identifier of Flash

query Parameters
$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "UniqueId": "string",
  • "Title": "string",
  • "ReleaseTime": "2019-08-24T14:15:22Z",
  • "Description": "string",
  • "LeadText": "string",
  • "Url": "string",
  • "MetaDescription": "string",
  • "Language": "string",
  • "Version": -2147483648,
  • "SortOrder": -2147483648,
  • "ItemNameLowerCase": "string",
  • "Updated": "2019-08-24T14:15:22Z",
  • "Created": "2019-08-24T14:15:22Z"
}

Articles

Invoke functionImport GetArticlesByArticleType

path Parameters
ArticleType
required
string (ArticleType)
Enum: "Any" "Article" "Background" "Custom" "News" "Publication" "Visualisation" "Corporate" "Unknown"

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Invoke functionImport GetArticlesBySeries

path Parameters
Series
required
string or null

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Invoke functionImport GetArticlesByTableId

path Parameters
TableId
required
string or null

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Invoke functionImport GetArticlesByTaxonomyTag

path Parameters
Tag
required
string or null

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Invoke functionImport GetArticlesByTheme

path Parameters
Theme
required
string or null

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Media

Invoke functionImport GetMediaByMediaType

path Parameters
MediaType
required
string (MediaType)
Enum: "Any" "Video" "Chart" "Image" "Table" "Unknown"

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Pages

Invoke functionImport GetPagesByPageType

path Parameters
PageType
required
string (PageType)
Enum: "Any" "Page" "Visualisation" "Dossier" "Overview" "Form" "Vacancy" "Longread" "LongreadChapter" "Unknown"

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Invoke functionImport GetPagesByResearchCode

path Parameters
ResourceCode
required
string or null

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Invoke functionImport GetPagesBySeries

path Parameters
Series
required
string or null

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Invoke functionImport GetPagesByTaxonomyTag

path Parameters
Tag
required
string or null

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Invoke functionImport GetPagesByTheme

path Parameters
Theme
required
string or null

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Search

Invoke functionImport GetSearchResultsByArticleType

path Parameters
ArticleType
required
string (ArticleType)
Enum: "Any" "Article" "Background" "Custom" "News" "Publication" "Visualisation" "Corporate" "Unknown"

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Invoke functionImport GetSearchResultsByPath

path Parameters
Path
required
string or null

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Invoke functionImport GetSearchResultsByPathAndTemplateId

path Parameters
Path
required
string or null
TemplateId
required
string or null

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Invoke functionImport GetSearchResultsByTemplate

path Parameters
Template
required
string or null

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Invoke functionImport GetSearchResultsByTheme

path Parameters
Theme
required
string or null

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Invoke functionImport GetSearchResultsByWord

path Parameters
Word
required
string or null

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Invoke functionImport GetSearchResultsByWordAndTemplateId

path Parameters
Word
required
string or null
TemplateId
required
string or null

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Media.Medium

Get entities from Media

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get entity from Media by key

path Parameters
UniqueId
required
string

The unique identifier of Medium

query Parameters
$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "UniqueId": "string",
  • "Title": "string",
  • "MediaType": "Any",
  • "MediaTypeInt": -2147483648,
  • "ReleaseTime": "2019-08-24T14:15:22Z",
  • "Description": "string",
  • "LeadText": "string",
  • "Url": "string",
  • "MetaDescription": "string",
  • "TaxonomyTags": [
    ],
  • "Themes": [
    ],
  • "Series": [
    ],
  • "Language": "string",
  • "Version": -2147483648,
  • "SortOrder": -2147483648,
  • "ItemNameLowerCase": "string",
  • "Updated": "2019-08-24T14:15:22Z",
  • "Created": "2019-08-24T14:15:22Z",
  • "Permalink": "string"
}

Pages.Page

Get entities from Pages

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get entity from Pages by key

path Parameters
UniqueId
required
string

The unique identifier of Page

query Parameters
$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "UniqueId": "string",
  • "PageType": "Any",
  • "PageTypeInt": -2147483648,
  • "Title": "string",
  • "SubTitle": "string",
  • "Edition": "string",
  • "Url": "string",
  • "MetaDescription": "string",
  • "Image": "string",
  • "ImageAlt": "string",
  • "Category": [
    ],
  • "Photographer": "string",
  • "LeadText": "string",
  • "Body": "string",
  • "Footnote": "string",
  • "Authors": "string",
  • "Location": "string",
  • "TaxonomyTags": [
    ],
  • "Themes": [
    ],
  • "Series": [
    ],
  • "ResearchCodes": [
    ],
  • "References": {
    },
  • "Downloads": {
    },
  • "Links": {
    },
  • "Language": "string",
  • "Version": -2147483648,
  • "SortOrder": -2147483648,
  • "ItemNameLowerCase": "string",
  • "Updated": "2019-08-24T14:15:22Z",
  • "ReleaseTime": "2019-08-24T14:15:22Z",
  • "Created": "2019-08-24T14:15:22Z",
  • "Permalink": "string"
}

Search.SearchResultItem

Get entities from Search

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get entity from Search by key

path Parameters
UniqueId
required
string

The unique identifier of SearchResultItem

query Parameters
$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "UniqueId": "string",
  • "Type": "string",
  • "Permalink": "string",
  • "Title": "string",
  • "ReleaseTime": "2019-08-24T14:15:22Z",
  • "Url": "string",
  • "MetaDescription": "string",
  • "Image": "string",
  • "ImageAlt": "string",
  • "Description": "string",
  • "LeadText": "string",
  • "Body": "string",
  • "Snippet": "string",
  • "Location": "string",
  • "Language": "string",
  • "Themes": [
    ],
  • "TemplateName": "string",
  • "ItemNameLowerCase": "string",
  • "SortOrder": -2147483648
}

Vacancies.Vacancy

Get entities from Vacancies

query Parameters
$top
integer >= 0
Example: $top=50

Show only the first n items

$skip
integer >= 0

Skip the first n items

$filter
string

Filter items by property values

$count
boolean

Include count of items

$orderby
Array of strings unique

Order items by property values

$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "value": [
    ]
}

Get entity from Vacancies by key

path Parameters
UniqueId
required
string

The unique identifier of Vacancy

query Parameters
$select
Array of strings unique

Select properties to be returned

$expand
Array of strings unique

Expand related entities

Responses

Response samples

Content type
application/json
{
  • "UniqueId": "string",
  • "Title": "string",
  • "Url": "string",
  • "MetaDescription": "string",
  • "Image": "string",
  • "ImageAlt": "string",
  • "LeadText": "string",
  • "Body": "string",
  • "VacancyNumber": "string",
  • "WorkingEnvironment": "string",
  • "TheWork": "string",
  • "YourProfile": "string",
  • "TermsOfEmployment": "string",
  • "EmploymentType": [
    ],
  • "MoreInformation": "string",
  • "PublicationDate": "2019-08-24T14:15:22Z",
  • "ClosingDate": "2019-08-24T14:15:22Z",
  • "Engagement": "string",
  • "VacancyCategory": [
    ],
  • "HoursPerWeek": "string",
  • "Salary": "string",
  • "MinSalary": 0,
  • "MaxSalary": 0,
  • "SalaryPeriod": "string",
  • "Recruiter": {
    },
  • "LevelOfEducation": [
    ],
  • "JobLocations": {
    },
  • "WorkLocation": [
    ],
  • "Location": "string",
  • "References": {
    },
  • "Downloads": {
    },
  • "Links": {
    },
  • "Language": "string",
  • "Version": -2147483648,
  • "SortOrder": -2147483648,
  • "ItemNameLowerCase": "string",
  • "Updated": "2019-08-24T14:15:22Z",
  • "Created": "2019-08-24T14:15:22Z",
  • "Permalink": "string",
  • "TeamFacts": {
    },
  • "CbsFacts": {
    },
  • "BreadCrumb": {
    }
}