Phoenix Media

Sharing video, images & audio

Category

Categories grouped similarly themed content together. Categories are applicable to Media and Channels. All Media and Channels must belong to a single Category.

Properties

Name Type Description
IdSystem.Int32 the primary identifier for the Category[queryable][sortable]
ProjectIdSystem.Int32 the Project that this Category belongs to[queryable][sortable][required]
EntityTypeIdEntityTypeEnum the type of entity that this Category refers to (ie Channel or Media)[queryable][sortable]
NameSystem.String the Name of this Category[queryable][sortable][required]
DescriptionSystem.Stringa verbose Description of this Category[required]
ReferenceSystem.String a unique Reference for this Category that can be used by external systems[queryable]
IsActiveSystem.Boolean whether this Category is visible or not[queryable][sortable][required]
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this Object last viewed[queryable][sortable]
ProjectProjectNavigation property to Project [expandable]

Operations

CreateCategory
Creates a new category objectSoapRestC#
GetCategory
Gets a single category entity by its IdSoapRestC#
ListCategory
Returns a paged list of category optionally filtered and sortedSoapRestC#
UpdateCategory
Updates a Category entitySoapRestC#

Channel

Channels are collections of Media that is owned by one User.

Properties

Name Type Description
IdSystem.Int32 the primary identifier of the Channel[queryable][sortable]
ProjectIdSystem.Int32 the Project that this Channel belongs to[queryable][sortable][required]
OwnerProfileIdSystem.Int32 the Profile that this Channel belongs to[queryable][sortable][required]
CategoryIdSystem.Int32 the Category that this Channel belongs to[queryable][sortable]
NameSystem.String the Name of this Channel[sortable][required]
ReferenceSystem.String a unique Reference for this Channel that can be used by external systems[queryable]
DescriptionSystem.Stringa verbose Description of this Channel[required]
ImageUrlSystem.String Url to the Channel's image
VoteCount_OverallSystem.Int32 Total vote count for this channel[readonly][required]
Rating_OverallSystem.Double Total rating count for this channel[readonly][required]
ViewCount_OverallSystem.Int32 Total view count for this channel[readonly][required]
MediaCount_OverallSystem.Int32 Total media count for this channel[readonly][required]
LastMediaCreatedDateSystem.DateTime UTC date of when this Object media was created (redundant)?[queryable][sortable]
IsActiveSystem.Boolean Whether this Category is visible or not[queryable][sortable][required]
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this Object last viewed[queryable][sortable]
PhoenixIdentity_GroupId_SubscribersSystem.Int32 The Phoenix Identity Group which represents subscribers to this Channel.[queryable][queryable][sortable]
PhoenixIdentity_GroupId_EditorsSystem.Int32 The Phoenix Identity Group which represents editors of this Channel.[queryable][queryable][sortable]
OwnerProfileProfileNavigation property to Profile [expandable]
CategoryCategoryNavigation property to Category [expandable]
ProjectProjectNavigation property to Project [expandable]

Operations

CreateChannel
Creates a new ChannelSoapRestC#
GetChannel
Gets a single channel entity by its IdSoapRestC#
ListChannel
Returns a paged list of Channel optionally filtered and sortedSoapRestC#
UpdateChannel
Updates a Channel entitySoapRestC#

DeleteResponse

Properties

Name Type Description

Operations

DeactivateModule
Sets the Project record to inactiveSoapRestC#
DeleteCategory
Deletes a customer by its IdSoapRestC#
DeleteChannel
Deletes a Channel entitySoapRestC#
DeleteMedia
Delete an existing Media entitySoapRestC#
DeleteMediaFileType
Deletes a customer by its IdSoapRestC#
DeletePlaylist
Deletes a Playlist entitySoapRestC#
DeleteProfile
Deletes a customer by its IdSoapRestC#
DeleteProjectMediaFileTypeMap
Deletes a customer by its IdSoapRestC#
DeleteTag
Deletes a customer by its IdSoapRestC#
RemoveMediaFromChannel
Remove a media from a channelSoapRestC#
RemoveMediaFromPlaylist
Remove a media from a playlistSoapRestC#

FileExtension

FileExtensions are a list of file types that are identified to be categorised as MediaTypes (eg an mp4 FileExtension is a Video MediaType)

Properties

Name Type Description
IdSystem.Int32 the primary identifier of the entity[queryable][sortable]
MediaTypeIdMediaTypeEnumwhat type of Media item this file extension relates to
ExtensionSystem.Stringthe actual file extension (eg jpg, mp4)[required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed

Media

A Media is a video, audio, image or plain text item. It is created by a Profile and must belong to a Category. It may be added to a Playlist, added to a Channel and/or be Tagged. It can be viewed, rated or shared.

Properties

Name Type Description
IdSystem.Int32 The primary identifier for the Media item[queryable][sortable]
ParentMediaIdSystem.Int32 Whether this Media is a reply to another MediaId[queryable][sortable]
ProjectIdSystem.Int32 The project that this Media itembelongs to[queryable][sortable][required]
ProfileIdSystem.Int32 The Profile that submitted this Media item[queryable][sortable][required]
StatusTypeIdStatusTypeEnum The moderation status of this Media item[queryable][sortable]
CategoryIdSystem.Int32 The Category that this Media item belongs to[queryable][sortable][required]
CategoryNameSystem.StringThe name of the Category this Media belongs to. Read-only and set when the Media item changes CategoryId.
TagsSystem.String A comma-delimiated list of associated Tags. This column is read-only, and set by a trigger when the MediaTagMap changes.[queryable][sortable]
MediaTypeIdMediaTypeEnum The type of Media (eg Audio, Image, Video, Text)[queryable][sortable]
PrivacyTypeIdNullable Whether this Media is public or private (ie restricted to the owning Profile)[queryable][sortable]
DurationInSecondsSystem.Int32 How long this video Media plays for (in seconds)[queryable][sortable]
NameSystem.String The human readable name given to this Media[queryable][sortable][required]
DescriptionSystem.StringA longer description about this Media[required]
ReferenceSystem.String An option reference to a 3rd party system. An alternative identifier but not necessarily unique.[queryable]
LocationSystem.Data.Spatial.DbGeographyThe location (lat/long) this Media relates to
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
LastViewedDateSystem.DateTimeUTC date of when this Media was last viewed
LastVotedDateSystem.DateTimeUTC date of when this Media was last voted on
LastSharedDateSystem.DateTimeUTC date of when this Media was last shared
LastCommentedDateSystem.DateTimeUTC date of when this Media was last commented on
ViewCount_DailySystem.Int32The number of views this Media had on the previous day.[required]
ViewCount_WeeklySystem.Int32The number of views this Media has had in the previous 7 days.[required]
ViewCount_MonthlySystem.Int32The number of views this Media had in the previous 30 days.[required]
ViewCount_OverallSystem.Int32  The number of views this Media has had overall.[queryable][sortable][required]
VoteCount_DailySystem.Int32The number of votes this Media had on the previous day.[required]
VoteCount_WeeklySystem.Int32The number of votes this Media has had in the previous 7 days.[required]
VoteCount_MonthlySystem.Int32The number of votes this Media has had in the previous 30 days.[required]
VoteCount_OverallSystem.Int32  The number of votes this Media has had overall.[queryable][sortable][required]
Rating_DailySystem.DoubleThe average rating of this Media over the previous day.[required]
Rating_WeeklySystem.DoubleThe average rating of this Media over the previous 7 days.[required]
Rating_MonthlySystem.DoubleThe average rating of this Media over the previous 30 days.[required]
Rating_OverallSystem.Double  The average rating of this Media overall.[queryable][sortable][required]
ShareCount_DailySystem.Int32The number of shares this Media had on the previous day.[required]
ShareCount_WeeklySystem.Int32The number of shares this Media has had in the previous 7 days.[required]
ShareCount_MonthlySystem.Int32The number of shares this Media has had in the previous 30 days.[required]
ShareCount_OverallSystem.Int32  The number of shares this Media has had overall.[queryable][sortable][required]
CommentCount_DailySystem.Int32The number of comments this Media had on the previous day.[required]
CommentCount_WeeklySystem.Int32The number of comments this Media has had in the previous 7 days.[required]
CommentCount_MonthlySystem.Int32The number of comments this Media has had in the previous 30 days.[required]
CommentCount_OverallSystem.Int32  The number of comments this Media has had overall.[queryable][sortable][required]
ProcessedTypeIdProcessedTypeEnum Determines whether this media item has been processed and ready for viewing[queryable][sortable]
SourceFilePathSystem.StringThe original file sent by the user
PreviewFilePathSystem.StringA preview image for the Media (in the case of Image or Video media types)
MetaDataParametersList<KeyValuePair<string, string>>optional XML data to associate with this Application
ReplyCount_DailySystem.Int32The number of replies this Media had on the previous day.[required]
ReplyCount_WeeklySystem.Int32The number of replies this Media has had in the previous 7 days.[required]
ReplyCount_MonthlySystem.Int32The number of replies this Media has had in the previous 30 days.[required]
ReplyCount_OverallSystem.Int32The number of replies this Media has had overall.[required]
ModifyDateSystem.DateTime UTC date of when this Object last viewed[queryable][sortable]
CategoryCategoryNavigation property to Category [expandable]
ParentMediaMediaNavigation property to Media [expandable]
ProfileProfileNavigation property to Profile [expandable]
MediaFilesICollection[]Navigation property to MediaFile [expandable]
ProjectProjectNavigation property to Project [expandable]

Operations

AddMediaToChannel
Add a media to a channelSoapRestC#
AddMediaToPlaylist
Add media to a playlistSoapRestC#
CreateMedia
Creates a new Media objectSoapRestC#
GetMedia
Gets a single Media entity by its IdSoapRestC#
ListMedia
Returns a paged list of customer optionally filtered and sortedSoapRestC#
ListMediaAssignedToChannel
Returns a paged list of Media belonging to a channel optionally filtered and sortedSoapRestC#
ListMediaAssignedToPlaylist
Returns a paged list of Media belonging to a Playlist optionally filtered and sortedSoapRestC#
RateMedia
Rate a media objectSoapRestC#
RateProfile
Rate an existing Media profileSoapRestC#
UpdateMedia
Updates a Media entitySoapRestC#
ViewMedia
Record that the media has been viewedSoapRestC#

MediaFile

Various transcodings of the Media.SourceFile

Properties

Name Type Description
IdSystem.Int32 the primary identifier of the entity[queryable][sortable]
MediaIdSystem.Int32 the Media that this file was created from[queryable][sortable][required]
ProcessedTypeIdProcessedTypeEnumDetermines whether this media item has been processed and ready for viewing
MediaFileTypeIdSystem.Byte the type of file that was created[queryable][sortable][required]
FilePathSystem.StringPath to the hosted file
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed
MediaFileTypeMediaFileTypeNavigation property to MediaFileType [expandable]

MediaFileType

The configuration for each transcoding output of the Phoenix Media Processor (eg MP4 HD)

Properties

Name Type Description
IdSystem.Byte the primary identifier of the entity[queryable][sortable]
DescriptionSystem.Stringa description of the type of file[required]
OutputSuffixSystem.Stringsuffix for the filename of created files[required]
OutputFileExtensionIdSystem.Int32the extension to give to files that are created[required]
ReferenceSystem.StringUser defined reference to the media configuration
IsPreviewSystem.Booleanwhether this file is a preview of the original Media[required]
InputMediaTypeIdMediaTypeEnumwhat type of input file this relates to
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed
ConfigXmlSystem.Stringthe XML configuration for transcoding files[required]
FileExtensionFileExtensionNavigation property to FileExtension [expandable]

Operations

CreateMediaFileType
Creates a new MediaFileType objectSoapRestC#
GetMediaFileType
Gets a single MediaFileType entity by its IdSoapRestC#
ListMediaFileType
Returns a paged list of MediaFileType optionally filtered and sortedSoapRestC#
UpdateMediaFileType
Returns a paged list of MediaFileType optionally filtered and sortedSoapRestC#

Playlist

Playlists are ordered lists of Media that belong to Profiles and may be private or public

Properties

Name Type Description
IdSystem.Int32 the primary identifier of the Playlist[queryable][sortable]
ProjectIdSystem.Int32 the Project that this Playlist belongs to[queryable][sortable][required]
OwnerProfileIdSystem.Int32 the Profile that this Playlist belongs to[queryable][sortable]
PrivacyTypeIdPrivacyTypeEnum whether this Playlist is publicly visible (eg editors picks) or private to a profile (eg my favourites)[queryable][sortable]
NameSystem.String the name of the Playlists[queryable][sortable][required]
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
IsActiveSystem.Booleanwhether this Playlist is active or not[required]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed
ReferenceSystem.String a unique Reference for this Playlist that can be used by external systems[queryable]
ProfileProfileNavigation property to Profile [expandable]
ProjectProjectNavigation property to Project [expandable]

Operations

CreatePlaylist
Creates a new PlaylistSoapRestC#
GetPlaylist
Gets a single Playlist entity by its IdSoapRestC#
ListPlaylist
Returns a paged list of Playlist optionally filtered and sortedSoapRestC#
UpdatePlaylist
Updates a Playlist entitySoapRestC#

Profile

Each Phoenix Customer requires a Profile

Properties

Name Type Description
IdSystem.Int32 the primary identifier for the Profile[queryable][sortable]
ProjectIdSystem.Int32 the Project that this Profile belongs to[queryable][sortable][required]
StatusTypeIdStatusTypeEnum the type of entity that this Profile refers to[queryable][sortable]
NameSystem.String the Name of this Profile[queryable][sortable][required]
DescriptionSystem.Stringa verbose Description of this Profile[required]
ProfileImageUrlSystem.StringUrl to the profile image avatar
VoteCount_OverallSystem.Int32Vote count for this profile[required]
Rating_OverallSystem.Doubletotal rating for this profile[required]
ViewCount_OverallSystem.Int32total view count for this profile[required]
MediaCount_OverallSystem.Int32total media count for this profile[required]
LastMediaCreatedDateSystem.DateTime UTC date of when this Object media was created (redundant)?[queryable][sortable]
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
ReferenceSystem.String Reference to map this user to an external system[queryable]
ModifyDateSystem.DateTime UTC date of when this Object last viewed[queryable][sortable]
PhoenixIdentity_UserIdSystem.Int32 The Company that this Account belongs to[queryable][sortable][required]
ProjectProjectNavigation property to Project [expandable]

Operations

CreateProfile
Creates a new Profile objectSoapRestC#
GetProfile
Gets a single Profile entity by its IdSoapRestC#
ListProfile
Returns a paged list of Profile optionally filtered and sortedSoapRestC#
UpdateProfile
Updates a Profile entitySoapRestC#

Project

As with all Phoenix modules, a Project is the basis of multi-tenancy

Properties

Name Type Description
PhoenixIdentity_ProjectIdSystem.Int32 refers to the master ProjectId in the PhoenixIdentity database[queryable][sortable][required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed

Operations

ActivateModule
Activates the module for a particular project by creating a new Project recordSoapRestC#
AddMediaFileType
Adds a media file type map to a projectSoapRestC#
GetModuleSettings
Gets the DataCapture.Project recordSoapRestC#
UpdateModuleSettings
Updates the settings for this Project recordSoapRestC#

ProjectMediaFileTypeMap

Each Project will transcode a list particular list of Media File Types

Properties

Name Type Description
IdSystem.Int32 the primary identifier for this entity[queryable][sortable]
ProjectIdSystem.Int32 the ProjectId this mapping belongs to[queryable][sortable][required]
MediaFileTypeIdSystem.Byte the type of file to transcode to[queryable][sortable][required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed
MediaFileTypeMediaFileTypeNavigation property to MediaFileType [expandable]
ProjectProjectNavigation property to Project [expandable]

Operations

CreateProjectMediaFileTypeMap
Creates a new ProjectMediaFileTypeMap objectSoapRestC#
ListProjectMediaFileTypeMap
Returns a paged list of ProjectMediaFileTypeMap optionally filtered and sortedSoapRestC#

Tag

Tags are strings that describe the nature of a Channel or Media

Properties

Name Type Description
IdSystem.Int32 the primary identifier for the entity[queryable][sortable]
ProjectIdSystem.Int32the Project that this entity belongs to[required]
EntityTypeIdEntityTypeEnumType of entity the tag relates to
NameSystem.String a friendly name for this entity[queryable][required]
TagCountSystem.Int32Number of media tagged with this (Generated by triggers)[required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last viewed
ProjectProjectNavigation property to Project [expandable]

Operations

CreateTag
Creates a new Tag objectSoapRestC#
GetTag
Gets a single Tag entity by its IdSoapRestC#
ListTag
Returns a paged list of Tag optionally filtered and sortedSoapRestC#

UploadChannelImageResponse

Properties

Name Type Description

Operations

UploadChannelImage
Upload a Channel Image objectSoapRestC#

UploadMediaResponse

Properties

Name Type Description

Operations

UploadMedia
Upload a media item to be transcoded and attach it to an existing media itemSoapRestC#
UploadMediaFile
Upload a transcoded media file and attach it to the parent media itemSoapRestC#

UploadProfileResponse

Properties

Name Type Description

Operations

UploadProfile
Upload a profile objectSoapRestC#