 |
 |
 |
 |
 |
 |
 |
 |
||||||
 |
 |
 |
 |
 |
|
Web API Guide - Parameter specificationsWhat Parameters and Values must be specified to display a LISTING of a particular
|
Request |
DisplayList |
Display a directory listing |
| Type | Organization | Display the list of organizations |
| Service | Display the list of services | |
| ProductCollection | Display the list of databases (a.k.a. product collections) | |
| Target | <A single character from A to Z> | Display the list of items that begin with the given character |
| Canada | Display the list of Canadian items | |
| All | Display the list of all items | |
| Other | Display the list of items that do not begin with an alphabetic character | |
| Language | English | Display the list in the English language |
| French | Display the list in the French language |
The following example URL would display a list of all Services described in the directory, in the English language.
What Parameters and Values must be specified To display a DESCRIPTION of a particular
Organization, Service, or Database?
The table below shows what Parameters you must specify, and the meaning of each possible Value.
| Parameter | Value | Meaning |
| Request | DisplayAd | Display an advertisement (a description of an organization, service or database) |
| Type | Organization | Display a description of an organization |
| Service | Display a description of a service | |
| ProductCollection | Display a description of a database (a.k.a. product collection) | |
| ProductCollectionSummary | Display the brief metadata summary for a database (a.k.a. product collection) | |
| Target | <Organization> | The name of the organization (if Type=Organization) |
| <Organization> <Servicee> | The name of the service, and the organization responsible for it (if Type=Service) | |
| <Organization> <ProductCollection> | The name of the database (a.k.a. product collection), and the organization responsible for it (if Type=ProductCollection) | |
| Language | English | Display the list in the English language |
| French | Display the list in the French language |
The following example URL would display a description of a database. Because no Language Parameter is specified, the list would be displayed by default in English.Parameter
What Parameters and Values must be specified to display the Discovery Interface
(to update an organization, service, or database registered content)?
The table below shows what Parameters you must specify, and the meaning of each possible Value .
| Parameter | Valuee | Meaning |
| Request Meaning | Update | Display the advertising interface to update an organization, service, or database advertisement (but only if the correct password for the organization is entered by the user, when prompted) |
| Type | Organization | Display an organization's advertisement page for update |
| Display a service's advertisement page for update | ||
| ProductCollection | Display a database's (a.k.a. product collection) advertisement page for update | |
| Target | <Organization> | The name of the organization (if Type=Organization) |
| <Organization> <Service> | The name of the service, and the organization responsible for it (if Type=Service) | |
| <Organization> <ProductCollection> | The name of the database (a.k.a. product collection), and the organization responsible for it (if Type=ProductCollection) | |
| Language | English | Display the advertisement page in the English language |
| French | Display the advertisement page in the French language |
The following example URL would display an organization's advertisement update page. Because no Language Parameter is specified, the page would be displayed in English.
Note that the user will be prompted for the correct user name and password before the page is displayed, so as to validate that they have the correct privileges to perform the advertisement update.
What Parameters and Values must be specified to do a Directory Search?
A Directory Search enables you to search the central directory for organizations and databases of interest. The Web API provides two interfaces to the directory search capability of the system:
- Display a "Search for Organizations" or "Search for Product Collections" form ( "form" = " database") containing specified search constraints; this form enables the end user to modify the default search Parameters provided and then to submit the form to actually execute the search.
- execute a "Search for Organizations" or "Search for Product Collections" ( "form" = " database" ) using specified search constraints, and display the results of that search; this interface does not provide a means for the end user to modify the search Parameters , database
The table below shows what Parameters you must specify, and the meaning of each possible Value .
| Parameter | Value | Meaning |
| Request | Display the search form populated with the specified search Parameters | |
| ExecSearch | Display search results (i.e. execute the search with the search Parameters specified) | |
| Organization | Search the central directory of organizations | |
| ProductCollection | Search the central directory of databases (a.k.a. product collections) | |
| Service | Search the central directory of services | |
| BoundingWENS | <Ouest>,
<Est>, <Nord>, <Sud> |
Extent of the spatial region of interest (applicable only if Type=ProductCollection ). The format of BoundingWENS Values are discussed below |
| TimePeriod | <begin> ,<end> | Extent of the temporal range of interest (applicable only if Type=ProductCollection). The format of TimePeriod Values are discussed below |
| FreeText | <text> | FreeText can consists of a word or phrase to be searched for. Free Text also supports a special free text syntax that allows multiple free text words and FGDC tags to be combined logically with AND , OR , and AND NOT operators. The format of FreeText Values are discussed below |
| MaxRecords | <number> | Maximum number of search results to display or retrieve. |
| Language | English | Display the resource management pages in the English language |
| French | Display the resource management pages in the French language |
The following example URL would display an English language "Search for Product Collections" form ( "Product Collection" = "database" ) containing the specified Values in the spatial and temporal constraint fields:
This following example URL would display a maximum of 15 "Search for Organizations" result records, in the English language, each of which include the text "mapping" in their organization description somewhere:
This following example URL would display a maximum of 10 "Search for Product Collections" results records ( "Product Collection" = "database" ), in the English language (by default), each of which include the text "biodiversity" or "" in their product description somewhere:
To search through a Database connected through the Internet for an Individual Product?
An Individual Product Search enables you to search different remote databases to discover what individual products (e.g. a specific map sheet or satellite image) exist. The Web API provides two interfaces to Individual Product Search:
- Display a " Search for Individual Products" form containing specified search constraints; this form enables the end user to modify the default search Parameters provided and then to submit the form to actually execute the search.
- execute a "Search for Individual Products" using specified search constraints, and display the results of that search; this interface does not provide a means for the end user to modify the search Parameters , only the results of the defined search are displayed.
Note that it is possible to search more than one remote database at a time. You can do so by specifying the Target Parameter repeatedly, each time with a different Value.
The table below shows what ,
Parameters
you must specify, and the meaning of each possible
Value.
| Parameter | Value | Meaning |
| Request | NewSearch | Display the search form populated with the specified search Parameters |
| ExecSearch | Display search results (i.e. execute the search with the search Parameters specified) | |
| Target | <Organization>
<ProductCollection> |
The name of the database (a.k.a. product collection) to be searched, and the organization responsible for it. This Parameter may be repeated any number of times, so as to search more than one database simultaneously. |
| DirectZTarget | <remote server name>:< port number>/< database name> | DirectZTarget consists of an unregistered database's remote server name, port number and the database name. . This Parameter may be repeated any number of times, so as to search more than one database simultaneously. |
| ExtraZPara | <Geo atrribute id>: <>/< Relation Attribute Type>:< Relation attribute value>/< Structure Attribute Type>:< Structure attribute value> | ExtraZPara consists of an extra FGDC/GEO use attribute id and search
values, relation attribute type ids and values , structure attribute
type ids and values . The search server needs to map to the specified
GEO search use attribute id in order to ensure the validity of the
search query.
For example: 1035:Land/2:3/4:6 This Parameter may be repeated any number of times.
All the possible relation values are: All the possible stucture values are: |
| Type | IndividualProduct | Search for Individual Products |
| BoundingWENS | <Ouest>, <Est>, <Nord>, <Sud> | Extent of the spatial region of interest. The format of BoundingWENS Values are discussed below<> |
| TimePeriod | <begin>, <end> | Extent of the temporal range of interest. The format of TimePeriod Values are discussed below |
| FreeText | <texte> | FreeText can consists of a word or phrase to be searched for. Free Text also supports a special free text syntax that allows multiple free text words and FGDC tags to be combined logically with AND , OR , and AND NOT operators. The format of The format of FreeText Values are discussed below |
| MaxRecords | <number> | Maximum number of search results to display or retrieve. |
| MaxTimeout | <number> | Maximum number of seconds to wait for a database to finish searching. |
| Language | English | Display the resource management pages in the English language |
| French | Display the resource management pages in the French language |
The following example URL would display a English language "Search for Individual Products" form containing the specified Values in the spatial and temporal constraint fields. The data sets that would be selected by default for searching would be the RADARSAT International Catalog (provided by RADARSAT International) and the LANDSAT TM Scenes Collected by CCRS ( provided by Canada Centre for Remote Sensing, ESS / NRCan ):
What Parameters and Values must be specified to display a "What's New" page?
The table below shows what Parameter you must specify, and the meaning of each possible Value.
| Parameter | Value | Meaning |
| Request | DisplayWhatsNew | Display a section from the What's New pages |
| Target | Organization | Display all new registered organizations in the Discovery Portal |
| Services | Display all new registered services in the Discovery Portal | |
| Products | Display all new registered products in the Discovery Portal | |
| All | Display all new registered organizations, services and products in the Discovery Portal | |
| English | Display the information in the English language | |
| French | Display the information in the French language |
The following example URL would display a English language "What's Newpage.
http://geodiscover.cgdi.ca/api?Language=English&Request=DisplayWhatsNew& Target=All
For more information...
Should you have further questions please contact us via E-mail at:
