GET Ad Break By Id

Overview

---

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

GET Adbreak By Id
Method	GET
URL or Endpoint	/api/projects/projectId/ad-schedules/adScheduleId/ad-breaks/id
Headers	Authorization
Parameters	id, adScheduleId, projectId, api-version
Body	Not Applicable

The description of the URL parameter is as follows:

Parameter Name	Mandatory	Type	Description
id	Yes	string	The id of ad breaks.
adScheduleId	Yes	string	The id of ad schedules.
projectId	Yes	string	The id of the project.
api-version	No	string	The correct api version to use.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "result": [
    {
      "id": 0,
      "adBreakTypeId": 0,
      "adScheduleId": "string",
      "breakTimingTypeId": 0,
      "breakTiming": 0,
      "liveVideoPrerollsNr": 0,
      "midrollTypeId": 0,
      "secondsToRepeat": 0,
      "protectFirstSeconds": 0,
      "protectLastSeconds": 0,
      "distributionMethodTypeId": 0,
      "nonLinearOverlayAd": true,
      "skipableAfterSeconds": true,
      "skipableAfterSecondsNr": 0,
      "adBreakType": {
        "id": 0,
        "name": "string"
      },
      "midrollType": {
        "id": 0,
        "name": "string",
        "value": "string",
        "description": "string",
        "icon": "string"
      },
      "distributionMethodType": {
        "id": 0,
        "name": "string",
        "value": "string",
        "description": "string"
      },
      "adBreakSettings": [
        {
          "adBreakId": 0,
          "fromSecond": 0,
          "toSecond": 0,
          "adsNumber": 0,
          "percentages": [
            0
          ]
        }
      ],
      "breakTimingType": {
        "id": 0,
        "name": "string"
      },
      "waterfallTags": [
        {
          "id": 0,
          "adBreakId": 0,
          "waterfallTagUrl": "string"
        }
      ]
    }
  ],
  "resultInfo": "string",
  "statusCode": 0
}

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.
id	integer($int32)	Id of the ad break.
adBreakTypeId	integer($int32)	Id of the ad break type.
adScheduleId	string	Id of the ad schedule.
breakTimingTypeId	integer($int32)	Id of the break timing type.
breakTiming	integer($int32)	The break timing of the ad.
liveVideoPrerollsNr	integer($int32)	The number of live video prerolls.
midrollTypeId	integer($int32)	Id of midroll type.
secondsToRepeat	string	Seconds for the ad to repeat.
protectFirstSeconds	string	Protecting the first seconds.
protectLastSeconds	string	Protecting the last seconds.
distributionMethodTypeId	integer($int32)	Id of the distribution method type.
nonLinearOverlayAd	bool	Indictaes whether ads that appear before, n between or after the video content appear.
skipableAfterSeconds	bool	Indictaes whether the ad is skipable after a certain number of seconds.
skipableAfterSecondsNr	integer($int32)	The number of skipable ads after a certain number of seconds.
adBreakType	array[Object]	Returns the response object.
id	integer($int32)	Id of the ad break type.
name	string	The name of the ad break type.
midrollType	array[Object]	Returns the response object.
id	integer($int32)	Id of the midroll type.
name	string	The name of the midroll type.
value	string	Value of the midroll.
description	string	Description of the midroll.
icon	string	Icon of the midroll.
distributionMethodType	array[Object]	Returns the response object.
id	integer($int32)	Id of the distribution method type.
name	string	The name of the distribution method type.
value	string	Value of the distribution method.
description	string	Description of the distribution method.
adBreakSettings	array[Object]	Returns the response object.
adBreakId	integer($int32)	Id of the ad break in settings.
fromSecond	integer($int32)	Second when ad begins.
toSecond	integer($int32)	Second when ad ends.
adsNumber	integer($int32)	The number of eds.
percentages	array[Object]	Returns the response object.
breakTimingType	array[Object]	Returns the response object.
id	integer($int32)	Id of the break timing type.
name	string	The name of the break timing type.
waterfallTags	array[Object]	Returns the response object.
id	integer($int32)	Id of the waterfall tag.
adBreakid	integer($int32)	Id of the ad break.
waterfallTagUrl	string	The url of the waterfall tag.
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