Indicates whether the ONC Production server URL is used for service requests.

• Default is True.
• False is intended for internal ONC testing only.
• All non-ONC users must use True or leave blank. Non-ONC user IP addresses are blocked from accessing the Oceans 2.0 QA server.

Indicates whether verbose script messages are displayed, such as request url and processing time information.

• Default is False.
• True is intended for script debugging.

The path that downloaded files are saved to.

• Default is 'c:/Temp'.
• Full path will be created if it does not already exist.

A dictionary of one or more filter criteria, used to return an exclusive set of location elements from the ONC locations endpoint.

• If excluded, all locations are returned.
• Valid filters
  • locationCode, locationName, deviceCategoryCode, deviceCode, propertyCode, dataProductCode, dateFrom, dateTo, includeChildren
• See locations Discovery Service for more information on filter usage.

{'locationCode':'BACAX'}

location[].deployments

"locationName":"Axis (POD 1)"

"depth" : 75

"description":"Depth: 985 m Latitude: 48.3167 Longitude: -126.0501 Type: Stationary platform 

               Description: Canyon axis: benthic processes, biodiversity, sediment dynamics."

"hasDeviceData": "true"

"locationCode":"BACAX"

"hasPropertyData":"true"

"dataSearchURL":"https://data.oceannetworks.ca/DataSearch?location=BACAX"

A dictionary of one or more filter criteria, used to return an exclusive set of location elements from the ONC locations endpoint.

• If excluded, all locations are returned.
• Valid filters: locationCode
• See locations Discovery Service for more information on filter usage.

{'locationCode':'BACAX'}

"locationName":"Axis (POD 1)"

"children" : null

"description":"Depth: 985 m Latitude: 48.3167 Longitude: -126.0501 Type: Stationary platform 

               Description: Canyon axis: benthic processes, biodiversity, sediment dynamics."

"hasDeviceData": "true"

"locationCode":"BACAX"

"hasPropertyData":"true"

A dictionary of one or more filter criteria, used to return an exclusive set of device elements from the ONC devices endpoint.

• If excluded, all devices are returned.
• Valid filters
  • deviceCode, deviceName, locationCode, deviceCategoryCode, propertyCode, dataProductCode, dateFrom, dateTo
• See devices Discovery Service for more information on filter usage.

{'deviceCode':'NORTEKADCP9917'}

The starting datetime for a data rating.

• Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.

• datetime is represented in Coordinated Universal Time (UTC).

"dateFrom": "2008-11-01T00:00:00.000Z",

The ending datetime for a data rating.

• If None, the data rating was still in affect when the request was made.
• Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.

• datetime is represented in Coordinated Universal Time (UTC).

"dateTo": "2010-05-27T19:27:04.000Z"

"sampleSize": 1

"deviceCode": "BC_POD1_AD2M"

"deviceId": 11302

"deviceLink": "https://data.oceannetworks.ca/DeviceListing?DeviceId=11302"

"deviceName": "Nortek Aquadopp HR-Profiler 2965"

A dictionary of one or more filter criteria, used to return an exclusive set of device elements from the ONC devices endpoint.

• If excluded, all devices are returned.
• Valid filters
  • locationCode, deviceCode,deviceCategoryCode, propertyCode, dateFrom, dateTo
• See devices Discovery Service for more information on filter usage.

{'deviceCode':'NORTEKADCP9917'}

A dictionary of one or more filter criteria, used to return an exclusive set of deviceCategory elements from the ONC deviceCategories endpoint.

• If excluded, all device categories are returned.
• Valid filters
  • deviceCategoryCode, deviceCategoryName, description, locationCode, propertyCode
• See deviceCategories Discovery Service for more information on filter usage.

{'deviceCategoryCode':'HYDROPHONE'}

[]

"cvTerm": { }

"deviceCategory": [ { } ]

"uri": "http://vocab.nerc.ac.uk/collection/L05/current/130/"

"vocabulary": "SeaDataNet device categories"

"description": "Conductivity Temperature (and Depth Sensor)"

"deviceCategoryCode": "CTD"

"deviceCategoryName": "CTD"

"hasDeviceData": "true"

"longDescription": " Conductivity Temperature Depth (CTD) is an abbreviated 
                     name for an instrument package that contains sensors for
                     measuring the conductivity, temperature, and pressure of
                     seawater. Salinity, sound velocity, and density are variables
                     derived from sensor measurements. CTDs can carry additional
                     instruments and sensors such as oxygen sensors, turbidity
                     sensors and fluorometers. "

A dictionary of one or more filter criteria, used to return an exclusive set of property elements from the ONC properties endpoint.

• If excluded, all properties are returned.
• Valid filters
  • propertyCode, propertyName, description, locationCode, deviceCategoryCode, deviceCode
• See properties Discovery Service for more information on filter usage.

{'propertyCode':'seawatertemperature'}

[]

"cvTerm": { }

"property": []

"uom": []

"uri": "http://vocab.nerc.ac.uk/collection/P06/current/UPDB/"

"vocabulary": "BODC data storage units"

"description": "Pressure"

"hasDeviceData": "true"

"hasPropertyData": "true"

"propertyCode": "pressure"

"propertyName": "Pressure"

"uom": "decibar"

A dictionary of one or more filter criteria, used to return an exclusive set of dataProduct & extension elements from the ONC dataProducts endpoint.

• If excluded, all data products are returned.
• Valid filters
  •  dataProductCode, extension, locationCode, deviceCategoryCode, deviceCode, propertyCode
• See dataProducts Discovery Service for more information on parameter filter usage.

{'dataProductCode':'TSSD','extension':'json'}

[]

"dataProductCode": "TSSD" 

"dataProductName": "Time Series Scalar Data"

"extension": "json"

"hasDeviceData": true

"hasPropertyData": true,

"helpDocument": "https://wiki.oceannetworks.ca/display/DP/1"

A dictionary of filter criteria parameters, used to request data as a data product from the ONC dataProductDelivery endpoint.

• Required filters
  
  • For Site Device data request include locationCode and deviceCategoryCode
  • For Primary Sensor level data request include locationCode and propertyCode
  • For Sensor Level data request include locationCode, deviceCategoryCode and propertyCode
  • For Device (all properties) data request use deviceCode
  • For Device Property data request use deviceCode and deviceCategoryCode
  • Include dateFrom and dateTo (a date range)
  • Include dataProductCode, extension and appropriate data product options
• See locations Discovery Service, devices Discovery Service, deviceCategories Discovery Service, properties Discovery Service and dataProducts Discovery Service for more information on filter usage.

{'locationCode':'BACAX',
'deviceCategoryCode':'ADCP2MHZ',
'dataProductCode':'TSSD',
'extension':'csv',
'dateFrom':'2016-07-27T00:00:00.000Z',
'dateTo':'2016-08-01T00:00:00.000Z',
'dpo_qualityControl':1,
'dpo_resample':'none',
'dpo_dataGaps':0}

The number of times to retry the service before the function aborts.

• If excluded, the default of 100 is used.

Indicates whether the files will be downloaded or if only the URL to the file will be returned.

• False - Files are downloaded to the ONC class outPath property location.
• True - Files will not be downloaded. The download URLs are available from the url property for each downloadResult in downloadResults in the returned dictionary.
• If excluded, the default of False is used.

Indicates if the metadata file associated with the data product request will be downloaded

• False - Metadata file is not downloaded.
• True - Metadata file is downloaded.
• If excluded, the default of False is used.

True

A dictionary of filter criteria parameters, used to request data as a data product from the ONC dataProductDelivery endpoint.

• Required filters
  • For Site Device data request include locationCode and deviceCategoryCode.
  • For Primary Sensor level data request include locationCode and propertyCode.
  • For Sensor Level data request include locationCode, deviceCategoryCode and propertyCode.
  • For Device (all properties) data request use deviceCode.
  • For Device Property data request use deviceCode and deviceCategoryCode.
  • Include dateFrom and dateTo (a date range).
  • Include dataProductCode, extension and appropriate data product options.
• See locations Discovery Service, devices Discovery Service, deviceCategories Discovery Service, properties Discovery Service and dataProducts Discovery Service for more information on filter usage.

{'locationCode':'BACAX',
 'deviceCategoryCode':'ADCP2MHZ',
 'dataProductCode':'TSSD',
 'extension':'csv',
 'dateFrom':'2016-07-27T00:00:00.000Z',
 'dateTo':'2016-08-01T00:00:00.000Z',
 'dpo_qualityControl':1,
 'dpo_resample':'none',
 'dpo_dataGaps':0}

Indicates whether error messages from the dataProductDelivery service should be returned.

• True - error messages from the service call payload will be returned.
• False - error messages will not be returned, but printed to console.
• If excluded, the default value of False is used.

"dpRequestId":2046404

A dataProductDelivery dpRequestId, which is returned by the dataProductDelivery service request method, or as the 'dpRequestId' property in the dpRequest returned by the requestDataProduct() method.

2046404

A dataProductDelivery dpRunId, which is returned by the dataProductDelivery service run method, or as the dpRunId property in the list returned by the runDataProduct() method.

4629218

The actual or estimated file count, which is returned from the dataProductDelivery request method.

• If there is no estimated file count, use 0.
• If excluded, the default of 0 is used.

The estimated time in seconds, to run the request on the task machine.

• Used to determine how often the dataProductDelivery service is called to determine whether the task processing is complete.
• Estimated processing time is provided by the dataProductDelivery request method.

The number of times to retry the service before the function aborts.

• If excluded, the default of 100 is used.

Determines whether the files will be downloaded or if only the url to the file will be returned.

• False - Files are downloaded to the ONC class outPath property location
• True - Files will not be downloaded. The download URLs are available from the url property for each downloadResult in downloadResults in the returned dictionary
• If excluded, the default of False is used

Indicates if the metadata file associated with the data product request will be downloaded

• False - Metadata file is not downloaded.
• True - Metadata file is downloaded.
• If excluded, the default of False is used.

True

Determines how the method and called method should print messages to the console. If downloading data products in a multi-threaded pattern, messages written to the console can overlap and progress dots can be written out of context

• If excluded, the default of False is used.

A dictionary of filter criteria parameters, used to request data as a data product from the ONC dataProductDelivery endpoint.

• Required filters
  • For Site Device data request include locationCode and deviceCategoryCode
  • For Primary Sensor level data request include locationCode and propertyCode
  • For Sensor Level data request include locationCode, deviceCategoryCode and propertyCode
  • For Device (all properties) data request use deviceCode
  • For Device Property data request use deviceCode and deviceCategoryCode
  • Include dateFrom and dateTo (a date range)
  • Include dataProductCode, extension and appropriate data product options
• See locations Discovery Service, devices Discovery Service, deviceCategories Discovery Service, properties Discovery Service and dataProducts Discovery Service for more information on filter usage.

{'locationCode':'BACAX',
 'deviceCategoryCode':'ADCP2MHZ',
 'dataProductCode':'TSSD',
 'extension':'csv',
 'dateFrom':'2016-07-27T00:00:00.000Z',
 'dateTo':'2016-08-01T00:00:00.000Z',
 'dpo_qualityControl':1,
 'dpo_resample':'none',
 'dpo_dataGaps':0}

The number of times to retry the service before the function aborts.

• If excluded, the default of 100 is used

The URL to be downloaded.

https://data.oceannetworks.ca/api/dataProductDelivery?method=download&token=<YOUR_TOKEN_HERE>

&dpRunId=<YOUR_RUN_ID_HERE>&index=<YOUR_INDEX_HERE>

The full path of the file download destination.

• If excluded, the file name from the content disposition in the header is used, along with the ONC class object outPath to create a full file name path.

Determines how the method and called method should print messages to the console. If downloading data products in a multi-threaded pattern, messages written to the console can overlap and progress dots can be written out of context.

• If excluded, the default of False is used.

The URL to a JSON data product delivery result.

https://data.oceannetworks.ca/api/dataProductDelivery?method=download&token=<YOUR_TOKEN_HERE>&dpRunId=<YOUR_RUN_ID_HERE>&index=<YOUR_INDEX_HERE>

The code of the location.

'VION'

'OCEANOGRAPHICRADAR'

A dictionary representing a JSON object with a set of optional filters, which can include any of the following:

• dateFrom: Only include files obtained after this date and time.
• dateTo: Only include files obtained before this date and time.
• dateArchivedFrom: Only include files archived after this date and time.
• dateArchivedTo: Only include files archived before this date and time.

Note: All dates in "yyyy-MM-ddTHH:mm:ss.SSSZ" format.

A dictionary representing a JSON object with a set of configuration options, which can include any of the following:

• returnOptions: Set the detail level of the result as follows:
  • "archiveLocation": Return a file list with their archiveLocation (used by www.oceannetworks.ca website)
  • "all": Return a file list with all metadata information (serviceMetadata object).
  • If returnOptions is not specified, return a simple list of filenames.
• rowLimit: (number) The maximum number of rows to return (100,000 by default), within the constraints of the service. Note this will limit the data starting at the dateFrom time and ending at the row limit, not necessarily at the dateTo time.
• page: (number) In case that the file list obtained is longer than "rowLimit", results will be split into pages where each would contain at most "rowLimit" rows, and this method will only return the subset of rows for a certain "page" (by default 1). The serviceMetadata.next parameter in the response can be used to get the next page of rows.

The code of the device.

'BC_POD2_JB'

Same as getListByLocation()

Same as getListByLocation()

A dictionary of filter criteria parameters, used to request data and metadata from the ONC scalardata endpoint.

• Filters must include locationCode and deviceCategoryCode.
• Filters can optionally Include begin and end (a date range).
• See locations Discovery Service and deviceCategories Discovery Service  for more information on filter usage.

{
'locationCode':'TWDP',
'deviceCategoryCode':'TSG',
'begin':'2016-09-01T00:00:00.000Z',
'end':'2016-09-01T08:00:00.000Z'
}

The encoding of the response output.

• Object - Data are a list of dictionaries with sampleTime, value and qaqcFlag for a given sensor.
• Array - Data have 3 arrays for a given sensor. Array of sampleTime, array of values and array of qaqcFlags
• If excluded, the default 'Object' is used.

The amount of metadata detail included in the response output.

• Minimum - Provides only basic property information. Response includes serviceMetadata dictionary only.
• Full - Provides all property information. Response includes both metadata and serviceMetadata dictionaries.
• If excluded, the default 'Minimum' is used.

The maximum number of rows of scalar data that will be returned for each sensor.

• Maximum is 100,000.
• If excluded, the default 100,000 is used.

The recorded time of the observation.

• Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.

• datetime is represented in Coordinated Universal Time (UTC) .

A dictionary of filter criteria parameters, used to request data and metadata from the ONC scalardata endpoint.

• Filters must include locationCode and deviceCategoryCode.
• Filters can optionally Include dateFrom and dateTo (a date range).
• Filters can optionally specify "metadata" as "minimum" (default) or "full".
  • Minimum provides only basic property information.
  • Full provides all property information. Response includes metadata structure.
• Filters can optionally specify "rowLimit", the maximum number of rows of data that will be returned for each sensor.
  • The maximum is 100,000. If omitted or a higher or invalid limit is specified, the default of 100,000 is used.
• See locations Discovery Service and deviceCategories Discovery Service  for more information on filter usage.

{
'locationCode':'TWDP',
'deviceCategoryCode':'TSG',
'dateFrom':'2016-09-01T00:00:00.000Z',
'dateTo':'2016-09-01T08:00:00.000Z'
}

The recorded time of the observation.

• Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.

• datetime is represented in Coordinated Universal Time (UTC) .

A dictionary of filter criteria parameters, used to request data and metadata from the ONC rawdata endpoint.

• Filters must include locationCode and deviceCategoryCode.
• Filters can optionally Include begin and end (a date range).
• See locations Discovery Service and deviceCategories Discovery Service  for more information on filter usage.

{
'locationCode':'TWDP',
'deviceCategoryCode':'TSG',
'begin':'2016-09-01T00:00:00.000Z',
'end':'2016-09-01T08:00:00.000Z'
}

The maximum number of rows of raw data that will be returned.

• Maximum is 100,000.
• If excluded, the default 100,000 is used.

The recorded time of the observation.

• Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.

• datetime is represented in Coordinated Universal Time (UTC).

Whether more data are available within the range of the request. For example if 1,000 records are returned (because the rowLimit=1000), but there could be 200,000 rows as defined by the filter criteria.

• 0 = False
• 1 = True

A dictionary of filter criteria parameters, used to request data and metadata from the ONC rawdata endpoint.

• Filters must include locationCode and deviceCategoryCode.
• Filters can optionally Include dateFrom and dateTo (a date range).
• Filters can optionally specify "rowLimit", the maximum number of rows of data that will be returned for each sensor.
  • The maximum is 100,000. If omitted or a higher or invalid limit is specified, the default of 100,000 is used.
• See locations Discovery Service and deviceCategories Discovery Service  for more information on filter usage.

{
'locationCode':'TWDP',
'deviceCategoryCode':'TSG',
'dateFrom':'2016-09-01T00:00:00.000Z',
'dateTo':'2016-09-01T08:00:00.000Z'
}

The recorded time of the observation.

• Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.

• datetime is represented in Coordinated Universal Time (UTC).

A dictionary of filter criteria parameters, used to request data and metadata from the ONC rawdata endpoint.

• Filters must include deviceCode.
• Filters can optionally Include dateFrom and dateTo (a date range).
• Filters can optionally specify "rowLimit", the maximum number of rows of data that will be returned for each sensor.
  • The maximum is 100,000. If omitted or a higher or invalid limit is specified, the default of 100,000 is used.
• See locations Discovery Service and deviceCategories Discovery Service and devices Discovery Service for more information on filter usage.

{
'deviceCode':'SBECTD16p6002',
'dateFrom':'2016-09-01T00:00:00.000Z',
'dateTo':'2016-09-01T08:00:00.000Z'
}

The recorded time of the observation.

• Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.

• datetime is represented in Coordinated Universal Time (UTC).

dictionary

A dictionary of filter criteria parameters, used to request data and metadata from the rawdata endpoint.

• A list of filter/value pairs in the following format {'<filter_1>':'<value_1>','<filter_2>':'<value_2>',...}.
• Filters must include locationCode.
• Filters can optionally Include dateFrom and dateTo (a date range).
• See locations Discovery Service for more information on filter usage.

{'locationCode':'TWDP',
'deviceCategoryCode':'TSG',
'dateFrom':'2016-09-01T00:00:00.000Z',
'dateTo':'2016-09-01T08:00:00.000Z'}

• Various code improvements to deal with an issue that would throw an InsecureRequestWarning in certain configurations.

• Added timeout parameter to the onc class constructor
• Solved a bug that would prevent the onc package from updating the code

• Added new archivefile API wrapper functions: getListByLocation(), getListByDevice(), getFile()
• Updated the PyPI deployment scripts to accommodate new PyPI requirements
• Added Apache 2.0 license (package previously licensed as both Apache 2.0 and MIT)
• All package versions can be downloaded from the PyPI project at https://pypi.org/project/onc/#history

• Added UserTestCase_EMP_UTC_001.py to demonstrate use of discovery services
• Added UserTestCase_EMP_UTC_004.py to demonstrate use of archivefiles service
• Updated getDirectFiles() for changes in archivefiles service
• Updated user test case scripts for change of begin/end to dateFrom/dateTo

• Added UserTestCase_EMP_UTC*.py scripts to demonstrate use of client library functions
• Updated getDirectScalar*() functions for changes in scalardata service

• Added getLocationHerarchy() function to access getTree method of locations service
• Changed string testing for compatibility with Python V2
• Added getDirectRawBy*() functions for changes in rawdata service

• Updated orderDataProduct() function to handle estimatedProcessingTime string format
• Updated downloadDataProduct() function to throttle calls using onc.callsPerSecond when downloadResultsOnly=True