Overview

The API citation service returns a citation for a given DOI or Query PID. The Oceans 3.0 API allows this process to be automated, which facilitates easy computer-to-computer tasks such as scheduled record retrieval or download of large numbers of citations. Citations are formatted according to ESIP guidelines established by the earth science community as follows:

Full Dataset: Author(s). Publication Year. Title. Version. Repository. Persistent Identifier.
Subset of Dataset (from a query): Author(s). Publication Year. Title. Version. Repository. Persistent Identifier. Subset query PID. Accessed date.

where

Author(s) - as defined in creator field of our DataCite metadata
Publication year - as defined in the publicationYear field of DataCite metadata
Title - as defined in the title field of DataCite metadata
Repository - Ocean Networks Canada, which should also be the publisher in the DataCite metadata
Persistent identifier - as defined in the identifier field of DataCite metadata (DOI)
Subset query pid - local query identifier within the ONC database
Accessed date - date of query done in Oceans 3.0

While citations for our DOIs can also be retrieved from DataCite using their API, only Ocean Networks Canada can provide citations for specific subsets of our data through the use of Query PIDs stored in our Oceans 3.0 system.

See the Oceans 3.0 API Home for more information about all our available web services.

URL

https:/data.oceannetworks.ca/api/citationText

Method

Method=get - retrieves a citation for that DOI or Query PID

Parameters

The webservice parameter can be either the DataCite DOI OR the ONC queryPid

Parameter	Description	Example
DOI	The DOI of the dataset you want to cite.	doi=10.21383/5cxhry6t2x
queryPid	The Query PID of the data subset you want to cite.	queryPid=8297994

Response

Example call (DOI): https://data.oceannetworks.ca/api/citationText?method=get&doi=10.34943/115343a9-6d88-4f6c-a88b-9a7b17ad53e0

Example call (Query PID): https://data.oceannetworks.ca/api/citationText?method=get&queryPid=8297994

Success (HTTP 200)

A successful API call returns the citation in JSON format.

Example results via web browser using a DOI

Data Products > Data Citation Text Service > Data Citation Service DOI call.png

Firefox offers added functionality that formats the JSON to be easier for a human to read:

Data Products > Data Citation Text Service > citation_text_service_DOI_json.png

Example results via web browser using a Query PID

Data Products > Data Citation Text Service > Data Citation Service QPID call.png

Firefox offers added functionality that formats the JSON to be easier for a human to read:

Data Products > Data Citation Text Service > citation_text_service_QPID_json.png

Note the addition of the 'Subset Query: 8297994' information following the DOI at the end of the citation.

Example results via web browser using a Query PID with no DOI

Data Products > Data Citation Text Service > citation_text_case_A_final.png

Firefox offers added functionality that formats the JSON to be easier for a human to read:

Data Products > Data Citation Text Service > citation_text_case_A_firefox_final.png

For assistance or further enquiries, please email us a datacitations@oceannetworks.ca.

Bad Request (HTTP 400)

127	Invalid parameter value	Occurs when an invalid code is used in the filter. Most filters require an exact match.
128	Missing parameter	Occurs when a required parameter is missing.
129	Invalid parameter name	Occurs when a filter parameter is in the query but is not supported.