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	/adSchedule/adScheduleId.json
Headers	Authorization
Parameters	adScheduleId, api-version
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.
api-version	No	string	Correct api-version.

Request Body

The request does not contain a request body

Response

{
  "type": "DYNAMIC",
  "isVmap": false,
  "enableProgrammability": false,
  "vmap": null,
  "VPAIDmode": null,
  "adBreaks": [
    {
      "adTagUrl": [
        "string"
      ],
      "breakType": "midroll",
      "breakTimingType": "time",
      "breakTimingValue": 0,
      "schedule": {
        "liveCount": 0,
        "type": "RECURRING",
        "protectFirst": 0,
        "protectLast": 0,
        "occurEvery": 30,
        "algorithm": null,
        "ranges": [
          {
            "startTime": 0,
            "endTime": null,
            "count": 1,
            "breaks": [
              50
            ]
          }
        ]
      }
    }
  ],
  "bidding": false,
  "bidders": [],
  "functions": []
}

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