Version 8.3.8

Back | 

WsMidRollAd

URL

de.piksel.tech/services/index.php?&mode=json
Use "request" param as post variable for submitting json/xml request payload for all POST requests.

Request Headers

Name

Parameters

  • programUuid => uuid of the program for the mid roll to be added to

    startTime => start time for the ad to play in seconds

    type => type of ad: linear

    url => url for the media playback of the ad

    templateType => vast2/vast3

    backupUrl => backup url for media playbacks

Request

Ads a new mid roll ad to a program

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_Mid_Roll_Ad": {
      "programUuid": "abcd1234",
      "startTime": 13,
      "type": "linear",
      "url": "http:\/\/www.com",
      "templateType": "vast3",
      "backupUrl": "http:\/\/www.backup.com"
    }
  }
}

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_Mid_Roll_Ad": { "programUuid": "abcd1234", "startTime": 13, "type": "linear", "url": "http:\/\/www.com", "templateType": "vast3", "backupUrl": "http:\/\/www.backup.com" } } }

Response

Response format

{
  "response": {
    "success": {
      "code": 862,
      "message": "Midroll ad added\/updated",
      "details": ""
    },
    "WsMidRollAd": {
      "MidRollAd": [
        {
          "uuid": "oqh2258b",
          "programUuid": "abcd1234",
          "startTime": 15,
          "type": "linear",
          "url": "http:\/\/www.com",
          "templateType": "vast3",
          "backupUrl": "http:\/\/www.backup.com",
          "dateAdded": "2014-08-05T18:41:31Z",
          "dateModified": "2014-08-05T18:41:31Z"
        }
      ]
    }
  }
}