Trendsic Platform Service

<back to all web services

LobbyPlaylistRequest

Requires Authentication
The following routes are available for this service:
GET,PUT,OPTIONS/v1/lobby/playlist/{BranchId}
LobbyPlaylistRequest Parameters:
NameParameterData TypeRequiredDescription
BranchIdpathGuidNo
ItemsbodyList<LobbyPlaylistEntry>No
LobbyPlaylistEntry Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
SortOrderformintNo
HiddenformboolNo
LobbyContentResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ItemsformList<LobbyContentItem>No
LobbyContentItem Parameters:
NameParameterData TypeRequiredDescription
LobbyContentIdformintNo
TitleformstringNo
KindformstringNo
HasMediaformboolNo
MediaUrlformstringNo
HeadlineformstringNo
BodyformstringNo
AccentformstringNo
UrlformstringNo
DwellSecformintNo
StartsAtformDateTime?No
EndsAtformDateTime?No
DaysMaskformintNo
HourFromformint?No
HourToformint?No
IsThirdPartyformboolNo
StatusformstringNo
AllBranchesformboolNo
BranchIdsformList<Guid>No
Plays7dformintNo
OnNowformboolNo
SortOrderformintNo
CreatedByformstringNo
UpdatedAtformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /v1/lobby/playlist/{BranchId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	BranchId: 00000000000000000000000000000000,
	Items: 
	[
		{
			Id: 0,
			SortOrder: 0,
			Hidden: False
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Items: 
	[
		{
			LobbyContentId: 0,
			Title: String,
			Kind: String,
			HasMedia: False,
			MediaUrl: String,
			Headline: String,
			Body: String,
			Accent: String,
			Url: String,
			DwellSec: 0,
			StartsAt: 0001-01-01,
			EndsAt: 0001-01-01,
			DaysMask: 0,
			HourFrom: 0,
			HourTo: 0,
			IsThirdParty: False,
			Status: String,
			AllBranches: False,
			BranchIds: 
			[
				00000000000000000000000000000000
			],
			Plays7d: 0,
			OnNow: False,
			SortOrder: 0,
			CreatedBy: String,
			UpdatedAt: 0001-01-01
		}
	]
}