Attribute

Attributes are additional properties that can be assigned to screens.  If an attribute has been associated with a screen, all sessions on that screen will be assigned that attribute when it is created. For example, if a screen is given the attribute of a Premium screen, all sessions that are shown on that screen will have the Premium attribute.

Both calls return objects with the same properties.

Id
The unique identifier of this attribute
Description
The full description of this attribute
ShortName
The name to display when there is a limited number of space available
FontColor
The font colour to display this attribute with
BackgroundColor
The background colour to display this attribute with
ShowOnSessionsWithNoComps
Is this attribute applied to sessions if AreComplimentariesAllowed is false

GET /v1/attribute

This retrieves the list of all attributes from a Veezi customer database.

Sample Response JSON

[
  {
    "Id": "0000000005",
    "Description": "Gold Room",
    "ShortName": "GR",
    "FontColor": "#000000",
    "BackgroundColor": "#9d5151",
    "ShowOnSessionsWithNoComps": false
  },
  {
    "Id": "0000000007",
    "Description": "No Comps",
    "ShortName": "NC",
    "FontColor": "#1c1e1e",
    "BackgroundColor": "#53c338",
    "ShowOnSessionsWithNoComps": true
  }
]

Sample Response XML

<ArrayOfAttribute xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vista.Online.BackOffice.Api.Models.V1">
    <Attribute>
        <BackgroundColor>#9d5151</BackgroundColor>
        <Description>Gold Room</Description>
        <FontColor>#000000</FontColor>
        <Id>0000000005</Id>
        <ShortName>GR</ShortName>
        <ShowOnSessionsWithNoComps>false</ShowOnSessionsWithNoComps>
    </Attribute>
    <Attribute>
        <BackgroundColor>#53c338</BackgroundColor>
        <Description>No Comps</Description>
        <FontColor>#1c1e1e</FontColor>
        <Id>0000000007</Id>
        <ShortName>NC</ShortName>
        <ShowOnSessionsWithNoComps>true</ShowOnSessionsWithNoComps>
    </Attribute>
</ArrayOfAttribute>

GET /v1/attribute/{id}

This retrieves just one attribute based on the id. If there is no attribute with this id then a 404 HTTP error is returned.

Sample Response JSON

{
  "Id": "0000000005",
  "Description": "Gold Room",
  "ShortName": "GR",
  "FontColor": "#000000",
  "BackgroundColor": "#9d5151",
  "ShowOnSessionsWithNoComps": false
}

Sample Response XML

<Attribute xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vista.Online.BackOffice.Api.Models.V1">
    <BackgroundColor>#9d5151</BackgroundColor>
    <Description>Gold Room</Description>
    <FontColor>#000000</FontColor>
    <Id>0000000005</Id>
    <ShortName>GR</ShortName>
    <ShowOnSessionsWithNoComps>false</ShowOnSessionsWithNoComps>
</Attribute>