534
edits
Changes
Jump to navigation
Jump to search
Line 10:
Line 10: − + − + + + + Line 27:
Line 30: − + − + − + Line 42:
Line 45: + + Line 75:
Line 80: − + Line 181:
Line 186: − + − +
no edit summary
https://api.canada.ca/en/homepage
https://api.canada.ca/en/homepage
=== GitHub Repo - Search and Discovery (Python0 ===
=== GitHub Repo - Search and Discovery in Python ===
Checkout out our [https://github.com/nrcan-eodms-sgdot-rncan/eodms-ogc-client-py/wiki open source Python module on GitHub] use the CSW and WCS APIs to order images from EODMS.
Checkout out our [https://github.com/nrcan-eodms-sgdot-rncan/eodms-ogc-client-py/wiki open source Python module on GitHub] which uses the CSW, WCS and REST APIs to automate the ordering of images from EODMS.
== REST API ==
== REST API ==
=== REST Search ===
=== REST Search ===
SEARCH FIELDS
Default result format is human-readable HTML. Appending <code>&format=json'</code> or <code>'=xml'</code> to the URL behaves as expected.
Default result format is human-readable HTML. Appending <code>&format=json'</code> or <code>'=xml'</code> to the URL behaves as expected.
Each collection has a unique set of search fields here:
Each collection has a unique set of search fields here:
<pre style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/search?collection=NAPL&query=CATALOG_IMAGE.THE_GEOM_4326 INTERSECTS POLYGON ((-75 45,-75 46,-76 46,-76 45,-75 45))&format=json</pre>
<pre style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/search?collection=NAPL&query=CATALOG_IMAGE.THE_GEOM_4326 INTERSECTS POLYGON ((-75 45,-75 46,-76 46,-76 45,-75 45))&format=json</pre>
TEMPORAL (timestamp e.g. 2000 - 2005)
TEMPORAL
<pre style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/search?collection=NAPL&query=CATALOG_IMAGE.START_DATETIME>'2000-01-01' AND CATALOG_IMAGE.START_DATETIME<'2005-01-01'</pre>
<pre style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/search?collection=NAPL&query=CATALOG_IMAGE.START_DATETIME>'2000-01-01' AND CATALOG_IMAGE.START_DATETIME<'2005-01-01'</pre>
BOOLEAN e.g. CATALOG_IMAGE.PUBLIC_GOOD
BOOLEAN
<pre style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/search?collection=NAPL&query=CATALOG_IMAGE.PUBLIC_GOOD=TRUE</pre>
<pre style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/search?collection=NAPL&query=CATALOG_IMAGE.PUBLIC_GOOD=TRUE</pre>
STRING e.g.ROLL.ROLL_NUMBER AND PHOTO.PHOTO_NUMBER
STRING
<pre style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/search?collection=NAPL&query=ROLL.ROLL_NUMBER='A128' AND PHOTO.PHOTO_NUMBER='0032</pre>
<pre style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/search?collection=NAPL&query=ROLL.ROLL_NUMBER='A128' AND PHOTO.PHOTO_NUMBER='0032</pre>
URL: https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/order
URL: https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/order
HTTP AUTH: Your EODMS username and password
HTTP POST XML:
HTTP POST XML:
=== OPENSEARCH Order ===
=== OPENSEARCH Order ===
Using a RESPONSE from the OPENSEARCH Search, you can parse out the <code style="background-color:#EEFFCC; border-color:#AACC99">collectionId</code> and <code style="background-color:#EEFFCC; border-color:#AACC99">recordId</code> and submit a corresponding [[#REST ORDER|REST ORDER]]. e.g. <code style="background-color:#EEFFCC; border-color:#AACC99">collectionId=Radarsat1</code> and <code style="background-color:#EEFFCC; border-color:#AACC99">recordId=1508207</code>
Using a RESPONSE from the OPENSEARCH Search, you can parse out the <code style="background-color:#EEFFCC; border-color:#AACC99">collectionId</code> and <code style="background-color:#EEFFCC; border-color:#AACC99">recordId</code> and submit a corresponding [[#REST Order|REST Order]]. e.g. <code style="background-color:#EEFFCC; border-color:#AACC99">collectionId=Radarsat1</code> and <code style="background-color:#EEFFCC; border-color:#AACC99">recordId=1508207</code>
<pre>
<pre>
...
...
</pre>
</pre>
== OpenSearch API - Copernicus Hub Inspired (for RADARSAT-1 and NAPL, ONLY) ==
== OPENSEARCH API. Copernicus Hub Inspired. Provides Direct Download. RADARSAT-1 and NAPL, ONLY) ==
This particular flavour of OpenSearch API is heavily modelled after [[https://scihub.copernicus.eu/userguide/OpenSearchAPI Copernicus Data Hub OpenSearch access program]] to align RADARSAT-1 access with SENTINEL access.
This particular flavour of OpenSearch API is heavily modeled after the [[https://scihub.copernicus.eu/userguide/OpenSearchAPI Copernicus Data Hub OpenSearch access program]] to align RADARSAT-1 and NAPL access with SENTINEL access. Each API response comes with a direct download URL (in contrast to the [[#REST Order|REST Order]] API call which invokes a slower archive-pull-and-stage operation.
QUERY FORMAT
QUERY FORMAT
