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}
LobbyPlaylistRequest Parameters:
NameParameterData TypeRequiredDescription
BranchIdpathGuidNo
ItemsbodyList<LobbyPlaylistEntry>No
LobbyPlaylistEntry Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
SortOrderformintNo
HiddenformboolNo
LobbyContentResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ItemsformList<LobbyContentItem>No
LobbyContentItem Parameters:
NameParameterData TypeRequiredDescription
LobbyContentIdformintNo
TitleformstringNo
KindformstringNo
HasMediaformboolNo
MediaUrlformstringNo
HeadlineformstringNo
BodyformstringNo
AccentformstringNo
UrlformstringNo
DwellSecformintNo
StartsAtformDateTime?No
EndsAtformDateTime?No
DaysMaskformintNo
HourFromformint?No
HourToformint?No
IsThirdPartyformboolNo
StatusformstringNo
AllBranchesformboolNo
BranchIdsformList<Guid>No
Plays7dformintNo
OnNowformboolNo
SortOrderformintNo
CreatedByformstringNo
UpdatedAtformDateTime?No

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.

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

<LobbyPlaylistRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
  <Items>
    <LobbyPlaylistEntry>
      <Hidden>false</Hidden>
      <Id>0</Id>
      <SortOrder>0</SortOrder>
    </LobbyPlaylistEntry>
  </Items>
</LobbyPlaylistRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LobbyContentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
</LobbyContentResponse>