HTTP Accept Headers¶
When querying for data from the Registry web service, or performing a Data Transformation via the Web service, the output data format is described using the HTTP Accept Header which describes the required data format.
SDMX Formats¶
Accept Headers
| Accept Header | Format |
|---|---|
| application/vnd.sdmx.structurespecificdata+xml;version=3.0 | Structure Specific (3.0) |
| application/vnd.sdmx.structurespecificdata+xml;version=2.1 | Structure Specific (2.1) |
| application/vnd.sdmx.structurespecificdata+xml;version=2.0 | Compact (2.0/1.0) |
| application/vnd.sdmx.genericdata+xml;version=2.1 | Generic (2.1/2.0/1.0) |
| application/vnd.sdmx.data+json;version=2.0.0 | SDMX JSON (2.0) |
| application/vnd.sdmx.data+json;version=1.0.0 | SDMX JSON (1.0) |
| application/vnd.sdmx.data+csv;version=2.0.0;labels=[id|name|both];timeFormat=[original|normalized];keys=[none|obs|series|both] | SDMX CSV (2.0) |
| application/vnd.sdmx.data+csv;version=1.0.0;labels=[id | both];timeFormat=[original |
| application/vnd.sdmx.data+edi | SDMX EDI |
CSV Formats¶
SDMX-CSV offers the possibility to set the value for three parameters via the media-type. These parameters are label, timeFormat, and keys. All the parameters are optional. The default values for these parameters are id, original, and none respectively. For additional information about these parameters, please refer to the SDMX-CSV specification.
Examples
application/vnd.sdmx.data+csv
application/vnd.sdmx.data+csv;version=1.0.0;
application/vnd.sdmx.data+csv;version=1.0.0;timeFormat=normalized
application/vnd.sdmx.data+csv;version=1.0.0;timeFormat=normalized;labels=both
Data Reporting Template¶
There are two types of output when converting data to a Data Reporting Template format. The first is where the Data reporting template is constructed in the usual way, with the Universe of Data being derived from the Dataflow, and related Content Constraints. The second is where the Universe of Data is derived from the dataset being written into the Excel workbook. The default output is to base the Report Template Universe on the constraints, to change this behaviour, use the +partial indicator in the VND Header.
| Accept Header | Description |
|---|---|
| application/vnd.reporttemplate | Excel Report Template pre-populated with the data from a dataset. The dataset should contain the Provision Agreement reference, to enable the Registry to determine the Data Provider The excel file will be the same as a Report Template generated via the Reporting Template Web Service, but it will be pre-populated with observation and attribute values from the dataset. |
| application/vnd.reporttemplate.ACY:BANKING(1.0) | This is an extension of application/vnd.reporttemplate, it tells the Registry which Reporting Template to use. Only required if there is more then one Reporting Template for the Dataflow(s) being written. |
| application/vnd.reporttemplate;DATA_PROVIDER=ONS | This is an extension of application/vnd.reporttemplate, it tells the Registry who the Data Provider is. The Data Provider's Agency defaults to SDMX. If this is not true, use the syntax DATA_PROVIDER=ACY_ID.ONS Can be used in conjunction with other VND arguments such as the Report Template identifer. |
| application/vnd.reporttemplate+partial | This outputs the dataset conforming to the layout of the Report Template, but includes only the worksheets, and observation cells for which there is data in the dataset. There is no main worksheet. A Data Provider reference is not necessary, however information about which Report Template to use can be provided using the .ACY:TEMPLATE_ID(1.0) syntax. |