StationOrStationGroup/id/CreateTimerEvent

From Oxygen.next Wiki

Jump to: navigation, search

Contents

[edit] Description

Creates a new TimerEvent on the given Station.

[edit] Summary

URL: https://api.oxygennext.com/Station/Id/CreateTimerEvent
Formats: Xml, Json
Requires Authentication (about Authentication): true
HTTP Method(s): POST
API rate limited (about Rate Limiting): true

[edit] Parameters

Id = Id (Guid) from the Station.

[edit] Request

The FootageLink is an REST API URI to the Footage that would be used.

XML Example (truncated)

<?xml version="1.0" encoding="utf-8" ?>
<TimerEvent>
  <FootageLink>https://api.oxygennext.com/Footage/9c6af98b-a04f-4118-a25e-48b8ebebe4b8</FootageLink>
  <StartDate>11/20/2009 6:00:00 PM</StartDate>
</TimerEvent>

[edit] Response

XML Example (truncated)

<?xml version="1.0" encoding="utf-8" ?>
<TimerEvent>
  <LastChange>1/1/0001 12:00:00 AM</LastChange>
  <TimerEventLink>https://api.oxygennext.com/TimerEvent/edb24b9d-7587-45f0-982a-56e78c954013</TimerEventLink>
  <FootageLink>https://api.oxygennext.com/Footage/9c6af98b-a04f-4118-a25e-48b8ebebe4b8</FootageLink>
  <StartDate>11/20/2009 6:00:00 PM</StartDate>
  <ExactStart>False</ExactStart>
  <Active>True</Active>
  <AllowOverlay>True</AllowOverlay>
  <AllowStationLogo>True</AllowStationLogo>
  <PlayAudio>True</PlayAudio>
  <Duration>15</Duration>
  <Channel>1</Channel>
  <Notes />
  <IsPeriodicTimerEvent>False</IsPeriodicTimerEvent>
  <ParentPeriodicTimerEventLink>https://api.oxygennext.com/PeriodicTimerEvent/00000000-0000-0000-0000-000000000000</ParentPeriodicTimerEventLink>
  <Name>Google.de 4444</Name>
</TimerEvent>

[edit] Usage examples

cURL (about cURL):
curl -u user:password https://api.oxygennext.com/Station/15bb6d26-40d7-465f-bc2e-1c65bb5b5f93/CreateTimerEvent

Do you have an example to share in the language of your choice? Please share!