Difference between revisions of "NEAFC2ICES WS"
(→Endpoint) |
(→Endpoint) |
||
| Line 14: | Line 14: | ||
==== Endpoint ==== | ==== Endpoint ==== | ||
The test WS endpoint is currently [http://figisapps.fao.org/vrmf/neafc2ices http://figisapps.fao.org/vrmf/neafc2ices] with specific services detailed in the following paragraphs. | The test WS endpoint is currently [http://figisapps.fao.org/vrmf/neafc2ices http://figisapps.fao.org/vrmf/neafc2ices] with specific services detailed in the following paragraphs. | ||
| − | The data export | + | |
| + | The specific data-export services can be invoked with the following URL: | ||
http://figisapps.fao.org/vrmf/neafc2ices/services/exchange/export/{data}(/current|?{params}) | http://figisapps.fao.org/vrmf/neafc2ices/services/exchange/export/{data}(/current|?{params}) | ||
| Line 20: | Line 21: | ||
where {data} is one among: | where {data} is one among: | ||
| − | * vessels | + | * vessels (vessel details, is not related to a given timeframe) |
| − | * authorization | + | * authorization (vessel authorization in a given timeframe) |
| − | * positions | + | * positions (vessel positions in a given timeframe) |
| − | * catch | + | * catch (catch data in a given timeframe) |
| − | * all | + | * all (all of the above, in a given timeframe) |
==== Retrieve vessel data ==== | ==== Retrieve vessel data ==== | ||
Revision as of 14:53, 18 June 2014
Purposes
This wiki page details the API and the expected behavior of the NEAFC 2 ICES data exchange web service. Currently, the WS is hosted by FAO and provides access to a limited set of data (not intended for public use). In the future, this same WS will be made available by NEAFC and additional access constraints will apply.
Background
Please refer to this ticket for background about the purposes and rationale of this WS
Remarks
Unless a specific timeframe is explicitly requested, the extracted data will always reference information belonging to the past semester. This means that in such circumstances:
- Incoming requests sent from January 1st to June 30th will produce data related to the time period spanning from July 1st to December 31st of the previous year
- Incoming requests sent from July 1st to December 31st will produce data related to the time period spanning from January 1st to June 30th of the same year
API
Endpoint
The test WS endpoint is currently http://figisapps.fao.org/vrmf/neafc2ices with specific services detailed in the following paragraphs.
The specific data-export services can be invoked with the following URL:
http://figisapps.fao.org/vrmf/neafc2ices/services/exchange/export/{data}(/current%7C?{params})
where {data} is one among:
- vessels (vessel details, is not related to a given timeframe)
- authorization (vessel authorization in a given timeframe)
- positions (vessel positions in a given timeframe)
- catch (catch data in a given timeframe)
- all (all of the above, in a given timeframe)
Retrieve vessel data
This service extracts all the vessel data currently available, regardless of a time frame. The produced data
URL example
RID LENGTH_CATEGORY POWER_CATEGORY VESSEL_TYPE FISHING_GEAR
