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 .xml suffix or ?format=xml

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LobbyBranchesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Branches>
    <LobbyBranch>
      <Allowed>false</Allowed>
      <BookingSlug>String</BookingSlug>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <Density>String</Density>
      <IdleContentId>0</IdleContentId>
      <IdleMode>String</IdleMode>
      <Name>String</Name>
      <ShowServices>false</ShowServices>
      <TakeoverEveryMin>0</TakeoverEveryMin>
      <TakeoverSec>0</TakeoverSec>
      <TimeZone>String</TimeZone>
      <TvCount>0</TvCount>
      <ZoneMode>String</ZoneMode>
    </LobbyBranch>
  </Branches>
  <Policy>
    <BodyMax>0</BodyMax>
    <CaptionMax>0</CaptionMax>
    <DwellMax>0</DwellMax>
    <DwellMin>0</DwellMin>
    <HeadlineMax>0</HeadlineMax>
    <ImageExtensions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </ImageExtensions>
    <MaxImageBytes>0</MaxImageBytes>
    <MaxVideoBytes>0</MaxVideoBytes>
    <MaxVideoSec>0</MaxVideoSec>
    <TitleMax>0</TitleMax>
  </Policy>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</LobbyBranchesResponse>