Trendsic Platform Service

<back to all web services

LobbyPlayedRequest

The following routes are available for this service:
POST,OPTIONS/v1/lobby/{LocationId}/played/{LobbyContentId}
"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 LobbyPlayedRequest {
    /** @param {{LocationId?:string,LobbyContentId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LocationId;
    /** @type {number} */
    LobbyContentId;
}

JavaScript LobbyPlayedRequest DTOs

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.

POST /v1/lobby/{LocationId}/played/{LobbyContentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	LocationId: 00000000000000000000000000000000,
	LobbyContentId: 0
}
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
		}
	],
	ZoneMode: String,
	TakeoverEveryMin: 0,
	TakeoverSec: 0,
	IdleScreen: False,
	BranchLocalNow: 0001-01-01
}