Detect new events

To return a list of all events, in the Service Document, click the URL for the event list:

https://<server.example.com>/opr-web/rest/9.10/event_list

By default, clicking this URL opens the event list in XML format. You can add HTTP query parameters to this base URL to change the way you want to view the data in the list:

• format=atom: This parameter presents the list of events in an Atom feed format. How the event data is displayed is determined by meta-data (for example, categories, author, and so on). For further details about the format media type, see Media type.

• format=json: This parameter presents the list of events in JSON format.

• format=xml: This parameter presents the list of events in XML format. This the default for a web browser.

Receiving events as Atom feeds

Most browsers come with a very basic internal feed reader for Atom and RSS feeds. As the feed readers vary in their features and in the way they represent data, the same data may be represented differently by different readers (and you would typically also access the data in a different way, too).

The two most commonly available browsers with feed readers are Mozilla Firefox and Microsoft Internet Explorer. The following examples show how the Atom web service works with these browsers.

Event lists in an Atom feed are ordered as “last changed”, so a new event, or an event that was modified last would be at the top of the list.

To return a list of events in an atom feed format, follow these steps:

1. Enter the URL for the event list in your web browser, specifying the format=atom parameter as follows:

   https://<server.example.com>/opr-web/rest/9.10/event_list/?format=atom

2. You now see a list of events. Firefox and Internet Explorer represent the data in a slightly different way.

   • In Firefox:

     You see a list of events where the title and description of each event are shown.

     If you click the title of an event in the atom feed, you start the URL launch of the Event Details for that event. For more information about the URL launch of the Event Browser and Event Details, see Specify a URL launch.

     Note If you want to see a more detailed list of the events, right-click the page and select View Page Source. This displays the whole atom feed in XML format. Now you can see all other properties and information regarding the events that are listed.

   • In Internet Explorer:

     You see a list of events where the title and description of each event are shown. In addition to the list, you see a filter box on the right, where you can sort the list by date and title. You can also filter the events by specific categories.

     If you click the title of an event in the atom feed, you start the URL launch of the Event Details to drill down into the OMi user interface. For more information about the URL launch of the Event Browser and Event Details, see Specify a URL launch.

     Only basic details about the events are shown, and to see all the details, right-click on the page and select View Source. This opens the page in your XML editor.

Specifying parameters to filter the event list

The Event Web Service provides a number of parameters for filtering the event list by specific criteria. For details about the URL query language, query filter, and parameters, see HTTP query parameters.