The get-statements have the following form: {get: <what>; <parameters>}

Functions

The value of <what> specifies what information is requested.

Parameters Overview

The following parameters are supported:

Notes:

• Parameters with * require additional selection inputs.
• periodoffset can be used for expressions like “one year earlier”
• periodfullname, periodpending, periodstock, and periodalternative can be used to customize how the period name is shown.

The following functions can be requested:

Indicator settings

data

{get: data; varcode: bevtot}

Retrieves the value of the indicator.

{get: data; varcode: kb_bev_lft05; dim-item: dnc_gsl_m}

Retrieves the value of a cube indicator (dimension level: dnc_gsl and dimension item: m).

{get: data; varcode: kb_bev_lft05; dim-item: dnc_gsl_m; dim-item: dnc_alg_lft_10}

Retrieves the value of a cube indicator for multiple dimension levels.

name

{get: name; varcode: bevtot}

Retrieves the name of the indicator.

description

{get: description; varcode: bevtot}

Retrieves the description of the indicator.

footnote

{get: footnote; varcode: bevtot}

Retrieves the footnote of the indicator.

lastupdate

{get: lastupdate; varcode: bevtot}

Retrieves the last update date of the indicator.

datatype

{get: datatype; varcode: bevtot}

Retrieves the datatype of the indicator. (numeric, percentage, etc).

periodtype

{get: periodtype; varcode: bevtot}

Retrieves the periodtype of the indicator. (stock, pending, etc.).

geotype

{get: geotype; varcode: bevtot}

Retrieves the geotype of the indicator. (single, stream ,etc).

first-period

{get: first-period; varcode: bevtot}

Retrieves the first period of the indicator.

last-period

{get: last-period; varcode: bevtot}

Retrieves the last period of the specified indicator.

forecastperiod

{get: forecastperiod; varcode: bevtot}

Retrieves the forecast period of the indicator.

provisionalperiod

{get: provisionalperiod; varcode: bevtot}

Retrieves the provisional period of the indicator.

rating

{get: rating; varcode: bevtot}

Retrieves the rating of the indicator (positive/negative/neutral/unknown).

threshold

{get: threshold; varcode: bevtot}

Retrieves the threshold of the indicator.

freetextfield1

{get: freetextfield1; varcode: bevtot}

Retrieves the first free text field of the indicator.

freetextfield2

{get: freetextfield2; varcode: bevtot}

Retrieves the second free text field of the indicator.

freetextfield3

{get: freetextfield3; varcode: bevtot}

Retrieves the third free text field of the indicator.

additional-info

{get: additional-info; varcode: bevtot}

Retrieves the additional info based on the indicator, period, geolevel and/or geoitemcode.

mosaic-publish-date

{get: mosaic-publish-date}

Retrieves the date and time when the mosaic was published.

datamodificationdate

{get: datamodificationdate; varcode: bevtot}

Retrieves the last modification date of the indicator. 

metadatamodificationdate

{get: metadatamodificationdate; varcode: bevtot}

Retrieves the last modification date of the metadata of the indicator. 

Unit settings

unit

{get: unit; varcode: bevtot}

Retrieves the unit of the indicator.

Data source settings

source

{get: source; varcode: bevtot}

Retrieves the source of the indicator.

source-url

{get: source-url; varcode: bevtot}

Retrieves the url of the source of the indicator.

sourcedescription

{get: sourcedescription; varcode: bevtot}

Retrieves the description of the source of the indicator.

sourceshortname

{get: sourceshortname; varcode: bevtot}

Retrieves the short name of the source of the indicator.

sourceactuality

{get: sourceactuality; varcode: bevtot}

Retrieves the actuality of the source of the indicator.

sourcecontactdetails

{get: sourcecontactdetails; varcode: bevtot}

Retrieves the contact details of the source of the indicator.

sourcedatafiles

{get: sourcedatafiles; varcode: bevtot}

Retrieves the datafiles of the source of the indicator.

sourcedatakeeper

{get: sourcedatakeeper; varcode: bevtot}

Retrieves the datakeeper of the source of the indicator.

sourcedataowner

{get: sourcedataowner; varcode: bevtot}

Retrieves the dataowner of the source of the indicator.

sourcedataprocessingmethod

{get: sourcedataprocessingmethod; varcode: bevtot}

Retrieves the data processing method of the source of the indicator.

sourcedatasourcetype

{get: sourcedatasourcetype; varcode: bevtot}

Retrieves the type of the source of the indicator.

sourcefreetext1

{get: sourcefreetext1; varcode: bevtot}

Retrieves the first free text field of the source of the indicator.

sourcefreetext2

{get: sourcefreetext2; varcode: bevtot}

Retrieves the second free text field of the source of the indicator.

sourcefreetext3

{get: sourcefreetext3; varcode: bevtot}

Retrieves the third free text field of the source of the indicator.

sourcefootnote

{get: sourcefootnote; varcode: bevtot}

Retrieves the footnote of the source of the indicator.

sourcefrequency

{get: sourcefrequency; varcode: bevtot}

Retrieves the frequency of the source of the indicator.

sourcereferencedate

{get: sourcereferencedate; varcode: bevtot}

Retrieves the reference date of the source of the indicator.

sourcescalelevel

{get: sourcescalelevel; varcode: bevtot}

Retrieves the scale level of the source of the indicator.

sourcekeywords

{get: sourcekeywords; varcode: bevtot}

Retrieves the search tags of the source of the indicator.

sourcelastupdate

{get: sourcelastupdate; varcode: bevtot}

Retrieves the last update date of the source of the indicator.

sourcemetadatamodified

{get: sourcemetadatamodified; varcode: bevtot}

Retrieves the modify metadata of the source of the indicator.

sourceremarks

{get: sourceremarks; varcode: bevtot}

Retrieves the remarks of the source of the indicator.

sourcetermsofuse

{get: sourcetermsofuse; varcode: bevtot}

Retrieves the terms of use of the source of the indicator.

sourcetimecomparability

{get: sourcetimecomparability; varcode: bevtot}

Retrieves the time comparability of the source of the indicator.

sourcesummary

{get: sourcesummary; varcode: bevtot}

Retrieves the summary of the source of the indicator.

sourcedatalimitations

{get: sourcedatalimitations; varcode: bevtot}

Retrieves the data limitations of the source of the indicator.

sourcedatamodificationdate

{get: sourcedatamodificationdate; varcode: bevtot;}

Retrieves the data limitations of the source of the indicator.

sourcemetadatamodificationdate

{get: sourcemetadatamodificationdate; varcode: bevtot}

Retrieves the last modification date of the metadata of the indicator.

Selection Settings

Geo level settings

base-level

{get: base-level}

Retrieves the name of the geolevel of the current base selection.

base-level; parentlevel

{get: base-level; parentlevel: provincie}

Retrieves the name of the parent geolevel of the selected base area level.

compare-level

{get: compare-level}

Retrieves the name of the geolevel of the current compare selection.

compare-level; parentlevel

{get: compare-item; parentlevel: Nederland}

Retrieves the name of the parent geolevel of the selected compare area level.

Geo item settings

base-item

{get: base-item}

Retrieves the selected base area item.

base-item; parentlevel

{get: base-item; parentlevel: provincie}

Retrieves the parent of the selected base area item.

compare-item

{get: compare-item}

Retrieves the selected compare area item.

compare-item; parentlevel

{get: compare-item; parentlevel: Nederland}

Retrieves the parent of the selected compare area item.

Period settings

base-period*

{get: base-period}

Retrieves the selected base period.

compare-period*

{get: compare-period}

Retrieves the selected compare period.

Dimension item settings

base-dimensionitem

{get: base-dimensionitem}

Retrieves the name of the selected base dimension.

base-dimensionitem

{get: base-dimensionitem; option: name}

Retrieves the name of the selected base dimension.

base-dimensionitem

{get: base-dimensionitem; option: description}

Retrieves the description of the selected base dimension.

base-dimensionitem

{get: base-dimensionitem; option: code}

Retrieves the code of the selected base dimension.

compare-dimensionitem

{get: compare-dimensionitem}

Retrieves the name of the selected compare dimension.

compare-dimensionitem

{get: compare-dimensionitem; option: name}

Retrieves the name of the selected compare dimension.

compare-dimensionitem

{get: compare-dimensionitem; option: description

Retrieves the description of the selected compare dimension.

compare-dimensionitem

{get: compare-dimensionitem; option: code

Retrieves the code of the selected compare dimension.

dimmember-property

{get: dimmember-property; dim-item: code; option: description;}

Retrieves the description of a dimension member. Dimension item codes are constructed by combining the dimension level code and the dimension level item code, separated by an underscore. For example: dnc_gsl_m