Northwest Fisheries Science Center


West Coast Groundfish Observer Program In-Season Salmon Reporting

Description

The In-Season Salmon Reporting Service is a RESTful web service that reports expanded weights and counts for WCGOP observed discarded salmon species from the Catch Shares sector. Data is available for 2015 through current year. Details for accessing the API are described in the API description section below.

Application Programming Interface (API) Description

The web service can be accessed from the following location:

Base Service

The base service is accessible via the following URL:
https://www.nwfsc.noaa.gov/observersalmon/api/v1/data/observer/selection.csv

Output Format

Output file format may be specified by appending a file type suffix to the selection URL, as follows:
https://www.nwfsc.noaa.gov/observersalmon/api/v1/data/observer/selection.{format}

Supported formats include 'csv' (useful for spreadsheet import) and 'json' (for 3rd party App developers).

Subsetting

A subset of the available Data source variables may be obtained by specifying a DAP4 Constraint Expression, naming one or more of the data set fields delimited by semi-colons (';'). The service will default to retrieving all variables if no Constraint Expression is provided, or no ';' delimited fields are named.

Example:
https://www.nwfsc.noaa.gov/observersalmon/api/v1/data/observer/selection.csv?dap4.ce=common_name;season_year;

Example:
https://www.nwfsc.noaa.gov/observersalmon/api/v1/data/observer/selection.csv?dap4.ce=;

Filtering

The Data source selection may be filtered by appending a pipe-character ('|') and one or more comma-delimited filtering statements after any of the DAP4 Constrain Expression subsettings fields. (If no field subsettings have been specified and/or all variables are desired, but with filtering, a '|' can simply be included by itself [implying an empty/non-specified field to the right of the pipe]) Filter need not be included in the ';' separated field subsetting requesting that variable. A filter may follow any field subsetting, or even reference a variable not included in the subset e.g.: ?dap4.ce=pacfin_code;common_name|season_year=2012;

Example:
https://www.nwfsc.noaa.gov/observersalmon/api/v1/data/observer/selection.csv?dap4.ce=season_year|season_year>=2015,season_year<2016;pacfin_code;common_name;

Example:
https://www.nwfsc.noaa.gov/observersalmon/api/v1/data/observer/selection.csv?dap4.ce=|season_year<=2015;

Example:
https://www.nwfsc.noaa.gov/observersalmon/api/v1/data/observer/selection.csv?dap4.ce=|season_year<=2015;

Example: Service returning only 2016 records
https://www.nwfsc.noaa.gov/observersalmon/api/v1/data/observer/selection.csv?dap4.ce=|season_year=2016

Supported filter operations

WCGOP bycatch data set items that are missing are marked by a 2-character placeholder code.

Data Update Frequency

Daily

Point of Contact

NWFSC / FRAM Data Team, Todd Hay, todd.hay@noaa.gov, 206.302.2449

Other Data Sources

A list of all currently available data sources may be obtained via:
https://www.nwfsc.noaa.gov/observersalmon/api/v1/data

The data source (e.g.: Program) is specified via the URL when selecting as follows:
https://www.nwfsc.noaa.gov/observersalmon/api/v1/data/{source_id}/selection

Currently 'observer' is the only available data source.

Copyright 2015, 2017 ERT Inc. All Rights reserved