Veezi API Help

Film

There are two operations supported on films.

GET /v4/film
GET /v4/film/{id}

Both calls return objects with the same properties.

Id

The unique identifier of this film

Title

The full title of this film

ShortName

The name to display when there is a limited number of space available (max 10 characters)

Synopsis

Plot synopsis for this film

Genre

The genre of this film

SignageText

The title that is displayed in POS (max 20 characters)

Distributor

The name of the distributor

OpeningDate

When did this film first show in the country of this Veezi customer

Rating

Censor rating. Values vary depending on country

Status

Valid values are:Active, Inactive, Deleted

Content

Content advisory for the film

Duration

The duration of the film in minutes

DisplaySequence

Determines the order in which films are listed on POS. A lower number indicates a higher position

NationalCode

If the government of the Veezi customer's country requires film data to be reported, the film's report code should be entered here

Format

The format that this film will play in. Possible values are

2D Film
2D Digital
3D Digital
3D HFR
Not a Film

The "Not a Film" option can be used when a cinema wants to schedule a show that is not a film, like a play or a concert

IsRestricted

Is this film be restricted to adults only

People

The people involved with the film. The valid values for Role are:Actor, Director, Producer

AudioLanguage

The original audio language of the film

GovernmentFilmTitle

If the government of the Veezi customer's country requires film data to be reported, the film's reporting title should be entered here

FilmPosterUrl

A link to a large image of the film poster.

FilmPosterThumbnailUrl

A link to a thumbnail image of the film poster.

BackdropImageUrl

A link to a backdrop image of the film.

FilmTrailerUrl

A link to a trailer video of the film

GET /v4/film

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

Sample Response JSON

[
    {
        "Id":"ST00000032",
        "Title":"Avatar",
        "ShortName":"Avatar",
        "Synopsis":"A paraplegic Marine dispatched to the moon Pandora on a unique mission becomes torn between following his orders and protecting the world he feels is his home.",
        "Genre":"Action",
        "SignageText":"Avatar",
        "Distributor":"20th Century Fox",
        "OpeningDate":"2009-09-17T00:00:00",
        "Rating":"PG13",
        "Status":"Active",
        "Content":"Restricted to persons 13 years and over",
        "Duration":162,
        "NationalCode":null,
        "Format":"3D Digital",
        "IsRestricted":false,
        "People":[
             {
                 "Id":"0000000032",
                 "FirstName":"Sam",
                 "LastName":"Worthington",
                 "Role":"Actor"
             },
             {
                 "Id":"HO00000176",
                 "FirstName":"James",
                 "LastName":"Cameron",
                 "Role":"Director"
             },
             {
                 "Id":"HO00000578",
                 "FirstName":"Sigourney",
                 "LastName":"Weaver",
                 "Role":"Actor"
            }
        ],
        "AudioLanguage":"English",
        "GovernmentFilmTitle":"Avatar",
        "FilmPosterUrl":"http://s3.foxmovies.com/foxmovies/production/films/18/images/posters/251-asset-page.jpg",
        "FilmPosterThumbnailUrl":"https://cdn.useast.veezi.com/Media/data/v2/get/7DHr7RbOk62MQa4x8iK9Q==/0000000100",
        "BackdropImageUrl": "https://cdn.useast.veezi.com/Media/data/v2/get/7DHr7RbOk62MQa4x8iK9Q==/0000000101",
        "FilmTrailerUrl":"https://www.youtube.com/watch?v=5PSNL1qE6VY"
    },
    {
        "Id":"ST00000065",
        "Title":"Chronicle",
        "ShortName":"Chronicle",
        "Synopsis":"Three high school friends gain superpowers after making an incredible discovery. Soon, though, they find their lives spinning out of control and their bond tested as they embrace their darker sides.",
        "Genre":"Drama",
        "SignageText":"Chronicle",
        "Distributor":"20th Century Fox",
        "OpeningDate":"2012-03-15T16:39:25",
        "Rating":"M -V",
        "Status":"Active",
        "Content":"M Contains violence.",
        "Duration":84,
        "NationalCode":"",
        "Format":"2D Digital",
        "IsRestricted":false,
        "People":[],
        "AudioLanguage":"English",
        "GovernmentFilmTitle":null,
        "FilmPosterUrl":"",
        "FilmPosterThumbnailUrl":"",
        "BackdropImageUrl": "",
        "FilmTrailerUrl": null
    },
    {
        "Id":"ST00000074",
        "Title":"Blade Runner",
        "ShortName":"Blade Runn",
        "Synopsis":"Deckard, a blade runner, has to track down and terminate 4 replicants who hijacked a ship in space and have returned to earth seeking their maker.",
        "Genre":"Drama",
        "SignageText":"Blade Runner",
        "Distributor":"Warner Bros Pictures",
        "OpeningDate":"1982-06-25T16:29:09",
        "Rating":"R",
        "Status":"Active",
        "Content":"Restricted to persons over 16 years of age unless accompanied by a parent or guardian.",
        "Duration":117,
        "NationalCode":"",
        "IsRestricted":false,
        "Format":"2D Film",
        "People":[],
        "AudioLanguage":"English",
        "GovernmentFilmTitle":null,
        "FilmPosterUrl":"",
        "FilmPosterThumbnailUrl":"",
        "BackdropImageUrl": "",
        "FilmTrailerUrl": null
    }
]

Sample Response XML

<ArrayOfFilm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vista.Online.BackOffice.Api.Models.V1">
    <Film>
        <Id>ST00000032</Id>
        <Title>Avatar</Title>
        <ShortName>Avatar</ShortName>
        <Synopsis>A paraplegic Marine dispatched to the moon Pandora on a unique mission becomes torn between following his orders and protecting the world he feels is his home.</Synopsis>
        <Genre>Action</Genre>
        <SignageText>Avatar</SignageText>
        <Distributor>20th Century Fox</Distributor>
        <OpeningDate>2009-09-17T00:00:00</OpeningDate>
        <Rating>PG13</Rating>
        <Status>Active</Status>
        <Content>Restricted to persons 13 years and over</Content>
        <Duration>162</Duration>
        <NationalCode />
        <Format>3D Digital</Format>
        <IsRestricted>false</IsRestricted>
        <People>
            <Id>0000000032</Id>
            <FirstName>Sam</FirstName>
            <LastName>Worthington</LastName>
            <Role>Actor</Role>
        </People>
        <People>
            <Id>HO00000176</Id>
            <FirstName>James</FirstName>
            <LastName>Cameron</LastName>
            <Role>Director</Role>
        </People>
        <People>
            <Id>HO00000578</Id>
            <FirstName>Sigourney</FirstName>
            <LastName>Weaver</LastName>
            <Role>Actor</Role>
        </People>
        <AudioLanguage>English</AudioLanguage>    
        <GovernmentFilmTitle>Avatar</GovernmentFilmTitle>    
        <FilmPosterUrl>http://s3.foxmovies.com/foxmovies/production/films/18/images/posters/251-asset-page.jpg</FilmPosterUrl>    
        <FilmPosterThumbnailUrl>https://cdn.useast.veezi.com/Media/data/v2/get/7DHr7RbOk62MQa4x8iK9Q==/0000000100</FilmPosterThumbnailUrl>    
        <BackdropImageUrl>https://cdn.useast.veezi.com/Media/data/v2/get/7DHr7RbOk62MQa4x8iK9Q==/0000000101</BackdropImageUrl>    
        <FilmTrailerUrl>https://www.youtube.com/watch?v=5PSNL1qE6VY</FilmTrailerUrl>
    </Film>
    <Film>
        <Id>ST00000065</Id>
        <Title>Chronicle</Title>
        <ShortName>Chronicle</ShortName>
        <Synopsis>Three high school friends gain superpowers after making an incredible discovery. Soon, though, they find their lives spinning out of control and their bond tested as they embrace their darker sides.</Synopsis>
        <Genre>Drama</Genre>
        <SignageText>Chronicle</SignageText>
        <Distributor>20th Century Fox</Distributor>
        <OpeningDate>2012-03-15T16:39:25</OpeningDate>
        <Rating>M -V</Rating>
        <Status>Active</Status>
        <Content>M Contains violence.</Content>
        <Duration>84</Duration>
        <NationalCode></NationalCode>
        <Format>2D Digital</Format>
        <IsRestricted>false</IsRestricted>
        <AudioLanguage>English</AudioLanguage>    
        <GovernmentFilmTitle/>    
        <FilmPosterUrl/>    
        <FilmPosterThumbnailUrl/>    
        <BackdropImageUrl/>    
        <FilmTrailerUrl/>
    </Film>
    <Film>
        <Id>ST00000074</Id>
        <Title>Blade Runner</Title>
        <ShortName>Blade Runn</ShortName>
        <Synopsis>Deckard, a blade runner, has to track down and terminate 4 replicants who hijacked a ship in space and have returned to earth seeking their maker.</Synopsis>
        <Genre>Drama</Genre>
        <SignageText>Blade Runner</SignageText>
        <Distributor>Warner Bros Pictures</Distributor>
        <OpeningDate>1982-06-25T16:29:09</OpeningDate>
        <Rating>R</Rating>
        <Status>Active</Status>
        <Content>Restricted to persons over 16 years of age unless accompanied by a parent or guardian.</Content>
        <Duration>117</Duration>
        <NationalCode></NationalCode>
        <IsRestricted>false</IsRestricted>
        <Format>2D Film</Format>
        <AudioLanguage>English</AudioLanguage>
        <GovernmentFilmTitle/>    
        <FilmPosterUrl/>    
        <FilmPosterThumbnailUrl/>    
        <BackdropImageUrl/>    
        <FilmTrailerUrl/>
    </Film>
</ArrayOfFilm>

GET /v4/film/{id}

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

Sample Response JSON

{
    "Id":"ST00000032",
    "Title":"Avatar",
    "ShortName":"Avatar",
    "Synopsis":"A paraplegic Marine dispatched to the moon Pandora on a unique mission becomes torn between following his orders and protecting the world he feels is his home.",
    "Genre":"Action",
    "SignageText":"Avatar",
    "Distributor":"20th Century Fox",
    "OpeningDate":"2009-09-17T00:00:00",
    "Rating":"PG13",
    "Status":"Active",
    "Content":"Restricted to persons 13 years and over",
    "Duration":162,
    "DisplaySequence":22,
    "NationalCode":null,
    "People":[
        {
            "Id":"0000000032",
            "FirstName":"Sam",
            "LastName":"Worthington",
            "Role":"Actor"
        },
        {
            "Id":"HO00000176",
            "FirstName":"James",
            "LastName":"Cameron",
            "Role":"Dicrector"
        },
        {
            "Id":"HO00000578",
            "FirstName":"Sigourney",
            "LastName":"Weaver",
            "Role":"Actor"
        }
    ],
    "AudioLanguage":"English",
    "GovernmentFilmTitle":"Avatar",
    "FilmPosterUrl":"http://s3.foxmovies.com/foxmovies/production/films/18/images/posters/251-asset-page.jpg",
    "FilmPosterThumbnailUrl":"https://cdn.useast.veezi.com/Media/data/v2/get/7DHr7RbOk62MQa4x8iK9Q==/0000000100",
    "BackdropImageUrl": "https://cdn.useast.veezi.com/Media/data/v2/get/7DHr7RbOk62MQa4x8iK9Q==/0000000101",
    "FilmTrailerUrl":"https://www.youtube.com/watch?v=5PSNL1qE6VY"
}

Sample Response XML

<Film xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vista.Online.BackOffice.Api.Models.V1">
    <Id>ST00000032</Id>
    <Title>Avatar</Title>
    <ShortName>Avatar</ShortName>
    <Synopsis>A paraplegic Marine dispatched to the moon Pandora on a unique mission becomes torn between following his orders and protecting the world he feels is his home.</Synopsis>
    <Genre>Action</Genre>
    <SignageText>Avatar</SignageText>
    <Distributor>20th Century Fox</Distributor>
    <OpeningDate>2009-09-17T00:00:00</OpeningDate>
    <Rating>PG13</Rating>
    <Status>Active</Status>
    <Content>Restricted to persons 13 years and over</Content>
    <Duration>162</Duration>
    <DisplaySequence>22</DisplaySequence>
    <NationalCode />
    <People>
        <Id>0000000032</Id>
        <FirstName>Sam</FirstName>
        <LastName>Worthington</LastName>
        <Role>Actor</Role>
    </People>
    <People>
        <Id>HO00000176</Id>
        <FirstName>James</FirstName>
        <LastName>Cameron</LastName>
        <Role>Dicrector</Role>
    </People>
    <People>
        <Id>HO00000578</Id>
        <FirstName>Sigourney</FirstName>
        <LastName>Weaver</LastName>
        <Role>Actor</Role>
    </People>
    <Format>3D Digital</Format>
    <AudioLanguage>English</AudioLanguage>    
    <GovernmentFilmTitle>Avatar</GovernmentFilmTitle>    
    <FilmPosterUrl>http://s3.foxmovies.com/foxmovies/production/films/18/images/posters/251-asset-page.jpg</FilmPosterUrl>    
    <FilmPosterThumbnailUrl>https://cdn.useast.veezi.com/Media/data/v2/get/7DHr7RbOk62MQa4x8iK9Q==/0000000100</FilmPosterThumbnailUrl>    
    <BackdropImageUrl>https://cdn.useast.veezi.com/Media/data/v2/get/7DHr7RbOk62MQa4x8iK9Q==/0000000101</BackdropImageUrl>    
    <FilmTrailerUrl>https://www.youtube.com/watch?v=5PSNL1qE6VY</FilmTrailerUrl>
</Film>