GET All Links for a Playlist
Overview
The following table contains important information about the GET
method in regards to receiving all links for a playlist.
GET All Links for a Playlist | |
---|---|
Method | GET |
URL or Endpoint | /playlist/embed/playerPublicId /playlistPublicId |
Headers | Authorization |
Parameters | playerPublicId, playlistPublicId |
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. |
playlistPublicId | Yes | string | Unique id of the playlist. |
Request Body
The request does not contain a request body
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"javaScriptEmbedCode": " <script src='https://vp-dev.gjirafa.net/player/ptkzurkg/lzxikfcr.js'></script>",
"iFrameEmbedCode": " <div style='position:relative; overflow:hidden; padding-bottom:56.25%'> <iframe src='https://vp-dev.gjirafa.net/player/ptkzurkg/lzxikfcr.html' width='100%' height='100%' frameborder='0' scrolling='auto' title='untitled playlist 6666666' style='position:absolute;' allowfullscreen> </iframe> </div>"
},
"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. |
javaScriptEmbedCode | string | The embed code of the javascript script. |
iFrameEmbedCode | string | The embed code of the iFrame. |
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