Description
A connector which downloads a chosen data set from the CSV endpoint given a dataset ID, e.g. GET https://api.education.gov.uk/statistics/v1/data-sets/019cc380-0338-7072-ba5c-5b4d0c2c3635/csv?dataSetVersion=1.0
This is equivalent to preview_dataset() from eesyapi.R:
https://github.com/dfe-analytical-services/eesyapi.R/blob/main/R/preview_dataset.R
Use case
User's need a way to connect to the CSV endpoint on the EES API for a given data set
Why this is important
Quick previewing and downloading of full data sets
Acceptance criteria
- function created that downloads a CSV data set from the EES API CSV endpoint when given the following:
- Dataset ID
- Dataset version
- API version
- EES environment
- Unit tests are created that test the function
Additional Context
Description
A connector which downloads a chosen data set from the CSV endpoint given a dataset ID, e.g. GET https://api.education.gov.uk/statistics/v1/data-sets/019cc380-0338-7072-ba5c-5b4d0c2c3635/csv?dataSetVersion=1.0
This is equivalent to
preview_dataset()from eesyapi.R:https://github.com/dfe-analytical-services/eesyapi.R/blob/main/R/preview_dataset.R
Use case
User's need a way to connect to the CSV endpoint on the EES API for a given data set
Why this is important
Quick previewing and downloading of full data sets
Acceptance criteria
Additional Context