GET Ad Schedule by ID

Overview

---

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

GET Playlist by PublicId
Method	GET
URL or Endpoint	/api/projects/projectId/ad-schedules/id
Headers	Authorization
Parameters	projectId, id
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
projectId	Yes	string	Unique Id of the project.
id	Yes	string	Unique id of the ad schedule.

Request Body

The request does not contain a request body

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "adManagerId": 1,
    "vpaidModeOptionId": null,
    "publicId": "smyrfbue",
    "name": "AdSchedule2",
    "adSeenOnSubsequentVisitOptionId": 1,
    "vmapAdTag": null,
    "timeBetweenAds": 0,
    "startOnPlaylistItem": 1,
    "repeatOnInterval": 1,
    "enableBidding": false,
    "biddingTemplatePublicId": null,
    "vpaidModeOption": null,
    "adSeenOnSubsequentVisitOption": {
      "id": 1,
      "name": "Play the preroll break"
    },
    "adManager": {
      "id": 1,
      "Value": "VAST"
    },
    "biddingTemplate": null,
    "adBreaks": []
  },
  "resultInfo": null,
  "statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
adManagerId	integer($int32)	The id of the ad manager type.
vpaidModeOptionId	integer($int32)	The id of the VPAID mode option.
publicId	string	The id of the ad schedule.
name	string	The name of the ad schedule.
adSeenOnSubsequentVisitOptionId	integer($int32)	Indicates that the video should play the preroll break.
vmapAdTag	string	The tag of the VMAP ad.
timeBetweenAds	integer($int32)	Indicates the time ads should have between each other.
startOnPlaylistItem	integer($int32)	Indicates on which playlist item the ad schedule should start.
repeatOnInterval	integer($int32)	Indicates the interval at which the ad schedules should repeat.
enableBidding	bool	Indicates whether bidding is enabled or disabled.
biddingTemplatePublicId	integer($int32)	The id of the bidding template.
vpaidModeOption	Object	Returns the VPID mode option.
adSeenOnSubsequentVisitOption	Object	Returns the subsequent visit option of the ad schedule.
id	integer($int32)	The id of the subsequent visit option.
name	string	Name of the subsequent visit option.
adManager	Object	Returns the ad manager of the ad schedule.
id	integer($int32)	The id of the ad manager.
name	string	The name of the ad manager.
biddingTemplate	Object	Returns the bidding template as an object.
adBreaks	array[Object]	Returns the ad breaks as an array of objects.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

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