Request Parameters

Please visit the API documentation prepared in Postman which is widely accepted by industry. The documentation provides clear and precise definition for each request parameters as shown below:

• Parameter order is not significant however users are advised to place parameters that identify the data item first, followed by any additional criteria and end with date range. This is a recommended convention to facilitate troubleshooting.
• Not delivering optional attribute will be considered as a request for all available options e.g. not specifying planned/unplanned outage will return both.
• Parameter names are case sensitive. 
• In every request, time interval must be provided as request parameter. This is the major and mandatory variable to limit the response size. There are 2 alternatives while defining time interval.
• Optional parameters (TimeIntervalUpdate or combination of PeriodStartUpdate and PeriodEndUpdate) are only available for Outages. Please refer to the technical documentation when/how to use these parameters.

  • The usage of the new optional attribites, TimeIntervalUpdate or combination of PeriodStartUpdate, in the query will fetch only latest updated version of outages within secified Outage's Timeinterval and specified TimeIntervalUpdate. TimeIntervalUpdate corresponds to 'Updated(UTC)' timestamp in value details of the outage published in the paltform. For example, UK outages where query results in getting more then 200 documents even when queried for 2 hrs. It this extra optional paramter is added i..e Updated start and Updated end, the API call will limit the results to fetch on the latest updated documents. This will help in not fetching already downloaded outages, which you have queried previously. 

  • It is important to take area’s timezone into consideration, as well as winter/summer time. For example, consider the day of February 2 2016 in CET. This is during winter time and hence using UTC this day is considered to start at 2016-01-01 at 23:00 and end at 2016-01-02 at 23:00. As another example, the day of July 5 2016 in CET is during summer time and using UTC this day is considered to start at 2016-07-04 at 22:00 and end at 2016-07-05 at 22:00.