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.

Selects communication mixes based on the provided parameters with pagination support.

  • Updated on Mar 20, 2026
  • Published on Jul 23, 2025
  • 18 minute(s) reading time
Prev Next
Post
/api/selectcommunicationmixes
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
Min length0
Max length24
api-version
string
Body parameters
Expand All
object
skip
integer (int32) | null
take
integer (int32) | null
searchText
string | null
filterCondition
object (Contracts.Common.Entities.Filters.FilterConditionNodeJson)
permission
string
Valid values[ "None", "Enabled", "Disabled", "AddAndEdit", "ViewOnly", "Hide", "Add", "Edit", "Remove" ]
type
string
Valid values[ "None", "And", "Or", "Locations", "Aspects", "Tags", "Players", "Media", "Role", "Layers", "Clients", "Organizations", "Users", "PlayerStatus", "SearchTexts", "MatchingLocations", "AnyLocations", "MatchingRegions", "AnyRegions", "MatchingContentTypes", "AnyContentTypes", "MatchingAccounts", "NoLocations", "Accounts", "Customers", "Broadcasts", "ContentTypes", "MatchingCommunicationMixes", "AttributeValues", "LicenseContracts", "LicenseBusinessBrands", "LicenseCustomers", "LocationTags", "Channels" ]
all
boolean | null
none
boolean | null
matching
boolean | null
matchingButAllOnEmpty
boolean | null
no
boolean | null
mediaType
string
Valid values[ "None", "Audio", "Video", "Photo", "Text", "HtmlSign", "Json", "HtmlTemplate", "WebPage", "File" ]
nodes
Array of object (Contracts.Common.Entities.Filters.FilterConditionNodeJson) | null
object Recursive
condition
string
Valid values[ "None", "In", "NotIn", "All", "Matching", "No", "MatchingButAllOnEmpty" ]
accounts
Array of object (Contracts.Common.Jsons.Refs.AccountRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
clients
Array of object (Contracts.Common.Jsons.Refs.ClientRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
locations
Array of object (Contracts.Common.Jsons.Refs.LocationRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
players
Array of object (Contracts.Common.Jsons.Refs.PlayerRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
location
object (Contracts.Common.Jsons.Refs.LocationRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
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" ]
locationTags
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" ]
aspects
Array of object (Contracts.Common.Jsons.Refs.AspectRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
users
Array of object (Contracts.Common.Jsons.Refs.UserRefJson) | 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", "Machine", "Player", "Human", "Client", "Module" ]
email
string | null
playerStatus
Array of object (Contracts.Common.Jsons.Refs.PlayerStatusRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
media
Array of object (Contracts.Common.Jsons.Refs.MediaRefJson) | null
object
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" ]
roles
Array of object (Contracts.Common.Jsons.Refs.RoleRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
layers
Array of object (Contracts.Common.Jsons.Refs.PlayoutFormatLayerRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
isMainLayer
boolean | null
organizations
Array of object (Contracts.Common.Jsons.Refs.OrganizationRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
seachTexts
Array of string | null
string
searchTexts
Array of string | null
string
customers
Array of object (Contracts.Common.Jsons.Refs.CustomerRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
broadcasts
Array of object (Contracts.Common.Jsons.Refs.BroadcastRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
contentTypes
Array of object (Contracts.Common.Jsons.Refs.ContentTypeRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
communicationMixes
Array of object (Contracts.Common.Jsons.Refs.CommunicationMixRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
key
string | null
values
Array of string | null
string
licenseContracts
Array of object (Contracts.Common.Jsons.Refs.LicenseContractRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
licenseBusinessBrands
Array of object (Contracts.Common.Jsons.Refs.LicenseBusinessBrandRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
licenseCustomers
Array of object (Contracts.Common.Jsons.Refs.LicenseCustomerRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
touchpointChannels
Array of object (Contracts.Common.Jsons.Refs.TouchpointChannelRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
Expand All
object
skip
integer (int32) | null
take
integer (int32) | null
searchText
string | null
filterCondition
object (Contracts.Common.Entities.Filters.FilterConditionNodeJson)
permission
string
Valid values[ "None", "Enabled", "Disabled", "AddAndEdit", "ViewOnly", "Hide", "Add", "Edit", "Remove" ]
type
string
Valid values[ "None", "And", "Or", "Locations", "Aspects", "Tags", "Players", "Media", "Role", "Layers", "Clients", "Organizations", "Users", "PlayerStatus", "SearchTexts", "MatchingLocations", "AnyLocations", "MatchingRegions", "AnyRegions", "MatchingContentTypes", "AnyContentTypes", "MatchingAccounts", "NoLocations", "Accounts", "Customers", "Broadcasts", "ContentTypes", "MatchingCommunicationMixes", "AttributeValues", "LicenseContracts", "LicenseBusinessBrands", "LicenseCustomers", "LocationTags", "Channels" ]
all
boolean | null
none
boolean | null
matching
boolean | null
matchingButAllOnEmpty
boolean | null
no
boolean | null
mediaType
string
Valid values[ "None", "Audio", "Video", "Photo", "Text", "HtmlSign", "Json", "HtmlTemplate", "WebPage", "File" ]
nodes
Array of object (Contracts.Common.Entities.Filters.FilterConditionNodeJson) | null
object Recursive
condition
string
Valid values[ "None", "In", "NotIn", "All", "Matching", "No", "MatchingButAllOnEmpty" ]
accounts
Array of object (Contracts.Common.Jsons.Refs.AccountRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
clients
Array of object (Contracts.Common.Jsons.Refs.ClientRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
locations
Array of object (Contracts.Common.Jsons.Refs.LocationRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
players
Array of object (Contracts.Common.Jsons.Refs.PlayerRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
location
object (Contracts.Common.Jsons.Refs.LocationRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
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" ]
locationTags
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" ]
aspects
Array of object (Contracts.Common.Jsons.Refs.AspectRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
users
Array of object (Contracts.Common.Jsons.Refs.UserRefJson) | 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", "Machine", "Player", "Human", "Client", "Module" ]
email
string | null
playerStatus
Array of object (Contracts.Common.Jsons.Refs.PlayerStatusRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
media
Array of object (Contracts.Common.Jsons.Refs.MediaRefJson) | null
object
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" ]
roles
Array of object (Contracts.Common.Jsons.Refs.RoleRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
layers
Array of object (Contracts.Common.Jsons.Refs.PlayoutFormatLayerRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
isMainLayer
boolean | null
organizations
Array of object (Contracts.Common.Jsons.Refs.OrganizationRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
seachTexts
Array of string | null
string
searchTexts
Array of string | null
string
customers
Array of object (Contracts.Common.Jsons.Refs.CustomerRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
broadcasts
Array of object (Contracts.Common.Jsons.Refs.BroadcastRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
contentTypes
Array of object (Contracts.Common.Jsons.Refs.ContentTypeRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
communicationMixes
Array of object (Contracts.Common.Jsons.Refs.CommunicationMixRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
key
string | null
values
Array of string | null
string
licenseContracts
Array of object (Contracts.Common.Jsons.Refs.LicenseContractRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
licenseBusinessBrands
Array of object (Contracts.Common.Jsons.Refs.LicenseBusinessBrandRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
licenseCustomers
Array of object (Contracts.Common.Jsons.Refs.LicenseCustomerRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
touchpointChannels
Array of object (Contracts.Common.Jsons.Refs.TouchpointChannelRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
Expand All
object
skip
integer (int32) | null
take
integer (int32) | null
searchText
string | null
filterCondition
object (Contracts.Common.Entities.Filters.FilterConditionNodeJson)
permission
string
Valid values[ "None", "Enabled", "Disabled", "AddAndEdit", "ViewOnly", "Hide", "Add", "Edit", "Remove" ]
type
string
Valid values[ "None", "And", "Or", "Locations", "Aspects", "Tags", "Players", "Media", "Role", "Layers", "Clients", "Organizations", "Users", "PlayerStatus", "SearchTexts", "MatchingLocations", "AnyLocations", "MatchingRegions", "AnyRegions", "MatchingContentTypes", "AnyContentTypes", "MatchingAccounts", "NoLocations", "Accounts", "Customers", "Broadcasts", "ContentTypes", "MatchingCommunicationMixes", "AttributeValues", "LicenseContracts", "LicenseBusinessBrands", "LicenseCustomers", "LocationTags", "Channels" ]
all
boolean | null
none
boolean | null
matching
boolean | null
matchingButAllOnEmpty
boolean | null
no
boolean | null
mediaType
string
Valid values[ "None", "Audio", "Video", "Photo", "Text", "HtmlSign", "Json", "HtmlTemplate", "WebPage", "File" ]
nodes
Array of object (Contracts.Common.Entities.Filters.FilterConditionNodeJson) | null
object Recursive
condition
string
Valid values[ "None", "In", "NotIn", "All", "Matching", "No", "MatchingButAllOnEmpty" ]
accounts
Array of object (Contracts.Common.Jsons.Refs.AccountRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
clients
Array of object (Contracts.Common.Jsons.Refs.ClientRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
locations
Array of object (Contracts.Common.Jsons.Refs.LocationRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
players
Array of object (Contracts.Common.Jsons.Refs.PlayerRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
location
object (Contracts.Common.Jsons.Refs.LocationRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
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" ]
locationTags
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" ]
aspects
Array of object (Contracts.Common.Jsons.Refs.AspectRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
users
Array of object (Contracts.Common.Jsons.Refs.UserRefJson) | 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", "Machine", "Player", "Human", "Client", "Module" ]
email
string | null
playerStatus
Array of object (Contracts.Common.Jsons.Refs.PlayerStatusRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
media
Array of object (Contracts.Common.Jsons.Refs.MediaRefJson) | null
object
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" ]
roles
Array of object (Contracts.Common.Jsons.Refs.RoleRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
layers
Array of object (Contracts.Common.Jsons.Refs.PlayoutFormatLayerRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
isMainLayer
boolean | null
organizations
Array of object (Contracts.Common.Jsons.Refs.OrganizationRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
seachTexts
Array of string | null
string
searchTexts
Array of string | null
string
customers
Array of object (Contracts.Common.Jsons.Refs.CustomerRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
broadcasts
Array of object (Contracts.Common.Jsons.Refs.BroadcastRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
contentTypes
Array of object (Contracts.Common.Jsons.Refs.ContentTypeRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
communicationMixes
Array of object (Contracts.Common.Jsons.Refs.CommunicationMixRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
key
string | null
values
Array of string | null
string
licenseContracts
Array of object (Contracts.Common.Jsons.Refs.LicenseContractRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
licenseBusinessBrands
Array of object (Contracts.Common.Jsons.Refs.LicenseBusinessBrandRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
licenseCustomers
Array of object (Contracts.Common.Jsons.Refs.LicenseCustomerRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
touchpointChannels
Array of object (Contracts.Common.Jsons.Refs.TouchpointChannelRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
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
mixes
Array of object (Contracts.Connect.Results.Broadcasts.SelectCommunicationMixesResultCommunicationMix) | null

List of communication mixes.

object
id
string | null

ID of the communication mix.

code
string | null

The unique code of the communication mix.

name
string | null

Name of the communication mix.

loopLengthSec
number (double) | null

Total length of one loop (all content types combined) in seconds.

contentTypes
Array of object (Contracts.Connect.Results.Broadcasts.SelectContentTypeJson) | null

List of content types that can be used in this communication mix.

object
id
string | null

ID of the content type.

code
string | null

Unique code of the content type.

name
string | null

Name of the content type.

durationSecs
number (double) | null

The duration of the content type in seconds.

periods
Array of object (Contracts.Connect.Results.Broadcasts.SelectPeriodJson) | null

List of periods when the communication mix is active. An empty list means always active.

object
id
string | null

ID of the period.

code
string | null

Unique code of the period.

startDateTime
string (date-time) | null

Start date and time of the period. If null, the period starts immediately.

endDateTime
string (date-time) | null

End date and time of the period. If null, the period does not end.

weekdayStartTime
string (date-span) | null

Start time of the period on weekdays. If null, the period starts at midnight.

weekdayEndTime
string (date-span) | null

End time of the period on weekdays. If null, the period ends at midnight.

dayOfWeeks
string
Valid values[ "None", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "NotWeekends", "Saturday", "Sunday", "Weekends", "All" ]
layers
Array of object (Contracts.Connect.Results.Broadcasts.SelectBroadcastLayerJson) | null

List of broadcast layers to which this communication mix will be applied. An empty list means all layers.

object
id
string | null

ID of the broadcast layer.

code
string | null

Unique code of the broadcast layer.

name
string | null

Name of the broadcast layer.

isMain
boolean | null

Defines if this layer is the main layer or not.

isSOV
boolean

Defines if this layer is a SOV (Share of Voice) layer.

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
mixes
Array of object (Contracts.Connect.Results.Broadcasts.SelectCommunicationMixesResultCommunicationMix) | null

List of communication mixes.

object
id
string | null

ID of the communication mix.

code
string | null

The unique code of the communication mix.

name
string | null

Name of the communication mix.

loopLengthSec
number (double) | null

Total length of one loop (all content types combined) in seconds.

contentTypes
Array of object (Contracts.Connect.Results.Broadcasts.SelectContentTypeJson) | null

List of content types that can be used in this communication mix.

object
id
string | null

ID of the content type.

code
string | null

Unique code of the content type.

name
string | null

Name of the content type.

durationSecs
number (double) | null

The duration of the content type in seconds.

periods
Array of object (Contracts.Connect.Results.Broadcasts.SelectPeriodJson) | null

List of periods when the communication mix is active. An empty list means always active.

object
id
string | null

ID of the period.

code
string | null

Unique code of the period.

startDateTime
string (date-time) | null

Start date and time of the period. If null, the period starts immediately.

endDateTime
string (date-time) | null

End date and time of the period. If null, the period does not end.

weekdayStartTime
string (date-span) | null

Start time of the period on weekdays. If null, the period starts at midnight.

weekdayEndTime
string (date-span) | null

End time of the period on weekdays. If null, the period ends at midnight.

dayOfWeeks
string
Valid values[ "None", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "NotWeekends", "Saturday", "Sunday", "Weekends", "All" ]
layers
Array of object (Contracts.Connect.Results.Broadcasts.SelectBroadcastLayerJson) | null

List of broadcast layers to which this communication mix will be applied. An empty list means all layers.

object
id
string | null

ID of the broadcast layer.

code
string | null

Unique code of the broadcast layer.

name
string | null

Name of the broadcast layer.

isMain
boolean | null

Defines if this layer is the main layer or not.

isSOV
boolean

Defines if this layer is a SOV (Share of Voice) layer.

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
mixes
Array of object (Contracts.Connect.Results.Broadcasts.SelectCommunicationMixesResultCommunicationMix) | null

List of communication mixes.

object
id
string | null

ID of the communication mix.

code
string | null

The unique code of the communication mix.

name
string | null

Name of the communication mix.

loopLengthSec
number (double) | null

Total length of one loop (all content types combined) in seconds.

contentTypes
Array of object (Contracts.Connect.Results.Broadcasts.SelectContentTypeJson) | null

List of content types that can be used in this communication mix.

object
id
string | null

ID of the content type.

code
string | null

Unique code of the content type.

name
string | null

Name of the content type.

durationSecs
number (double) | null

The duration of the content type in seconds.

periods
Array of object (Contracts.Connect.Results.Broadcasts.SelectPeriodJson) | null

List of periods when the communication mix is active. An empty list means always active.

object
id
string | null

ID of the period.

code
string | null

Unique code of the period.

startDateTime
string (date-time) | null

Start date and time of the period. If null, the period starts immediately.

endDateTime
string (date-time) | null

End date and time of the period. If null, the period does not end.

weekdayStartTime
string (date-span) | null

Start time of the period on weekdays. If null, the period starts at midnight.

weekdayEndTime
string (date-span) | null

End time of the period on weekdays. If null, the period ends at midnight.

dayOfWeeks
string
Valid values[ "None", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "NotWeekends", "Saturday", "Sunday", "Weekends", "All" ]
layers
Array of object (Contracts.Connect.Results.Broadcasts.SelectBroadcastLayerJson) | null

List of broadcast layers to which this communication mix will be applied. An empty list means all layers.

object
id
string | null

ID of the broadcast layer.

code
string | null

Unique code of the broadcast layer.

name
string | null

Name of the broadcast layer.

isMain
boolean | null

Defines if this layer is the main layer or not.

isSOV
boolean

Defines if this layer is a SOV (Share of Voice) layer.

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*
500

Internal Server Error

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