version 7.8.2

Back | 

WsMidRollAd

Returns midroll ads for a program

URL Format

/ws/ws_mid_roll_ad/api/{app_token}/mode/json/apiv/5/p/{programuuiid}

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.
p string programUuid of the program to retrieve midRollAds for

Possible Responses

  • 860 Midroll ads found
  • 861 No midroll ads found
  • 316 Invalid Program UUID
  • 102 Invalid app token

Example Response

{
  "response": {
    "success": {
      "code": 860,
      "message": "Midroll ads found",
      "details": ""
    },
    "WsMidRollAd": {
      "MidRollAds": [
        {
          "uuid": "1234aaaa",
          "programUuid": "abcd1234",
          "startTime": 13,
          "type": "linear",
          "url": "http:\/\/www.com",
          "templateType": "VAST",
          "backupUrl": "http:\/\/www.backup.com",
          "dateAdded": "-0001-11-30T00:00:00Z",
          "dateModified": "-0001-11-30T00:00:00Z"
        }
      ]
    }
  }
}