You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

The API citation service returns a citation for a given DOI or Query PID.

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

Endpoint URL

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

Method

Method=get retrieves a citation for that DOI.

Parameters

Parameter

Description

Example

DOI

The DOI of the dataset you want to cite.

doi=10.21383/5cxhry6t2x

Response

Example call:  https://data.oceannetworks.ca/api/method=get&doi=10.21383/mdlk7ursmx&token=9aa154c9-06dc-40f2-8989-70c85a90bb53

Success (HTTP 200)

Returns a JSON file with an attached citation.

{"citationText":["Ocean Networks Canada Society. 2015. Central_Strait of Georgia VENUS Instrument Platform_Conductivity Temperature Depth_20-Sep-2014. Ocean Networks Canada Society. https://doi.org/10.21383/5cxhry6t2x. Accessed 2020-02-13."]}

Bad Request (HTTP 400)

127Invalid parameter value

Occurs when an invalid code is used in the filter. Most filters require an exact match, otherwise this error will occur.

128Missing parameterOccurs when a required parameter is missing.
129Invalid parameter name

Occurs when a filter parameter is in the query but is not supported.

  • No labels