GET All Select Options
Overview
The following table contains important information about the GET method in regards to receiving all select options.
| GET All Select Options | |
|---|---|
| Method | GET |
| URL or Endpoint | /api/projects/projectId/players/options |
| Headers | Authorization |
| Parameters | projectId |
| Body | Not Applicable |
The description of the URL parameter is as follows:
| projectId URL Parameter | |
|---|---|
| URL Parameter Name | projectId |
| Mandatory | Yes |
| Type | string |
| Description | Unique Id of the project |
Request Body
The request does not contain a request body.
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"playerSizeTypes": [
{
"id": 1,
"name": "Responsive"
},
{
"id": 2,
"name": "Fixed"
}
],
"preloadOptions": [
{
"id": 1,
"name": "None",
"value": "none",
"tooltipText": "Incurs no additional bandwidth usage, but does not ensure immediate playback. The player begins to load media only when the viewer clicks play."
},
{
"id": 2,
"name": "Quick Start (default)",
"value": "metadata",
"tooltipText": "For the fastest startup time. When the player becomes viewable or if it's the only player on the embedded page, the player will load the media's metadata and up to one segment."
},
{
"id": 3,
"name": "HighQuality",
"value": "auto",
"tooltipText": "For the fastest startup time with the highest playback quality. When the player becomes viewable or if it's the only player embedded on the page, the player will preload up to 30 seconds in the background."
}
],
"defaultBandwidthEstimateOptions": [
{
"id": 1,
"name": "None",
"value": "0"
},
{
"id": 2,
"name": "LTE (1mb/s)",
"value": "1000000"
},
{
"id": 3,
"name": "Standard Definition Broadband (2mb/s)",
"value": "2000000"
},
{
"id": 4,
"name": "High Definition Broadband (5mb/s)",
"value": "5000000"
}
],
"sharingTypes": [
{
"id": 1,
"name": "Page URL",
"value": "URL"
},
{
"id": 2,
"name": "Page URL & IFrame",
"value": "URL&IFrame"
}
],
"castingOptions": [
{
"id": 1,
"name": "Chromecast",
"icon": "Redirect"
},
{
"id": 2,
"name": "Airplay",
"icon": "Redirect"
}
],
"responsiveSizeOptions": [
{
"id": 1,
"name": "16:9"
},
{
"id": 2,
"name": "16:10"
},
{
"id": 3,
"name": "9:16"
},
{
"id": 4,
"name": "4:3"
},
{
"id": 5,
"name": "3:2"
},
{
"id": 6,
"name": "1:1"
},
{
"id": 7,
"name": "2.4:1"
}
],
"floatPositionOptions": [
{
"id": 1,
"name": "Top right (default)",
"value": "TOP_RIGHT"
},
{
"id": 2,
"name": "Top left",
"value": "TOP_LEFT"
},
{
"id": 3,
"name": "Bottom right",
"value": "BOTTOM_RIGHT"
},
{
"id": 4,
"name": "Bottom left",
"value": "BOTTOM_LEFT"
}
],
"logoPositionOptions": [
{
"id": 1,
"name": "Top right (default)",
"value": "TOP_RIGHT"
},
{
"id": 2,
"name": "Top left",
"value": "TOP_LEFT"
},
{
"id": 3,
"name": "Bottom right",
"value": "BOTTOM_RIGHT"
},
{
"id": 4,
"name": "Bottom left",
"value": "BOTTOM_LEFT"
},
{
"id": 5,
"name": "Control Bar",
"value": "CONTROL_BAR"
}
],
"releaseChannels": [
{
"id": 1,
"name": "v1.1",
"originalPath": "vpplayer/templates/v151/vp-player-dev.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v151/vp-player-dev.js"
},
{
"id": 2,
"name": "v1.2",
"originalPath": "vpplayer/templates/v151/vp-player-dev.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v151/vp-player-dev.js"
},
{
"id": 3,
"name": "v1.3",
"originalPath": "vpplayer/templates/v13/vp-player.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v13/vp-player.js"
},
{
"id": 4,
"name": "v1.4",
"originalPath": "vpplayer/templates/v14/vp-player.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v14/vp-player.js"
},
{
"id": 5,
"name": "v1.4.2",
"originalPath": "vpplayer/templates/v142/vp-player.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v142/vp-player.js"
},
{
"id": 6,
"name": "v1.4.3",
"originalPath": "vpplayer/templates/v143/vp-player.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v143/vp-player.js"
},
{
"id": 7,
"name": "v1.5",
"originalPath": "vpplayer/templates/v15/vp-player.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v15/vp-player.js"
},
{
"id": 8,
"name": "v1.5.1",
"originalPath": "vpplayer/templates/v151/vp-player-dev.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v151/vp-player-dev.js"
},
{
"id": 9,
"name": "v1.5.2",
"originalPath": "vpplayer/templates/v152/vp-player-dev.js",
"templateOriginalPath": "https://vp-dev.gjirafa.net/vps/vpplayer/templates/v152/vp-player-dev.js"
}
],
"adSchedules": [
{
"id": 1096,
"name": "Test vmap",
"value": null
},
{
"id": 1097,
"name": "Test 1.1 midrolls",
"value": null
},
{
"id": 1098,
"name": "Test multi midrolls ",
"value": null
},
{
"id": 1099,
"name": "lumi",
"value": null
},
{
"id": 1100,
"name": "Preroll & Postroll",
"value": null
},
{
"id": 1101,
"name": "Preroll, 2x Midrolls & Postroll",
"value": null
},
{
"id": 1102,
"name": "AdSchedule With same preroll and postroll",
"value": null
},
{
"id": 1103,
"name": "New Ad Schedule - Breror",
"value": null
},
{
"id": 7,
"name": "AdSchedule2",
"value": null
},
{
"id": 1104,
"name": "New Ad Schedule - VAST",
"value": null
},
{
"id": 9,
"name": "AdSchedule2",
"value": null
},
{
"id": 10,
"name": "AdSchedule10",
"value": null
},
{
"id": 11,
"name": "AdSchedule11",
"value": null
},
{
"id": 12,
"name": "AdSchedule12",
"value": null
},
{
"id": 13,
"name": "AdSchedule13",
"value": null
},
{
"id": 16,
"name": "AdSchedule16",
"value": null
},
{
"id": 23,
"name": "AdSchedule23",
"value": null
},
{
"id": 28,
"name": "",
"value": null
},
{
"id": 30,
"name": "",
"value": null
},
{
"id": 32,
"name": "",
"value": null
},
{
"id": 34,
"name": "",
"value": null
},
{
"id": 35,
"name": null,
"value": null
},
{
"id": 52,
"name": "AdSchedule10",
"value": null
},
{
"id": 61,
"name": "Ad Schedule ",
"value": null
},
{
"id": 62,
"name": "Ad Schedule ",
"value": null
},
{
"id": 64,
"name": "Waterfall Tag",
"value": null
},
{
"id": 66,
"name": "Waterfall Tag",
"value": null
},
{
"id": 67,
"name": "Waterfall Tag",
"value": null
},
{
"id": 68,
"name": "Waterfall Tag 1",
"value": null
},
{
"id": 69,
"name": "Waterfall Tag 1",
"value": null
},
{
"id": 70,
"name": "Waterfall Tag",
"value": null
},
{
"id": 71,
"name": "Waterfall Tag",
"value": null
},
{
"id": 72,
"name": "Waterfall Tag test",
"value": null
},
{
"id": 73,
"name": "Ad Schedule Create",
"value": null
},
{
"id": 74,
"name": "Test Ad Schedule",
"value": null
},
{
"id": 82,
"name": "Waterfall URLs Test",
"value": null
},
{
"id": 94,
"name": "Test w/ ad breaks",
"value": null
},
{
"id": 95,
"name": "TEst front 1",
"value": null
},
{
"id": 96,
"name": "test 2 front",
"value": null
},
{
"id": 100,
"name": "Test Front ylberi",
"value": null
},
{
"id": 102,
"name": "Ad schedule ylber",
"value": null
},
{
"id": 110,
"name": "Test Ad Schedule FRONT",
"value": null
},
{
"id": 121,
"name": "test ad schedule njomzaaaaaaa",
"value": null
},
{
"id": 1093,
"name": "test ylber ad schedule",
"value": null
},
{
"id": 1095,
"name": "test midrolls",
"value": null
}
],
"socialNetworks": [
{
"id": 1,
"name": "Facebook",
"icon": "FacebookIcon"
},
{
"id": 2,
"name": "LinkedIn",
"icon": "LinkedinIcon"
},
{
"id": 3,
"name": "Pinterest",
"icon": "FigmaIcon"
},
{
"id": 4,
"name": "Reddit",
"icon": null
},
{
"id": 5,
"name": "Tumblr",
"icon": null
},
{
"id": 6,
"name": "Twitter",
"icon": "TwitterIcon"
},
{
"id": 7,
"name": "Email",
"icon": "MailIcon"
}
]
},
"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. |
| playerSizeTypes | array[Object] | Returns the player size types as an array of objects. |
| id | integer($int32) | The id of the player size type. |
| name | string | The name of the player size type. |
| preloadOptions | array[Object] | Returns the preload options as an array of objects. |
| id | integer($int32) | The id of the preload option. |
| name | string | The name of the preload option. |
| value | string | The value of the preload option. |
| tooltipText | string | Gives a description about the preload option. |
| defaultBandwidthEstimateOptions | array[Object] | Returns the default bandwidth estimate options as an array of objects. |
| id | integer($int32) | The id of the default bandwidth estimate option. |
| name | string | The name of the default bandwidth estimate option. |
| value | string | The value of the default bandwidth estimate option. |
| sharingTypes | array[Object] | Returns the sharing types as an array of objects. |
| id | integer($int32) | The id of the sharing type. |
| name | string | The name of the sharing type. |
| value | string | The value of the sharing type. |
| castingOptions | array[Object] | Returns the casting options as an array of objects. |
| id | integer($int32) | The id of the casting option. |
| name | string | The name of the casting option. |
| responsiveSizeOptions | array[Object] | Returns the responsive size options as an array of objects. |
| id | integer($int32) | The id of the responsive size option. |
| name | string | The name of the responsive size option. |
| floatPositionOptions | array[Object] | Returns the float position options as an array of objects. |
| id | integer($int32) | The id of the float position option. |
| name | string | The name of the float position option. |
| value | string | The value of the float position option. |
| logoPositionOptions | array[Object] | Returns the logo position options as an array of objects. |
| id | integer($int32) | The id of the logo position option. |
| name | string | The name of the logo position option. |
| value | string | The value of the logo position option. |
| releaseChannels | array[Object] | Returns the release channels as an array of objects. |
| id | integer($int32) | The id of the release channel. |
| name | string | The name of the release channel. |
| originalPath | string | The original path of the release channel. |
| templateOriginalPath | string | The original path of the template release channel. |
| adSchedules | array[Object] | Returns the ad schedules as an array of objects. |
| id | integer($int32) | The id of the ad schedule. |
| name | string | The name of the ad schedule. |
| value | string | The value of the ad schedule. |
| socialNetworks | array[Object] | Returns the social networks as an array of objects. |
| id | integer($int32) | The id of the social network. |
| name | string | The name of the social network. |
| icon | string | The icon of the social network. |
| 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