Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Attempts to download a file at an index. If the file at that index has not been available for download at the time of the download request, the service will return information about the status of the process. The client application will need to continue to request the download until the file is ready to be downloaded, or an error is encountered.

URL

No Format
http://dmasdata.uvicoceannetworks.ca/api/dataProductDelivery

...

  • Request a 'Log File' data product in 'txt' format, using a Data Product Code of LF and Extension of 'txt' for Device Category Code of 'ADCP2MHZ' at the Location Code of 'BACAX', Between July 25th and 28th, 2016

http://dmasdata.uvicoceannetworks.ca/api/dataProductDelivery?method=request&token=[YOUR_TOKEN_HERE]&locationCode=BACAX&deviceCategoryCode=ADCP2MHZ&dataProductCode=LF&extension=txt&begin=2016-07-25T00:00:00.000Z&end=2016-07-29T00:00:00.000Z

...

  • Request a 'Time Series Scalar Data' data product in 'csv' format, using a Data Product Code of 'TSSD' and Extension of 'csv' for the Property Code of 'salinity' at the 'Barkley Canyon Axis (Pod 1) location using the Location Code of 'BACAX', Between July 1st and 12th, 2017

http://dmasdata.uvicoceannetworks.ca/api/dataProductDelivery?method=request&token=[YOUR_TOKEN_HERE]&locationCode=BACAX&propertyCode=salinity&dataProductCode=TSSD&extension=csv&begin=2017-01-01T00:00:00.000Z&end=2017-01-13T00:00:00.000Z&dpo_qualityControl=1&dpo_resample=none&dpo_dataGaps=0

...

errorCode
errorMessage
Description
127

Invalid search header ID.

Occurs when an invalid Request ID is used in the dpRequestId paramters.

128Missing parameter

Occurs when multiple parameters are needed, but not all are present. Occurs when begin is used without end

  • The names of the required filter parameters will be included in the "parameter" property separated by /
129Invalid parameter name

Occurs when a filter parameter is used, but is not supported.

 

Example

http://dmasdata.uvicoceannetworks.ca/api/dataProductDelivery?method=run&token=[YOUR_TOKEN_HERE]&dpRequestId=[YOUR_REQUEST_ID_HERE]

...

The following is an example of the return of data product that is still being processed, note that the response code in this case is 202.

http://dmasdata.uvicoceannetworks.ca/api/dataProductDelivery?method=download&token=[YOUR_TOKEN_HERE]&dpRunId=[YOUR_RUN_ID_HERE]&index=[YOUR_INDEX_#_HERE]

...