GET Ad Schedule Config By Id

Overview

---

The following table contains important information about the GET method in regards to receiving the ad schedule configuration.

GET Ad Schedule Config By Id
Method	GET
URL or Endpoint	/outstream-player/adSchedule/adScheduleId.json
Headers	Authorization
Parameters	adScheduleId
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
adScheduleId	Yes	string	Unique Id of the ad schedule.

Request Body

The request does not contain a request body

Response

{
  "type": null,
  "isVmap": false,
  "enableProgrammability": false,
  "vmap": null,
  "skipAllAds": false,
  "VPAIDmode": null,
  "adBreaks": [
    {
      "adTagUrl": [
        "string"
      ],
      "breakType": null,
      "breakTimingType": null,
      "breakTimingValue": 0,
      "schedule": {
        "liveCount": 0,
        "type": null,
        "protectFirst": 0,
        "protectLast": 0,
        "occurEvery": 0,
        "algorithm": null,
        "ranges": []
      }
    }
  ],
  "bidding": false,
  "bidders": [],
  "functions": [],
  "enableDemandManager": false,
  "demandManager": {
    "prebidUrl": null,
    "bidderTimeOut": 0,
    "serverTimeOut": 0,
    "coppaInventory": false,
    "enableCache": true,
    "adUnits": null
  },
  "frequency": {
    "type": null,
    "value": 0
  },
  "maxCap": 0,
  "initialDelay": {
    "type": null,
    "value": 0
  },
  "adCycleDelayMs": 3000,
  "adRetryLimit": 2,
  "adCycleRestartMs": null
}

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed