Documentation Index

Fetch the complete documentation index at: https://docs.grassfish.com/llms.txt

Use this file to discover all available pages before exploring further.

/api/v{version}/locations/{locationId}

  • Updated on Mar 20, 2026
  • Published on Jul 23, 2025
  • 6 minute(s) reading time
Prev Next
Get
/api/v{version}/locations/{locationId}
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-settings
boolean
x-request-players
boolean
api-version
string
Path parameters
locationId
stringRequired
version
stringRequired
Responses
200

OK

Expand All
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
location
object (Contracts.Connect.Results.Locations.SelectLocationJson)
code
string | null
id
string | null
name
string | null
address
object (Contracts.Connect.Results.Locations.SelectLocationAddressJson)
postalCode
string | null
city
string | null
coordinate
object (Contracts.Connect.Results.Locations.SelectLocationCoordinateJson)
x
number (double) | null
y
number (double) | null
z
number (double) | null
country
string | null
addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
stateProvinceCounty
string | null
timeZoneId
string | null
contact
object (Contracts.Connect.Results.Locations.SelectLocationContactJson)
emailAddress
string | null
name
string | null
phoneNumber
string | null
type
string | null
tags
Array of object (Contracts.Common.Jsons.Refs.TagRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
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" ]
externalId
string | null
players
Array of object (Contracts.Connect.Results.Locations.SelectLocationPlayerJson) | null
object
code
string | null
id
string | null
name
string | null
playerApplication
string
Valid values[ "None", "Tizen", "Windows", "SPP", "WAB", "WebOS", "SSSP", "Content", "Android", "IOS", "WinChrome", "Linux", "Proxy", "BrightSign", "ChromeOS" ]
macAddress
string | null
computerSerialNumber
string | null
computerNameOS
string | null
settings
Array of object (Contracts.Connect.Results.Locations.SelectLocationSettingJson) | 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" ]
rateLimit
integer (int32) | null
Expand All
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
location
object (Contracts.Connect.Results.Locations.SelectLocationJson)
code
string | null
id
string | null
name
string | null
address
object (Contracts.Connect.Results.Locations.SelectLocationAddressJson)
postalCode
string | null
city
string | null
coordinate
object (Contracts.Connect.Results.Locations.SelectLocationCoordinateJson)
x
number (double) | null
y
number (double) | null
z
number (double) | null
country
string | null
addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
stateProvinceCounty
string | null
timeZoneId
string | null
contact
object (Contracts.Connect.Results.Locations.SelectLocationContactJson)
emailAddress
string | null
name
string | null
phoneNumber
string | null
type
string | null
tags
Array of object (Contracts.Common.Jsons.Refs.TagRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
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" ]
externalId
string | null
players
Array of object (Contracts.Connect.Results.Locations.SelectLocationPlayerJson) | null
object
code
string | null
id
string | null
name
string | null
playerApplication
string
Valid values[ "None", "Tizen", "Windows", "SPP", "WAB", "WebOS", "SSSP", "Content", "Android", "IOS", "WinChrome", "Linux", "Proxy", "BrightSign", "ChromeOS" ]
macAddress
string | null
computerSerialNumber
string | null
computerNameOS
string | null
settings
Array of object (Contracts.Connect.Results.Locations.SelectLocationSettingJson) | 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" ]
rateLimit
integer (int32) | null
Expand All
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
location
object (Contracts.Connect.Results.Locations.SelectLocationJson)
code
string | null
id
string | null
name
string | null
address
object (Contracts.Connect.Results.Locations.SelectLocationAddressJson)
postalCode
string | null
city
string | null
coordinate
object (Contracts.Connect.Results.Locations.SelectLocationCoordinateJson)
x
number (double) | null
y
number (double) | null
z
number (double) | null
country
string | null
addressLine1
string | null
addressLine2
string | null
addressLine3
string | null
stateProvinceCounty
string | null
timeZoneId
string | null
contact
object (Contracts.Connect.Results.Locations.SelectLocationContactJson)
emailAddress
string | null
name
string | null
phoneNumber
string | null
type
string | null
tags
Array of object (Contracts.Common.Jsons.Refs.TagRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
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" ]
externalId
string | null
players
Array of object (Contracts.Connect.Results.Locations.SelectLocationPlayerJson) | null
object
code
string | null
id
string | null
name
string | null
playerApplication
string
Valid values[ "None", "Tizen", "Windows", "SPP", "WAB", "WebOS", "SSSP", "Content", "Android", "IOS", "WinChrome", "Linux", "Proxy", "BrightSign", "ChromeOS" ]
macAddress
string | null
computerSerialNumber
string | null
computerNameOS
string | null
settings
Array of object (Contracts.Connect.Results.Locations.SelectLocationSettingJson) | 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" ]
rateLimit
integer (int32) | 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

Products
Company
Support
Follow us
© 2025 Grassfish. All Rights Reserved.