GET All Links for a Video with Ad Schedule

Overview

---

The following table contains important information about the GET method in regards to receiving all links for playing a specific video in the vertical player with a specific ad schedule.

GET All Links for a Video with Ad Schedule
Method	GET
URL or Endpoint	/vertical-player/video/embed/playerPublicId/videoPublicId/adSchedulePublicId/includeSeo
Headers	Not Applicable
Parameters	playerPublicId, videoPublicId, adSchedulePublicId, includeSeo
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
playerPublicId	Yes	string	Unique Id of the vertical player.
videoPublicId	Yes	string	Unique Id of the video.
adSchedulePublicId	Yes	string	Unique Id of the ad schedule.
includeSeo	Yes	boolean	Indicates whether SEO metadata should be included.

Request Body

The request does not contain a request body

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "javaScriptEmbedCode": "{javaScriptEmbedCode}",
    "iFrameEmbedCode": "{iFrameEmbedCode}"
  },
  "resultInfo": null,
  "statusCode": 200
}

The description of the response fields is as follows:

Top-Level Properties

Field Name	Type	Description
success	boolean	If the response is successful it will return true. Otherwise will return false.
errors	array[string]	Indicates if there was an error.
messages	array[string]	Returns the response message from back-end.
result	object	Returns the response object.
javaScriptEmbedCode	string	The JavaScript embed code for the vertical player.
iFrameEmbedCode	string	The iFrame embed code for the vertical player.
resultInfo	string	Returns extra information about the result.
statusCode	integer	Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 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