Version 7.7.3

Functions

EPG
Function Description
Get Channels Get channels for a given package
Get Schedule Items For Playout Gets the schedule items for a given start and end times for a schedule
Update Bundle Add/create a bundle. Bundle is the wrapper for list of media items. 1=>asset mediaType 2=>live stream package media type. id is set to 0 for creating new bundle.
Update Default Schedule Update a default schedule for a given channel.
Update Schedule Add/Update a schedule for a given channel. Set id to 0 for creating a new schedule.
Update Schedule Items Add schedule items to the existing schedule. Media type 4=>bundle,1=>asset,2=>live stream package
Asset Functions
Function Description
Add Asset Add a new asset. Usage: Submit a valid filename that exist's in the client's webdir. If title isn't specified, it is pulled from the filename Specify to generate thumbnails or pass a valid thumb filename. asset_type defaults to video. Only use graphic_file if the asset is a graphic or slide. Optionally specify the name of Asset Folder that the file should be placed into. <br> For Remote Source set is_remote_source to 1 and filename as the remote source file name. Remote source file only works for inegesting media (audio/video) files <br> Use either video_file,audio_file or graphic_file based on the type of file.<br> Bypass transcoding (transcode=0/false) wont work with this api version. Set transcode to true (not 1) for video/audio files. <br> media_properties is optional and can be ignored.<br> video_width and video_height are optional and can be ignored. Width and height will be set based on the transcoding profile. hidden, publish and youtube_publish are optional and can accept the values yes/no or true/false. start date and end date must be the timezone set within the account default asset and program timezone setting. content type, rating scheme and rating value are only required for Sony T2 integration. content type: movie, broadcast, trailer, song, concert, sporting event, ugc, news rating system: mpaa - NR, G, PG, PG-13, NC-17 | tvpg - NR, Y, Y7, G, PG, 14, MA
Add Asset File Adds assetfile to the existing asset
Add Slide Adds a image asset (as a slide) to an existing presentation
Add Thumbnail Adds thumbnails to a given asset Usage: Submit a valid file name for adding a thumbnail For Remote Source set is_remote_source to 1 and thumbnail_url as the remote source file name. Url encode the thumbnail url before sending request Error Codes: 656=>Invalid Thumbnail URL, 657=>Invalid Thumbnail,637=>Invalid Asset,302=>Invalid Asset ID,
Retranscode Asset Transcoding Request Sent successfully <br> Usage: Retranscoding an existing asset with new transcoding profile<br> Callback _url=>Url encode the call back url<br> remove_existing_renditions=>Should be set to "true"/"false" If set to true will remove all existing renditions <br> asset_id, profile_id are required fields <br> Error Codes: 658=>Invalid Transcoding Profile, <br> 660=>Invalid Asset File <br> ID,661=>Invalid Asset File,637=>Invalid Asset, <br>302=>Invalid Asset ID,<br> 659=>Invalid Client,205=>invalid asset type, <br> 1025=>Transcoding still in process <br>
Truncate Folder Truncate a folder Usage: Remove/deletes association for a given folder. <br> <b> Warning: <b/> This cannot be reversed.
Update Asset Edit command for an asset. Usage: The element's unique ID must exist and be valid. Only specified fields are updated. Omitted fields are ignored. Specify the path of a caption file already uploaded to the server to add to the asset. hidden, publish and youtube_publish are optional and can accept the values yes/no or true/false. start date and end date must be the timezone set within the account default asset and program timezone setting.
Client Functions
Function Description
Add Metadata Adds client metadata. This can be seen using the CMS by selecting a client, going to client settings, and then clicking the "Client Metadata" link. Multiple metadata entries can be defined inside of the "metadata_list" array.
Program Functions
Function Description
Add Program Adds a new Program to the target Abstract Project, or Vod Project. PLEASE NOTE that if the client setting "Sync Asset Metadata to Program Metadata" is set to yes, then any data you provide will be overridden by the program's asset data. Usage: (abstract_project_id OR vod_project_id), start_date, end_date, asset_id are mandatory. Categories are mandatory if the project uses a category player. Metadata is optional
Delete Chapter Deletes a given chapter
Update Chapter Adds chapter to a given program
Update Program Edit command for a Program. Usage: The program's unique ID must exist and be valid. Only specified fields are updated. Omitted fields are ignored. See Add_Program
Update Program Slide Adds a image to a program that already has a presentation or create a new presentation for a program that does not have a presentation setup yet with just that slide
User Functions
Function Description
Get Client Request a single client for the current user. Returns the immeditate children of the client as well. Usage: Either specify a client_id here, or a client_token in authentication. This client_id is checked first for validity because the token is pulled from authentication.
Get Client List Request a list of clients for the current user. Includes the total immediate child clients for the client. Usage: see limit.
Login Request an authentication token by logging in to the system. Usage: username and password are plain text. If select_first_client is set to true, a client token for the first available client is returned (Convenience for user with only 1 client). static_login is only applicable if the user has said permissions. When static_login is used, the user token returned but not regenerated.