Session

There are two operations supported on sessions.

Both calls return objects with the same properties.

Id
The unique identifier of this session
FilmId
If this session is just showing a single film, this is the unique identifier of that film
FilmPackageId
If this session is for a multi/double feature, then this will be the unique identifier of the film package
Title
The title of the film or film package showing at this session
ScreenId
the unique identifier of the screen that this session is showing on
Seating
How seats are allocated for this session. Valid values are
Allocated
Seats are allocated
Select
Seats are allocated and must be chosen by the POS operator
Open
No seating allocation
AreComplimentariesAllowed
Are complimentary tickets allows to be used for this session
ShowType
Is this session Public or Private
SalesVia
What sales channels are tickets for this session available on. There could be zero (alothough this is unlikely) to two of these.
WWW
Available for sale via the web
POS
Avaliable for sales from POS
Status
The status of this session. Valid values are Open, Closed, Planned
PreShowStartTime
The time the pre-show (trailers) are scheduled to start for this session
SalesCutOffTime
The time when the sales close for this session
TicketsSoldOut
Are all tickets sold out for this session
FewTicketsLeft
Is the current available tickets percentage lower than the low tickets threshold set in the database
FeatureStartTime
The time the feature is scheduled to start
FeatureEndTime
The time the feature is scheduled to end
CleanupEndTime
The time the cleanup for this session is scheduled to end
SeatsAvailable
The number of seats that are available for sale to this session. This includes wheel chair seats, but excludes house seats
SeatsHeld
The number of seats that are being held by unpaid bookings
SeatsHouse
The number of house seats that are still being held for this session
SeatsSold
The number of seats that have been sold for this session
FilmFormat
The format that the session will be played in. Possible values are
2D Film
2D Digital
3D Digital
PriceCardName
The price card is a set of ticket prices that can be applied to a session. For example a cinema may have a price card for matinee sessions and another for their evening sessions. This is the name or the price card for this session.
Attributes
The attribute codes assigned to this screen for this session. These attribute codes can be matched against attributes found using the Attribute API
AudioLanguage
The audio language assigned to this session. This may differ from the original language of the film. This is not able to be set

GET v1/session

This retrieves a list of all sessions where the CleanupEndTime is in the future for the site that is associated with the access token.

Sample Response JSON

[
    {
        "Id":702,
        "FilmId":"ST00000069",
        "FilmPackageId":null,
        "Title":"Contraband",
        "ScreenId":2,
        "Seating":"Select",
        "AreComplimentariesAllowed":true,
        "ShowType":"Public",
        "SalesVia":
            [
                "WWW",
                "POS"
            ],
        "Status":"Open",
        "PreShowStartTime":"2013-06-28T17:00:00",
        "SalesCutOffTime":"2013-06-28T16:50:00",
        "FeatureStartTime":"2013-06-28T17:00:00",
        "FeatureEndTime":"2013-06-28T18:49:00",
        "CleanupEndTime":"2013-06-28T18:49:00",
        "TicketsSoldOut": true,
        "FewTicketsLeft": false,
        "SeatsAvailable":70,
        "SeatsHeld":0,
        "SeatsHouse":3,
        "SeatsSold":2,
        "FilmFormat": "2D Digital",
        "PriceCardName": "General Admission"
    },
    {
        "Id":703,
        "FilmId":"ST00000047",
        "FilmPackageId":null,
        "Title":"The Godfather",
        "ScreenId":2,
        "Seating":"Open",
        "AreComplimentariesAllowed":true,
        "ShowType":"Public",
        "SalesVia":
            [
                "POS"
            ],
        "Status":"Open",
        "PreShowStartTime":"2013-06-28T12:15:00",
        "SalesCutOffTime":"2013-06-28T12:05:00",
        "FeatureStartTime":"2013-06-28T12:15:00",
        "FeatureEndTime":"2013-06-28T14:05:00",
        "CleanupEndTime":"2013-06-28T14:05:00",
        "TicketsSoldOut": false,
        "FewTicketsLeft": true,
        "SeatsAvailable":72,
        "SeatsHeld":0,
        "SeatsHouse":3,
        "SeatsSold":0,
        "FilmFormat":"2D Film",
        "PriceCardName": "Matinee"
    }
]

Sample Response XML

<ArrayOfSession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vista.Online.BackOffice.Api.Models.V1">
    <Session>
        <AreComplimentariesAllowed>true</AreComplimentariesAllowed>
        <CleanupEndTime>2013-06-28T18:49:00</CleanupEndTime>
        <FeatureEndTime>2013-06-28T18:49:00</FeatureEndTime>
        <FeatureStartTime>2013-06-28T17:00:00</FeatureStartTime>
        <FilmFormat>2D Digital</FilmFormat>
        <FilmId>ST00000069</FilmId>
        <FilmPackageId i:nil="true"></FilmPackageId>
        <Id>702</Id>
        <PreShowStartTime>2013-06-28T17:00:00</PreShowStartTime>
        <SalesCutOffTime>2013-06-28T16:50:00</SalesCutOffTime>
        <PriceCardName>General Admission</PriceCardName>
        <SalesVia>
            <SalesChannel>WWW</SalesChannel>
            <SalesChannel>POS</SalesChannel>
        </SalesVia>
        <ScreenId>2</ScreenId>
        <Seating>Select</Seating>
        <TicketsSoldOut>True</TicketsSoldOut>
        <FewTicketsLeft>False</FewTicketsLeft>
        <SeatsAvailable>70</SeatsAvailable>
        <SeatsHeld>0</SeatsHeld>
        <SeatsHouse>3</SeatsHouse>
        <SeatsSold>2</SeatsSold>
        <ShowType>Public</ShowType>
        <Status>Open</Status>
        <Title>Contraband</Title>
    </Session>
    <Session>
        <AreComplimentariesAllowed>true</AreComplimentariesAllowed>
        <CleanupEndTime>2013-06-28T14:05:00</CleanupEndTime>
        <FeatureEndTime>2013-06-28T14:05:00</FeatureEndTime>
        <FeatureStartTime>2013-06-28T12:15:00</FeatureStartTime>
        <FilmFormat>2D Film</FilmFormat>
        <FilmId>ST00000047</FilmId>
        <FilmPackageId i:nil="true"></FilmPackageId>
        <Id>703</Id>
        <PreShowStartTime>2013-06-28T12:15:00</PreShowStartTime>
        <SalesCutOffTime>2013-06-28T12:05:00</SalesCutOffTime>
        <PriceCardName>Matinee</PriceCardName>
        <SalesVia>
            <SalesChannel>POS</SalesChannel>
        </SalesVia>
        <ScreenId>2</ScreenId>
        <Seating>Open</Seating>
        <TicketsSoldOut>True</TicketsSoldOut>
        <FewTicketsLeft>False</FewTicketsLeft>
        <SeatsAvailable>72</SeatsAvailable>
        <SeatsHeld>0</SeatsHeld>
        <SeatsHouse>3</SeatsHouse>
        <SeatsSold>0</SeatsSold>
        <ShowType>Public</ShowType>
        <Status>Open</Status>
        <Title>The Godfather</Title>
    </Session>
</ArrayOfSession>

GET v1/session/{id}

This retrieves just one session based on the id, even if it is not currently being returned in the list. If there is no session with this id then a 404 HTTP error is returned.

Sample Response JSON

{
    "Id":429,
    "FilmId":"ST00000005",
    "FilmPackageId":null,
    "Title":"Women on the 6th Floor",
    "ScreenId":1,
    "Seating":"Open",
    "AreComplimentariesAllowed":true,
    "ShowType":"Public",
    "SalesVia":
        [
            "WWW",
            "POS"
        ],
    "Status":"Open",
    "PreShowStartTime":"2013-08-01T14:00:00",
    "SalesCutOffTime":"2013-08-01T13:50:00",
    "FeatureStartTime":"2013-08-01T14:10:00",
    "FeatureEndTime":"2013-08-01T15:54:00",
    "CleanupEndTime":"2013-08-01T15:54:00",
    "TicketsSoldOut": true,
    "FewTicketsLeft": false,
    "SeatsAvailable":106,
    "SeatsHeld":0,
    "SeatsHouse":0,
    "SeatsSold":0,
    "FilmFormat":"2D Digital",
    "PriceCardName": "Matinee"
}

Sample Response XML

<Session xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vista.Online.BackOffice.Api.Models.V1">
    <AreComplimentariesAllowed>true</AreComplimentariesAllowed>
    <CleanupEndTime>2013-08-01T15:54:00</CleanupEndTime>
    <FeatureEndTime>2013-08-01T15:54:00</FeatureEndTime>
    <FeatureStartTime>2013-08-01T14:10:00</FeatureStartTime>
    <FilmFormat>3D Digital</FilmFormat>
    <FilmId>ST00000005</FilmId>
    <FilmPackageId i:nil="true"></FilmPackageId>
    <Id>429</Id>
    <PreShowStartTime>2013-08-01T14:00:00</PreShowStartTime>
    <SalesCutOffTime>2013-08-01T13:50:00</SalesCutOffTime>
    <PriceCardName>Matinee</PriceCardName>
    <SalesVia>
        <SalesChannel>WWW</SalesChannel>
        <SalesChannel>POS</SalesChannel>
    </SalesVia>
    <ScreenId>1</ScreenId>
    <Seating>Open</Seating>
    <TicketsSoldOut>True</TicketsSoldOut>
    <FewTicketsLeft>False</FewTicketsLeft>
    <SeatsAvailable>106</SeatsAvailable>
    <SeatsHeld>0</SeatsHeld>
    <SeatsHouse>0</SeatsHouse>
    <SeatsSold>0</SeatsSold>
    <ShowType>Public</ShowType>
    <Status>Open</Status>
    <Title>Women on the 6th Floor</Title>
</Session>