Data visualization: service file

This service can be used to obtain a list of URLs pointing to online files (mostly figures) regarding a float or one of its cycle.

This service does not offer any function but has options (see below).

This service is used by the NA-ARC website on the Data Explorer panel view.

Usage

To obtain files for a float: use the option wmo to specify an exact WMO number.
To obtain files for a profile: use the option wmo and add the option cyc to specify a float's cycle number.

The most general request form to use this service is:

  • [api]/?file&wmo=WMONumber&cyc=CYCLENumber

where option cyc is really optional.

Service file has thus two options to specify the float WMO and possibly one of its cycle number:

  • wmo
    To specify the float WMO to retrieve files for.
    It takes as argument a numerical value.
    This option is not really an option because its mandatory (!).     1
  • cyc
    To specify the cycle number to retrieve files for.
    It takes as argument a numerical value.     2

Default output format

The default output is a JSON object where keys/values depends on the options used.

Output for a float

The output JSON object has keys/values where keys are:

  • status: The file listing outcome status: 'ok' or 'error'.
  • source: The online ressource we found files from.
  • credits: The online ressource file provider.
  • ove_temp: Overlayed temperature profiles.
  • sec_temp: Pressure/cycle temperature section.
  • ove_psal: Overlayed salinity profiles.
  • sec_psal: Pressure/cycle salinity section.
  • ove_doxy: Overlayed oxygen profiles.
  • sec_doxy: Pressure/cycle oxygen section.
  • cls: CLS/Coriolis Altimetring QC test figure.
  • trajectory: Coriolis float trajectory figure.
  • netcdf: URL to request float NetCDF file from Coriolis.
  • csv: URL to request float CSV file from Coriolis.

Note that if salinity or oxygen measurements are not available for the selected float, fields ove_psal/sec_psal or ove_doxy/sec_doxy will not be defined in the NA-ARC web API output.

Output for a profile

The output JSON object has keys/values where keys are:

  • status: The file listing outcome status: 'ok' or 'error'.
  • source: The online ressource we found files from.
  • credits: The online ressource file provider.
  • temp: Temperature profile.
  • psal: Salinity profile.
  • ts: Temperature/Salinity diagram.
  • doxy: Oxygen profile.
  • more: Extra figure with undefined content.
  • stationId: Coriolis asset unique Id for this profile.
  • netcdf: URL to request profile NetCDF file from Coriolis.
  • csv: URL to request profile CSV file from Coriolis.

If salinity or oxygen measurements are not available for the selected float cycle, fields psal, ts or doxy will not be defined in the NA-ARC web API output.

NOTE:
If the requested profile is one of those with a PROVBIO configuration handled by the Oceanographic Autonomous Observations system (Laboratoire d'Oceanographie de Villefranche), then additional files field are available:

  • oao: Additional sensors profiles figure.
  • oao_ctd: CTD (temperature/salinity) RAW data from Provbio.
  • oao_opt: Optical (Fluo, CDOM, ...) RAW data from Provbio.
  • oao_source: The online OAO ressource we found files from.
  • oao_credits: Credit for those ressources: Oceanographic Autonomous Observations (Laboratoire d'Oceanographie de Villefranche).

Examples

Let's retrieve files for float WMO 4900881:

?file&wmo=4900881

An API response example to this request is:

And let's retrieve files for float WMO 4900881 and cycle number 12:

?file&wmo=6900087&cyc=12

An API response example to this request is:

Other output format

There are no other output format supported at this time for this service.