Get
/api/v{version}/players/{locationId}/{playerId}
Security
OAuth
Authorization using OAuth2 with Client Credentials
FlowClient Credentials
Authorization URLhttps://identity.eu01.grassfish.com/connect/authorize
Token URLhttps://identity.eu01.grassfish.com/connect/token
Header parameters
x-correlationToken
string
x-clientId
string
x-onBehalfOf
string
x-request-location
boolean
Defaulttrue
x-request-tags
boolean
Defaulttrue
x-request-identification
boolean
Defaulttrue
x-request-layers
boolean
Defaulttrue
x-request-settings
boolean
Defaulttrue
x-request-status
boolean
Defaulttrue
x-request-information
boolean
Defaulttrue
api-version
string
Path parameters
locationId
stringRequired
playerId
stringRequired
version
stringRequired
Responses
200
OK
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[
"InvalidDatePeriodEndDateBeforeStartDate",
"NameAlreadyTaken",
"ExternalIdAlreadyTaken",
"CodeAlreadyTaken"
]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
player
object (Contracts.Connect.Results.Locations.SelectPlayerJson)
name
string | null
clientName
string | null
code
string | null
id
string | null
location
object (Contracts.Connect.Results.Locations.SelectPlayersResultItemLocationJson)
name
string | null
code
string | null
id
string | null
timeZoneId
string | null
playerApplication
string
Valid values[
"None",
"Tizen",
"Windows",
"SPP",
"WAB",
"WebOS",
"SSSP",
"Content",
"Android",
"IOS",
"WinChrome",
"Linux",
"Proxy",
"BrightSign",
"ChromeOS"
]
tags
Array of object (Contracts.Connect.Results.Locations.SelectPlayersResultItemTagJson) | null
object
type
string
Valid values[
"None",
"Profile",
"Zone",
"Whatever",
"MediaFormat",
"Permission",
"Application",
"Cluster",
"ContentType",
"Item",
"POSItem",
"Assortment",
"Record",
"Location",
"Region",
"Offer",
"Customer",
"PlayerFeature",
"AI",
"Media",
"Player",
"LocationRef"
]
id
string | null
name
string | null
layers
Array of object (Contracts.Connect.Results.Locations.SelectPlayersResultItemLayerJson) | null
object
name
string | null
aspectCode
string | null
orderN
integer (int32)
left
integer (int32)
top
integer (int32)
width
integer (int32)
height
integer (int32)
identification
object (Contracts.Connect.Results.Locations.SelectPlayersResultItemIdentificationJson)
alias
string | null
playerUniqueId
string | null
isAdministratingPlayer
boolean
isAllowAutoIdentification
boolean
autoIdentificationMACAddress
string | null
settings
Array of object (Contracts.Connect.Results.Locations.SelectPlayersResultItemSettingJson) | null
object
attributeId
string | null
attributeCode
string | null
attributeType
string
Valid values[
"None",
"Item",
"POSItem",
"ClientLocationPlayer",
"Offer",
"Assortment",
"Record",
"AssortmentItem",
"TreeSchemaLevel"
]
attributeFlags
string
Valid values[
"None",
"Mandatory",
"Default",
"Share",
"ValidityPeriod",
"Options",
"Fixed",
"Multi",
"ShowAsListColumn"
]
valueType
string
Valid values[
"String",
"Currency",
"Day",
"DateTime",
"Int",
"Float",
"Media",
"DatePeriod",
"Record",
"Bool",
"Slider"
]
orderN
integer (int32)
value
string | null
isDefault
boolean | null
validFrom
string (date-time) | null
validTo
string (date-time) | null
unset
boolean | null
media
object (Contracts.Common.Jsons.Refs.MediaRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
library
string
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
status
object (Contracts.Connect.Results.Locations.SelectPlayersResultItemStatusJson)
statusFromPlayer
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
statusFromPlayerModifiedDateTime
string (date-time) | null
lastCommunicationDateTime
string (date-time) | null
userDefinedStatus
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
statusCalculated
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
forgivingStatus
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
mlStatus
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
isEmptyPlaylist
boolean
isError
boolean
isNotStarted
boolean
information
object (Contracts.Connect.Results.Locations.SelectPlayersResultItemInformationJson)
macAddress
string | null
computerSerialNumber
string | null
osVersion
string | null
ipAddress
string | null
ipMask
string | null
dnsServer
string | null
gateway
string | null
lastCommunicationDateTime
string (date-time) | null
lastCommunicationDateTimeLocal
string (date-time) | null
warrantyDate
string (date-time) | null
modifiedDateTime
string (date-time) | null
insertedDateTime
string (date-time) | null
computerManufacturer
string | null
computerName
string | null
computerNameOS
string | null
biosDate
string | null
biosVersion
string | null
cpuModel
string | null
hardDriveModel
string | null
webBrowserVersion
string | null
screenOneSerialNumber
string | null
screenOneFirmware
string | null
screenOneModel
string | null
screenModels
Array of string | null
string
timeZoneName
string | null
networkConnectionType
string | null
networkStrength
string | null
playerVersion
string | null
modification
object (Contracts.Connect.Results.Locations.SelectPlayersResultModificationJson)
insertedDateTime
string (date-time) | null
removedDateTime
string (date-time) | null
modifiedDateTime
string (date-time) | null
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[
"InvalidDatePeriodEndDateBeforeStartDate",
"NameAlreadyTaken",
"ExternalIdAlreadyTaken",
"CodeAlreadyTaken"
]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
player
object (Contracts.Connect.Results.Locations.SelectPlayerJson)
name
string | null
clientName
string | null
code
string | null
id
string | null
location
object (Contracts.Connect.Results.Locations.SelectPlayersResultItemLocationJson)
name
string | null
code
string | null
id
string | null
timeZoneId
string | null
playerApplication
string
Valid values[
"None",
"Tizen",
"Windows",
"SPP",
"WAB",
"WebOS",
"SSSP",
"Content",
"Android",
"IOS",
"WinChrome",
"Linux",
"Proxy",
"BrightSign",
"ChromeOS"
]
tags
Array of object (Contracts.Connect.Results.Locations.SelectPlayersResultItemTagJson) | null
object
type
string
Valid values[
"None",
"Profile",
"Zone",
"Whatever",
"MediaFormat",
"Permission",
"Application",
"Cluster",
"ContentType",
"Item",
"POSItem",
"Assortment",
"Record",
"Location",
"Region",
"Offer",
"Customer",
"PlayerFeature",
"AI",
"Media",
"Player",
"LocationRef"
]
id
string | null
name
string | null
layers
Array of object (Contracts.Connect.Results.Locations.SelectPlayersResultItemLayerJson) | null
object
name
string | null
aspectCode
string | null
orderN
integer (int32)
left
integer (int32)
top
integer (int32)
width
integer (int32)
height
integer (int32)
identification
object (Contracts.Connect.Results.Locations.SelectPlayersResultItemIdentificationJson)
alias
string | null
playerUniqueId
string | null
isAdministratingPlayer
boolean
isAllowAutoIdentification
boolean
autoIdentificationMACAddress
string | null
settings
Array of object (Contracts.Connect.Results.Locations.SelectPlayersResultItemSettingJson) | null
object
attributeId
string | null
attributeCode
string | null
attributeType
string
Valid values[
"None",
"Item",
"POSItem",
"ClientLocationPlayer",
"Offer",
"Assortment",
"Record",
"AssortmentItem",
"TreeSchemaLevel"
]
attributeFlags
string
Valid values[
"None",
"Mandatory",
"Default",
"Share",
"ValidityPeriod",
"Options",
"Fixed",
"Multi",
"ShowAsListColumn"
]
valueType
string
Valid values[
"String",
"Currency",
"Day",
"DateTime",
"Int",
"Float",
"Media",
"DatePeriod",
"Record",
"Bool",
"Slider"
]
orderN
integer (int32)
value
string | null
isDefault
boolean | null
validFrom
string (date-time) | null
validTo
string (date-time) | null
unset
boolean | null
media
object (Contracts.Common.Jsons.Refs.MediaRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
library
string
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
status
object (Contracts.Connect.Results.Locations.SelectPlayersResultItemStatusJson)
statusFromPlayer
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
statusFromPlayerModifiedDateTime
string (date-time) | null
lastCommunicationDateTime
string (date-time) | null
userDefinedStatus
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
statusCalculated
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
forgivingStatus
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
mlStatus
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
isEmptyPlaylist
boolean
isError
boolean
isNotStarted
boolean
information
object (Contracts.Connect.Results.Locations.SelectPlayersResultItemInformationJson)
macAddress
string | null
computerSerialNumber
string | null
osVersion
string | null
ipAddress
string | null
ipMask
string | null
dnsServer
string | null
gateway
string | null
lastCommunicationDateTime
string (date-time) | null
lastCommunicationDateTimeLocal
string (date-time) | null
warrantyDate
string (date-time) | null
modifiedDateTime
string (date-time) | null
insertedDateTime
string (date-time) | null
computerManufacturer
string | null
computerName
string | null
computerNameOS
string | null
biosDate
string | null
biosVersion
string | null
cpuModel
string | null
hardDriveModel
string | null
webBrowserVersion
string | null
screenOneSerialNumber
string | null
screenOneFirmware
string | null
screenOneModel
string | null
screenModels
Array of string | null
string
timeZoneName
string | null
networkConnectionType
string | null
networkStrength
string | null
playerVersion
string | null
modification
object (Contracts.Connect.Results.Locations.SelectPlayersResultModificationJson)
insertedDateTime
string (date-time) | null
removedDateTime
string (date-time) | null
modifiedDateTime
string (date-time) | null
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[
"InvalidDatePeriodEndDateBeforeStartDate",
"NameAlreadyTaken",
"ExternalIdAlreadyTaken",
"CodeAlreadyTaken"
]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
player
object (Contracts.Connect.Results.Locations.SelectPlayerJson)
name
string | null
clientName
string | null
code
string | null
id
string | null
location
object (Contracts.Connect.Results.Locations.SelectPlayersResultItemLocationJson)
name
string | null
code
string | null
id
string | null
timeZoneId
string | null
playerApplication
string
Valid values[
"None",
"Tizen",
"Windows",
"SPP",
"WAB",
"WebOS",
"SSSP",
"Content",
"Android",
"IOS",
"WinChrome",
"Linux",
"Proxy",
"BrightSign",
"ChromeOS"
]
tags
Array of object (Contracts.Connect.Results.Locations.SelectPlayersResultItemTagJson) | null
object
type
string
Valid values[
"None",
"Profile",
"Zone",
"Whatever",
"MediaFormat",
"Permission",
"Application",
"Cluster",
"ContentType",
"Item",
"POSItem",
"Assortment",
"Record",
"Location",
"Region",
"Offer",
"Customer",
"PlayerFeature",
"AI",
"Media",
"Player",
"LocationRef"
]
id
string | null
name
string | null
layers
Array of object (Contracts.Connect.Results.Locations.SelectPlayersResultItemLayerJson) | null
object
name
string | null
aspectCode
string | null
orderN
integer (int32)
left
integer (int32)
top
integer (int32)
width
integer (int32)
height
integer (int32)
identification
object (Contracts.Connect.Results.Locations.SelectPlayersResultItemIdentificationJson)
alias
string | null
playerUniqueId
string | null
isAdministratingPlayer
boolean
isAllowAutoIdentification
boolean
autoIdentificationMACAddress
string | null
settings
Array of object (Contracts.Connect.Results.Locations.SelectPlayersResultItemSettingJson) | null
object
attributeId
string | null
attributeCode
string | null
attributeType
string
Valid values[
"None",
"Item",
"POSItem",
"ClientLocationPlayer",
"Offer",
"Assortment",
"Record",
"AssortmentItem",
"TreeSchemaLevel"
]
attributeFlags
string
Valid values[
"None",
"Mandatory",
"Default",
"Share",
"ValidityPeriod",
"Options",
"Fixed",
"Multi",
"ShowAsListColumn"
]
valueType
string
Valid values[
"String",
"Currency",
"Day",
"DateTime",
"Int",
"Float",
"Media",
"DatePeriod",
"Record",
"Bool",
"Slider"
]
orderN
integer (int32)
value
string | null
isDefault
boolean | null
validFrom
string (date-time) | null
validTo
string (date-time) | null
unset
boolean | null
media
object (Contracts.Common.Jsons.Refs.MediaRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
library
string
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
status
object (Contracts.Connect.Results.Locations.SelectPlayersResultItemStatusJson)
statusFromPlayer
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
statusFromPlayerModifiedDateTime
string (date-time) | null
lastCommunicationDateTime
string (date-time) | null
userDefinedStatus
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
statusCalculated
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
forgivingStatus
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
mlStatus
string
Valid values[
"None",
"FakePlayer",
"NoContactOrError",
"Error",
"NoContactOrErrorFor20Min",
"NoContactOrErrorFor4Hours",
"NoContactOrErrorFor12Hours",
"NoContactOrErrorFor24Hours",
"NoContactOrErrorFor48Hours",
"NotStarted",
"OK"
]
isEmptyPlaylist
boolean
isError
boolean
isNotStarted
boolean
information
object (Contracts.Connect.Results.Locations.SelectPlayersResultItemInformationJson)
macAddress
string | null
computerSerialNumber
string | null
osVersion
string | null
ipAddress
string | null
ipMask
string | null
dnsServer
string | null
gateway
string | null
lastCommunicationDateTime
string (date-time) | null
lastCommunicationDateTimeLocal
string (date-time) | null
warrantyDate
string (date-time) | null
modifiedDateTime
string (date-time) | null
insertedDateTime
string (date-time) | null
computerManufacturer
string | null
computerName
string | null
computerNameOS
string | null
biosDate
string | null
biosVersion
string | null
cpuModel
string | null
hardDriveModel
string | null
webBrowserVersion
string | null
screenOneSerialNumber
string | null
screenOneFirmware
string | null
screenOneModel
string | null
screenModels
Array of string | null
string
timeZoneName
string | null
networkConnectionType
string | null
networkStrength
string | null
playerVersion
string | null
modification
object (Contracts.Connect.Results.Locations.SelectPlayersResultModificationJson)
insertedDateTime
string (date-time) | null
removedDateTime
string (date-time) | null
modifiedDateTime
string (date-time) | null
400
Bad Request
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
401
Unauthorized
403
Forbidden
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
404
Not Found
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
500
Internal Server Error