534
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: − + + + + + − − 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] Line 14:
Line 16: − + − + − + − + Line 36:
Line 38: − + Line 43:
Line 45: − + Line 57:
Line 59: − See [[File:EODMS OGC Services.pdf|none]] for complete details as well as an end-to-end sample.+ − + − + − + Line 81:
Line 83: − + Line 127:
Line 129: − + − + − + Line 172:
Line 174: − + + + − + − + − + Line 195:
Line 199: − + Line 274:
Line 278: − + − The following steps use Python to search the EODMS_Catalog CSW and WCS services to order a Radarsat-1 image from the EODMS.+ − For this example, the following restrictions will be place on the query:+ − * A bounding box surrounding the City of Ottawa city limits with coordinates: − : <code>lower corner: -76.3556 44.9617</code> − : <code>upper corner: -75.2466 45.5371</code> − * All dates before to March 29, 2013 as this was the last day Radarsat-1 transmitted data − ==== Python Packages ====+ − The only Python package that needs to be installed prior running these scripts is the Requests package (https://realpython.com/python-requests/). It can be installed by running the command <code>pip install requests</code>.+ − ==== GetRecords POST Request ====+ − SET VARIABLES+ − − First step is to set the input parameters (restrictions listed above) for the '''GetRecords''' request. − Python code:+ − <pre style="background-color:#EEFFCC; border-color:#AACC99"># Set specific parameters − lower_corner = '-76.3556 44.9617' − upper_corner = '-75.2466 45.5371' − end_date = '2013-03-29Z'</pre> − − CREATE REQUEST XML − − Next, create the XML POST '''GetRecords''' request with the above variables. The request tells the CSW to return the first 15 records based on these variables (or search criteria). − NOTE: To change the number of records returned, change the <code>maxRecords</code> attribute in the XML below to the desired value. − − GetRecords POST request example: − <pre><?xml version="1.0" encoding="UTF-8"?> − <csw:GetRecords service='CSW' version='2.0.2' − maxRecords='15' − startPosition='1' − resultType='results' − outputFormat='application/xml' − outputSchema='http://www.opengis.net/cat/csw/2.0.2' − xmlns='http://www.opengis.net/cat/csw/2.0.2' − xmlns:csw='http://www.opengis.net/cat/csw/2.0.2' − xmlns:ogc='http://www.opengis.net/ogc' − xmlns:ows='http://www.opengis.net/ows' − xmlns:dc='http://purl.org/dc/elements/1.1/' − xmlns:dct='http://purl.org/dc/terms/' − xmlns:gml='http://www.opengis.net/gml' − xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' − xsi:schemaLocation='http://www.opengis.net/cat/csw/2.0.2 − http://schemas.opengis.net/csw/2.0.2/CSW-discovery.xsd'> − <csw:Query typeNames='csw:Record'> − <csw:ElementSetName typeNames='csw:Record'>full</csw:ElementSetName> − <csw:Constraint version="1.1.0"> − <ogc:Filter> − <ogc:And> − <ogc:PropertyIsLessThan> − <ogc:PropertyName>dc:date</ogc:PropertyName> − <ogc:Literal>%s</ogc:Literal> − </ogc:PropertyIsLessThan> − <ogc:PropertyIsLike escapeChar='\\' singleChar='?' − wildCard='*'> − <ogc:PropertyName>dc:title</ogc:PropertyName> − <ogc:Literal>*</ogc:Literal> − </ogc:PropertyIsLike> − <ogc:BBOX> − <ogc:PropertyName>ows:BoundingBox</ogc:PropertyName> − <gml:Envelope> − <gml:lowerCorner>%s</gml:lowerCorner> − <gml:upperCorner>%s</gml:upperCorner> − </gml:Envelope> − </ogc:BBOX> − </ogc:And> − </ogc:Filter> − </csw:Constraint> − </csw:Query> − </csw:GetRecords></pre> − − Python code of request: − − <pre style="background-color:#EEFFCC; border-color:#AACC99"># Submit a GetRecords to the CSW − post_xml = '''<?xml version="1.0" encoding="UTF-8"?> − <csw:GetRecords service='CSW' version='2.0.2' − maxRecords='15' − startPosition='1' − resultType='results' − outputFormat='application/xml' − outputSchema='http://www.opengis.net/cat/csw/2.0.2' − xmlns='http://www.opengis.net/cat/csw/2.0.2' − xmlns:csw='http://www.opengis.net/cat/csw/2.0.2' − xmlns:ogc='http://www.opengis.net/ogc' − xmlns:ows='http://www.opengis.net/ows' − xmlns:dc='http://purl.org/dc/elements/1.1/' − xmlns:dct='http://purl.org/dc/terms/' − xmlns:gml='http://www.opengis.net/gml' − xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' − xsi:schemaLocation='http://www.opengis.net/cat/csw/2.0.2 − http://schemas.opengis.net/csw/2.0.2/CSW-discovery.xsd'> − <csw:Query typeNames='csw:Record'> − <csw:ElementSetName typeNames='csw:Record'>full</csw:ElementSetName> − <csw:Constraint version="1.1.0"> − <ogc:Filter> − <ogc:And> − <ogc:PropertyIsLessThan> − <ogc:PropertyName>dc:date</ogc:PropertyName> − <ogc:Literal>%s</ogc:Literal> − </ogc:PropertyIsLessThan> − <ogc:PropertyIsLike escapeChar='\\' singleChar='?' − wildCard='*'> − <ogc:PropertyName>dc:title</ogc:PropertyName> − <ogc:Literal>*</ogc:Literal> − </ogc:PropertyIsLike> − <ogc:BBOX> − <ogc:PropertyName>ows:BoundingBox</ogc:PropertyName> − <gml:Envelope> − <gml:lowerCorner>%s</gml:lowerCorner> − <gml:upperCorner>%s</gml:upperCorner> − </gml:Envelope> − </ogc:BBOX> − </ogc:And> − </ogc:Filter> − </csw:Constraint> − </csw:Query> − </csw:GetRecords>''' % (end_date, lower_corner, upper_corner)</pre> − − SEND THE REQUEST − − The next step is to send the request to the WCS URL. In Python, use the requests object to send a POST request: − − <pre style="background-color:#EEFFCC; border-color:#AACC99">csw_url = 'https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW' \ − '/csw/eodms_catalog' − headers = {'Content-Type':'application/xml'} − csw_r = requests.post(csw_url, data=post_xml)</pre> − − The GetRecords response will contain all the records up to the <code>maxRecords</code> value (in this case the first 15). The following HTTP response will be returned from the CSW: − − <pre><?xml version="1.0" encoding="UTF-8"?> − <GetRecordsResponse xmlns="http://www.opengis.net/cat/csw/2.0.2"> − <SearchStatus timestamp="2019-11-22T04:11:02-05:00"/> − <SearchResults numberOfRecordsMatched="705" − numberOfRecordsReturned="15" nextRecord="16"> − <csw:Record xmlns:csw="http://www.opengis.net/cat/csw/2.0.2" − xmlns:ows="http://www.opengis.net/ows" − xmlns:dct="http://purl.org/dc/terms/" − xmlns:dc="http://purl.org/dc/elements/1.1/"> − <dc:identifier>1508208</dc:identifier> − <dc:title>Radarsat-1 Raw Scenes</dc:title> − <dc:type>dataset</dc:type> − <dc:subject>Satellites, Imaging,Radar, Digital Collection, − Mapping, Spatial Data, Remote Sensing − </dc:subject> − <dc:subject>F2</dc:subject> − <dc:format>GeoTIFF</dc:format> − <dc:creator>Government of Canada; Natural Resources Canada; − Earth Sciences Sector; Canada Centre for Mapping and − Earth Observation − </dc:creator> − <dc:description>The Radarsat-1 satellite has a synthetic − aperture radar(SAR) imaging instrument. The images are − used internationally to manage and monitor the Earth's − resources and to monitor global climate change, as well − as in many other commercial and scientific applications. − RADARSAT-1 is ideally suited to supporting these tasks − because of its wide range of beams, SAR technology, − frequent revisit period, high-quality products and fast, − efficient delivery. Each of Radarsat-1's seven beam − modes offer a different image resolution. The modes − include Fine, which covers an area of 50 km × 50 km − (31 mi × 31 mi) (2,500 km2 (970 sq mi)) with a resolution − of 10 metres (33 ft); Standard, which covers an area of − 100 km × 100 km (62 mi × 62 mi) (10,000 km2 (3,900 sq mi)) − and has a resolution of 30 metres (98 ft); and ScanSAR − wide, which covers a 500 km × 500 km (310 mi × 310 mi) − (250,000 km2 (97,000 sq mi)) area with a resolution of − 100 metres (330 ft). Radarsat-1 also has the unique − ability to direct its beam at different angles. − </dc:description> − <dct:abstract>The Radarsat-1 satellite has a synthetic − aperture radar(SAR) imaging instrument. The images are − used internationally to manage and monitor the Earth's − resources and to monitor global climate change, as well − as in many other commercial and scientific applications. − RADARSAT-1 is ideally suited to supporting these tasks − because of its wide range of beams, SAR technology, − frequent revisit period, high-quality products and fast, − efficient delivery. Each of Radarsat-1's seven beam − modes offer a different image resolution. The modes − include Fine, which covers an area of 50 km × 50 km − (31 mi × 31 mi) (2,500 km2 (970 sq mi)) with a resolution − of 10 metres (33 ft); Standard, which covers an area of − 100 km × 100 km (62 mi × 62 mi) (10,000 km2 (3,900 sq mi)) − and has a resolution of 30 metres (98 ft); and ScanSAR − wide, which covers a 500 km × 500 km (310 mi × 310 mi) − (250,000 km2 (97,000 sq mi)) area with a resolution of − 100 metres (330 ft). Radarsat-1 also has the unique − ability to direct its beam at different angles. − </dct:abstract> − <dc:publisher>NRCan/CCMEO/EODMS section head</dc:publisher> − <dc:date>2013-02-21</dc:date> − <dc:language>eng; CAN</dc:language> − <dct:references scheme="OVERVIEW"> − https://was-eodms.compusult.net/wes/getObject? − FeatureID=SERVICE-RSAT1_001-000000000000000000-1508208 − &ObjectType=Thumbview&collectionId=Radarsat1 − </dct:references> − <dct:references scheme="THUMBVIEW"> − https://was-eodms.compusult.net/wes/getObject? − FeatureID=SERVICE-RSAT1_001-000000000000000000-1508208 − &ObjectType=Thumbview&collectionId=Radarsat1 − </dct:references> − <dct:references scheme="transferOptions"> − http://gs.mdacorporation.com/SatelliteData/ − Radarsat1/Radarsat1.aspx − </dct:references> − <dct:references scheme="transferOptions"> − http://ceocat.ccrs.nrcan.gc.ca − </dct:references> − <dc:source> − https://www.eodms-sgdot.nrcan-rncan.gc.ca:80/MetaManagerCSW − /csw/eodms_catalog?service=CSW&request=GetRecordById − &version=2.0.2&ElementSetName=full&outputSchema=http:// − www.isotc211.org/2005/gmd&Id=1508208&outputFormat=text/html − </dc:source> − <ows:BoundingBox> − <ows:LowerCorner>-76.275153 45.191208</ows:LowerCorner> − <ows:UpperCorner>-75.444661 45.739692</ows:UpperCorner> − </ows:BoundingBox> − </csw:Record> − <csw:Record xmlns:csw="http://www.opengis.net/cat/csw/2.0.2" − xmlns:ows="http://www.opengis.net/ows" − xmlns:dct="http://purl.org/dc/terms/" − xmlns:dc="http://purl.org/dc/elements/1.1/"> − . − . − . − </csw:Record> − . − . − . − </SearchResults> − </GetRecordsResponse></pre> − − EXTRACT RECORD ID AND COLLECTION ID FROM RESPONSE − − Using the GetRecords HTTP response, the record ID and the collection ID can be extracted. The record ID is taken from <code><dc:identifier></code> in the response. The collection ID can be extracted by parsing the URL in the <code><dct:references></code>. − The next step in the script is to convert the XML response into an ElementTree and get the XML element of the first record (or remove the '''<code style='color:blue'>break</code>''' and add each <code>rec_element</code> to a list to go through each record in the response): − − <pre style="background-color:#EEFFCC; border-color:#AACC99"># Get first record from the response XML − resp_xml = csw_r.content − root = ElementTree.fromstring(resp_xml) − − record_tag = '{http://www.opengis.net/cat/csw/2.0.2}Record' − for child in root.iter('*'): − if child.find(record_tag): − rec_element = child.find(record_tag) − break</pre> − − Using the record element, locate the <code><dc:identifier></code> element and get its text: − − <pre style="background-color:#EEFFCC; border-color:#AACC99"># Get the ID of the first record − id_tag = '{http://purl.org/dc/elements/1.1/}identifier' − id_el = rec_element.find(id_tag) − rec_id = id_el.text</pre> − − Next, locate the <code><dct:references></code> in the record element and parse the URL from it: − − <pre style="background-color:#EEFFCC; border-color:#AACC99"># Parse the collection ID from the first dct:references links − ref_tag = '{http://purl.org/dc/terms/}references' − ref_el = rec_element.find(ref_tag) − ref_url = ref_el.text − − url_parse = urlparse(ref_url) − url_query = url_parse.query − query_items = {u.split('=')[0]:u.split('=')[1] for u in url_query.split('&')} − collection_id = query_items['collectionId']</pre> − − ==== DescribeCoverage Request ==== − − The '''DescribeCoverage''' feature can be sent as a POST or GET request. − − The URL for the '''DescribeCoverage''' GET request is: − https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs?SERVICE=WCS&version=2.0.1&REQUEST=DescribeCoverage&coverageId=1508208&CollectionId=Radarsat1 − − The POST request would be: − − <pre><?xml version="1.0" encoding="UTF-8"?> − <wcs:DescribeCoverage service="WCS" version="2.0.1" − xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' − xsi:schemaLocation="http://www.opengis.net/wcs/2.0 − http://schemas.opengis.net/wcs/2.0/wcsAll.xsd" − xmlns="http://www.opengis.net/wcs/2.0" − xmlns:wcs="http://www.opengis.net/wcs/2.0"> − <wcs:CoverageId>Radarsat1--5117806</wcs:CoverageId> − </wcs:DescribeCoverage></pre> − − For the Python scripts, the GET URL will be used. The code for the '''DescribeCoverage''' GET URL is: − − <pre style="background-color:#EEFFCC; border-color:#AACC99"># Submit a DescribeCoverage GET request to the WCS using the record and collection IDs − wcs_url = 'https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/' \ − 'wcs?SERVICE=WCS&version=2.0.1&REQUEST=DescribeCoverage' \ − '&coverageId=%s&CollectionId=%s' % (rec_id, collection_id)</pre> − − Using the WCS service requires a user account. To send an authenticated request in Python, a session containing the username and password has to be created first. The following code creates a session with username and password and then sends the GET request through the session: − − <pre style="background-color:#EEFFCC; border-color:#AACC99">username = '######' − password = base64.b64decode("######").decode("utf-8") − − session = requests.Session() − session.auth = (username, password) − wcs_desccov = session.get(url=wcs_url)</pre> − − Next, the DescribeCoverage will send back the following response if the request was successful: − − <pre><wcs:CoverageDescriptions xmlns:wcs="http://www.opengis.net/wcs/2.0"> − <wcs:CoverageDescription xmlns:gml="http://www.opengis.net/gml/3.2" − gml:id="Cd5a023dc-0003-4ddf-b5cc-5d2e533eac05"> − <wcs:CoverageId>Radarsat1--1508208</wcs:CoverageId> − <metadata xmlns="http://www.opengis.net/gmlcov/1.0" − xmlns:xlink="http://www.w3.org/1999/xlink" − xlink:href="https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes − /services/WESSearch/csw/Radarsat1?request=GetRecordById − &Id=1508208&version=2.0.2&outputSchema=http://schema.compusult.net/ − services/2.2.0/WESSearch/csw&service=CSW" − xlink:title="CSW GetRecordById" − xlink:type="simple"/> − <gml:domainSet> − <gml:Polygon xmlns:gml="http://www.opengis.net/gml/3.2" − gml:id="C49b46f31-cbe9-433b-9201-d4f0cc04ee0d" − srsDimension="2" srsName="EPSG:4326"> − <gml:exterior> − <gml:LinearRing> − <gml:posList> − -76.275153 45.652944 − -76.157606 45.191208 − -75.444661 45.278003 − -75.556206 45.739692 − -76.275153 45.652944 − </gml:posList> − </gml:LinearRing> − </gml:exterior> − </gml:Polygon> − </gml:domainSet> − <rangeType xmlns="http://www.opengis.net/gmlcov/1.0"/> − <wcs:ServiceParameters> − <wcs:CoverageSubtype>GridCoverage</wcs:CoverageSubtype> − <wcs:nativeFormat/> − <wcs:Extension> − <DestinationTypes xmlns="http://schema.compusult.net/ − services/2.7.0/WESOrder/wcs"> − <Type>Download</Type> − </DestinationTypes> − <Parameter xmlns="http://schema.compusult.net/services/ − 2.7.0/WESOrder"> − <Name>packagingFormat</Name> − <Title>Packaging Format</Title> − <Description>Packaging Format</Description> − <Default>ZIP</Default> − <Choices> − <Value>ZIP</Value> − <Display>Zip</Display> − <Description>Zip</Description> − <DependentParameters/> − </Choices> − <Choices> − <Value>TAR</Value> − <Display>Tar</Display> − <Description>Tar</Description> − <DependentParameters/> − </Choices> − <Choices> − <Value>TARGZ</Value> − <Display>Tar/GZ</Display> − <Description>Tar/GZ</Description> − <DependentParameters/> − </Choices> − <Choices> − <Value>TAR</Value> − <Display>Tar</Display> − <Description>Tar</Description> − <DependentParameters/> − </Choices> − <Choices> − <Value>TARGZ</Value> − <Display>Tar/GZ</Display> − <Description>Tar/GZ</Description> − <DependentParameters/> − </Choices> − </Parameter> − </wcs:Extension> − </wcs:ServiceParameters> − </wcs:CoverageDescription> − </wcs:CoverageDescriptions></pre> − − ==== GetCoverage Request ==== − − If the request was successful, the status code of 200 will be returned with the request and the '''GetCoverage''' operation can be sent to the WCS. A GET request similar to the DescribeCoverage can be sent to the WCS (adding <code>format=applicationgml+xml</code> to the URL query). − − In this case, a POST request is used. For the POST request, the <code>CoverageId</code> must be in the format of <collection>--<record_id> so in this case the <code>CoverageId</code> is <code>Radarsat1--1508208</code>: − − <pre style="background-color:#EEFFCC; border-color:#AACC99">if wcs_desccov.status_code == 200: − − cov_id = '%s--%s' % (collection_id, rec_id) − − # Submit a GetCoverage to the WCS − getcov_post = '''<wcs:GetCoverage − xmlns:wos="http://schema.compusult.net/services/2.6.1/WESOrder" − xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' − xsi:schemaLocation="http://www.opengis.net/wcs/2.0 − http://schemas.opengis.net/wcs/2.0/wcsAll.xsd" − xmlns="http://www.opengis.net/wcs/2.0" − xmlns:wcs="http://www.opengis.net/wcs/2.0" − xmlns:wes="http://schema.compusult.net/services/2.6.1/WESOrder/wcs" − service="WCS" version="2.0.1"> − <wcs:CoverageId>%s</wcs:CoverageId> − <wcs:format>application/gml+xml</wcs:format> − </wcs:GetCoverage>''' % cov_id − − wcs_getcov = session.post(url=wcs_url, data=getcov_post)</pre> − − Once the request has been sent, the user will receive an “EODMS Image Request Submitted Notification” email letting them know that their request has been submitted. Shortly after receiving this email, the user should then receive another email called “EODMS Image Request Delivery Notification” with download links for the specific image. − − ==== Full Script ==== − − <pre style="background-color:#EEFFCC; border-color:#AACC99">import sys − import requests − from xml.etree import ElementTree − import base64 − from urllib.parse import urlencode − from urllib.parse import urlparse − − def main(): − − # Set specific parameters − aoi = '-76.3556 44.9617 -75.2466 44.9617 -75.2466 45.5371 ' \ − '-76.3556 45.5371 -76.3556 44.9617' − lower_corner = '-76.3556 44.9617' − upper_corner = '-75.2466 45.5371' − end_date = '2013-03-29Z' − − # Submit a GetRecords to the CSW − post_xml = '''<?xml version="1.0" encoding="UTF-8"?> − <csw:GetRecords service='CSW' version='2.0.2' − maxRecords='15' − startPosition='1' − resultType='results' − outputFormat='application/xml' − outputSchema='http://www.opengis.net/cat/csw/2.0.2' − xmlns='http://www.opengis.net/cat/csw/2.0.2' − xmlns:csw='http://www.opengis.net/cat/csw/2.0.2' − xmlns:ogc='http://www.opengis.net/ogc' − xmlns:ows='http://www.opengis.net/ows' − xmlns:dc='http://purl.org/dc/elements/1.1/' − xmlns:dct='http://purl.org/dc/terms/' − xmlns:gml='http://www.opengis.net/gml' − xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' − xsi:schemaLocation='http://www.opengis.net/cat/csw/2.0.2 − http://schemas.opengis.net/csw/2.0.2/CSW-discovery.xsd'> − <csw:Query typeNames='csw:Record'> − <csw:ElementSetName typeNames='csw:Record'>full</csw:ElementSetName> − <csw:Constraint version="1.1.0"> − <ogc:Filter> − <ogc:And> − <ogc:PropertyIsLessThan> − <ogc:PropertyName>dc:date</ogc:PropertyName> − <ogc:Literal>%s</ogc:Literal> − </ogc:PropertyIsLessThan> − <ogc:PropertyIsLike escapeChar='\\' singleChar='?' wildCard='*'> − <ogc:PropertyName>dc:title</ogc:PropertyName> − <ogc:Literal>*</ogc:Literal> − </ogc:PropertyIsLike> − <ogc:BBOX> − <ogc:PropertyName>ows:BoundingBox</ogc:PropertyName> − <gml:Envelope> − <gml:lowerCorner>%s</gml:lowerCorner> − <gml:upperCorner>%s</gml:upperCorner> − </gml:Envelope> − </ogc:BBOX> − </ogc:And> − </ogc:Filter> − </csw:Constraint> − </csw:Query> − </csw:GetRecords>''' % (end_date, lower_corner, upper_corner) − − csw_url = 'https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW' \ − '/csw/eodms_catalog' − headers = {'Content-Type':'application/xml'} − csw_r = requests.post(csw_url, data=post_xml) − − # Get first record from the response XML − resp_xml = csw_r.content − root = ElementTree.fromstring(resp_xml) − − record_tag = '{http://www.opengis.net/cat/csw/2.0.2}Record' − for child in root.iter('*'): − if child.find(record_tag): − rec_element = child.find(record_tag) − break − − # Get the ID of the first record − id_tag = '{http://purl.org/dc/elements/1.1/}identifier' − id_el = rec_element.find(id_tag) − rec_id = id_el.text − − # Parse the collection ID from the first dct:references links − ref_tag = '{http://purl.org/dc/terms/}references' − ref_el = rec_element.find(ref_tag) − ref_url = ref_el.text − − url_parse = urlparse(ref_url) − url_query = url_parse.query − query_items = {u.split('=')[0]:u.split('=')[1] \ − for u in url_query.split('&')} − collection_id = query_items['collectionId'] − − # Submit a DescribeCoverage GET request to the WCS using the record − # and collection IDs − wcs_url = 'https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/' \ − 'wcs?SERVICE=WCS&version=2.0.1&REQUEST=DescribeCoverage' \ − '&coverageId=%s&CollectionId=%s' % (rec_id, collection_id) − − # Create a session with authentication − username = 'keballan' − password = base64.b64decode("TWJWbUNoMTIj").decode("utf-8") − − session = requests.Session() − session.auth = (username, password) − wcs_desccov = session.get(url=wcs_url) − − if wcs_desccov.status_code == 200: − − cov_id = '%s--%s' % (collection_id, rec_id) − − # Submit a GetCoverage to the WCS − getcov_post = '''<wcs:GetCoverage − xmlns:wos="http://schema.compusult.net/services/2.6.1/WESOrder" − xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' − xsi:schemaLocation="http://www.opengis.net/wcs/2.0 − http://schemas.opengis.net/wcs/2.0/wcsAll.xsd" − xmlns="http://www.opengis.net/wcs/2.0" − xmlns:wcs="http://www.opengis.net/wcs/2.0" − xmlns:wes="http://schema.compusult.net/services/2.6.1/WESOrder/wcs" − service="WCS" version="2.0.1"> − <wcs:CoverageId>%s</wcs:CoverageId> − <wcs:format>application/gml+xml</wcs:format> − </wcs:GetCoverage>''' % cov_id − − wcs_getcov = session.post(url=wcs_url, data=getcov_post) − − if __name__ == '__main__': − sys.exit(main())</pre> − − == Katalon == − − * A [https://github.com/nrcan-eodms-sgdot-rncan/eodms-scene-retriever Katalon utility] to automate website user clicks for searching and ordering. − − @fr| − − SGDOT propose plusieurs options pour l’API Access et automation, à savoir Machine 2 Machine. Pour découvrir plus d’API du GC, visitez le site API du GC. − − Dans le cadre de la [https://www.tbs-sct.gc.ca/pol/doc-fra.aspx?id=28108 Directive sur la gouvernance ouverte], le gouvernement du Canada s'est engagé à améliorer sa [https: // twitter.com/hashtag/opendata?lang=en #OpenData] posture. API EODMS [http://www.canada.ca/fr/government/system/digital-government/modern-emerging-technologies/government-canada-standards-apis.html Normes du GC sur les API] − + − + − + − + Line 861:
Line 322: − + Line 868:
Line 329: − + Line 882:
Line 343: − + − + − + − + Line 906:
Line 367: − + Line 948:
Line 409: − + − + − + Line 991:
Line 452: − + + + − + − + − + Line 1,014:
Line 477: − + Line 1,093:
Line 556: − + + + + +
no edit summary
<multilang>@en|
<multilang>@en|
EODMS is has several options for API Access and automation i.e. Machine 2 Machine. To find more GC APIs, visit the GC API site.
[[Earth_Observation_Data_Management_System_(EODMS)|EODMS]] has several options for API Access and 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 GC API site.
[[File:Api-logo.png|link=https://api.canada.ca/en/homepage]]
[[File:Api-logo.png|link=https://api.canada.ca/en/homepage]]
https://api.canada.ca/en/homepage
https://api.canada.ca/en/homepage
== OpenSearch API (for RADARSAT-1 and NAPL) ==
== OpenSearch API (for RADARSAT-1 and NAPL) ==
To form a get query it would take the form of:
To form a get query it would take the form of:
<code>https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q={searchterms}</code>
<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>
e.g.:
e.g.:
<code>https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q=footprint:Intersects((-130.496,54.672))</code>
<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>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>
<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
SEARCH TERMS
<pre>
<pre style="background-color:#EEFFCC; border-color:#AACC99">
producttype which can be SCN,SGF, or SLC for Radarsat-1
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..
sensoroperationalmode which refers to the beam mnemonic like EH3, F1, W2, SCWB, SCNA etc..
The search terms can be used together with AND and OR. There is also support for wildcards, free text searching and other operators:
The search terms can be used together with AND and OR. There is also support for wildcards, free text searching and other operators:
<pre>
<pre style="background-color:#EEFFCC; border-color:#AACC99">
Wildcard Description
Wildcard Description
</pre>
</pre>
<pre>
<pre style="background-color:#EEFFCC; border-color:#AACC99">
Operator Description
Operator Description
== OGC APIs==
== OGC APIs==
The following is a complete end-to-end same to use OGC APIs
=== CSW GetRecords ===
=== Discover some data / CSW GetRecords ===
URL (POST)
URL (POST)
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog</code>
<code style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog</code>
HTTP POST - HEADER
HTTP POST - HEADER
<pre><csw:GetRecords service='CSW' version='2.0.2' maxRecords='10' startPosition='1' resultType='results'
<pre style="background-color:#EEFFCC; border-color:#AACC99"><csw:GetRecords service='CSW' version='2.0.2' maxRecords='10' startPosition='1' resultType='results'
	outputFormat='application/xml' outputSchema='http://www.opengis.net/cat/csw/2.0.2'
	outputFormat='application/xml' outputSchema='http://www.opengis.net/cat/csw/2.0.2'
	xmlns='http://www.opengis.net/cat/csw/2.0.2' xmlns:csw='http://www.opengis.net/cat/csw/2.0.2'
	xmlns='http://www.opengis.net/cat/csw/2.0.2' xmlns:csw='http://www.opengis.net/cat/csw/2.0.2'
HTTP RESPONSE
HTTP RESPONSE
<pre>
<pre style="background-color:#EEFFCC; border-color:#AACC99">
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<GetRecordsResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
<GetRecordsResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
</pre>
</pre>
=== CSW GetRecordById ===
=== Fetch a Single Record / CSW GetRecordById ===
URL (GET REQUEST)
URL (GET REQUEST)
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog?request=GetRecordById&id=1515826&service=CSW&version=2.0.2</code>
<code style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog?request=GetRecordById&id=1515826&service=CSW&version=2.0.2</code>
HTTP RESPONSE
HTTP RESPONSE
<pre>
<pre style="background-color:#EEFFCC; border-color:#AACC99">
<GetRecordByIdResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
<GetRecordByIdResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
	<csw:SummaryRecord xmlns:csw="http://www.opengis.net/cat/csw/2.0.2"
	<csw:SummaryRecord xmlns:csw="http://www.opengis.net/cat/csw/2.0.2"
</pre>
</pre>
=== WCS DescribeCoverage ===
=== Order that Record / WCS DescribeCoverage ===
The WCS DescribeCoverage message is used for ordering and can be sent as a POST or GET (recommended) request.
URL (GET REQUEST)
URL (GET REQUEST)
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs?SERVICE=WCS&version=2.0.1&REQUEST=DescribeCoverage&coverageId=5117806&CollectionId=Radarsat1</code>
<code style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs?SERVICE=WCS&version=2.0.1&REQUEST=DescribeCoverage&coverageId=5117806&CollectionId=Radarsat1</code>
URL (POST)
URL (POST)
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs</code>
<code style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs</code>
HTTP POST - HEADER
HTTP POST - HEADER
<pre><wcs:DescribeCoverage service="WCS" version="2.0.1"
<pre style="background-color:#EEFFCC; border-color:#AACC99"><wcs:DescribeCoverage service="WCS" version="2.0.1"
	xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
	xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
	xsi:schemaLocation="http://www.opengis.net/wcs/2.0
	xsi:schemaLocation="http://www.opengis.net/wcs/2.0
HTTP RESPONSE
HTTP RESPONSE
<pre><wcs:CoverageDescriptions xmlns:wcs="http://www.opengis.net/wcs/2.0">
<pre style="background-color:#EEFFCC; border-color:#AACC99"><wcs:CoverageDescriptions xmlns:wcs="http://www.opengis.net/wcs/2.0">
	<wcs:CoverageDescription xmlns:gml="http://www.opengis.net/gml/3.2"
	<wcs:CoverageDescription xmlns:gml="http://www.opengis.net/gml/3.2"
		gml:id="C380b242c-b324-4364-9ea5-7798f2f5e648">
		gml:id="C380b242c-b324-4364-9ea5-7798f2f5e648">
</wcs:CoverageDescriptions></pre>
</wcs:CoverageDescriptions></pre>
=== End-to-End Order Example (using Python) ===
=== End-to-End OGC Order Example with Python ===
Checkout out our [https://github.com/nrcan-eodms-sgdot-rncan/eodms-ogc-client-py/wiki open source Python module on GitHub] to search the EODMS_Catalog CSW and WCS services to order a Radarsat-1 image from the EODMS.
== 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.
@fr|
[[Earth_Observation_Data_Management_System_(EODMS)|SGDOT]] propose plusieurs options pour l’API Access et automation, à savoir Machine 2 Machine.
Dans le cadre de la [https://www.tbs-sct.gc.ca/pol/doc-fra.aspx?id=28108 Directive sur la gouvernance ouverte], le gouvernement du Canada s'est engagé à améliorer sa [https: // twitter.com/hashtag/opendata?lang=en #OpenData] posture. API EODMS [http://www.canada.ca/fr/government/system/digital-government/modern-emerging-technologies/government-canada-standards-apis.html Normes du GC sur les API]
Pour découvrir plus d’API du GC, visitez le site API du GC.
[[File:Api-logo.png|link=https://api.canada.ca/en/homepage]]
[[File:Api-logo.png|link=https://api.canada.ca/en/homepage]]
https://api.canada.ca/en/homepage
https://api.canada.ca/en/homepage
== API OpenSearch (pour RADARSAT-1 et NAPL) ==
== API OpenSearch (pour RADARSAT-1 et NAPL) ==
Pour former une requête get, cela prendrait la forme suivante:
Pour former une requête get, cela prendrait la forme suivante:
<code>https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q={searchterms}</code>
<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>
Par exemple:
Par exemple:
<code>https://data.eodms-sgdot.nrcan-rncan.gc.ca/api/dhus/v1/products/Radarsat1/search?q=footprint:Intersects((-130.496,54.672))</code>
<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>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>
<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>
Termes de recherche
Termes de recherche
<pre>
<pre style="background-color:#EEFFCC; border-color:#AACC99">
producttype pouvant être SCN, SGF ou SLC pour Radarsat-1
producttype pouvant être SCN, SGF ou SLC pour Radarsat-1
sensoroperationalmode qui fait référence à la mnémonique du faisceau comme EH3, F1, W2, SCWB, SCNA, etc.
sensoroperationalmode qui fait référence à la mnémonique du faisceau comme EH3, F1, W2, SCWB, SCNA, etc.
Les termes de recherche peuvent être utilisés avec AND et OR. Il existe également un support pour les caractères génériques, la recherche de texte libre et d'autres opérateurs:
Les termes de recherche peuvent être utilisés avec AND et OR. Il existe également un support pour les caractères génériques, la recherche de texte libre et d'autres opérateurs:
<pre>
<pre style="background-color:#EEFFCC; border-color:#AACC99">
Wildcard Description
Wildcard Description
</pre>
</pre>
<pre>
<pre style="background-color:#EEFFCC; border-color:#AACC99">
Operator Description
Operator Description
== OGC ==
== OGC ==
* API compatibles OGC: CSW pour la recherche et WCS pour la commande. Voir [[File:EODMS OGC Services.pdf|none]] pour plus d'informations.
* API compatibles OGC: CSW pour la recherche et WCS pour la commande.
=== CSW GetRecords ===
=== Découvrez des images / CSW GetRecords ===
URL
URL
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog</code>
<code style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog</code>
HTTP POST - HEADER
HTTP POST - HEADER
<pre><csw:GetRecords service='CSW' version='2.0.2' maxRecords='10' startPosition='1' resultType='results'
<pre style="background-color:#EEFFCC; border-color:#AACC99"><csw:GetRecords service='CSW' version='2.0.2' maxRecords='10' startPosition='1' resultType='results'
	outputFormat='application/xml' outputSchema='http://www.opengis.net/cat/csw/2.0.2'
	outputFormat='application/xml' outputSchema='http://www.opengis.net/cat/csw/2.0.2'
	xmlns='http://www.opengis.net/cat/csw/2.0.2' xmlns:csw='http://www.opengis.net/cat/csw/2.0.2'
	xmlns='http://www.opengis.net/cat/csw/2.0.2' xmlns:csw='http://www.opengis.net/cat/csw/2.0.2'
HTTP RESPONSE
HTTP RESPONSE
<pre>
<pre style="background-color:#EEFFCC; border-color:#AACC99">
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<GetRecordsResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
<GetRecordsResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
</pre>
</pre>
=== CSW GetRecordById ===
=== Chercher une seule image / CSW GetRecordById ===
URL (GET REQUEST)
URL (GET REQUEST)
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog?request=GetRecordById&id=1515826&service=CSW&version=2.0.2</code>
<code style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/MetaManagerCSW/csw/eodms_catalog?request=GetRecordById&id=1515826&service=CSW&version=2.0.2</code>
HTTP RESPONSE
HTTP RESPONSE
<pre>
<pre style="background-color:#EEFFCC; border-color:#AACC99">
<GetRecordByIdResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
<GetRecordByIdResponse xmlns="http://www.opengis.net/cat/csw/2.0.2">
	<csw:SummaryRecord xmlns:csw="http://www.opengis.net/cat/csw/2.0.2"
	<csw:SummaryRecord xmlns:csw="http://www.opengis.net/cat/csw/2.0.2"
</pre>
</pre>
=== WCS DescribeCoverage ===
=== Commandez cette image / WCS DescribeCoverage ===
Le message WCS DescribeCoverage est utilisé pour la commande et peut être envoyé sous forme de demande POST ou GET (recommandée).
URL (GET REQUEST)
URL (GET REQUEST)
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs?SERVICE=WCS&version=2.0.1&REQUEST=DescribeCoverage&coverageId=5117806&CollectionId=Radarsat1</code>
<code style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs?SERVICE=WCS&version=2.0.1&REQUEST=DescribeCoverage&coverageId=5117806&CollectionId=Radarsat1</code>
URL (POST)
URL (POST)
<code>https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs</code>
<code style="background-color:#EEFFCC; border-color:#AACC99">https://www.eodms-sgdot.nrcan-rncan.gc.ca/wes/services/WESOrder/wcs</code>
HTTP POST - HEADER
HTTP POST - HEADER
<pre><wcs:DescribeCoverage service="WCS" version="2.0.1"
<pre style="background-color:#EEFFCC; border-color:#AACC99"><wcs:DescribeCoverage service="WCS" version="2.0.1"
	xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
	xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
	xsi:schemaLocation="http://www.opengis.net/wcs/2.0
	xsi:schemaLocation="http://www.opengis.net/wcs/2.0
HTTP RESPONSE
HTTP RESPONSE
<pre><wcs:CoverageDescriptions xmlns:wcs="http://www.opengis.net/wcs/2.0">
<pre style="background-color:#EEFFCC; border-color:#AACC99"><wcs:CoverageDescriptions xmlns:wcs="http://www.opengis.net/wcs/2.0">
	<wcs:CoverageDescription xmlns:gml="http://www.opengis.net/gml/3.2"
	<wcs:CoverageDescription xmlns:gml="http://www.opengis.net/gml/3.2"
		gml:id="C380b242c-b324-4364-9ea5-7798f2f5e648">
		gml:id="C380b242c-b324-4364-9ea5-7798f2f5e648">
</wcs:CoverageDescriptions></pre>
</wcs:CoverageDescriptions></pre>
== Katalon ==
=== Exemple de commande de bout en bout (avec Python) ===
Découvrez notre [https://github.com/nrcan-eodms-sgdot-rncan/eodms-ogc-client-py/wiki module Python Open Source sur GitHub] pour rechercher les services EODMS_Catalog CSW et WCS afin de commander un Radarsat-1. image de l'EODMS.
== Automatisation web avec Katalon ==
Un [https://github.com/nrcan-eodms-sgdot-rncan/eodms-scene-retriever Outil Katalon] pour automatiser les clics de l'utilisateur du site Web pour la recherche et la commande.
Un [https://github.com/nrcan-eodms-sgdot-rncan/eodms-scene-retriever Outil Katalon] pour automatiser les clics de l'utilisateur du site Web pour la recherche et la commande.
</multilang>
</multilang>
