getPlayerManifest

GET

/api/v1/player/manifest

const url = 'https://example.com/api/v1/player/manifest';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/player/manifest \
  --header 'Authorization: Bearer <token>'

Authorizations

deviceBearer

Parameters

Header Parameters

If-None-Match

string

Responses

200

Stable screen-specific manifest or no-assignment manifest

application/json

object

data

required

object

schemaVersion

required

integer

Allowed values: 11 12 13 14 15

manifestVersion

required

integer format: int64

>= 1

screenId

required

string format: uuid

generatedAt

required

string format: date-time

mode

required

string

Allowed value: presentation

playlist

required

One of:

null
object

null

layout

One of:

null
object

null

layouts

Array<object>

object

assets

required

Array<object>

object

canvas

One of:

null
object

null

viewport

One of:

null
object

null

schedules

Array<object>

object

required

string format: uuid

playlistId

string format: uuid

nullable

layoutId

string format: uuid

nullable

displayAction

One of:

null
object

null

type

required

string

Allowed values: weekly one_time

timezone

required

string

priority

required

integer

>= -999 <= 999

specificity

required

integer

startDate

string format: date

nullable

endDate

string format: date

nullable

oneTimeStart

string format: date-time

nullable

oneTimeEnd

string format: date-time

nullable

dailyStart

string

nullable

dailyEnd

string

nullable

daysOfWeek

Array<integer>

widgets

Array<object>

object

dataSources

Array<object>

object

presentationOverride

One of:

null
object

null

Example

{
  "data": {
    "schemaVersion": 11,
    "mode": "presentation",
    "schedules": [
      {
        "displayAction": {
          "type": "display_power_on"
        },
        "type": "weekly"
      }
    ],
    "presentationOverride": {
      "contentType": "playlist"
    }
  }
}

304

Manifest ETag matched

401

Device credential invalid or revoked

403

Screen disabled