Version 7.9.3

Back | 

WsVodProject

Returns a vod project or list of vod projects for an account

URL Format

/ws/ws_vod_project/api/{app_token}/mode/json/apiv/5?uuid={project_uuid}&referenceId={referenceId}&template={template}&start={start}&end={end}&elements=[{settingName1}:{settingValue1},{settingName2}:{settingValue2}]

Parameters

Name Req Type Description
app_token string The api token for the given account. You can find the api token when navigating through account->api accounts
apiv integer The api version; only version 5 supported.
uuid string The uuid of a given vod project. Supports comma spearated uuid value to get list of multiple projects
referenceId string The referenceid of a given vod project
template string The name of a flash template to filter all vod projects by. Asterisk could be used for partial search.
start integer Will return a subset of available projects. Used primarily for pagination. Default is set to 0
end integer Will return a subset of available projects. Used primarily for pagination. Default is set to start + 20. Zero-based inclusive index: E.G. &start=0&end=4 will return five projects from the beginning.
title string Filter the response based on project title.
elements json Filter to add multiple json settings key value pair to filter projects based on thosesetting values

Possible Responses

  • 202 Vod Project Found
  • 302 Vod Projects Found
  • 702 No Vod Projects Found
  • 659 Invalid Client
  • 102 Invalid app token.
  • 315 Invalid Vod Project UUID
  • 1036 Invalid reference Id
  • 430 No Vod Project Found

Example Response

{
  "response": {
    "success": {
      "code": 202,
      "message": "Vod Project Found",
      "details": ""
    },
    "WsVodProjectResponse": {
      "project": [
        {
          "class": "VodProject",
          "pdate": "2014-07-01T16:57:52Z",
          "uuid": "iayeq834",
          "clientUUID": "d4c1b92c0acb102ba3e10015c5f061d1",
          "title": "ezTest",
          "description": "",
          "tag": "",
          "playerSwfUrl": "http:\/\/qa-appasset.appstudio.piksel.com\/\/app\/AppLoader.swf?compiledApp=http:\/\/qa-appasset.appstudio.piksel.com\/\/compiled\/mediasuite_73\/AppShell_pc09u76r.swf",
          "rssLinks": {
            "vidego": "http:\/\/dev01-ovp.piksel.com\/ws\/get_rss\/p_iayeq834\/thumbs_true\/allfiles_true\/download_true\/lang_en-us\/icategory_Business\/iayeq834.xml",
            "subscriptions": {
              "yahoo": "http:\/\/e.my.yahoo.com\/config\/cstore?.opt=content&.url=http:\/\/dev01-ovp.piksel.com\/ws\/get_rss\/p_iayeq834\/thumbs_true\/allfiles_true\/download_true\/lang_en-us\/icategory_Business\/iayeq834.xml",
              "bloglines": "http:\/\/www.bloglines.com\/login?r=\/sub\/http:\/\/dev01-ovp.piksel.com\/ws\/get_rss\/p_iayeq834\/thumbs_true\/allfiles_true\/download_true\/lang_en-us\/icategory_Business\/iayeq834.xml",
              "google": "http:\/\/www.google.com\/ig\/add?feedurl=http:\/\/dev01-ovp.piksel.com\/ws\/get_rss\/p_iayeq834\/thumbs_true\/allfiles_true\/download_true\/lang_en-us\/icategory_Business\/iayeq834.xml",
              "itunes": "itpc:\/\/dev01-ovp.piksel.com\/ws\/get_rss\/p_iayeq834\/thumbs_true\/allfiles_true\/download_true\/lang_en-us\/icategory_Business\/iayeq834.xml"
            }
          },
          "elements": {
            "showMenuFullScreen": true,
            "emailShareUrl": "",
            "customEventStartMessage": "",
            "mixedVodLive": false,
            "imgBranding": "",
            "geofilter": "0",
            "iTunesCustomImage": "",
            "landingPage": "",
            "iTunesOwnerEmail": "",
            "centerAlignPermalink": false,
            "flash9FS": true,
            "colorPlayerBG": "#FFFFFF",
            "videoScaling": null,
            "iTunesNewFeed": true,
            "prerollVideoFreq": "2",
            "autoPlay": true,
            "showInfoButton": false,
            "showShareButton": false,
            "showMoreButton": false,
            "useC2pIcon": true,
            "c2pIconAlpha": "10",
            "disbaleDirectDownload": false,
            "appstudioDelivery": "Akamai HD",
            "AppStudio Custom Player": "1703",
            "AppStudio Facebook Player": "",
            "postRollImg": "",
            "postRollClickAction": "Replay",
            "postRollClickURL": "",
            "embedOverride": true,
            "showAbout": true,
            "showLink": true,
            "showRSS": true,
            "showS2f": true,
            "showEmbed": true,
            "showHelp": true,
            "showQuality": true
          },
          "hasGeoFilter": false,
          "googleAnalyticsAccount": "123"
        }
      ]
    }
  }
}