Trendsic Platform Service

<back to all web services

LobbyBranchesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/lobby/branches
"use strict";
export class LobbyBranch {
    /** @param {{BranchId?:string,Name?:string,Allowed?:boolean,TvCount?:number,ZoneMode?:string,TakeoverEveryMin?:number,TakeoverSec?:number,Density?:string,IdleMode?:string,IdleContentId?:number,ShowServices?:boolean,TimeZone?:string,BookingSlug?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    BranchId;
    /** @type {string} */
    Name;
    /** @type {boolean} */
    Allowed;
    /** @type {number} */
    TvCount;
    /** @type {string} */
    ZoneMode;
    /** @type {?number} */
    TakeoverEveryMin;
    /** @type {?number} */
    TakeoverSec;
    /** @type {string} */
    Density;
    /** @type {string} */
    IdleMode;
    /** @type {?number} */
    IdleContentId;
    /** @type {boolean} */
    ShowServices;
    /** @type {string} */
    TimeZone;
    /** @type {string} */
    BookingSlug;
}
export class LobbyPolicy {
    /** @param {{ImageExtensions?:string[],MaxImageBytes?:number,MaxVideoBytes?:number,MaxVideoSec?:number,TitleMax?:number,HeadlineMax?:number,BodyMax?:number,CaptionMax?:number,DwellMin?:number,DwellMax?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string[]} */
    ImageExtensions = [];
    /** @type {number} */
    MaxImageBytes;
    /** @type {number} */
    MaxVideoBytes;
    /** @type {number} */
    MaxVideoSec;
    /** @type {number} */
    TitleMax;
    /** @type {number} */
    HeadlineMax;
    /** @type {number} */
    BodyMax;
    /** @type {number} */
    CaptionMax;
    /** @type {number} */
    DwellMin;
    /** @type {number} */
    DwellMax;
}
export class LobbyBranchesResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Branches?:LobbyBranch[],Policy?:LobbyPolicy}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {LobbyBranch[]} */
    Branches = [];
    /** @type {LobbyPolicy} */
    Policy;
}
export class LobbyBranchesRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript LobbyBranchesRequest 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.

GET /v1/lobby/branches 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"}},"Branches":[{"BranchId":"00000000000000000000000000000000","Name":"String","Allowed":false,"TvCount":0,"ZoneMode":"String","TakeoverEveryMin":0,"TakeoverSec":0,"Density":"String","IdleMode":"String","IdleContentId":0,"ShowServices":false,"TimeZone":"String","BookingSlug":"String"}],"Policy":{"ImageExtensions":["String"],"MaxImageBytes":0,"MaxVideoBytes":0,"MaxVideoSec":0,"TitleMax":0,"HeadlineMax":0,"BodyMax":0,"CaptionMax":0,"DwellMin":0,"DwellMax":0}}