Screen

There are two operations supported on film screens.

• GET /v1/screen
• GET /v1/screen/{id}

Both calls return objects with the same properties.

Id

The unique identifier of this screen

Name

The name used to describe this screen

ScreenNumber

The order to display this screen in POS

HasCustomLayout

Has this screen been configured for allocated seating

TotalSeats

Total number of seats for this screen

HouseSeats

The number of seats that are reserved by the house for exceptional circumstances

WheelChairSeats

The number of seats that are reserved for customers with wheel chairs

GET /v1/screen

This retrieves a list of all screens for the site that is associated with the access token.

Sample Response JSON

[
    {
        "Id":1,
        "Name":"Screen 1",
        "ScreenNumber":"1",
        "HasCustomLayout":true,
        "TotalSeats":118,
        "HouseSeats":3,
        "WheelChairSeats":2
    },
    {
        "Id":3,
        "Name":"Screen 2",
        "ScreenNumber":"2",
        "HasCustomLayout":true,
        "TotalSeats":59,
        "HouseSeats":2,
        "WheelChairSeats":0
    }
]

Sample Response XML

<ArrayOfScreen xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vista.Online.BackOffice.Api.Models.V1">
    <Screen>
        <HasCustomLayout>true</HasCustomLayout>
        <HouseSeats>3</HouseSeats>
        <Id>1</Id>
        <Name>Screen 1</Name>
        <ScreenNumber>1</ScreenNumber>
        <TotalSeats>118</TotalSeats>
        <WheelChairSeats>2</WheelChairSeats>
    </Screen>
 <Screen>
        <HasCustomLayout>true</HasCustomLayout>
        <HouseSeats>2</HouseSeats>
        <Id>3</Id>
        <Name>Screen 2</Name>
        <ScreenNumber>2</ScreenNumber>
        <TotalSeats>59</TotalSeats>
        <WheelChairSeats>0</WheelChairSeats>
    </Screen>
</ArrayOfScreen>

GET /v1/screen/{id}

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

Sample Response JSON

{
    "Id":1,
    "Name":"Screen 1",
    "ScreenNumber":"1",
    "HasCustomLayout":true,
    "TotalSeats":118,
    "HouseSeats":3,
    "WheelChairSeats":2
}

Sample Response XML

<Screen xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vista.Online.BackOffice.Api.Models.V1">
    <HasCustomLayout>true</HasCustomLayout>
    <HouseSeats>3</HouseSeats>
    <Id>1</Id>
    <Name>Screen 1</Name>
    <ScreenNumber>1</ScreenNumber>
    <TotalSeats>118</TotalSeats>
    <WheelChairSeats>2</WheelChairSeats>
</Screen>