Trendsic Platform Service

<back to all web services

LobbyPlayRequest

The following routes are available for this service:
GET,OPTIONS/v1/lobby/{LocationId}/play
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LobbyContentItem:
    lobby_content_id: int = 0
    title: Optional[str] = None
    kind: Optional[str] = None
    has_media: bool = False
    media_url: Optional[str] = None
    headline: Optional[str] = None
    body: Optional[str] = None
    accent: Optional[str] = None
    url: Optional[str] = None
    dwell_sec: int = 0
    starts_at: Optional[datetime.datetime] = None
    ends_at: Optional[datetime.datetime] = None
    days_mask: int = 0
    hour_from: Optional[int] = None
    hour_to: Optional[int] = None
    is_third_party: bool = False
    status: Optional[str] = None
    all_branches: bool = False
    branch_ids: List[str] = field(default_factory=list)
    plays7d: int = 0
    on_now: bool = False
    sort_order: int = 0
    created_by: Optional[str] = None
    updated_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LobbyPlayResponse:
    response_status: Optional[ResponseStatus] = None
    items: List[LobbyContentItem] = field(default_factory=list)
    zone_mode: Optional[str] = None
    takeover_every_min: Optional[int] = None
    takeover_sec: Optional[int] = None
    idle_screen: bool = False
    branch_local_now: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LobbyPlayRequest:
    location_id: Optional[str] = None

Python LobbyPlayRequest 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/{LocationId}/play HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
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>