Versions Compared

Old Version 12

changes.mady.by.user Former WMDA staff member

Saved on

compared with

New Version 13

changes.mady.by.user Riny Heijdendael

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated documentation
Info
titleINFORMATION

This API user guide is subject to change as development of the new BMDW data upload service continues.

The API document is set to point to the staging environment to ensure your registry can connect to.

The URL will change when we go LIVE from 1st November 2017.

Purpose

Data upload can be done using various mechanisms : 

This document describes the data upload mechanism via the REST API method, where users can upload a PGP encrypted XML file to the new submission platformfile.

Using the REST API

To test the API you may use a tool like Restlet, a plugin for Chrome browsers to test API calls before you deploy. The server responds with a HTTP code 200 in when succesfull, but may the response body may contain detailed error messages.

...

URL 
SERVER URLhttps://staging-dataupload.wmda.info
URI

/pydio/api/v2/io/bmdwxmlupload/UPD-ION0000-C.pgpION0999/

UPD-ION0000-C.pgp is the filename to be used. Please refer to the file naming convention.

This  is stated as : For XML format:The files are marked with ION numbers ( ION-1234-D or ION-1234-C)

The ION number is an unique number of an organisation sending the file.

The D give the information that it is a donor file and the C give the information that it is a cord blood file

METHODPUT
HEADER 
Authorization

basic

Content-Typeapplication/x-www-form-urlencoded
X-Rename-If-Existstrue
RESPONSE 
XML
Code Block
languagexml
themeDJango
titleResponse body
<?xml version="1.0" encoding="UTF-8" ?>
<tree>
<nodes_diff>
<add>
<treeis_file="true" filename="/UPD-ION0000-C12.pgp" mimestring_id="23" 
icon="mime_empty.png" fonticon="file" file_group="1" file_owner="1" 
ajxp_readonly="false" ajxp_modiftime="1490728602" 
bytesize="6387" ajxp_relativetime="Modified today at 19:16" 
ajxp_description="Modified today at 19:16" filesize="6.24 KB" md5="4a95dd3138a1ed69fa7d77eb7d1c1696" 
mimestring="File"
node_repository_id="0228a1d8bf6005dff74f366c6432cb81" 
text="UPD-ION0000-C12.pgp" ajxp_im_time="1490728602"/>
</add>
</nodes_diff>
</tree>

SAMPLE Request

server name should be staging-dataupload.wmda.info

Server name should be staging-dataupload.wmda.info

Please note that the URL will change to https://dataupload.wmda.info in production.

 


SAMPLE Request

 

First test the connection by using the right path and fetching the metadata : it should result in a response 200 OK.

Look carefully at the path : here we use ion0999, that should be replaced by your ION.

 

Image Added

 

Now we know the path is correct and we can do an upload: 

(for clarity we omit X-Rename-If-Exists)

curl -i -X PUT -H "Authorization:Basic d21.....uZT=="   -T "./test.pgp"  'https://staging-dataupload.wmda.info/api/v2/io/ION0999/'

In RESTLET :


Image Added
                       

Click on Code to get raw CURL syntax

Image Added

 

Response should be 200

Image Added


                            


 

 Image Removed