Deleteme - Revision history

William.mackinnon: William.mackinnon moved page EODMS APIs to Deleteme

2022-01-07T00:05:40Z

William.mackinnon moved page EODMS APIs to Deleteme

William.mackinnon: Blanked the page

2022-01-07T00:04:46Z

Blanked the page

Kevin.ballantyne at 15:49, 7 September 2021

2021-09-07T15:49:55Z

Kevin.ballantyne at 15:49, 7 September 2021

2021-09-07T15:49:30Z

Kevin.ballantyne at 15:47, 7 September 2021

2021-09-07T15:47:52Z

Kevin.ballantyne: /* REST API */

2021-09-07T15:42:10Z

REST API

William.mackinnon at 21:02, 5 March 2021

2021-03-05T21:02:55Z

Show changes

William.mackinnon at 20:56, 5 March 2021

2021-03-05T20:56:34Z

William.mackinnon at 20:39, 5 March 2021

2021-03-05T20:39:39Z

William.mackinnon at 18:17, 18 December 2020

2020-12-18T18:17:18Z

← Older revision		Revision as of 00:04, 7 January 2022
Line 1:		Line 1:
−	~~== Overview ==~~

−	[[Earth_Observation_Data_Management_System_(EODMS)\|EODMS]] has several options for search and download API access as well as automation i.e. Machine 2 Machine. As part of the [https://www.tbs-sct.gc.ca/pol/doc-eng.aspx?id=28108 Directive on Open Government], the Government of Canada is committed to improving its [https://twitter.com/hashtag/opendata?lang=en #OpenData] posture. EODMS API access aims to promote practices per the [https://www.canada.ca/en/government/system/digital-government/modern-emerging-technologies/government-canada-standards-apis.html GC Standards on APIs].
−	~~To find more GC APIs, visit the [https://api.canada.ca/en/homepage GC API site]~~
−
−	~~== GitHub Repo - Search and Download in Python ==~~
−
−	~~[[File:GitHub Logo.png\|frameless\|link=https://github.com/nrcan-eodms-sgdot-rncan/eodms-ogc-client-py/wiki]]~~
−
−	Checkout out our [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload REST API client] and [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload OGC API client] Python repos on GitHub which automate the search and download of images from EODMS.
−
−	~~== Python Package ==~~
−
−	For any Python developers, we also have a [https://pypi.org/project/py-eodms-rapi/ Python package to access the REST API]. To learn how to use the package, visit [https://py-eodms-rapi.readthedocs.io/en/latest/].
−
−	~~== REST API ==~~
−
−	Visit [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload/wiki] to find out more about our client to search and download images. To access the REST API directly, see [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload/wiki/Directly-Accessing-the-EODMS-REST-API].
−
−	~~== OPENSEARCH API ==~~
−
−	~~=== OPENSEARCH Search ===~~
−
−	~~To see a list of collection names open to GUEST users to supply to the collection query string argument visit: https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/collections~~
−
−	~~BASIC~~
−
−	~~<pre style="background-color:#EEFFCC; border-color:#AACC99">~~
−	https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/opensearch/search?collection=Radarsat1&q=*
−	~~</pre>~~
−
−	~~SPATIAL~~
−
−	~~<pre style="background-color:#EEFFCC; border-color:#AACC99">~~
−	~~https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/opensearch/search?collection=NAPL&q=*&bbox=-75.71,45.42,-75.69,45.43~~
−	~~</pre>~~
−
−	~~=== 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>
−
−
−	~~== OPENSEARCH API. Copernicus Hub Inspired. Provides Direct Download. RADARSAT-1 and NAPL, ONLY) ==~~
−
−	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~~
−
−	~~<code style="background-color:#EEFFCC; border-color:#AACC99">https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q={searchterms}</code>~~
−
−	~~QUERY EXAMPLES~~
−
−	~~<code style="background-color:#EEFFCC; border-color:#AACC99">https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q=footprint:Intersects((-130.496,54.672))</code>~~
−
−	<pre style="background-color:#EEFFCC; border-color:#AACC99">https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q=beginposition:[2007-08-20T00:49:50Z%20TO%202007-08-22T10:50:50Z]</pre>
−
−	~~SEARCH TERMS~~
−
−	~~<pre style="background-color:#EEFFCC; border-color:#AACC99">~~
−	~~producttype which can be SCN,SGF, or SLC for Radarsat-1~~
−	~~sensoroperationalmode which refers to the beam mnemonic like EH3, F1, W2, SCWB, SCNA etc..~~
−	~~polarisationmode which is only HH for R1~~
−	~~ingestiondate~~
−	~~beginposition~~
−	~~endposition~~
−	~~footprint (point and polygon)~~
−	~~</pre>~~
−
−	~~The search terms can be used together with AND and OR. There is also support for wildcards, free text searching and other operators:~~
−
−	~~<pre style="background-color:#EEFFCC; border-color:#AACC99">~~
−	~~Wildcard Description~~
−
−	* any sequence of zero or more characters
−	~~? any one character~~
−	~~</pre>~~
−
−	~~<pre style="background-color:#EEFFCC; border-color:#AACC99">~~
−	~~Operator Description~~
−
−	~~AND Narrow search and retrieve records containing all of the words it separates.~~
−	~~OR Broaden search and retrieve records containing any of the words it separates.~~
−	~~NOT Narrow search and retrieve records that do not contain the term following it.~~
−	~~( ) Group words or phrases when combining Boolean phrases and to show the order in which relationships should be considered.~~
−	~~</pre>~~
−
−	~~Heavily modeled after the ESA Data hubs so the following should apply:~~
−	~~<code>https://colhub.copernicus.eu/userguide/OpenSearchAPI</code>~~
−
−	~~== OGC APIs ==~~
−
−	To use The following are usage samples of EODMS' OGC APIs with a fully [https://github.com/nrcan-eodms-sgdot-rncan/eodms-ogc-client-py/wiki open source Python client on GitHub]. To find out how to access the OGC APIs directly visit repo's [https://github.com/nrcan-eodms-sgdot-rncan/eodms-ogc-client-py/wiki wiki page]
−
−	~~== Github Repo - Web Automation with Katalon ==~~
−
−	* A [https://github.com/nrcan-eodms-sgdot-rncan/eodms-scene-retriever Katalon utility] to automate website user clicks for searching and ordering.

@@ Line 12: / Line 12: @@
 == Python Package ==
-For any Python developers, we also have a [https://pypi.org/project/py-eodms-rapi/ Python package used to access the REST API]. To learn how to use the package, visit [https://py-eodms-rapi.readthedocs.io/en/latest/].
+For any Python developers, we also have a [https://pypi.org/project/py-eodms-rapi/ Python package to access the REST API]. To learn how to use the package, visit [https://py-eodms-rapi.readthedocs.io/en/latest/].
 == REST API ==

@@ Line 12: / Line 12: @@
 == Python Package ==
-For any Python developers, we also have a [https://pypi.org/project/py-eodms-rapi/ Python package used to access the EODMS RAPI]. To learn how to use the package, visit [https://py-eodms-rapi.readthedocs.io/en/latest/].
+For any Python developers, we also have a [https://pypi.org/project/py-eodms-rapi/ Python package used to access the REST API]. To learn how to use the package, visit [https://py-eodms-rapi.readthedocs.io/en/latest/].
 == REST API ==

← Older revision		Revision as of 15:47, 7 September 2021
Line 9:		Line 9:

	Checkout out our [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload REST API client] and [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload OGC API client] Python repos on GitHub which automate the search and download of images from EODMS.		Checkout out our [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload REST API client] and [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload OGC API client] Python repos on GitHub which automate the search and download of images from EODMS.
		+
		+	== Python Package ==
		+
		+	For any Python developers, we also have a [https://pypi.org/project/py-eodms-rapi/ Python package used to access the EODMS RAPI]. To learn how to use the package, visit [https://py-eodms-rapi.readthedocs.io/en/latest/].

	== REST API ==		== REST API ==

@@ Line 12: / Line 12: @@
 == REST API ==
-Visit [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload] to find out more about our client to search and download images. To access the REST API directly, see [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload/wiki/Directly-Accessing-the-EODMS-REST-API].
+Visit [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload/wiki] to find out more about our client to search and download images. To access the REST API directly, see [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload/wiki/Directly-Accessing-the-EODMS-REST-API].
 == OPENSEARCH API ==

← Older revision	Revision as of 00:05, 7 January 2022
(No difference)

@@ Line 12: / Line 12: @@
 == REST API ==
-=== REST Search ===
+Visit [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload] to find out more about our client to search and download images. To access the REST API directly, see [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload/wiki/Directly-Accessing-the-EODMS-REST-API].
 == OPENSEARCH API ==
@@ Line 62: / Line 18: @@
 === OPENSEARCH Search ===
-To see a list of collection names open to GUESTS to supply to the collection query string argument visit: https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/collections
+To see a list of collection names open to GUEST users to supply to the collection query string argument visit: https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/collections
 BASIC

@@ Line 8: / Line 8: @@
 [[File:GitHub Logo.png|frameless|link=https://github.com/nrcan-eodms-sgdot-rncan/eodms-ogc-client-py/wiki]]
-Checkout out our [https://github.com/nrcan-eodms-sgdot-rncan/eodms-ogc-client-py/wiki open source Python module on GitHub] which uses OGC (CSW, WCS) and REST APIs to automate the search and download of images from EODMS.
+Checkout out our [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload REST API client] and [https://github.com/nrcan-eodms-sgdot-rncan/eodms-rapi-orderdownload OGC API client] Python repos on GitHub which automate the search and download of images from EODMS.
 == REST API ==

@@ Line 61: / Line 61: @@
 === OPENSEARCH Search ===
 BASIC
 <pre style="background-color:#EEFFCC; border-color:#AACC99">
-https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/opensearch/search?q=*
+https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/opensearch/search?collection=Radarsat1&q=*
 </pre>
@@ Line 71: / Line 73: @@
 <pre style="background-color:#EEFFCC; border-color:#AACC99">
-https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/opensearch/search?q=*&bbox=-75.71,45.42,-75.69,45.43
+https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/rapi/opensearch/search?collection=NAPL&q=*&bbox=-75.71,45.42,-75.69,45.43
 </pre>