Get
/api/clients/{clientId}
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
Min length0
Max length128
x-onBehalfOf
string
x-request-settings
boolean
Defaulttrue
x-request-attributes
boolean
Defaulttrue
x-request-accounts
boolean
Defaultfalse
x-request-countlocationsplayers
boolean
Defaultfalse
api-version
string
Path parameters
clientId
stringRequired
Min length0
Max length128
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
client
object (Contracts.Connect.Results.Locations.SelectClientJson)
code
string | null
id
string | null
name
string | null
settings
Array of object (Contracts.Connect.Results.Attributes.SettingJson) | null
object
id
string | null
value
string | null
displayName
string | null
sectionName
string | null
fieldType
string
Valid values[
"String",
"Currency",
"Day",
"DateTime",
"Int",
"Float",
"Media",
"DatePeriod",
"Record",
"Bool",
"Slider"
]
description
string | null
placeholder
string | null
OSVersion
string | null
inherit
boolean
unset
boolean | null
isDefinitionEditable
boolean
hasOverrides
boolean | null
accounts
Array of object (Contracts.Connect.Results.Locations.SelectClientAccountJson) | null
object
code
string | null
id
string | null
name
string | null
isDefaultAccount
boolean
countLocations
integer (int32) | null
countPlayers
integer (int32) | null
countNotStartedPlayers
integer (int32) | null
countPlayersWithEmptyPlaylist
integer (int32) | null
countErrorPlayers
integer (int32) | null
rateLimit
integer (int32)
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
client
object (Contracts.Connect.Results.Locations.SelectClientJson)
code
string | null
id
string | null
name
string | null
settings
Array of object (Contracts.Connect.Results.Attributes.SettingJson) | null
object
id
string | null
value
string | null
displayName
string | null
sectionName
string | null
fieldType
string
Valid values[
"String",
"Currency",
"Day",
"DateTime",
"Int",
"Float",
"Media",
"DatePeriod",
"Record",
"Bool",
"Slider"
]
description
string | null
placeholder
string | null
OSVersion
string | null
inherit
boolean
unset
boolean | null
isDefinitionEditable
boolean
hasOverrides
boolean | null
accounts
Array of object (Contracts.Connect.Results.Locations.SelectClientAccountJson) | null
object
code
string | null
id
string | null
name
string | null
isDefaultAccount
boolean
countLocations
integer (int32) | null
countPlayers
integer (int32) | null
countNotStartedPlayers
integer (int32) | null
countPlayersWithEmptyPlaylist
integer (int32) | null
countErrorPlayers
integer (int32) | null
rateLimit
integer (int32)
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
client
object (Contracts.Connect.Results.Locations.SelectClientJson)
code
string | null
id
string | null
name
string | null
settings
Array of object (Contracts.Connect.Results.Attributes.SettingJson) | null
object
id
string | null
value
string | null
displayName
string | null
sectionName
string | null
fieldType
string
Valid values[
"String",
"Currency",
"Day",
"DateTime",
"Int",
"Float",
"Media",
"DatePeriod",
"Record",
"Bool",
"Slider"
]
description
string | null
placeholder
string | null
OSVersion
string | null
inherit
boolean
unset
boolean | null
isDefinitionEditable
boolean
hasOverrides
boolean | null
accounts
Array of object (Contracts.Connect.Results.Locations.SelectClientAccountJson) | null
object
code
string | null
id
string | null
name
string | null
isDefaultAccount
boolean
countLocations
integer (int32) | null
countPlayers
integer (int32) | null
countNotStartedPlayers
integer (int32) | null
countPlayersWithEmptyPlaylist
integer (int32) | null
countErrorPlayers
integer (int32) | null
rateLimit
integer (int32)
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