Get a list of spots assigned to an existing player

  • Published on Jan 24, 2025
  • 1 minute(s) reading time
Prev Next
Get
/v{version}/Players/{playerId}/AssignedSpots
Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
playerId
integer (int32) Required

Unique ID of the player

version
stringRequired

The requested API version

Default"1.18"
Responses
200

OK

Array of object
object

Assigned spot

FileCrc
integer (int32)

CRC of the spot file

FileName
string

File name of the spot

FileSize
integer (int64)

File size of the spot

FileVersion
integer (int32)

File version of the spot

MediaType
string

Type of the media

Valid values[ "Unknown", "Video", "Flash", "Picture", "PowerPoint", "Pdf", "Shockwave", "Xml", "Mp3", "Html", "EPaper", "Draft", "Zip", "AndroidPackage", "AndroidSkin", "OverlayTrigger", "Qml" ]
Name
string

Name of the spot

SpotFileId
integer (int32)

Unique ID of the spot file

SpotGroupId
integer (int32)

Unique ID of the spot group

SpotId
integer (int32)

Unique ID of the spot

SpotVersionId
integer (int32)

Unique ID of the spot version

Type
string

Type of the spot

Valid values[ "Default", "Composer", "Trigger", "Ticker", "Url", "OverlayTrigger", "XmlDataSpot", "Audio", "Stream", "Zip", "WebsiteSpot", "HtmlComposerSpot", "WizardSpot", "Font", "WizardSpotMedia", "DashboardWidget", "DashboardWidgetMedia", "Qml", "ComposerPlayer", "RoomManager", "ConvertedSpot", "AscInterface", "AscPlayer" ]
VersionStatus
string

Status of the spot version

Valid values[ "Unversioned", "CheckedOut", "CheckedIn", "Obsolete", "Deleted" ]
400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Player access denied

404

Player not found.

500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties