GET api/OpenDataGateway/{id}?vintage={vintage}&version={version}&dateTimeSince={dateTimeSince}

This service requests a specific table using the ID of said table. The return document is an XML/JSON rendering of the published table, or it could be a base 64 encoded file containing any file. Vintage, Version and DateTimeSince are optional parameters

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique ID of the table. This is required to retrieve the table data	globally unique identifier	Required
vintage	optional - If specified, MCE will return data only if the table's Vintage is newer. Vintage is ignored if version is specified	string	None.
version	optional - If specified, the latest version of table is returned. However, an alert is issued if the given version does not match MCE's. An MCE version that is newer signals a structural data change	string	None.
dateTimeSince	Optional Parameter (Format: YYYYMMDD). If specified, MCE will return only data since the specified datetime.	string	None.

Body Parameters

None.

Response Information

Resource Description

OpenDataGateway

Name	Description	Type	Additional information
SourceData	The source data of the table represented in XML format	Object	None.
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

Sample:

{
  "SourceData": {},
  "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": 2,
  "SourceVersionDescription": "sample string 3",
  "Vintage": 1,
  "DescriptionEN": "sample string 4",
  "DescriptionFR": "sample string 5",
  "Id": "913555b1-e542-4806-bc48-f8ba11caa9ae",
  "Name": "sample string 7"
}

application/xml, text/xml

Sample:

<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>2</Version>
  <SourceVersionDescription>sample string 3</SourceVersionDescription>
  <Vintage>1</Vintage>
  <DescriptionEN>sample string 4</DescriptionEN>
  <DescriptionFR>sample string 5</DescriptionFR>
  <Id>913555b1-e542-4806-bc48-f8ba11caa9ae</Id>
  <Name>sample string 7</Name>
  <SourceData />
</OpenDataGateway>