Difference between revisions of "Data Formats"
(Created page with "= Overview = Fusion Registry accepts and outputs datasets in a number of formats. When consuming data, the Fusion Registry will analyse the dataset to try to determine what...") |
(→HTTP Accept Headers) |
||
| Line 6: | Line 6: | ||
= HTTP Accept Headers = | = HTTP Accept Headers = | ||
| + | |||
| + | ==[[Data_Reporting_Template|Data Reporting Template]]== | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| − | + | ! Accept Header !! Description | |
|- | |- | ||
| − | + | | application/vnd.reporttemplate | |
| − | |||
|| Excel Report Template pre-populated with the data from a dataset. | || Excel Report Template pre-populated with the data from a dataset. | ||
<br/> The dataset should contain the Provision Agreement reference, to enable the Fusion Registry to determine the Data Provider | <br/> The dataset should contain the Provision Agreement reference, to enable the Fusion Registry to determine the Data Provider | ||
| Line 18: | Line 19: | ||
|- | |- | ||
| − | + | | application/vnd.reporttemplate.ACY:BANKING(1.0) | |
| − | |||
|| This is an extension of <b>application/vnd.reporttemplate</b>, it tells the Fusion Registry which Reporting Template to use. Only required if there is more then one Reporting Template for the Dataflow(s) being written. | || This is an extension of <b>application/vnd.reporttemplate</b>, it tells the Fusion 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 <b>application/vnd.reporttemplate</b>, it tells the Fusion Registry who the Data Provider is. | |
| − | || This is an extension of <b>application/vnd.reporttemplate</b>, it tells the Fusion Registry who the Data Provider is. The Data Provider's Agency | + | |
| + | 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 <b>.ACY:TEMPLATE_ID(1.0)</b> syntax. | || 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 <b>.ACY:TEMPLATE_ID(1.0)</b> syntax. | ||
|} | |} | ||
Revision as of 01:53, 19 March 2020
Overview
Fusion Registry accepts and outputs datasets in a number of formats. When consuming data, the Fusion Registry will analyse the dataset to try to determine what data format it has received, so that it is able to direct it to the right reader. All datasets are read by the Fusion Registry in excatly the same way, so any data processing performed on a Dataset is the same, regardless of the input Data Format.
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.
HTTP Accept Headers
Data Reporting Template
| Accept Header | Description |
|---|---|
| application/vnd.reporttemplate | Excel Report Template pre-populated with the data from a dataset.
|
| application/vnd.reporttemplate.ACY:BANKING(1.0) | This is an extension of application/vnd.reporttemplate, it tells the Fusion 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 Fusion 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. |
