Project

General

Profile

Feature #8688

Updated by Tom Clegg about 8 years ago

The API call will have these arguments: 

 a) a unique identifier for the external data provider 

 b) the 3rd party activity identifier for the pgp participant which was sent to the data provider when the participant signed up for the activity 

 c) a payload which indicates what file(s) to import. Details of the format of that payload are TBD, but at a minimum it should probably be a collection of URLs, ideally associated with a file type for each individual file to download. The URLs _should_ include either a manifest file with MD5 digests (like http://cdimage.debian.org/debian-cd/8.3.0/amd64/iso-cd/MD5SUMS), or an @*.md5@ file for each data file.    The size of each file should also be included. 

 h2. Acceptance criteria 

 When a researcher or admin shows/edits a third party study, the unique identifier for the study is shown. (This is passed as @api_key@.) 

 Given a @POST /third_party/add_dataset@ /third_party/study/add_dataset@ request: 
 # Ensure @api_key@ corresponds to an approved third-party study 
 # Ensure @participant_code@ param corresponds @study_id@ and @participant_id@ params correspond to a participant who is participating in the study (otherwise HTTP 4xx) 
 # Ensure @data_sources_tsv@ param is a TSV document, where each line has a URI, size, and hex md5 digest of the corresponding file data 
 # Respond HTTP 4xx if any parameters are invalid or there is an error submitting the download job; otherwise 200 

Back