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}

export class LobbyContentItem
{
    public LobbyContentId: number;
    public Title: string;
    public Kind: string;
    public HasMedia: boolean;
    public MediaUrl: string;
    public Headline: string;
    public Body: string;
    public Accent: string;
    public Url: string;
    public DwellSec: number;
    public StartsAt?: string;
    public EndsAt?: string;
    public DaysMask: number;
    public HourFrom?: number;
    public HourTo?: number;
    public IsThirdParty: boolean;
    public Status: string;
    public AllBranches: boolean;
    public BranchIds: string[] = [];
    public Plays7d: number;
    public OnNow: boolean;
    public SortOrder: number;
    public CreatedBy: string;
    public UpdatedAt?: string;

    public constructor(init?: Partial<LobbyContentItem>) { (Object as any).assign(this, init); }
}

export class LobbyContentResponse
{
    public ResponseStatus: ResponseStatus;
    public Items: LobbyContentItem[] = [];

    public constructor(init?: Partial<LobbyContentResponse>) { (Object as any).assign(this, init); }
}

export class LobbyPlaylistEntry
{
    public Id: number;
    public SortOrder: number;
    public Hidden: boolean;

    public constructor(init?: Partial<LobbyPlaylistEntry>) { (Object as any).assign(this, init); }
}

export class LobbyPlaylistRequest
{
    public BranchId: string;
    public Items: LobbyPlaylistEntry[] = [];

    public constructor(init?: Partial<LobbyPlaylistRequest>) { (Object as any).assign(this, init); }
}

TypeScript LobbyPlaylistRequest DTOs

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.

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

{"BranchId":"00000000000000000000000000000000","Items":[{"Id":0,"SortOrder":0,"Hidden":false}]}
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"}]}