Trendsic Platform Service

<back to all web services

LobbyPlayRequest

The following routes are available for this service:
GET,OPTIONS/v1/lobby/{LocationId}/play
"use strict";
export class LobbyContentItem {
    /** @param {{LobbyContentId?:number,Title?:string,Kind?:string,HasMedia?:boolean,MediaUrl?:string,Headline?:string,Body?:string,Accent?:string,Url?:string,DwellSec?:number,StartsAt?:string,EndsAt?:string,DaysMask?:number,HourFrom?:number,HourTo?:number,IsThirdParty?:boolean,Status?:string,AllBranches?:boolean,BranchIds?:string[],Plays7d?:number,OnNow?:boolean,SortOrder?:number,CreatedBy?:string,UpdatedAt?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    LobbyContentId;
    /** @type {string} */
    Title;
    /** @type {string} */
    Kind;
    /** @type {boolean} */
    HasMedia;
    /** @type {string} */
    MediaUrl;
    /** @type {string} */
    Headline;
    /** @type {string} */
    Body;
    /** @type {string} */
    Accent;
    /** @type {string} */
    Url;
    /** @type {number} */
    DwellSec;
    /** @type {?string} */
    StartsAt;
    /** @type {?string} */
    EndsAt;
    /** @type {number} */
    DaysMask;
    /** @type {?number} */
    HourFrom;
    /** @type {?number} */
    HourTo;
    /** @type {boolean} */
    IsThirdParty;
    /** @type {string} */
    Status;
    /** @type {boolean} */
    AllBranches;
    /** @type {string[]} */
    BranchIds = [];
    /** @type {number} */
    Plays7d;
    /** @type {boolean} */
    OnNow;
    /** @type {number} */
    SortOrder;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    UpdatedAt;
}
export class LobbyPlayResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Items?:LobbyContentItem[],ZoneMode?:string,TakeoverEveryMin?:number,TakeoverSec?:number,IdleScreen?:boolean,BranchLocalNow?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {LobbyContentItem[]} */
    Items = [];
    /** @type {string} */
    ZoneMode;
    /** @type {?number} */
    TakeoverEveryMin;
    /** @type {?number} */
    TakeoverSec;
    /** @type {boolean} */
    IdleScreen;
    /** @type {string} */
    BranchLocalNow;
}
export class LobbyPlayRequest {
    /** @param {{LocationId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LocationId;
}

JavaScript LobbyPlayRequest DTOs

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

HTTP + OTHER

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: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}