version 8.3.8

Back | 

WsVodProject

URL

http://de.piksel.tech/ws/ws_vod_project/mode/json/apiv/5.0?method=put&
Use "request" param as post variable for submitting json/xml request payload for all PUT requests.

Parameters

  • uuid => Uuid of project
  • title => Title of project
  • description => Description of project
  • tag => Keyword tags for project
  • referenceId => Unique reference id for project
  • settings => Array of project settings, with setting name as the key and setting value as the value

Request

Updates an existing Vod Project

Request format

{
  "request": {
    "authentication": {
      "app_token": "7cd207c2-6808-11e3-b865-22000a8a28ea",
      "client_token": "d4c1b92c0acb102ba3e10015c5f061d1",
      "user_token": "f277cb9d46e45f67f44de949cdde110f"
    },
    "header": {
      "header_version": 1,
      "api_version": "5",
      "no_cache": true
    },
    "ws_vod_project": {
      "uuid": "a1b2c3d4",
      "title": "New Project Title",
      "description": "New Project Description",
      "tag": "project,vod,player",
      "referenceId": "new abc123",
      "parentRefId": "palette parent refId",
      "settings": {
        "settingName1": "settingValue1",
        "settingName2": "settingValue2",
        "settingName3": "settingValue3"
      }
    }
  }
}

Test Example

{ "request": { "authentication": { "app_token": "#app_token#", "client_token": "#client_token#", "user_token": "#user_token#" }, "header": { "header_version": 1, "api_version": "5", "no_cache": true }, "ws_vod_project": { "uuid": "a1b2c3d4", "title": "New Project Title", "description": "New Project Description", "tag": "project,vod,player", "referenceId": "new abc123", "parentRefId": "palette parent refId", "settings": { "settingName1": "settingValue1", "settingName2": "settingValue2", "settingName3": "settingValue3" } } } }

Response

Response format

{
  "success": {
    "code": 517,
    "message": "Vod Project Updated",
    "details": ""
  },
  "WsVodProject": {
    "project": [
      {
        "class": "VodProject",
        "pdate": "2014-08-20T16:20:15Z",
        "uuid": "a1b2c3d4",
        "clientUUID": "CLIENT_UUID",
        "title": "New Project Title",
        "description": "New Project Description",
        "tag": "project,vod,player",
        "playerSwfUrl": "SWF_URL",
        "elements": {
          "mixedVodLive": false,
          "showMenuFullScreen": true,
          "emailShareUrl": "",
          "customEventStartMessage": "",
          "iTunesCustomImage": "",
          "imgBranding": "",
          "geofilter": null,
          "iTunesOwnerEmail": null,
          "landingPage": "",
          "centerAlignPermalink": false,
          "flash9FS": true,
          "colorPlayerBG": "#FFFFFF",
          "videoScaling": "5",
          "prerollVideoAd": "",
          "iTunesNewFeed": true,
          "prerollVideoFreq": "2",
          "postrollVideoAd": "",
          "autoPlay": true,
          "showInfoButton": false,
          "showShareButton": false,
          "showMoreButton": false,
          "useC2pIcon": true,
          "c2pIconAlpha": "10",
          "disbaleDirectDownload": false,
          "appstudioDelivery": "Akamai HD",
          "AppStudio Custom Player": "1",
          "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"
      }
    ]
  }
}