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

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

<LobbyPlayedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <LobbyContentId>0</LobbyContentId>
  <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
</LobbyPlayedRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LobbyPlayResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BranchLocalNow>0001-01-01T00:00:00</BranchLocalNow>
  <IdleScreen>false</IdleScreen>
  <Items>
    <LobbyContentItem>
      <Accent>String</Accent>
      <AllBranches>false</AllBranches>
      <Body>String</Body>
      <BranchIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
      </BranchIds>
      <CreatedBy>String</CreatedBy>
      <DaysMask>0</DaysMask>
      <DwellSec>0</DwellSec>
      <EndsAt>0001-01-01T00:00:00</EndsAt>
      <HasMedia>false</HasMedia>
      <Headline>String</Headline>
      <HourFrom>0</HourFrom>
      <HourTo>0</HourTo>
      <IsThirdParty>false</IsThirdParty>
      <Kind>String</Kind>
      <LobbyContentId>0</LobbyContentId>
      <MediaUrl>String</MediaUrl>
      <OnNow>false</OnNow>
      <Plays7d>0</Plays7d>
      <SortOrder>0</SortOrder>
      <StartsAt>0001-01-01T00:00:00</StartsAt>
      <Status>String</Status>
      <Title>String</Title>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <Url>String</Url>
    </LobbyContentItem>
  </Items>
  <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>
  <TakeoverEveryMin>0</TakeoverEveryMin>
  <TakeoverSec>0</TakeoverSec>
  <ZoneMode>String</ZoneMode>
</LobbyPlayResponse>