GET api/OpenDataGateway?name={name}&domain={domain}
This service returns a list of tables that are published by MCE. The return document contains the table name, a description of the table, and information about the currency of the data in the tables. Name and Domain are optional parameters
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
name |
Optional parameter. Returns only data with this name |
string |
None. |
domain |
Optional Parameter. Returns only data within this domain |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
List of all available tables published by MCE
OpenDataGatewayListModelName | Description | Type | Additional information |
---|---|---|---|
Alerts |
Any alerts tied to this table (such as version changes) |
Collection of Alert |
None. |
Version |
Indicates the highest level of structural change for this table. A higher value indicates a more recent structural change occurred. For all but Version=1 of the table the user can expect a Version Description to be returned with the version value |
integer |
None. |
SourceVersionDescription |
Describes the modifications to the table's structure. Returned for all but Version=1 of the table |
string |
None. |
Vintage |
An indicator (ex. datetime) of the most recent addition of rows or modification to the content of rows in the table |
integer |
None. |
DescriptionEN |
English description of table contents |
string |
None. |
DescriptionFR |
French description of table contents |
string |
None. |
Id |
Unique Identifier of table |
globally unique identifier |
None. |
Name |
The table name |
string |
None. |
Response Formats
application/json, text/json
{ "Alerts": [ { "code": "sample string 1", "MessageEN": "sample string 2", "MessageFR": "sample string 3", "Property": "sample string 4", "Severity": 0, "Value": "sample string 5" }, { "code": "sample string 1", "MessageEN": "sample string 2", "MessageFR": "sample string 3", "Property": "sample string 4", "Severity": 0, "Value": "sample string 5" } ], "Version": 1, "SourceVersionDescription": "sample string 2", "Vintage": 1, "DescriptionEN": "sample string 3", "DescriptionFR": "sample string 4", "Id": "5dc121b3-f4d5-4132-943b-1f6d8d8fd564", "Name": "sample string 6" }
application/xml, text/xml
<OpenDataGateway xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Alerts> <Alert> <code>sample string 1</code> <MessageEN>sample string 2</MessageEN> <MessageFR>sample string 3</MessageFR> <Property>sample string 4</Property> <Severity>Notification</Severity> <Value>sample string 5</Value> </Alert> <Alert> <code>sample string 1</code> <MessageEN>sample string 2</MessageEN> <MessageFR>sample string 3</MessageFR> <Property>sample string 4</Property> <Severity>Notification</Severity> <Value>sample string 5</Value> </Alert> </Alerts> <Version>1</Version> <SourceVersionDescription>sample string 2</SourceVersionDescription> <Vintage>1</Vintage> <DescriptionEN>sample string 3</DescriptionEN> <DescriptionFR>sample string 4</DescriptionFR> <Id>5dc121b3-f4d5-4132-943b-1f6d8d8fd564</Id> <Name>sample string 6</Name> </OpenDataGateway>