Trendsic Platform Service

<back to all web services

LobbyPlayRequest

The following routes are available for this service:
GET,OPTIONS/v1/lobby/{LocationId}/play
LobbyPlayRequest Parameters:
NameParameterData TypeRequiredDescription
LocationIdpathGuidNo
LobbyPlayResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ItemsformList<LobbyContentItem>No
ZoneModeformstringNo
TakeoverEveryMinformint?No
TakeoverSecformint?No
IdleScreenformboolNo
BranchLocalNowformDateTimeNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /v1/lobby/{LocationId}/play HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","EndsAt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000"}],"ZoneMode":"String","TakeoverEveryMin":0,"TakeoverSec":0,"IdleScreen":false,"BranchLocalNow":"0001-01-01T00:00:00.0000000"}