Film Package

A film package is used to program a mulit/double feature. There are two operations supported on film packages.

• GET /v1/filmpackage
• GET /v1/filmpackage/{id}

Both calls return objects with the same properties.

Id

The unique identifier of this film package

Title

The title of this film package

Status

Valid values are: Active, Inactive, Deleted

Films

The films that are a part of this package

The films collection includes the following properties

FilmId

The unique indetifier of the film. Full details can be retrieved from films

Title

The title of the film

SplitPercent

What percentage of the box office revenue is assigned to this film

TrailerDuration

How long are the trailers for this film

CleanUpDuration

How long after this film is finished is allocated for cleanup

Order

In what order should this film show

GET /v1/filmpackage

This retrieves a list of all film packages from a Veezi customer database. This may include film packages that have never been shown at this site.

Sample Response JSON

[
    {
        "Id":22,
        "Title":"Star Wars Trilogy",
        "Status":"Active",
        "Films":[
            {
                "FilmId":"ST00000068",
                "Title":"Star Wars",
                "SplitPercent":20.000000,
                "TrailerDuration":10,
                "CleanUpDuration":5,
                "Order":1
            },
            {
                "FilmId":"ST00000072",
                "Title":"The Empire Strikes Back",
                "SplitPercent":25.000000,
                "TrailerDuration":0,
                "CleanUpDuration":5,
                "Order":2
            },
            {
                "FilmId":"ST00000074",
                "Title":"Return of the Jedi",
                "SplitPercent":55.000000,
                "TrailerDuration":0,
                "CleanUpDuration":20,
                "Order":3
            }
        ]
    },
    {
        "Id":23,
        "Title":"Horror Double Feature",
        "Status":"Active",
        "Films":[
            {
                "FilmId":"ST00000059",
                "Title":"Friday the 13th",
                "SplitPercent":50.000000,
                "TrailerDuration":15,
                "CleanUpDuration":5,
                "Order":1
            },
            {
                "FilmId":"ST00000063",
                "Title:"A Nightmare on Elm Street",
                "SplitPercent":50.000000,
                "TrailerDuration":10,
                "CleanUpDuration":20,
                "Order":2
            }
        ]
    }
]

Sample Response XML

<ArrayOfFilmPackage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vista.Online.BackOffice.Api.Models.V1">
    <FilmPackage>
        <Films>
            <FilmPackageFilm>
                <CleanUpDuration>5</CleanUpDuration>
                <FilmId>ST00000068</FilmId>
                <Order>1</Order>
                <SplitPercent>20.000000</SplitPercent>
                <Title>Star Wars</Title>
                <TrailerDuration>10</TrailerDuration>
            </FilmPackageFilm>
            <FilmPackageFilm>
                <CleanUpDuration>5</CleanUpDuration>
                <FilmId>ST00000072</FilmId>
                <Order>2</Order>
                <SplitPercent>25.000000</SplitPercent>
                <Title>The Empire Strikes Back</Title>
                <TrailerDuration>0</TrailerDuration>
            </FilmPackageFilm>
            <FilmPackageFilm>
                <CleanUpDuration>20</CleanUpDuration>
                <FilmId>ST00000074</FilmId>
                <Order>3</Order>
                <SplitPercent>55.000000</SplitPercent>
                <Title>Return of the Jedi</Title>
                <TrailerDuration>0</TrailerDuration>
            </FilmPackageFilm>
        </Films>
        <Id>22</Id>
        <Status>Active</Status>
        <Title>Star Wars Trilogy</Title>
    </FilmPackage>
    <FilmPackage>
        <Films>
            <FilmPackageFilm>
                <CleanUpDuration>5</CleanUpDuration>
                <FilmId>ST00000059</FilmId>
                <Order>1</Order>
                <SplitPercent>50.000000</SplitPercent>
                <Title>Friday the 13th</Title>
                <TrailerDuration>15</TrailerDuration>
            </FilmPackageFilm>
            <FilmPackageFilm>
                <CleanUpDuration>20</CleanUpDuration>
                <FilmId>ST00000063</FilmId>
                <Order>2</Order>
                <SplitPercent>50.000000</SplitPercent>
                <Title>A Nightmare on Elm Street</Title>
                <TrailerDuration>10</TrailerDuration>
            </FilmPackageFilm>
        </Films>
        <Id>23</Id>
        <Status>Active</Status>
        <Title>Horror Double Feature</Title>
    </FilmPackage>
</ArrayOfFilmPackage>

GET /v1/filmpackage/{id}

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

Sample Response JSON

{
    "Id":22,
    "Title":"Star Wars Trilogy",
    "Status":"Active",
    "Films":[
        {
            "FilmId":"ST00000068",
            "Title":"A New Hope",
            "SplitPercent":20.000000,
            "TrailerDuration":10,
            "CleanUpDuration":5,
            "Order":1
        },
        {
            "FilmId":"ST00000072",
            "Title":"The Empire Strikes Back",
            "SplitPercent":25.000000,
            "TrailerDuration":0,
            "CleanUpDuration":5,
            "Order":2
        },
        {
            "FilmId":"ST00000074",
            "Title":"Return of the Jedi",
            "SplitPercent":55.000000,
            "TrailerDuration":0,
            "CleanUpDuration":20,
            "Order":3
        }
    ]
}

Sample Response XML

<FilmPackage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vista.Online.BackOffice.Api.Models.V1">
    <Films>
        <FilmPackageFilm>
            <CleanUpDuration>5</CleanUpDuration>
            <FilmId>ST00000068</FilmId>
            <Order>1</Order>
            <SplitPercent>20.000000</SplitPercent>
            <Title>Star Wars</Title>
            <TrailerDuration>10</TrailerDuration>
        </FilmPackageFilm>
        <FilmPackageFilm>
            <CleanUpDuration>5</CleanUpDuration>
            <FilmId>ST00000072</FilmId>
            <Order>2</Order>
            <SplitPercent>25.000000</SplitPercent>
            <Title>The Empire Strikes Back</Title>
            <TrailerDuration>0</TrailerDuration>
        </FilmPackageFilm>
        <FilmPackageFilm>
            <CleanUpDuration>20</CleanUpDuration>
            <FilmId>ST00000074</FilmId>
            <Order>3</Order>
            <SplitPercent>55.000000</SplitPercent>
            <Title>Return of the Jedi</Title>
            <TrailerDuration>0</TrailerDuration>
        </FilmPackageFilm>
    </Films>
    <Id>22</Id>
    <Status>Active</Status>
    <Title>Star Wars Trilogy</Title>
</FilmPackage>