GET All Links For Playing a Specific Ad

Overview

---

The following table contains important information about the GET method in regards to receiving all available links for playing a specific ad.

GET All Links For Playing a Specific Ad
Method	GET
URL or Endpoint	/outstream-player/embed/playerPublicId/adschedulePublicId.json
Headers	Authorization
Parameters	playerPublicId, adschedulePublicId
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 player.
adschedulePublicId	Yes	string	Unique Id of the ad schedule.

Request Body

The request does not contain a request body

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "javaScriptEmbedCode": "<script src='https://host-dev.vpplayer.tech/outstream-player/{playerpublicid}/{adschedulepublicid}.js'></script>",
    "iFrameEmbedCode": "<div style=\"position: relative; overflow: hidden; padding-bottom: 177.78%\">    <iframe src='https://host-dev.vpplayer.tech/outstream-player/{playerpublicid}/{adschedulepublicid}.html' width='100%' height='100%' frameborder='0' style='position: absolute' allowfullscreen webkitallowfullscreen mozallowfullscreen oallowfullscreen msallowfullscreen>    </iframe></div>"
  },
  "resultInfo": null,
  "statusCode": 200
}

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