From Oxygen.next Wiki

Oxygen.next exposes its data via an Application Programming Interface (API). This document is the official reference for that functionality.

Contents 1 Code Samples 2 Libraries 3 Methods 3.1 REST API Methods 3.1.1 Global Methods 3.1.2 User Methods 3.1.3 Team Methods 3.1.4 Station and StationGroup Methods 3.1.5 FootageCategory Methods 3.1.6 Footage Methods 3.1.7 Timer Event Methods 3.1.8 Message Feed Methods 3.1.9 Message Methods 3.1.10 Template Category Methods 3.1.11 Template Methods

[edit] Code Samples

Sample Sources can be found here: http://oxygennext.codeplex.com/

Google Maps Mashup Sample (Javascript/php)

Youtube Mashup Sample (Microsoft .NET, Forms)

CSV Station Importer (Microsoft .NET, Forms)

Oxygen Monitoring Wall Sample (Microsoft .NET, WPF)

[edit] Libraries

Oxygen .Net Client Library Official Client Library from the Oxygen Dev Team

add yours here too!

[edit] Methods

The API supports the following methods to send and receive Oxygen data.

[edit] REST API Methods

HTTP Response Codes and Errors Applications send information throught the HTTP response codes and error messages.
Terms of Service The API is free, but here are the words to code by.
REST API Wiki Template The Wiki Template for REST API Methods.

[edit] Global Methods

• SupportedContentTypes
• SupportedTemplateTypes

[edit] User Methods

• User
• User/id
• User/id/Update
• User/id/MoveTo/targetId
• User/id/Delete

[edit] Team Methods

• Actions
  • Team
  • Team/id
  • Team/id/Create
  • Team/id/CreateUser
  • Team/id/CreateStation
  • Team/id/CreateStationGroup
  • Team/Id/Update
  • Team/id/MoveTo/targetId
  • Team/id/Delete

• Lists
  • Team/id/Users
  • Team/id/Teams
  • Team/id/Stations
  • Team/id/StationGroups

[edit] Station and StationGroup Methods

All this Methods can be used for both Station and StationGroup purpose.

Controller = Station or StationGroup

• Actions
  • Controller/id/Update
  • Controller/id/MoveTo/targetId
  • Controller/id/Delete
  • Controller/id/CreateFootageCategory
  • Controller/id/CreateTemplateCategory
  • Controller/id/CreateTimerEvent
  • Controller/id/CreatePeriodicTimerEvent

• Lists
  • Controller/id/FootageCategories
  • Controller/id/TemplateCategories
  • Controller/id/TimerEvents
  • Controller/id/MessageFeeds

• Only for Station
  • Station/id
  • Station/id/Screenshots
  • Station/id/Alerts
  • Controller/id/Playlist
  • Controller/id/PlayoutChannels
  • Controller/id/Schedule
  • Controller/id/ScheduleRange

• Only for StationGroup
  • StationGroup/id
  • StationGroup/id/CopyTo/targetId
  • StationGroup/id/Stations
  • StationGroup/id/StationGroups
  • StationGroup/id/AssignableStations
  • StationGroup/id/AssignableStationGroups
  • StationGroup/id/AddChilds
  • StationGroup/id/RemoveChilds

[edit] FootageCategory Methods

• FootageCategory/id
• FootageCategory/id/Footages
• FootageCategory/id/ActiveDays
• FootageCategory/id/Channels
• FootageCategory/id/CreateFootage
• FootageCategory/id/Update
• FootageCategory/id/MoveTo/StationOrStationGroupId
• FootageCategory/id/CopyTo/StationOrStationGroupId
• FootageCategory/id/Delete

[edit] Footage Methods

• Footage/Id
• Footage/Id/Update
• Footage/Id/Delete
• Footage/Id/MoveTo/FootageCategoryId
• Footage/Id/CopyTo/FootageCategoryId

[edit] Timer Event Methods

• TimerEvent/Id
• TimerEvent/Id/Update
• TimerEvent/Id/Delete

[edit] Message Feed Methods

• MessageFeed/Id
• MessageFeed/Id/Update
• MessageFeed/Id/Delete
• MessageFeed/Id/CreateMessage
• MessageFeed/Id/Messages

[edit] Message Methods

• Message/Id
• Message/Id/Update
• Message/Id/Delete

[edit] Template Category Methods

• TemplateCategory/Id
• TemplateCategory/Id/Update
• TemplateCategory/Id/Delete
• TemplateCategory/Id/CreateTemplate
• TemplateCategory/Id/MoveTo/StationOrStationGroupId
• TemplateCategory/Id/CopyTo/StationOrStationGroupId
• TemplateCategory/Id/Templates

[edit] Template Methods

• Template/Id
• Template/Id/Update
• Template/Id/Delete
• Template/Id/MoveTo/TemplateCategoryId
• Template/Id/CopyTo/TemplateCategoryId