Entertainment Express API

Analytics

getAnalyticEngagementActions

GetAnalyticEngagementActions

No required parameters, DateValue defaults to Today.


/Analytics/EngagementActions/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/EngagementActions/?ReportTag=&Start=&End=&DateValue=&Limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[EngagementActionsResponse] result = apiInstance.getAnalyticEngagementActions(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticEngagementActions");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[EngagementActionsResponse] result = apiInstance.getAnalyticEngagementActions(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticEngagementActions");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *start = start_example; // Report start date (optional)
String *end = end_example; // Report end date (optional)
String *dateValue = dateValue_example; // Days spanned by report (optional)
String *limit = limit_example; // Number of records returned from top of response (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// GetAnalyticEngagementActions
[apiInstance getAnalyticEngagementActionsWith:reportTag
    start:start
    end:end
    dateValue:dateValue
    limit:limit
              completionHandler: ^(array[EngagementActionsResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var opts = { 
  'reportTag': reportTag_example, // {String} Report Tag filter.
  'start': start_example, // {String} Report start date
  'end': end_example, // {String} Report end date
  'dateValue': dateValue_example, // {String} Days spanned by report
  'limit': limit_example // {String} Number of records returned from top of response
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticEngagementActions(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticEngagementActionsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var reportTag = reportTag_example;  // String | Report Tag filter. (optional) 
            var start = start_example;  // String | Report start date (optional) 
            var end = end_example;  // String | Report end date (optional) 
            var dateValue = dateValue_example;  // String | Days spanned by report (optional) 
            var limit = limit_example;  // String | Number of records returned from top of response (optional) 

            try
            {
                // GetAnalyticEngagementActions
                array[EngagementActionsResponse] result = apiInstance.getAnalyticEngagementActions(reportTag, start, end, dateValue, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticEngagementActions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$start = start_example; // String | Report start date
$end = end_example; // String | Report end date
$dateValue = dateValue_example; // String | Days spanned by report
$limit = limit_example; // String | Number of records returned from top of response

try {
    $result = $api_instance->getAnalyticEngagementActions($reportTag, $start, $end, $dateValue, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticEngagementActions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $start = start_example; # String | Report start date
my $end = end_example; # String | Report end date
my $dateValue = dateValue_example; # String | Days spanned by report
my $limit = limit_example; # String | Number of records returned from top of response

eval { 
    my $result = $api_instance->getAnalyticEngagementActions(reportTag => $reportTag, start => $start, end => $end, dateValue => $dateValue, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticEngagementActions: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
start = start_example # String | Report start date (optional)
end = end_example # String | Report end date (optional)
dateValue = dateValue_example # String | Days spanned by report (optional)
limit = limit_example # String | Number of records returned from top of response (optional)

try: 
    # GetAnalyticEngagementActions
    api_response = api_instance.get_analytic_engagement_actions(reportTag=reportTag, start=start, end=end, dateValue=dateValue, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticEngagementActions: %s\n" % e)

Parameters

Query parameters
Name Description
ReportTag
String
Report Tag filter.
Start
String
Report start date
End
String
Report end date
DateValue
String
Days spanned by report
Limit
String
Number of records returned from top of response

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getAnalyticsEngagementTimes

Get View count by Frequency.

No required parameters, DateValue defaults to Today.


/Analytics/EngagementTimes/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/EngagementTimes/?ReportTag=&Start=&End=&DateValue=&Limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[EngagementTimesResponse] result = apiInstance.getAnalyticsEngagementTimes(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsEngagementTimes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[EngagementTimesResponse] result = apiInstance.getAnalyticsEngagementTimes(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsEngagementTimes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *start = start_example; // Report start date (optional)
String *end = end_example; // Report end date (optional)
String *dateValue = dateValue_example; // Days spanned by report (optional)
String *limit = limit_example; // Number of records returned from top of response (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// Get View count by Frequency.
[apiInstance getAnalyticsEngagementTimesWith:reportTag
    start:start
    end:end
    dateValue:dateValue
    limit:limit
              completionHandler: ^(array[EngagementTimesResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var opts = { 
  'reportTag': reportTag_example, // {String} Report Tag filter.
  'start': start_example, // {String} Report start date
  'end': end_example, // {String} Report end date
  'dateValue': dateValue_example, // {String} Days spanned by report
  'limit': limit_example // {String} Number of records returned from top of response
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsEngagementTimes(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticsEngagementTimesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var reportTag = reportTag_example;  // String | Report Tag filter. (optional) 
            var start = start_example;  // String | Report start date (optional) 
            var end = end_example;  // String | Report end date (optional) 
            var dateValue = dateValue_example;  // String | Days spanned by report (optional) 
            var limit = limit_example;  // String | Number of records returned from top of response (optional) 

            try
            {
                // Get View count by Frequency.
                array[EngagementTimesResponse] result = apiInstance.getAnalyticsEngagementTimes(reportTag, start, end, dateValue, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsEngagementTimes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$start = start_example; // String | Report start date
$end = end_example; // String | Report end date
$dateValue = dateValue_example; // String | Days spanned by report
$limit = limit_example; // String | Number of records returned from top of response

try {
    $result = $api_instance->getAnalyticsEngagementTimes($reportTag, $start, $end, $dateValue, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsEngagementTimes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $start = start_example; # String | Report start date
my $end = end_example; # String | Report end date
my $dateValue = dateValue_example; # String | Days spanned by report
my $limit = limit_example; # String | Number of records returned from top of response

eval { 
    my $result = $api_instance->getAnalyticsEngagementTimes(reportTag => $reportTag, start => $start, end => $end, dateValue => $dateValue, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsEngagementTimes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
start = start_example # String | Report start date (optional)
end = end_example # String | Report end date (optional)
dateValue = dateValue_example # String | Days spanned by report (optional)
limit = limit_example # String | Number of records returned from top of response (optional)

try: 
    # Get View count by Frequency.
    api_response = api_instance.get_analytics_engagement_times(reportTag=reportTag, start=start, end=end, dateValue=dateValue, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsEngagementTimes: %s\n" % e)

Parameters

Query parameters
Name Description
ReportTag
String
Report Tag filter.
Start
String
Report start date
End
String
Report end date
DateValue
String
Days spanned by report
Limit
String
Number of records returned from top of response

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getAnalyticsGBUsage

Get GBUsage by Customer ID.

Requires a valid Customer ID.


/Analytics/GBUsage/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/GBUsage/?ReportTag=&Month=&Year="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String month = month_example; // String | Report month
        String year = year_example; // String | Report year
        try {
            GBUsageResponse result = apiInstance.getAnalyticsGBUsage(reportTag, month, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsGBUsage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String month = month_example; // String | Report month
        String year = year_example; // String | Report year
        try {
            GBUsageResponse result = apiInstance.getAnalyticsGBUsage(reportTag, month, year);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsGBUsage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *month = month_example; // Report month (optional)
String *year = year_example; // Report year (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// Get GBUsage by Customer ID.
[apiInstance getAnalyticsGBUsageWith:reportTag
    month:month
    year:year
              completionHandler: ^(GBUsageResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var opts = { 
  'reportTag': reportTag_example, // {String} Report Tag filter.
  'month': month_example, // {String} Report month
  'year': year_example // {String} Report year
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsGBUsage(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticsGBUsageExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var reportTag = reportTag_example;  // String | Report Tag filter. (optional) 
            var month = month_example;  // String | Report month (optional) 
            var year = year_example;  // String | Report year (optional) 

            try
            {
                // Get GBUsage by Customer ID.
                GBUsageResponse result = apiInstance.getAnalyticsGBUsage(reportTag, month, year);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsGBUsage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$month = month_example; // String | Report month
$year = year_example; // String | Report year

try {
    $result = $api_instance->getAnalyticsGBUsage($reportTag, $month, $year);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsGBUsage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $month = month_example; # String | Report month
my $year = year_example; # String | Report year

eval { 
    my $result = $api_instance->getAnalyticsGBUsage(reportTag => $reportTag, month => $month, year => $year);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsGBUsage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
month = month_example # String | Report month (optional)
year = year_example # String | Report year (optional)

try: 
    # Get GBUsage by Customer ID.
    api_response = api_instance.get_analytics_gb_usage(reportTag=reportTag, month=month, year=year)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsGBUsage: %s\n" % e)

Parameters

Query parameters
Name Description
ReportTag
String
Report Tag filter.
Month
String
Report month
Year
String
Report year

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getAnalyticsMostActive

Get Most Active Visitors by IP.

No required parameters, DateValue defaults to Today.


/Analytics/MostActive/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/MostActive/?ReportTag=&DateValue=&Limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[MostActiveResponse] result = apiInstance.getAnalyticsMostActive(reportTag, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsMostActive");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[MostActiveResponse] result = apiInstance.getAnalyticsMostActive(reportTag, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsMostActive");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *dateValue = dateValue_example; // Days spanned by report (optional)
String *limit = limit_example; // Number of records returned from top of response (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// Get Most Active Visitors by IP.
[apiInstance getAnalyticsMostActiveWith:reportTag
    dateValue:dateValue
    limit:limit
              completionHandler: ^(array[MostActiveResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var opts = { 
  'reportTag': reportTag_example, // {String} Report Tag filter.
  'dateValue': dateValue_example, // {String} Days spanned by report
  'limit': limit_example // {String} Number of records returned from top of response
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsMostActive(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticsMostActiveExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var reportTag = reportTag_example;  // String | Report Tag filter. (optional) 
            var dateValue = dateValue_example;  // String | Days spanned by report (optional) 
            var limit = limit_example;  // String | Number of records returned from top of response (optional) 

            try
            {
                // Get Most Active Visitors by IP.
                array[MostActiveResponse] result = apiInstance.getAnalyticsMostActive(reportTag, dateValue, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsMostActive: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$dateValue = dateValue_example; // String | Days spanned by report
$limit = limit_example; // String | Number of records returned from top of response

try {
    $result = $api_instance->getAnalyticsMostActive($reportTag, $dateValue, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsMostActive: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $dateValue = dateValue_example; # String | Days spanned by report
my $limit = limit_example; # String | Number of records returned from top of response

eval { 
    my $result = $api_instance->getAnalyticsMostActive(reportTag => $reportTag, dateValue => $dateValue, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsMostActive: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
dateValue = dateValue_example # String | Days spanned by report (optional)
limit = limit_example # String | Number of records returned from top of response (optional)

try: 
    # Get Most Active Visitors by IP.
    api_response = api_instance.get_analytics_most_active(reportTag=reportTag, dateValue=dateValue, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsMostActive: %s\n" % e)

Parameters

Query parameters
Name Description
ReportTag
String
Report Tag filter.
DateValue
String
Days spanned by report
Limit
String
Number of records returned from top of response

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getAnalyticsRecentVisitors

Get Most Recent Visitors by Time.

No required parameters, DateValue defaults to Today.


/Analytics/RecentVisitors/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/RecentVisitors/?ReportTag=&Limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[RecentVisitorsResponse] result = apiInstance.getAnalyticsRecentVisitors(reportTag, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsRecentVisitors");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[RecentVisitorsResponse] result = apiInstance.getAnalyticsRecentVisitors(reportTag, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsRecentVisitors");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *limit = limit_example; // Number of records returned from top of response (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// Get Most Recent Visitors by Time.
[apiInstance getAnalyticsRecentVisitorsWith:reportTag
    limit:limit
              completionHandler: ^(array[RecentVisitorsResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var opts = { 
  'reportTag': reportTag_example, // {String} Report Tag filter.
  'limit': limit_example // {String} Number of records returned from top of response
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsRecentVisitors(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticsRecentVisitorsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var reportTag = reportTag_example;  // String | Report Tag filter. (optional) 
            var limit = limit_example;  // String | Number of records returned from top of response (optional) 

            try
            {
                // Get Most Recent Visitors by Time.
                array[RecentVisitorsResponse] result = apiInstance.getAnalyticsRecentVisitors(reportTag, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsRecentVisitors: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$limit = limit_example; // String | Number of records returned from top of response

try {
    $result = $api_instance->getAnalyticsRecentVisitors($reportTag, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsRecentVisitors: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $limit = limit_example; # String | Number of records returned from top of response

eval { 
    my $result = $api_instance->getAnalyticsRecentVisitors(reportTag => $reportTag, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsRecentVisitors: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
limit = limit_example # String | Number of records returned from top of response (optional)

try: 
    # Get Most Recent Visitors by Time.
    api_response = api_instance.get_analytics_recent_visitors(reportTag=reportTag, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsRecentVisitors: %s\n" % e)

Parameters

Query parameters
Name Description
ReportTag
String
Report Tag filter.
Limit
String
Number of records returned from top of response

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getAnalyticsSummary

Get Summary by Customer ID.

Requires a valid Customer ID.


/Analytics/Summary/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/Summary/?ReportTag=&DateValue="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String dateValue = dateValue_example; // String | Days spanned by report
        try {
            SummaryResponse result = apiInstance.getAnalyticsSummary(reportTag, dateValue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsSummary");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String dateValue = dateValue_example; // String | Days spanned by report
        try {
            SummaryResponse result = apiInstance.getAnalyticsSummary(reportTag, dateValue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsSummary");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *dateValue = dateValue_example; // Days spanned by report (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// Get Summary by Customer ID.
[apiInstance getAnalyticsSummaryWith:reportTag
    dateValue:dateValue
              completionHandler: ^(SummaryResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var opts = { 
  'reportTag': reportTag_example, // {String} Report Tag filter.
  'dateValue': dateValue_example // {String} Days spanned by report
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsSummary(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticsSummaryExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var reportTag = reportTag_example;  // String | Report Tag filter. (optional) 
            var dateValue = dateValue_example;  // String | Days spanned by report (optional) 

            try
            {
                // Get Summary by Customer ID.
                SummaryResponse result = apiInstance.getAnalyticsSummary(reportTag, dateValue);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsSummary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$dateValue = dateValue_example; // String | Days spanned by report

try {
    $result = $api_instance->getAnalyticsSummary($reportTag, $dateValue);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsSummary: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $dateValue = dateValue_example; # String | Days spanned by report

eval { 
    my $result = $api_instance->getAnalyticsSummary(reportTag => $reportTag, dateValue => $dateValue);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsSummary: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
dateValue = dateValue_example # String | Days spanned by report (optional)

try: 
    # Get Summary by Customer ID.
    api_response = api_instance.get_analytics_summary(reportTag=reportTag, dateValue=dateValue)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsSummary: %s\n" % e)

Parameters

Query parameters
Name Description
ReportTag
String
Report Tag filter.
DateValue
String
Days spanned by report

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getAnalyticsTitleReport

Get Title Report by PublishedID.

Requires a valid published ID.


/Analytics/TitleReport/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/TitleReport/?PublishedId=&Start=&End="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String publishedId = publishedId_example; // String | Title published ID.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        try {
            array[TitleReportResponse] result = apiInstance.getAnalyticsTitleReport(publishedId, start, end);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsTitleReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String publishedId = publishedId_example; // String | Title published ID.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        try {
            array[TitleReportResponse] result = apiInstance.getAnalyticsTitleReport(publishedId, start, end);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsTitleReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *publishedId = publishedId_example; // Title published ID.
String *start = start_example; // Report start date (optional)
String *end = end_example; // Report end date (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// Get Title Report by PublishedID.
[apiInstance getAnalyticsTitleReportWith:publishedId
    start:start
    end:end
              completionHandler: ^(array[TitleReportResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var publishedId = publishedId_example; // {String} Title published ID.

var opts = { 
  'start': start_example, // {String} Report start date
  'end': end_example // {String} Report end date
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsTitleReport(publishedId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticsTitleReportExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var publishedId = publishedId_example;  // String | Title published ID.
            var start = start_example;  // String | Report start date (optional) 
            var end = end_example;  // String | Report end date (optional) 

            try
            {
                // Get Title Report by PublishedID.
                array[TitleReportResponse] result = apiInstance.getAnalyticsTitleReport(publishedId, start, end);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsTitleReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$publishedId = publishedId_example; // String | Title published ID.
$start = start_example; // String | Report start date
$end = end_example; // String | Report end date

try {
    $result = $api_instance->getAnalyticsTitleReport($publishedId, $start, $end);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsTitleReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $publishedId = publishedId_example; # String | Title published ID.
my $start = start_example; # String | Report start date
my $end = end_example; # String | Report end date

eval { 
    my $result = $api_instance->getAnalyticsTitleReport(publishedId => $publishedId, start => $start, end => $end);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsTitleReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
publishedId = publishedId_example # String | Title published ID.
start = start_example # String | Report start date (optional)
end = end_example # String | Report end date (optional)

try: 
    # Get Title Report by PublishedID.
    api_response = api_instance.get_analytics_title_report(publishedId, start=start, end=end)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsTitleReport: %s\n" % e)

Parameters

Query parameters
Name Description
PublishedId*
String
Title published ID.
Required
Start
String
Report start date
End
String
Report end date

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getAnalyticsViewers

Get viewers by Day.

Optional DateValue for length of report.


/Analytics/Viewers/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/Viewers/?ReportTag=&DateValue="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String dateValue = dateValue_example; // String | Days spanned by report
        try {
            array[ViewersResponse] result = apiInstance.getAnalyticsViewers(reportTag, dateValue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViewers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String dateValue = dateValue_example; // String | Days spanned by report
        try {
            array[ViewersResponse] result = apiInstance.getAnalyticsViewers(reportTag, dateValue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViewers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *dateValue = dateValue_example; // Days spanned by report (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// Get viewers by Day.
[apiInstance getAnalyticsViewersWith:reportTag
    dateValue:dateValue
              completionHandler: ^(array[ViewersResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var opts = { 
  'reportTag': reportTag_example, // {String} Report Tag filter.
  'dateValue': dateValue_example // {String} Days spanned by report
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsViewers(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticsViewersExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var reportTag = reportTag_example;  // String | Report Tag filter. (optional) 
            var dateValue = dateValue_example;  // String | Days spanned by report (optional) 

            try
            {
                // Get viewers by Day.
                array[ViewersResponse] result = apiInstance.getAnalyticsViewers(reportTag, dateValue);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsViewers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$dateValue = dateValue_example; // String | Days spanned by report

try {
    $result = $api_instance->getAnalyticsViewers($reportTag, $dateValue);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsViewers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $dateValue = dateValue_example; # String | Days spanned by report

eval { 
    my $result = $api_instance->getAnalyticsViewers(reportTag => $reportTag, dateValue => $dateValue);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsViewers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
dateValue = dateValue_example # String | Days spanned by report (optional)

try: 
    # Get viewers by Day.
    api_response = api_instance.get_analytics_viewers(reportTag=reportTag, dateValue=dateValue)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsViewers: %s\n" % e)

Parameters

Query parameters
Name Description
ReportTag
String
Report Tag filter.
DateValue
String
Days spanned by report

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getAnalyticsViewersByCity

Get Viewers by City.

No required parameters, DateValue defaults to Today..


/Analytics/City/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/City/?ReportTag=&Start=&End=&DateValue=&Limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[CityResponse] result = apiInstance.getAnalyticsViewersByCity(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViewersByCity");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[CityResponse] result = apiInstance.getAnalyticsViewersByCity(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViewersByCity");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *start = start_example; // Report start date (optional)
String *end = end_example; // Report end date (optional)
String *dateValue = dateValue_example; // Days spanned by report (optional)
String *limit = limit_example; // Number of records returned from top of response (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// Get Viewers by City.
[apiInstance getAnalyticsViewersByCityWith:reportTag
    start:start
    end:end
    dateValue:dateValue
    limit:limit
              completionHandler: ^(array[CityResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var opts = { 
  'reportTag': reportTag_example, // {String} Report Tag filter.
  'start': start_example, // {String} Report start date
  'end': end_example, // {String} Report end date
  'dateValue': dateValue_example, // {String} Days spanned by report
  'limit': limit_example // {String} Number of records returned from top of response
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsViewersByCity(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticsViewersByCityExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var reportTag = reportTag_example;  // String | Report Tag filter. (optional) 
            var start = start_example;  // String | Report start date (optional) 
            var end = end_example;  // String | Report end date (optional) 
            var dateValue = dateValue_example;  // String | Days spanned by report (optional) 
            var limit = limit_example;  // String | Number of records returned from top of response (optional) 

            try
            {
                // Get Viewers by City.
                array[CityResponse] result = apiInstance.getAnalyticsViewersByCity(reportTag, start, end, dateValue, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsViewersByCity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$start = start_example; // String | Report start date
$end = end_example; // String | Report end date
$dateValue = dateValue_example; // String | Days spanned by report
$limit = limit_example; // String | Number of records returned from top of response

try {
    $result = $api_instance->getAnalyticsViewersByCity($reportTag, $start, $end, $dateValue, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsViewersByCity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $start = start_example; # String | Report start date
my $end = end_example; # String | Report end date
my $dateValue = dateValue_example; # String | Days spanned by report
my $limit = limit_example; # String | Number of records returned from top of response

eval { 
    my $result = $api_instance->getAnalyticsViewersByCity(reportTag => $reportTag, start => $start, end => $end, dateValue => $dateValue, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsViewersByCity: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
start = start_example # String | Report start date (optional)
end = end_example # String | Report end date (optional)
dateValue = dateValue_example # String | Days spanned by report (optional)
limit = limit_example # String | Number of records returned from top of response (optional)

try: 
    # Get Viewers by City.
    api_response = api_instance.get_analytics_viewers_by_city(reportTag=reportTag, start=start, end=end, dateValue=dateValue, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsViewersByCity: %s\n" % e)

Parameters

Query parameters
Name Description
ReportTag
String
Report Tag filter.
Start
String
Report start date
End
String
Report end date
DateValue
String
Days spanned by report
Limit
String
Number of records returned from top of response

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getAnalyticsViewersByCountry

Get Viewers by Country.

No required parameters, DateValue defaults to Today.


/Analytics/Country/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/Country/?ReportTag=&Start=&End=&DateValue=&Limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response.
        try {
            array[AnalyticsCountryResponse] result = apiInstance.getAnalyticsViewersByCountry(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViewersByCountry");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response.
        try {
            array[AnalyticsCountryResponse] result = apiInstance.getAnalyticsViewersByCountry(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViewersByCountry");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *start = start_example; // Report start date (optional)
String *end = end_example; // Report end date (optional)
String *dateValue = dateValue_example; // Days spanned by report (optional)
String *limit = limit_example; // Number of records returned from top of response. (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// Get Viewers by Country.
[apiInstance getAnalyticsViewersByCountryWith:reportTag
    start:start
    end:end
    dateValue:dateValue
    limit:limit
              completionHandler: ^(array[AnalyticsCountryResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var opts = { 
  'reportTag': reportTag_example, // {String} Report Tag filter.
  'start': start_example, // {String} Report start date
  'end': end_example, // {String} Report end date
  'dateValue': dateValue_example, // {String} Days spanned by report
  'limit': limit_example // {String} Number of records returned from top of response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsViewersByCountry(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticsViewersByCountryExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var reportTag = reportTag_example;  // String | Report Tag filter. (optional) 
            var start = start_example;  // String | Report start date (optional) 
            var end = end_example;  // String | Report end date (optional) 
            var dateValue = dateValue_example;  // String | Days spanned by report (optional) 
            var limit = limit_example;  // String | Number of records returned from top of response. (optional) 

            try
            {
                // Get Viewers by Country.
                array[AnalyticsCountryResponse] result = apiInstance.getAnalyticsViewersByCountry(reportTag, start, end, dateValue, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsViewersByCountry: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$start = start_example; // String | Report start date
$end = end_example; // String | Report end date
$dateValue = dateValue_example; // String | Days spanned by report
$limit = limit_example; // String | Number of records returned from top of response.

try {
    $result = $api_instance->getAnalyticsViewersByCountry($reportTag, $start, $end, $dateValue, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsViewersByCountry: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $start = start_example; # String | Report start date
my $end = end_example; # String | Report end date
my $dateValue = dateValue_example; # String | Days spanned by report
my $limit = limit_example; # String | Number of records returned from top of response.

eval { 
    my $result = $api_instance->getAnalyticsViewersByCountry(reportTag => $reportTag, start => $start, end => $end, dateValue => $dateValue, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsViewersByCountry: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
start = start_example # String | Report start date (optional)
end = end_example # String | Report end date (optional)
dateValue = dateValue_example # String | Days spanned by report (optional)
limit = limit_example # String | Number of records returned from top of response. (optional)

try: 
    # Get Viewers by Country.
    api_response = api_instance.get_analytics_viewers_by_country(reportTag=reportTag, start=start, end=end, dateValue=dateValue, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsViewersByCountry: %s\n" % e)

Parameters

Query parameters
Name Description
ReportTag
String
Report Tag filter.
Start
String
Report start date
End
String
Report end date
DateValue
String
Days spanned by report
Limit
String
Number of records returned from top of response.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getAnalyticsViewersByPlatformHardware

Get Viewers by Platform Hardware.

No required parameters, DateValue defaults to Today.


/Analytics/PlatformHardware/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/PlatformHardware/?ReportTag=&Start=&End=&DateValue=&Limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[PlatformHardwareResponse] result = apiInstance.getAnalyticsViewersByPlatformHardware(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViewersByPlatformHardware");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[PlatformHardwareResponse] result = apiInstance.getAnalyticsViewersByPlatformHardware(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViewersByPlatformHardware");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *start = start_example; // Report start date (optional)
String *end = end_example; // Report end date (optional)
String *dateValue = dateValue_example; // Days spanned by report (optional)
String *limit = limit_example; // Number of records returned from top of response (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// Get Viewers by Platform Hardware.
[apiInstance getAnalyticsViewersByPlatformHardwareWith:reportTag
    start:start
    end:end
    dateValue:dateValue
    limit:limit
              completionHandler: ^(array[PlatformHardwareResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var opts = { 
  'reportTag': reportTag_example, // {String} Report Tag filter.
  'start': start_example, // {String} Report start date
  'end': end_example, // {String} Report end date
  'dateValue': dateValue_example, // {String} Days spanned by report
  'limit': limit_example // {String} Number of records returned from top of response
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsViewersByPlatformHardware(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticsViewersByPlatformHardwareExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var reportTag = reportTag_example;  // String | Report Tag filter. (optional) 
            var start = start_example;  // String | Report start date (optional) 
            var end = end_example;  // String | Report end date (optional) 
            var dateValue = dateValue_example;  // String | Days spanned by report (optional) 
            var limit = limit_example;  // String | Number of records returned from top of response (optional) 

            try
            {
                // Get Viewers by Platform Hardware.
                array[PlatformHardwareResponse] result = apiInstance.getAnalyticsViewersByPlatformHardware(reportTag, start, end, dateValue, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsViewersByPlatformHardware: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$start = start_example; // String | Report start date
$end = end_example; // String | Report end date
$dateValue = dateValue_example; // String | Days spanned by report
$limit = limit_example; // String | Number of records returned from top of response

try {
    $result = $api_instance->getAnalyticsViewersByPlatformHardware($reportTag, $start, $end, $dateValue, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsViewersByPlatformHardware: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $start = start_example; # String | Report start date
my $end = end_example; # String | Report end date
my $dateValue = dateValue_example; # String | Days spanned by report
my $limit = limit_example; # String | Number of records returned from top of response

eval { 
    my $result = $api_instance->getAnalyticsViewersByPlatformHardware(reportTag => $reportTag, start => $start, end => $end, dateValue => $dateValue, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsViewersByPlatformHardware: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
start = start_example # String | Report start date (optional)
end = end_example # String | Report end date (optional)
dateValue = dateValue_example # String | Days spanned by report (optional)
limit = limit_example # String | Number of records returned from top of response (optional)

try: 
    # Get Viewers by Platform Hardware.
    api_response = api_instance.get_analytics_viewers_by_platform_hardware(reportTag=reportTag, start=start, end=end, dateValue=dateValue, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsViewersByPlatformHardware: %s\n" % e)

Parameters

Query parameters
Name Description
ReportTag
String
Report Tag filter.
Start
String
Report start date
End
String
Report end date
DateValue
String
Days spanned by report
Limit
String
Number of records returned from top of response

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getAnalyticsViewersByPlatformOS

Get Viewers by Platform OS.

No required parameters, DateValue defaults to Today.


/Analytics/PlatformOS/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/PlatformOS/?ReportTag=&Start=&End=&DateValue=&Limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[PlatformOSResponse] result = apiInstance.getAnalyticsViewersByPlatformOS(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViewersByPlatformOS");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[PlatformOSResponse] result = apiInstance.getAnalyticsViewersByPlatformOS(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViewersByPlatformOS");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *start = start_example; // Report start date (optional)
String *end = end_example; // Report end date (optional)
String *dateValue = dateValue_example; // Days spanned by report (optional)
String *limit = limit_example; // Number of records returned from top of response (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// Get Viewers by Platform OS.
[apiInstance getAnalyticsViewersByPlatformOSWith:reportTag
    start:start
    end:end
    dateValue:dateValue
    limit:limit
              completionHandler: ^(array[PlatformOSResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var opts = { 
  'reportTag': reportTag_example, // {String} Report Tag filter.
  'start': start_example, // {String} Report start date
  'end': end_example, // {String} Report end date
  'dateValue': dateValue_example, // {String} Days spanned by report
  'limit': limit_example // {String} Number of records returned from top of response
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsViewersByPlatformOS(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticsViewersByPlatformOSExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var reportTag = reportTag_example;  // String | Report Tag filter. (optional) 
            var start = start_example;  // String | Report start date (optional) 
            var end = end_example;  // String | Report end date (optional) 
            var dateValue = dateValue_example;  // String | Days spanned by report (optional) 
            var limit = limit_example;  // String | Number of records returned from top of response (optional) 

            try
            {
                // Get Viewers by Platform OS.
                array[PlatformOSResponse] result = apiInstance.getAnalyticsViewersByPlatformOS(reportTag, start, end, dateValue, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsViewersByPlatformOS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$start = start_example; // String | Report start date
$end = end_example; // String | Report end date
$dateValue = dateValue_example; // String | Days spanned by report
$limit = limit_example; // String | Number of records returned from top of response

try {
    $result = $api_instance->getAnalyticsViewersByPlatformOS($reportTag, $start, $end, $dateValue, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsViewersByPlatformOS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $start = start_example; # String | Report start date
my $end = end_example; # String | Report end date
my $dateValue = dateValue_example; # String | Days spanned by report
my $limit = limit_example; # String | Number of records returned from top of response

eval { 
    my $result = $api_instance->getAnalyticsViewersByPlatformOS(reportTag => $reportTag, start => $start, end => $end, dateValue => $dateValue, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsViewersByPlatformOS: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
start = start_example # String | Report start date (optional)
end = end_example # String | Report end date (optional)
dateValue = dateValue_example # String | Days spanned by report (optional)
limit = limit_example # String | Number of records returned from top of response (optional)

try: 
    # Get Viewers by Platform OS.
    api_response = api_instance.get_analytics_viewers_by_platform_os(reportTag=reportTag, start=start, end=end, dateValue=dateValue, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsViewersByPlatformOS: %s\n" % e)

Parameters

Query parameters
Name Description
ReportTag
String
Report Tag filter.
Start
String
Report start date
End
String
Report end date
DateValue
String
Days spanned by report
Limit
String
Number of records returned from top of response

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getAnalyticsViewersByWebBrowsers

Get Viewers by Web Browser.

No required parameters, DateValue defaults to Today.


/Analytics/WebBrowsers/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/WebBrowsers/?ReportTag=&Start=&End=&DateValue=&Limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[WebBrowsersResponse] result = apiInstance.getAnalyticsViewersByWebBrowsers(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViewersByWebBrowsers");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[WebBrowsersResponse] result = apiInstance.getAnalyticsViewersByWebBrowsers(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViewersByWebBrowsers");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *start = start_example; // Report start date (optional)
String *end = end_example; // Report end date (optional)
String *dateValue = dateValue_example; // Days spanned by report (optional)
String *limit = limit_example; // Number of records returned from top of response (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// Get Viewers by Web Browser.
[apiInstance getAnalyticsViewersByWebBrowsersWith:reportTag
    start:start
    end:end
    dateValue:dateValue
    limit:limit
              completionHandler: ^(array[WebBrowsersResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var opts = { 
  'reportTag': reportTag_example, // {String} Report Tag filter.
  'start': start_example, // {String} Report start date
  'end': end_example, // {String} Report end date
  'dateValue': dateValue_example, // {String} Days spanned by report
  'limit': limit_example // {String} Number of records returned from top of response
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsViewersByWebBrowsers(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticsViewersByWebBrowsersExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var reportTag = reportTag_example;  // String | Report Tag filter. (optional) 
            var start = start_example;  // String | Report start date (optional) 
            var end = end_example;  // String | Report end date (optional) 
            var dateValue = dateValue_example;  // String | Days spanned by report (optional) 
            var limit = limit_example;  // String | Number of records returned from top of response (optional) 

            try
            {
                // Get Viewers by Web Browser.
                array[WebBrowsersResponse] result = apiInstance.getAnalyticsViewersByWebBrowsers(reportTag, start, end, dateValue, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsViewersByWebBrowsers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$start = start_example; // String | Report start date
$end = end_example; // String | Report end date
$dateValue = dateValue_example; // String | Days spanned by report
$limit = limit_example; // String | Number of records returned from top of response

try {
    $result = $api_instance->getAnalyticsViewersByWebBrowsers($reportTag, $start, $end, $dateValue, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsViewersByWebBrowsers: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $start = start_example; # String | Report start date
my $end = end_example; # String | Report end date
my $dateValue = dateValue_example; # String | Days spanned by report
my $limit = limit_example; # String | Number of records returned from top of response

eval { 
    my $result = $api_instance->getAnalyticsViewersByWebBrowsers(reportTag => $reportTag, start => $start, end => $end, dateValue => $dateValue, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsViewersByWebBrowsers: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
start = start_example # String | Report start date (optional)
end = end_example # String | Report end date (optional)
dateValue = dateValue_example # String | Days spanned by report (optional)
limit = limit_example # String | Number of records returned from top of response (optional)

try: 
    # Get Viewers by Web Browser.
    api_response = api_instance.get_analytics_viewers_by_web_browsers(reportTag=reportTag, start=start, end=end, dateValue=dateValue, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsViewersByWebBrowsers: %s\n" % e)

Parameters

Query parameters
Name Description
ReportTag
String
Report Tag filter.
Start
String
Report start date
End
String
Report end date
DateValue
String
Days spanned by report
Limit
String
Number of records returned from top of response

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getAnalyticsViews

Get views by Day.

Optional DateValue for length of report.


/Analytics/Views/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/Views/?ReportTag=&DateValue="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String dateValue = dateValue_example; // String | Days spanned by report
        try {
            array[ViewsResponse] result = apiInstance.getAnalyticsViews(reportTag, dateValue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViews");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String dateValue = dateValue_example; // String | Days spanned by report
        try {
            array[ViewsResponse] result = apiInstance.getAnalyticsViews(reportTag, dateValue);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViews");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *dateValue = dateValue_example; // Days spanned by report (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// Get views by Day.
[apiInstance getAnalyticsViewsWith:reportTag
    dateValue:dateValue
              completionHandler: ^(array[ViewsResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var opts = { 
  'reportTag': reportTag_example, // {String} Report Tag filter.
  'dateValue': dateValue_example // {String} Days spanned by report
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsViews(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticsViewsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var reportTag = reportTag_example;  // String | Report Tag filter. (optional) 
            var dateValue = dateValue_example;  // String | Days spanned by report (optional) 

            try
            {
                // Get views by Day.
                array[ViewsResponse] result = apiInstance.getAnalyticsViews(reportTag, dateValue);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsViews: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$dateValue = dateValue_example; // String | Days spanned by report

try {
    $result = $api_instance->getAnalyticsViews($reportTag, $dateValue);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsViews: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $dateValue = dateValue_example; # String | Days spanned by report

eval { 
    my $result = $api_instance->getAnalyticsViews(reportTag => $reportTag, dateValue => $dateValue);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsViews: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
dateValue = dateValue_example # String | Days spanned by report (optional)

try: 
    # Get views by Day.
    api_response = api_instance.get_analytics_views(reportTag=reportTag, dateValue=dateValue)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsViews: %s\n" % e)

Parameters

Query parameters
Name Description
ReportTag
String
Report Tag filter.
DateValue
String
Days spanned by report

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getAnalyticsViewsByVideoLog

Get Views by Video.

No required parameters, DateValue defaults to Today.


/Analytics/VideoLog/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Analytics/VideoLog/?ReportTag=&Start=&End=&DateValue=&Limit="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

import java.io.File;
import java.util.*;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[VideoLogResponse] result = apiInstance.getAnalyticsViewsByVideoLog(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViewsByVideoLog");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String reportTag = reportTag_example; // String | Report Tag filter.
        String start = start_example; // String | Report start date
        String end = end_example; // String | Report end date
        String dateValue = dateValue_example; // String | Days spanned by report
        String limit = limit_example; // String | Number of records returned from top of response
        try {
            array[VideoLogResponse] result = apiInstance.getAnalyticsViewsByVideoLog(reportTag, start, end, dateValue, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAnalyticsViewsByVideoLog");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *reportTag = reportTag_example; // Report Tag filter. (optional)
String *start = start_example; // Report start date (optional)
String *end = end_example; // Report end date (optional)
String *dateValue = dateValue_example; // Days spanned by report (optional)
String *limit = limit_example; // Number of records returned from top of response (optional)

AnalyticsApi *apiInstance = [[AnalyticsApi alloc] init];

// Get Views by Video.
[apiInstance getAnalyticsViewsByVideoLogWith:reportTag
    start:start
    end:end
    dateValue:dateValue
    limit:limit
              completionHandler: ^(array[VideoLogResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.AnalyticsApi()

var opts = { 
  'reportTag': reportTag_example, // {String} Report Tag filter.
  'start': start_example, // {String} Report start date
  'end': end_example, // {String} Report end date
  'dateValue': dateValue_example, // {String} Days spanned by report
  'limit': limit_example // {String} Number of records returned from top of response
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyticsViewsByVideoLog(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAnalyticsViewsByVideoLogExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new AnalyticsApi();
            var reportTag = reportTag_example;  // String | Report Tag filter. (optional) 
            var start = start_example;  // String | Report start date (optional) 
            var end = end_example;  // String | Report end date (optional) 
            var dateValue = dateValue_example;  // String | Days spanned by report (optional) 
            var limit = limit_example;  // String | Number of records returned from top of response (optional) 

            try
            {
                // Get Views by Video.
                array[VideoLogResponse] result = apiInstance.getAnalyticsViewsByVideoLog(reportTag, start, end, dateValue, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAnalyticsViewsByVideoLog: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\AnalyticsApi();
$reportTag = reportTag_example; // String | Report Tag filter.
$start = start_example; // String | Report start date
$end = end_example; // String | Report end date
$dateValue = dateValue_example; // String | Days spanned by report
$limit = limit_example; // String | Number of records returned from top of response

try {
    $result = $api_instance->getAnalyticsViewsByVideoLog($reportTag, $start, $end, $dateValue, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAnalyticsViewsByVideoLog: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $reportTag = reportTag_example; # String | Report Tag filter.
my $start = start_example; # String | Report start date
my $end = end_example; # String | Report end date
my $dateValue = dateValue_example; # String | Days spanned by report
my $limit = limit_example; # String | Number of records returned from top of response

eval { 
    my $result = $api_instance->getAnalyticsViewsByVideoLog(reportTag => $reportTag, start => $start, end => $end, dateValue => $dateValue, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAnalyticsViewsByVideoLog: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.AnalyticsApi()
reportTag = reportTag_example # String | Report Tag filter. (optional)
start = start_example # String | Report start date (optional)
end = end_example # String | Report end date (optional)
dateValue = dateValue_example # String | Days spanned by report (optional)
limit = limit_example # String | Number of records returned from top of response (optional)

try: 
    # Get Views by Video.
    api_response = api_instance.get_analytics_views_by_video_log(reportTag=reportTag, start=start, end=end, dateValue=dateValue, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAnalyticsViewsByVideoLog: %s\n" % e)

Parameters

Query parameters
Name Description
ReportTag
String
Report Tag filter.
Start
String
Report start date
End
String
Report end date
DateValue
String
Days spanned by report
Limit
String
Number of records returned from top of response

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


Changes

getEpisodeChangeHistory

Returns list of unique EpisodeId changes greater than or equal to date (UTC)

For each updated episode ID, pull the full episode data for that ID and update.


/Changes/Episodes/History/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Changes/Episodes/History/?Date=&Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChangesApi;

import java.io.File;
import java.util.*;

public class ChangesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[EpisodeChangeHistoryResponse] result = apiInstance.getEpisodeChangeHistory(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getEpisodeChangeHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChangesApi;

public class ChangesApiExample {

    public static void main(String[] args) {
        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[EpisodeChangeHistoryResponse] result = apiInstance.getEpisodeChangeHistory(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getEpisodeChangeHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *date = date_example; // Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Integer *skip = 56; // Offset for paging. Default is 0.
Integer *take = 56; // Maximum number of rows returned. Default is 1,000.

ChangesApi *apiInstance = [[ChangesApi alloc] init];

// Returns list of unique EpisodeId changes greater than or equal to date (UTC)
[apiInstance getEpisodeChangeHistoryWith:date
    skip:skip
    take:take
              completionHandler: ^(array[EpisodeChangeHistoryResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ChangesApi()

var date = date_example; // {String} Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z

var skip = 56; // {Integer} Offset for paging. Default is 0.

var take = 56; // {Integer} Maximum number of rows returned. Default is 1,000.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEpisodeChangeHistory(date, skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEpisodeChangeHistoryExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ChangesApi();
            var date = date_example;  // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
            var skip = 56;  // Integer | Offset for paging. Default is 0.
            var take = 56;  // Integer | Maximum number of rows returned. Default is 1,000.

            try
            {
                // Returns list of unique EpisodeId changes greater than or equal to date (UTC)
                array[EpisodeChangeHistoryResponse] result = apiInstance.getEpisodeChangeHistory(date, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChangesApi.getEpisodeChangeHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ChangesApi();
$date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
$skip = 56; // Integer | Offset for paging. Default is 0.
$take = 56; // Integer | Maximum number of rows returned. Default is 1,000.

try {
    $result = $api_instance->getEpisodeChangeHistory($date, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChangesApi->getEpisodeChangeHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChangesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChangesApi->new();
my $date = date_example; # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
my $skip = 56; # Integer | Offset for paging. Default is 0.
my $take = 56; # Integer | Maximum number of rows returned. Default is 1,000.

eval { 
    my $result = $api_instance->getEpisodeChangeHistory(date => $date, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChangesApi->getEpisodeChangeHistory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChangesApi()
date = date_example # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
skip = 56 # Integer | Offset for paging. Default is 0.
take = 56 # Integer | Maximum number of rows returned. Default is 1,000.

try: 
    # Returns list of unique EpisodeId changes greater than or equal to date (UTC)
    api_response = api_instance.get_episode_change_history(date, skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangesApi->getEpisodeChangeHistory: %s\n" % e)

Parameters

Query parameters
Name Description
Date*
String
Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Required
Skip*
Integer
Offset for paging. Default is 0.
Required
Take*
Integer
Maximum number of rows returned. Default is 1,000.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getEpisodeChangeHistoryWithEntity

Returns list of unique EpisodeId and Entity changes greater than or equal to date (UTC).

Lists each episode ID that has changed as well as the entity in the object that changed.


/Changes/Episodes/HistoryWithEntity/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Changes/Episodes/HistoryWithEntity/?Date=&Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChangesApi;

import java.io.File;
import java.util.*;

public class ChangesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[EpisodeChangeHistoryWithEntityResponse] result = apiInstance.getEpisodeChangeHistoryWithEntity(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getEpisodeChangeHistoryWithEntity");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChangesApi;

public class ChangesApiExample {

    public static void main(String[] args) {
        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[EpisodeChangeHistoryWithEntityResponse] result = apiInstance.getEpisodeChangeHistoryWithEntity(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getEpisodeChangeHistoryWithEntity");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *date = date_example; // Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Integer *skip = 56; // Offset for paging. Default is 0.
Integer *take = 56; // Maximum number of rows returned. Default is 1,000.

ChangesApi *apiInstance = [[ChangesApi alloc] init];

// Returns list of unique EpisodeId and Entity changes greater than or equal to date (UTC).
[apiInstance getEpisodeChangeHistoryWithEntityWith:date
    skip:skip
    take:take
              completionHandler: ^(array[EpisodeChangeHistoryWithEntityResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ChangesApi()

var date = date_example; // {String} Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z

var skip = 56; // {Integer} Offset for paging. Default is 0.

var take = 56; // {Integer} Maximum number of rows returned. Default is 1,000.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEpisodeChangeHistoryWithEntity(date, skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEpisodeChangeHistoryWithEntityExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ChangesApi();
            var date = date_example;  // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
            var skip = 56;  // Integer | Offset for paging. Default is 0.
            var take = 56;  // Integer | Maximum number of rows returned. Default is 1,000.

            try
            {
                // Returns list of unique EpisodeId and Entity changes greater than or equal to date (UTC).
                array[EpisodeChangeHistoryWithEntityResponse] result = apiInstance.getEpisodeChangeHistoryWithEntity(date, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChangesApi.getEpisodeChangeHistoryWithEntity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ChangesApi();
$date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
$skip = 56; // Integer | Offset for paging. Default is 0.
$take = 56; // Integer | Maximum number of rows returned. Default is 1,000.

try {
    $result = $api_instance->getEpisodeChangeHistoryWithEntity($date, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChangesApi->getEpisodeChangeHistoryWithEntity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChangesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChangesApi->new();
my $date = date_example; # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
my $skip = 56; # Integer | Offset for paging. Default is 0.
my $take = 56; # Integer | Maximum number of rows returned. Default is 1,000.

eval { 
    my $result = $api_instance->getEpisodeChangeHistoryWithEntity(date => $date, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChangesApi->getEpisodeChangeHistoryWithEntity: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChangesApi()
date = date_example # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
skip = 56 # Integer | Offset for paging. Default is 0.
take = 56 # Integer | Maximum number of rows returned. Default is 1,000.

try: 
    # Returns list of unique EpisodeId and Entity changes greater than or equal to date (UTC).
    api_response = api_instance.get_episode_change_history_with_entity(date, skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangesApi->getEpisodeChangeHistoryWithEntity: %s\n" % e)

Parameters

Query parameters
Name Description
Date*
String
Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Required
Skip*
Integer
Offset for paging. Default is 0.
Required
Take*
Integer
Maximum number of rows returned. Default is 1,000.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getMovieChangeHistory

Returns list of unique MovieId changes greater than or equal to date (UTC).

Use to get the ID's of the movies that have been added or changed and use /Movies/{ID} to get back the object with the updated data and replace in your database.


/Changes/Movies/History/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Changes/Movies/History/?Date=&Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChangesApi;

import java.io.File;
import java.util.*;

public class ChangesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[MovieChangeHistoryResponse] result = apiInstance.getMovieChangeHistory(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getMovieChangeHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChangesApi;

public class ChangesApiExample {

    public static void main(String[] args) {
        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[MovieChangeHistoryResponse] result = apiInstance.getMovieChangeHistory(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getMovieChangeHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *date = date_example; // Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Integer *skip = 56; // Offset for paging. Default is 0.
Integer *take = 56; // Maximum number of rows returned. Default is 1,000.

ChangesApi *apiInstance = [[ChangesApi alloc] init];

// Returns list of unique MovieId changes greater than or equal to date (UTC).
[apiInstance getMovieChangeHistoryWith:date
    skip:skip
    take:take
              completionHandler: ^(array[MovieChangeHistoryResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ChangesApi()

var date = date_example; // {String} Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z

var skip = 56; // {Integer} Offset for paging. Default is 0.

var take = 56; // {Integer} Maximum number of rows returned. Default is 1,000.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMovieChangeHistory(date, skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMovieChangeHistoryExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ChangesApi();
            var date = date_example;  // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
            var skip = 56;  // Integer | Offset for paging. Default is 0.
            var take = 56;  // Integer | Maximum number of rows returned. Default is 1,000.

            try
            {
                // Returns list of unique MovieId changes greater than or equal to date (UTC).
                array[MovieChangeHistoryResponse] result = apiInstance.getMovieChangeHistory(date, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChangesApi.getMovieChangeHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ChangesApi();
$date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
$skip = 56; // Integer | Offset for paging. Default is 0.
$take = 56; // Integer | Maximum number of rows returned. Default is 1,000.

try {
    $result = $api_instance->getMovieChangeHistory($date, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChangesApi->getMovieChangeHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChangesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChangesApi->new();
my $date = date_example; # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
my $skip = 56; # Integer | Offset for paging. Default is 0.
my $take = 56; # Integer | Maximum number of rows returned. Default is 1,000.

eval { 
    my $result = $api_instance->getMovieChangeHistory(date => $date, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChangesApi->getMovieChangeHistory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChangesApi()
date = date_example # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
skip = 56 # Integer | Offset for paging. Default is 0.
take = 56 # Integer | Maximum number of rows returned. Default is 1,000.

try: 
    # Returns list of unique MovieId changes greater than or equal to date (UTC).
    api_response = api_instance.get_movie_change_history(date, skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangesApi->getMovieChangeHistory: %s\n" % e)

Parameters

Query parameters
Name Description
Date*
String
Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Required
Skip*
Integer
Offset for paging. Default is 0.
Required
Take*
Integer
Maximum number of rows returned. Default is 1,000.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getMovieChangeHistoryWithEntity

Returns list of unique MovieId and Entity changes greater than or equal to date (UTC).

Same as /Changes/Movies/History but with the specific entities that have changed inside the MovieResponse.


/Changes/Movies/HistoryWithEntity/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Changes/Movies/HistoryWithEntity/?Date=&Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChangesApi;

import java.io.File;
import java.util.*;

public class ChangesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[MovieChangeHistoryWithEntityResponse] result = apiInstance.getMovieChangeHistoryWithEntity(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getMovieChangeHistoryWithEntity");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChangesApi;

public class ChangesApiExample {

    public static void main(String[] args) {
        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[MovieChangeHistoryWithEntityResponse] result = apiInstance.getMovieChangeHistoryWithEntity(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getMovieChangeHistoryWithEntity");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *date = date_example; // Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Integer *skip = 56; // Offset for paging. Default is 0.
Integer *take = 56; // Maximum number of rows returned. Default is 1,000.

ChangesApi *apiInstance = [[ChangesApi alloc] init];

// 
Returns list of unique MovieId and Entity changes greater than or equal to date (UTC).
[apiInstance getMovieChangeHistoryWithEntityWith:date
    skip:skip
    take:take
              completionHandler: ^(array[MovieChangeHistoryWithEntityResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ChangesApi()

var date = date_example; // {String} Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z

var skip = 56; // {Integer} Offset for paging. Default is 0.

var take = 56; // {Integer} Maximum number of rows returned. Default is 1,000.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMovieChangeHistoryWithEntity(date, skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMovieChangeHistoryWithEntityExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ChangesApi();
            var date = date_example;  // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
            var skip = 56;  // Integer | Offset for paging. Default is 0.
            var take = 56;  // Integer | Maximum number of rows returned. Default is 1,000.

            try
            {
                // 
Returns list of unique MovieId and Entity changes greater than or equal to date (UTC).
                array[MovieChangeHistoryWithEntityResponse] result = apiInstance.getMovieChangeHistoryWithEntity(date, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChangesApi.getMovieChangeHistoryWithEntity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ChangesApi();
$date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
$skip = 56; // Integer | Offset for paging. Default is 0.
$take = 56; // Integer | Maximum number of rows returned. Default is 1,000.

try {
    $result = $api_instance->getMovieChangeHistoryWithEntity($date, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChangesApi->getMovieChangeHistoryWithEntity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChangesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChangesApi->new();
my $date = date_example; # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
my $skip = 56; # Integer | Offset for paging. Default is 0.
my $take = 56; # Integer | Maximum number of rows returned. Default is 1,000.

eval { 
    my $result = $api_instance->getMovieChangeHistoryWithEntity(date => $date, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChangesApi->getMovieChangeHistoryWithEntity: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChangesApi()
date = date_example # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
skip = 56 # Integer | Offset for paging. Default is 0.
take = 56 # Integer | Maximum number of rows returned. Default is 1,000.

try: 
    # 
Returns list of unique MovieId and Entity changes greater than or equal to date (UTC).
    api_response = api_instance.get_movie_change_history_with_entity(date, skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangesApi->getMovieChangeHistoryWithEntity: %s\n" % e)

Parameters

Query parameters
Name Description
Date*
String
Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Required
Skip*
Integer
Offset for paging. Default is 0.
Required
Take*
Integer
Maximum number of rows returned. Default is 1,000.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getSeasonChangeHistory

Returns list of unique SeasonId changes greater than or equal to date (UTC).

Use if you want to check for specific updates to season records.


/Changes/Seasons/History/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Changes/Seasons/History/?Date=&Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChangesApi;

import java.io.File;
import java.util.*;

public class ChangesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[SeasonChangeHistoryResponse] result = apiInstance.getSeasonChangeHistory(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getSeasonChangeHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChangesApi;

public class ChangesApiExample {

    public static void main(String[] args) {
        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[SeasonChangeHistoryResponse] result = apiInstance.getSeasonChangeHistory(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getSeasonChangeHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *date = date_example; // Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Integer *skip = 56; // Offset for paging. Default is 0.
Integer *take = 56; // Maximum number of rows returned. Default is 1,000.

ChangesApi *apiInstance = [[ChangesApi alloc] init];

// Returns list of unique SeasonId changes greater than or equal to date (UTC).
[apiInstance getSeasonChangeHistoryWith:date
    skip:skip
    take:take
              completionHandler: ^(array[SeasonChangeHistoryResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ChangesApi()

var date = date_example; // {String} Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z

var skip = 56; // {Integer} Offset for paging. Default is 0.

var take = 56; // {Integer} Maximum number of rows returned. Default is 1,000.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSeasonChangeHistory(date, skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSeasonChangeHistoryExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ChangesApi();
            var date = date_example;  // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
            var skip = 56;  // Integer | Offset for paging. Default is 0.
            var take = 56;  // Integer | Maximum number of rows returned. Default is 1,000.

            try
            {
                // Returns list of unique SeasonId changes greater than or equal to date (UTC).
                array[SeasonChangeHistoryResponse] result = apiInstance.getSeasonChangeHistory(date, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChangesApi.getSeasonChangeHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ChangesApi();
$date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
$skip = 56; // Integer | Offset for paging. Default is 0.
$take = 56; // Integer | Maximum number of rows returned. Default is 1,000.

try {
    $result = $api_instance->getSeasonChangeHistory($date, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChangesApi->getSeasonChangeHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChangesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChangesApi->new();
my $date = date_example; # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
my $skip = 56; # Integer | Offset for paging. Default is 0.
my $take = 56; # Integer | Maximum number of rows returned. Default is 1,000.

eval { 
    my $result = $api_instance->getSeasonChangeHistory(date => $date, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChangesApi->getSeasonChangeHistory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChangesApi()
date = date_example # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
skip = 56 # Integer | Offset for paging. Default is 0.
take = 56 # Integer | Maximum number of rows returned. Default is 1,000.

try: 
    # Returns list of unique SeasonId changes greater than or equal to date (UTC).
    api_response = api_instance.get_season_change_history(date, skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangesApi->getSeasonChangeHistory: %s\n" % e)

Parameters

Query parameters
Name Description
Date*
String
Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Required
Skip*
Integer
Offset for paging. Default is 0.
Required
Take*
Integer
Maximum number of rows returned. Default is 1,000.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getSeasonChangeHistoryWithEntity

Returns list of unique SeasonId and Entity changes greater than or equal to date (UTC).

Returns list of new or changed SeasonIds with the entity that has changed.


/Changes/Seasons/HistoryWithEntity/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Changes/Seasons/HistoryWithEntity/?Date=&Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChangesApi;

import java.io.File;
import java.util.*;

public class ChangesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[SeasonChangeHistoryWithEntityResponse] result = apiInstance.getSeasonChangeHistoryWithEntity(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getSeasonChangeHistoryWithEntity");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChangesApi;

public class ChangesApiExample {

    public static void main(String[] args) {
        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[SeasonChangeHistoryWithEntityResponse] result = apiInstance.getSeasonChangeHistoryWithEntity(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getSeasonChangeHistoryWithEntity");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *date = date_example; // Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Integer *skip = 56; // Offset for paging. Default is 0.
Integer *take = 56; // Maximum number of rows returned. Default is 1,000.

ChangesApi *apiInstance = [[ChangesApi alloc] init];

// Returns list of unique SeasonId and Entity changes greater than or equal to date (UTC).
[apiInstance getSeasonChangeHistoryWithEntityWith:date
    skip:skip
    take:take
              completionHandler: ^(array[SeasonChangeHistoryWithEntityResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ChangesApi()

var date = date_example; // {String} Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z

var skip = 56; // {Integer} Offset for paging. Default is 0.

var take = 56; // {Integer} Maximum number of rows returned. Default is 1,000.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSeasonChangeHistoryWithEntity(date, skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSeasonChangeHistoryWithEntityExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ChangesApi();
            var date = date_example;  // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
            var skip = 56;  // Integer | Offset for paging. Default is 0.
            var take = 56;  // Integer | Maximum number of rows returned. Default is 1,000.

            try
            {
                // Returns list of unique SeasonId and Entity changes greater than or equal to date (UTC).
                array[SeasonChangeHistoryWithEntityResponse] result = apiInstance.getSeasonChangeHistoryWithEntity(date, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChangesApi.getSeasonChangeHistoryWithEntity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ChangesApi();
$date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
$skip = 56; // Integer | Offset for paging. Default is 0.
$take = 56; // Integer | Maximum number of rows returned. Default is 1,000.

try {
    $result = $api_instance->getSeasonChangeHistoryWithEntity($date, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChangesApi->getSeasonChangeHistoryWithEntity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChangesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChangesApi->new();
my $date = date_example; # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
my $skip = 56; # Integer | Offset for paging. Default is 0.
my $take = 56; # Integer | Maximum number of rows returned. Default is 1,000.

eval { 
    my $result = $api_instance->getSeasonChangeHistoryWithEntity(date => $date, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChangesApi->getSeasonChangeHistoryWithEntity: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChangesApi()
date = date_example # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
skip = 56 # Integer | Offset for paging. Default is 0.
take = 56 # Integer | Maximum number of rows returned. Default is 1,000.

try: 
    # Returns list of unique SeasonId and Entity changes greater than or equal to date (UTC).
    api_response = api_instance.get_season_change_history_with_entity(date, skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangesApi->getSeasonChangeHistoryWithEntity: %s\n" % e)

Parameters

Query parameters
Name Description
Date*
String
Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Required
Skip*
Integer
Offset for paging. Default is 0.
Required
Take*
Integer
Maximum number of rows returned. Default is 1,000.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getShowChangeHistory

Returns list of unique ShowId changes greater than or equal to date (UTC).

All new and updated shows from requested date and time. When a record gets updated, use the ID to get the full show object and replace the data in your cache.


/Changes/Shows/History/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Changes/Shows/History/?Date=&Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChangesApi;

import java.io.File;
import java.util.*;

public class ChangesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[ShowChangeHistoryResponse] result = apiInstance.getShowChangeHistory(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getShowChangeHistory");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChangesApi;

public class ChangesApiExample {

    public static void main(String[] args) {
        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[ShowChangeHistoryResponse] result = apiInstance.getShowChangeHistory(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getShowChangeHistory");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *date = date_example; // Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Integer *skip = 56; // Offset for paging. Default is 0.
Integer *take = 56; // Maximum number of rows returned. Default is 1,000.

ChangesApi *apiInstance = [[ChangesApi alloc] init];

// Returns list of unique ShowId changes greater than or equal to date (UTC).
[apiInstance getShowChangeHistoryWith:date
    skip:skip
    take:take
              completionHandler: ^(array[ShowChangeHistoryResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ChangesApi()

var date = date_example; // {String} Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z

var skip = 56; // {Integer} Offset for paging. Default is 0.

var take = 56; // {Integer} Maximum number of rows returned. Default is 1,000.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShowChangeHistory(date, skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getShowChangeHistoryExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ChangesApi();
            var date = date_example;  // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
            var skip = 56;  // Integer | Offset for paging. Default is 0.
            var take = 56;  // Integer | Maximum number of rows returned. Default is 1,000.

            try
            {
                // Returns list of unique ShowId changes greater than or equal to date (UTC).
                array[ShowChangeHistoryResponse] result = apiInstance.getShowChangeHistory(date, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChangesApi.getShowChangeHistory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ChangesApi();
$date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
$skip = 56; // Integer | Offset for paging. Default is 0.
$take = 56; // Integer | Maximum number of rows returned. Default is 1,000.

try {
    $result = $api_instance->getShowChangeHistory($date, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChangesApi->getShowChangeHistory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChangesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChangesApi->new();
my $date = date_example; # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
my $skip = 56; # Integer | Offset for paging. Default is 0.
my $take = 56; # Integer | Maximum number of rows returned. Default is 1,000.

eval { 
    my $result = $api_instance->getShowChangeHistory(date => $date, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChangesApi->getShowChangeHistory: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChangesApi()
date = date_example # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
skip = 56 # Integer | Offset for paging. Default is 0.
take = 56 # Integer | Maximum number of rows returned. Default is 1,000.

try: 
    # Returns list of unique ShowId changes greater than or equal to date (UTC).
    api_response = api_instance.get_show_change_history(date, skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangesApi->getShowChangeHistory: %s\n" % e)

Parameters

Query parameters
Name Description
Date*
String
Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Required
Skip*
Integer
Offset for paging. Default is 0.
Required
Take*
Integer
Maximum number of rows returned. Default is 1,000.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getShowChangeHistoryWithEntity

Returns list of unique ShowId and Entity changes greater than or equal to date (UTC).

Returns a list of ShowId and entity of any show that has been updated.


/Changes/Shows/HistoryWithEntity/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Changes/Shows/HistoryWithEntity/?Date=&Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChangesApi;

import java.io.File;
import java.util.*;

public class ChangesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[ShowChangeHistoryWithEntityResponse] result = apiInstance.getShowChangeHistoryWithEntity(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getShowChangeHistoryWithEntity");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChangesApi;

public class ChangesApiExample {

    public static void main(String[] args) {
        ChangesApi apiInstance = new ChangesApi();
        String date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[ShowChangeHistoryWithEntityResponse] result = apiInstance.getShowChangeHistoryWithEntity(date, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChangesApi#getShowChangeHistoryWithEntity");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *date = date_example; // Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Integer *skip = 56; // Offset for paging. Default is 0.
Integer *take = 56; // Maximum number of rows returned. Default is 1,000.

ChangesApi *apiInstance = [[ChangesApi alloc] init];

// Returns list of unique ShowId and Entity changes greater than or equal to date (UTC).
[apiInstance getShowChangeHistoryWithEntityWith:date
    skip:skip
    take:take
              completionHandler: ^(array[ShowChangeHistoryWithEntityResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ChangesApi()

var date = date_example; // {String} Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z

var skip = 56; // {Integer} Offset for paging. Default is 0.

var take = 56; // {Integer} Maximum number of rows returned. Default is 1,000.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShowChangeHistoryWithEntity(date, skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getShowChangeHistoryWithEntityExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ChangesApi();
            var date = date_example;  // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
            var skip = 56;  // Integer | Offset for paging. Default is 0.
            var take = 56;  // Integer | Maximum number of rows returned. Default is 1,000.

            try
            {
                // Returns list of unique ShowId and Entity changes greater than or equal to date (UTC).
                array[ShowChangeHistoryWithEntityResponse] result = apiInstance.getShowChangeHistoryWithEntity(date, skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChangesApi.getShowChangeHistoryWithEntity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ChangesApi();
$date = date_example; // String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
$skip = 56; // Integer | Offset for paging. Default is 0.
$take = 56; // Integer | Maximum number of rows returned. Default is 1,000.

try {
    $result = $api_instance->getShowChangeHistoryWithEntity($date, $skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChangesApi->getShowChangeHistoryWithEntity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChangesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChangesApi->new();
my $date = date_example; # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
my $skip = 56; # Integer | Offset for paging. Default is 0.
my $take = 56; # Integer | Maximum number of rows returned. Default is 1,000.

eval { 
    my $result = $api_instance->getShowChangeHistoryWithEntity(date => $date, skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChangesApi->getShowChangeHistoryWithEntity: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChangesApi()
date = date_example # String | Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
skip = 56 # Integer | Offset for paging. Default is 0.
take = 56 # Integer | Maximum number of rows returned. Default is 1,000.

try: 
    # Returns list of unique ShowId and Entity changes greater than or equal to date (UTC).
    api_response = api_instance.get_show_change_history_with_entity(date, skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChangesApi->getShowChangeHistoryWithEntity: %s\n" % e)

Parameters

Query parameters
Name Description
Date*
String
Starting date <= when record has changed (Maximum of 30 days back). ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Required
Skip*
Integer
Offset for paging. Default is 0.
Required
Take*
Integer
Maximum number of rows returned. Default is 1,000.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


Charts

getChartMoviesBoxoffice

Returns list of movies based on the weekend box office revenue.

Returns top 10 box office movies.


/Charts/Movies/Boxoffice

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Charts/Movies/Boxoffice?Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChartsApi;

import java.io.File;
import java.util.*;

public class ChartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ChartsApi apiInstance = new ChartsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 100)
        try {
            array[ChartItem] result = apiInstance.getChartMoviesBoxoffice(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChartsApi#getChartMoviesBoxoffice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChartsApi;

public class ChartsApiExample {

    public static void main(String[] args) {
        ChartsApi apiInstance = new ChartsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 100)
        try {
            array[ChartItem] result = apiInstance.getChartMoviesBoxoffice(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChartsApi#getChartMoviesBoxoffice");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Determines where to start page.  Ex: 0 starts at the beginning.
Integer *take = 56; // Determines the page size.  (Maximum of 100)

ChartsApi *apiInstance = [[ChartsApi alloc] init];

// Returns list of movies based on the weekend box office revenue.
[apiInstance getChartMoviesBoxofficeWith:skip
    take:take
              completionHandler: ^(array[ChartItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ChartsApi()

var skip = 56; // {Integer} Determines where to start page.  Ex: 0 starts at the beginning.

var take = 56; // {Integer} Determines the page size.  (Maximum of 100)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChartMoviesBoxoffice(skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getChartMoviesBoxofficeExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ChartsApi();
            var skip = 56;  // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
            var take = 56;  // Integer | Determines the page size.  (Maximum of 100)

            try
            {
                // Returns list of movies based on the weekend box office revenue.
                array[ChartItem] result = apiInstance.getChartMoviesBoxoffice(skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChartsApi.getChartMoviesBoxoffice: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ChartsApi();
$skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
$take = 56; // Integer | Determines the page size.  (Maximum of 100)

try {
    $result = $api_instance->getChartMoviesBoxoffice($skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChartsApi->getChartMoviesBoxoffice: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChartsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChartsApi->new();
my $skip = 56; # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
my $take = 56; # Integer | Determines the page size.  (Maximum of 100)

eval { 
    my $result = $api_instance->getChartMoviesBoxoffice(skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChartsApi->getChartMoviesBoxoffice: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChartsApi()
skip = 56 # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
take = 56 # Integer | Determines the page size.  (Maximum of 100)

try: 
    # Returns list of movies based on the weekend box office revenue.
    api_response = api_instance.get_chart_movies_boxoffice(skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChartsApi->getChartMoviesBoxoffice: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Determines where to start page. Ex: 0 starts at the beginning.
Required
Take*
Integer
Determines the page size. (Maximum of 100)
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getChartMoviesPopular

Returns list of popular movies.

Requires Skip and Take. Maximum page size is 100.


/Charts/Movies/Popular

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Charts/Movies/Popular?Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChartsApi;

import java.io.File;
import java.util.*;

public class ChartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ChartsApi apiInstance = new ChartsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 100)
        try {
            array[ChartItem] result = apiInstance.getChartMoviesPopular(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChartsApi#getChartMoviesPopular");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChartsApi;

public class ChartsApiExample {

    public static void main(String[] args) {
        ChartsApi apiInstance = new ChartsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 100)
        try {
            array[ChartItem] result = apiInstance.getChartMoviesPopular(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChartsApi#getChartMoviesPopular");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Determines where to start page.  Ex: 0 starts at the beginning.
Integer *take = 56; // Determines the page size.  (Maximum of 100)

ChartsApi *apiInstance = [[ChartsApi alloc] init];

// Returns list of popular movies.
[apiInstance getChartMoviesPopularWith:skip
    take:take
              completionHandler: ^(array[ChartItem] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ChartsApi()

var skip = 56; // {Integer} Determines where to start page.  Ex: 0 starts at the beginning.

var take = 56; // {Integer} Determines the page size.  (Maximum of 100)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChartMoviesPopular(skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getChartMoviesPopularExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ChartsApi();
            var skip = 56;  // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
            var take = 56;  // Integer | Determines the page size.  (Maximum of 100)

            try
            {
                // Returns list of popular movies.
                array[ChartItem] result = apiInstance.getChartMoviesPopular(skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChartsApi.getChartMoviesPopular: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ChartsApi();
$skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
$take = 56; // Integer | Determines the page size.  (Maximum of 100)

try {
    $result = $api_instance->getChartMoviesPopular($skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChartsApi->getChartMoviesPopular: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChartsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChartsApi->new();
my $skip = 56; # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
my $take = 56; # Integer | Determines the page size.  (Maximum of 100)

eval { 
    my $result = $api_instance->getChartMoviesPopular(skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChartsApi->getChartMoviesPopular: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChartsApi()
skip = 56 # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
take = 56 # Integer | Determines the page size.  (Maximum of 100)

try: 
    # Returns list of popular movies.
    api_response = api_instance.get_chart_movies_popular(skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChartsApi->getChartMoviesPopular: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Determines where to start page. Ex: 0 starts at the beginning.
Required
Take*
Integer
Determines the page size. (Maximum of 100)
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getChartShowsPopular

Returns a list of shows based on popularity.

Requires Skip and Take. Maximum page size is 100.


/Charts/Shows/Popular

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Charts/Shows/Popular?Take=&Skip="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ChartsApi;

import java.io.File;
import java.util.*;

public class ChartsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ChartsApi apiInstance = new ChartsApi();
        Integer take = 56; // Integer | Limits the total items returned. Maximum of 100 per request.
        Integer skip = 56; // Integer | Skips records using for paging results.
        try {
            ChartItem result = apiInstance.getChartShowsPopular(take, skip);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChartsApi#getChartShowsPopular");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ChartsApi;

public class ChartsApiExample {

    public static void main(String[] args) {
        ChartsApi apiInstance = new ChartsApi();
        Integer take = 56; // Integer | Limits the total items returned. Maximum of 100 per request.
        Integer skip = 56; // Integer | Skips records using for paging results.
        try {
            ChartItem result = apiInstance.getChartShowsPopular(take, skip);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChartsApi#getChartShowsPopular");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *take = 56; // Limits the total items returned. Maximum of 100 per request. (optional)
Integer *skip = 56; // Skips records using for paging results. (optional)

ChartsApi *apiInstance = [[ChartsApi alloc] init];

// Returns a list of shows based on popularity.
[apiInstance getChartShowsPopularWith:take
    skip:skip
              completionHandler: ^(ChartItem output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ChartsApi()

var opts = { 
  'take': 56, // {Integer} Limits the total items returned. Maximum of 100 per request.
  'skip': 56 // {Integer} Skips records using for paging results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getChartShowsPopular(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getChartShowsPopularExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ChartsApi();
            var take = 56;  // Integer | Limits the total items returned. Maximum of 100 per request. (optional) 
            var skip = 56;  // Integer | Skips records using for paging results. (optional) 

            try
            {
                // Returns a list of shows based on popularity.
                ChartItem result = apiInstance.getChartShowsPopular(take, skip);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ChartsApi.getChartShowsPopular: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ChartsApi();
$take = 56; // Integer | Limits the total items returned. Maximum of 100 per request.
$skip = 56; // Integer | Skips records using for paging results.

try {
    $result = $api_instance->getChartShowsPopular($take, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ChartsApi->getChartShowsPopular: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ChartsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ChartsApi->new();
my $take = 56; # Integer | Limits the total items returned. Maximum of 100 per request.
my $skip = 56; # Integer | Skips records using for paging results.

eval { 
    my $result = $api_instance->getChartShowsPopular(take => $take, skip => $skip);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ChartsApi->getChartShowsPopular: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ChartsApi()
take = 56 # Integer | Limits the total items returned. Maximum of 100 per request. (optional)
skip = 56 # Integer | Skips records using for paging results. (optional)

try: 
    # Returns a list of shows based on popularity.
    api_response = api_instance.get_chart_shows_popular(take=take, skip=skip)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ChartsApi->getChartShowsPopular: %s\n" % e)

Parameters

Query parameters
Name Description
Take
Integer
Limits the total items returned. Maximum of 100 per request.
Skip
Integer
Skips records using for paging results.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


Common

getCompanies

Paged list of companies.

Companies are listed in a movie, show, or game response as those whom are involved with the program. EX: Universal Pictures.


/Common/Companies/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Common/Companies/?Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommonApi;

import java.io.File;
import java.util.*;

public class CommonApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        CommonApi apiInstance = new CommonApi();
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[CompanyResponse] result = apiInstance.getCompanies(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#getCompanies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommonApi;

public class CommonApiExample {

    public static void main(String[] args) {
        CommonApi apiInstance = new CommonApi();
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[CompanyResponse] result = apiInstance.getCompanies(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#getCompanies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Offset for paging. Default is 0.
Integer *take = 56; // Maximum number of rows returned. Default is 1,000.

CommonApi *apiInstance = [[CommonApi alloc] init];

// Paged list of companies.
[apiInstance getCompaniesWith:skip
    take:take
              completionHandler: ^(array[CompanyResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.CommonApi()

var skip = 56; // {Integer} Offset for paging. Default is 0.

var take = 56; // {Integer} Maximum number of rows returned. Default is 1,000.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCompanies(skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCompaniesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new CommonApi();
            var skip = 56;  // Integer | Offset for paging. Default is 0.
            var take = 56;  // Integer | Maximum number of rows returned. Default is 1,000.

            try
            {
                // Paged list of companies.
                array[CompanyResponse] result = apiInstance.getCompanies(skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommonApi.getCompanies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\CommonApi();
$skip = 56; // Integer | Offset for paging. Default is 0.
$take = 56; // Integer | Maximum number of rows returned. Default is 1,000.

try {
    $result = $api_instance->getCompanies($skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommonApi->getCompanies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommonApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CommonApi->new();
my $skip = 56; # Integer | Offset for paging. Default is 0.
my $take = 56; # Integer | Maximum number of rows returned. Default is 1,000.

eval { 
    my $result = $api_instance->getCompanies(skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommonApi->getCompanies: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CommonApi()
skip = 56 # Integer | Offset for paging. Default is 0.
take = 56 # Integer | Maximum number of rows returned. Default is 1,000.

try: 
    # Paged list of companies.
    api_response = api_instance.get_companies(skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommonApi->getCompanies: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Offset for paging. Default is 0.
Required
Take*
Integer
Maximum number of rows returned. Default is 1,000.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getCountries

Returns a list of countries.

List of Countries, ISO codes and Country IDs used throughout the API.


/Common/Countries/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Common/Countries/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommonApi;

import java.io.File;
import java.util.*;

public class CommonApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        CommonApi apiInstance = new CommonApi();
        try {
            array[CountryResponse] result = apiInstance.getCountries();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#getCountries");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommonApi;

public class CommonApiExample {

    public static void main(String[] args) {
        CommonApi apiInstance = new CommonApi();
        try {
            array[CountryResponse] result = apiInstance.getCountries();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#getCountries");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];


CommonApi *apiInstance = [[CommonApi alloc] init];

// Returns a list of countries.
[apiInstance getCountriesWithCompletionHandler: 
              ^(array[CountryResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.CommonApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCountries(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCountriesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new CommonApi();

            try
            {
                // Returns a list of countries.
                array[CountryResponse] result = apiInstance.getCountries();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommonApi.getCountries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\CommonApi();

try {
    $result = $api_instance->getCountries();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommonApi->getCountries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommonApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CommonApi->new();

eval { 
    my $result = $api_instance->getCountries();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommonApi->getCountries: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CommonApi()

try: 
    # Returns a list of countries.
    api_response = api_instance.get_countries()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommonApi->getCountries: %s\n" % e)

Parameters

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getEncodeTypes

List of available encode types.

Videos are encoded in various formats and bitrates to reach any screen and work with any player.


/Common/EncodeTypes/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Common/EncodeTypes/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommonApi;

import java.io.File;
import java.util.*;

public class CommonApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        CommonApi apiInstance = new CommonApi();
        try {
            array[EncodeTypeResponse] result = apiInstance.getEncodeTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#getEncodeTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommonApi;

public class CommonApiExample {

    public static void main(String[] args) {
        CommonApi apiInstance = new CommonApi();
        try {
            array[EncodeTypeResponse] result = apiInstance.getEncodeTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#getEncodeTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];


CommonApi *apiInstance = [[CommonApi alloc] init];

// List of available encode types.
[apiInstance getEncodeTypesWithCompletionHandler: 
              ^(array[EncodeTypeResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.CommonApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEncodeTypes(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEncodeTypesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new CommonApi();

            try
            {
                // List of available encode types.
                array[EncodeTypeResponse] result = apiInstance.getEncodeTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommonApi.getEncodeTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\CommonApi();

try {
    $result = $api_instance->getEncodeTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommonApi->getEncodeTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommonApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CommonApi->new();

eval { 
    my $result = $api_instance->getEncodeTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommonApi->getEncodeTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CommonApi()

try: 
    # List of available encode types.
    api_response = api_instance.get_encode_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommonApi->getEncodeTypes: %s\n" % e)

Parameters

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getImageTypes

List of image types contained in the database.

A list of image types available in the IVA database. **EX: Poster**


/Common/ImageTypes/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Common/ImageTypes/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommonApi;

import java.io.File;
import java.util.*;

public class CommonApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        CommonApi apiInstance = new CommonApi();
        try {
            array[ImageTypeResponse] result = apiInstance.getImageTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#getImageTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommonApi;

public class CommonApiExample {

    public static void main(String[] args) {
        CommonApi apiInstance = new CommonApi();
        try {
            array[ImageTypeResponse] result = apiInstance.getImageTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#getImageTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];


CommonApi *apiInstance = [[CommonApi alloc] init];

// List of image types contained in the database.
[apiInstance getImageTypesWithCompletionHandler: 
              ^(array[ImageTypeResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.CommonApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getImageTypes(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getImageTypesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new CommonApi();

            try
            {
                // List of image types contained in the database.
                array[ImageTypeResponse] result = apiInstance.getImageTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommonApi.getImageTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\CommonApi();

try {
    $result = $api_instance->getImageTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommonApi->getImageTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommonApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CommonApi->new();

eval { 
    my $result = $api_instance->getImageTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommonApi->getImageTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CommonApi()

try: 
    # List of image types contained in the database.
    api_response = api_instance.get_image_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommonApi->getImageTypes: %s\n" % e)

Parameters

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getLanguages

Gets all languages.

Returns a list of languages used in the API as well as the ISO code and language ID.


/Common/Languages/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Common/Languages/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommonApi;

import java.io.File;
import java.util.*;

public class CommonApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        CommonApi apiInstance = new CommonApi();
        try {
            array[LanguageResponse] result = apiInstance.getLanguages();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#getLanguages");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommonApi;

public class CommonApiExample {

    public static void main(String[] args) {
        CommonApi apiInstance = new CommonApi();
        try {
            array[LanguageResponse] result = apiInstance.getLanguages();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#getLanguages");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];


CommonApi *apiInstance = [[CommonApi alloc] init];

// Gets all languages.
[apiInstance getLanguagesWithCompletionHandler: 
              ^(array[LanguageResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.CommonApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLanguages(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLanguagesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new CommonApi();

            try
            {
                // Gets all languages.
                array[LanguageResponse] result = apiInstance.getLanguages();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommonApi.getLanguages: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\CommonApi();

try {
    $result = $api_instance->getLanguages();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommonApi->getLanguages: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommonApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CommonApi->new();

eval { 
    my $result = $api_instance->getLanguages();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommonApi->getLanguages: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CommonApi()

try: 
    # Gets all languages.
    api_response = api_instance.get_languages()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommonApi->getLanguages: %s\n" % e)

Parameters

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getTags

Gets all tags.

Paged list of all tags used in the API.


/Common/Tags/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Common/Tags/?Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommonApi;

import java.io.File;
import java.util.*;

public class CommonApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        CommonApi apiInstance = new CommonApi();
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[TagResponse] result = apiInstance.getTags(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#getTags");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommonApi;

public class CommonApiExample {

    public static void main(String[] args) {
        CommonApi apiInstance = new CommonApi();
        Integer skip = 56; // Integer | Offset for paging. Default is 0.
        Integer take = 56; // Integer | Maximum number of rows returned. Default is 1,000.
        try {
            array[TagResponse] result = apiInstance.getTags(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#getTags");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Offset for paging. Default is 0.
Integer *take = 56; // Maximum number of rows returned. Default is 1,000.

CommonApi *apiInstance = [[CommonApi alloc] init];

// Gets all tags.
[apiInstance getTagsWith:skip
    take:take
              completionHandler: ^(array[TagResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.CommonApi()

var skip = 56; // {Integer} Offset for paging. Default is 0.

var take = 56; // {Integer} Maximum number of rows returned. Default is 1,000.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTags(skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTagsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new CommonApi();
            var skip = 56;  // Integer | Offset for paging. Default is 0.
            var take = 56;  // Integer | Maximum number of rows returned. Default is 1,000.

            try
            {
                // Gets all tags.
                array[TagResponse] result = apiInstance.getTags(skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommonApi.getTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\CommonApi();
$skip = 56; // Integer | Offset for paging. Default is 0.
$take = 56; // Integer | Maximum number of rows returned. Default is 1,000.

try {
    $result = $api_instance->getTags($skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommonApi->getTags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommonApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CommonApi->new();
my $skip = 56; # Integer | Offset for paging. Default is 0.
my $take = 56; # Integer | Maximum number of rows returned. Default is 1,000.

eval { 
    my $result = $api_instance->getTags(skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommonApi->getTags: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CommonApi()
skip = 56 # Integer | Offset for paging. Default is 0.
take = 56 # Integer | Maximum number of rows returned. Default is 1,000.

try: 
    # Gets all tags.
    api_response = api_instance.get_tags(skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommonApi->getTags: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Offset for paging. Default is 0.
Required
Take*
Integer
Maximum number of rows returned. Default is 1,000.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getVideoTypes

Gets all VideoTypes.

Returns a list of the types of videos that can be associated to a title.


/Common/VideoTypes/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Common/VideoTypes/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CommonApi;

import java.io.File;
import java.util.*;

public class CommonApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        CommonApi apiInstance = new CommonApi();
        try {
            array[VideoTypeResponse] result = apiInstance.getVideoTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#getVideoTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CommonApi;

public class CommonApiExample {

    public static void main(String[] args) {
        CommonApi apiInstance = new CommonApi();
        try {
            array[VideoTypeResponse] result = apiInstance.getVideoTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommonApi#getVideoTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];


CommonApi *apiInstance = [[CommonApi alloc] init];

// Gets all VideoTypes.
[apiInstance getVideoTypesWithCompletionHandler: 
              ^(array[VideoTypeResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.CommonApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideoTypes(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVideoTypesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new CommonApi();

            try
            {
                // Gets all VideoTypes.
                array[VideoTypeResponse] result = apiInstance.getVideoTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CommonApi.getVideoTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\CommonApi();

try {
    $result = $api_instance->getVideoTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommonApi->getVideoTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CommonApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CommonApi->new();

eval { 
    my $result = $api_instance->getVideoTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommonApi->getVideoTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.CommonApi()

try: 
    # Gets all VideoTypes.
    api_response = api_instance.get_video_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommonApi->getVideoTypes: %s\n" % e)

Parameters

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


ExternalIds

getGracenoteMovieIds

Returns list of all MovieId, Gracenote Id pairs.

Not accessible with a Demo account. **Special permissions needed** for access to this operation. Contact [Sales](mailto:sales@internetvideoarchive.com).


/ExternalIds/GracenoteMovie

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/ExternalIds/GracenoteMovie?Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExternalIdsApi;

import java.io.File;
import java.util.*;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[MovieExternalIdMap] result = apiInstance.getGracenoteMovieIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getGracenoteMovieIds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExternalIdsApi;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[MovieExternalIdMap] result = apiInstance.getGracenoteMovieIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getGracenoteMovieIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Determines where to start page.  Ex: 0 starts at the beginning.
Integer *take = 56; // Determines the page size.  (Maximum of 1000)

ExternalIdsApi *apiInstance = [[ExternalIdsApi alloc] init];

// Returns list of all MovieId, Gracenote Id pairs.
[apiInstance getGracenoteMovieIdsWith:skip
    take:take
              completionHandler: ^(array[MovieExternalIdMap] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ExternalIdsApi()

var skip = 56; // {Integer} Determines where to start page.  Ex: 0 starts at the beginning.

var take = 56; // {Integer} Determines the page size.  (Maximum of 1000)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGracenoteMovieIds(skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGracenoteMovieIdsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ExternalIdsApi();
            var skip = 56;  // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
            var take = 56;  // Integer | Determines the page size.  (Maximum of 1000)

            try
            {
                // Returns list of all MovieId, Gracenote Id pairs.
                array[MovieExternalIdMap] result = apiInstance.getGracenoteMovieIds(skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExternalIdsApi.getGracenoteMovieIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ExternalIdsApi();
$skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
$take = 56; // Integer | Determines the page size.  (Maximum of 1000)

try {
    $result = $api_instance->getGracenoteMovieIds($skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExternalIdsApi->getGracenoteMovieIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExternalIdsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExternalIdsApi->new();
my $skip = 56; # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
my $take = 56; # Integer | Determines the page size.  (Maximum of 1000)

eval { 
    my $result = $api_instance->getGracenoteMovieIds(skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExternalIdsApi->getGracenoteMovieIds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExternalIdsApi()
skip = 56 # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
take = 56 # Integer | Determines the page size.  (Maximum of 1000)

try: 
    # Returns list of all MovieId, Gracenote Id pairs.
    api_response = api_instance.get_gracenote_movie_ids(skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExternalIdsApi->getGracenoteMovieIds: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Determines where to start page. Ex: 0 starts at the beginning.
Required
Take*
Integer
Determines the page size. (Maximum of 1000)
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getGracenoteShowIds

Returns list of all ShowId, Gracenote Id pairs.

Not accessible with a Demo account. **Special permissions needed** for access to this operation. Contact [Sales](mailto:sales@internetvideoarchive.com).


/ExternalIds/GracenoteShow

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/ExternalIds/GracenoteShow?Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExternalIdsApi;

import java.io.File;
import java.util.*;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[ShowExternalIdMap] result = apiInstance.getGracenoteShowIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getGracenoteShowIds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExternalIdsApi;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[ShowExternalIdMap] result = apiInstance.getGracenoteShowIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getGracenoteShowIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Determines where to start page.  Ex: 0 starts at the beginning.
Integer *take = 56; // Determines the page size.  (Maximum of 1000)

ExternalIdsApi *apiInstance = [[ExternalIdsApi alloc] init];

// Returns list of all ShowId, Gracenote Id pairs.
[apiInstance getGracenoteShowIdsWith:skip
    take:take
              completionHandler: ^(array[ShowExternalIdMap] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ExternalIdsApi()

var skip = 56; // {Integer} Determines where to start page.  Ex: 0 starts at the beginning.

var take = 56; // {Integer} Determines the page size.  (Maximum of 1000)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGracenoteShowIds(skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getGracenoteShowIdsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ExternalIdsApi();
            var skip = 56;  // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
            var take = 56;  // Integer | Determines the page size.  (Maximum of 1000)

            try
            {
                // Returns list of all ShowId, Gracenote Id pairs.
                array[ShowExternalIdMap] result = apiInstance.getGracenoteShowIds(skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExternalIdsApi.getGracenoteShowIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ExternalIdsApi();
$skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
$take = 56; // Integer | Determines the page size.  (Maximum of 1000)

try {
    $result = $api_instance->getGracenoteShowIds($skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExternalIdsApi->getGracenoteShowIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExternalIdsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExternalIdsApi->new();
my $skip = 56; # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
my $take = 56; # Integer | Determines the page size.  (Maximum of 1000)

eval { 
    my $result = $api_instance->getGracenoteShowIds(skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExternalIdsApi->getGracenoteShowIds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExternalIdsApi()
skip = 56 # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
take = 56 # Integer | Determines the page size.  (Maximum of 1000)

try: 
    # Returns list of all ShowId, Gracenote Id pairs.
    api_response = api_instance.get_gracenote_show_ids(skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExternalIdsApi->getGracenoteShowIds: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Determines where to start page. Ex: 0 starts at the beginning.
Required
Take*
Integer
Determines the page size. (Maximum of 1000)
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getImdbMovieIds

Returns list of all MovieId, IMDB Id pairs.

Ingest this ID map to create connections between the objects in your existing database with an IMDB ID to the IVA Movie objects.


/ExternalIds/ImdbMovie

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/ExternalIds/ImdbMovie?Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExternalIdsApi;

import java.io.File;
import java.util.*;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[MovieExternalIdMap] result = apiInstance.getImdbMovieIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getImdbMovieIds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExternalIdsApi;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[MovieExternalIdMap] result = apiInstance.getImdbMovieIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getImdbMovieIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Determines where to start page.  Ex: 0 starts at the beginning.
Integer *take = 56; // Determines the page size.  (Maximum of 1000)

ExternalIdsApi *apiInstance = [[ExternalIdsApi alloc] init];

// Returns list of all MovieId, IMDB Id pairs.
[apiInstance getImdbMovieIdsWith:skip
    take:take
              completionHandler: ^(array[MovieExternalIdMap] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ExternalIdsApi()

var skip = 56; // {Integer} Determines where to start page.  Ex: 0 starts at the beginning.

var take = 56; // {Integer} Determines the page size.  (Maximum of 1000)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getImdbMovieIds(skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getImdbMovieIdsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ExternalIdsApi();
            var skip = 56;  // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
            var take = 56;  // Integer | Determines the page size.  (Maximum of 1000)

            try
            {
                // Returns list of all MovieId, IMDB Id pairs.
                array[MovieExternalIdMap] result = apiInstance.getImdbMovieIds(skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExternalIdsApi.getImdbMovieIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ExternalIdsApi();
$skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
$take = 56; // Integer | Determines the page size.  (Maximum of 1000)

try {
    $result = $api_instance->getImdbMovieIds($skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExternalIdsApi->getImdbMovieIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExternalIdsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExternalIdsApi->new();
my $skip = 56; # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
my $take = 56; # Integer | Determines the page size.  (Maximum of 1000)

eval { 
    my $result = $api_instance->getImdbMovieIds(skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExternalIdsApi->getImdbMovieIds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExternalIdsApi()
skip = 56 # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
take = 56 # Integer | Determines the page size.  (Maximum of 1000)

try: 
    # Returns list of all MovieId, IMDB Id pairs.
    api_response = api_instance.get_imdb_movie_ids(skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExternalIdsApi->getImdbMovieIds: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Determines where to start page. Ex: 0 starts at the beginning.
Required
Take*
Integer
Determines the page size. (Maximum of 1000)
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getImdbShowIds

Returns list of all MovieId, Tmdb Id pairs.

ngest this ID map to create connections between the objects in your existing database with an IMDB ID to the IVA Show objects.


/ExternalIds/ImdbShow

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/ExternalIds/ImdbShow?Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExternalIdsApi;

import java.io.File;
import java.util.*;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[ShowExternalIdMap] result = apiInstance.getImdbShowIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getImdbShowIds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExternalIdsApi;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[ShowExternalIdMap] result = apiInstance.getImdbShowIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getImdbShowIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Determines where to start page.  Ex: 0 starts at the beginning.
Integer *take = 56; // Determines the page size.  (Maximum of 1000)

ExternalIdsApi *apiInstance = [[ExternalIdsApi alloc] init];

// Returns list of all MovieId, Tmdb Id pairs.
[apiInstance getImdbShowIdsWith:skip
    take:take
              completionHandler: ^(array[ShowExternalIdMap] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ExternalIdsApi()

var skip = 56; // {Integer} Determines where to start page.  Ex: 0 starts at the beginning.

var take = 56; // {Integer} Determines the page size.  (Maximum of 1000)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getImdbShowIds(skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getImdbShowIdsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ExternalIdsApi();
            var skip = 56;  // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
            var take = 56;  // Integer | Determines the page size.  (Maximum of 1000)

            try
            {
                // Returns list of all MovieId, Tmdb Id pairs.
                array[ShowExternalIdMap] result = apiInstance.getImdbShowIds(skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExternalIdsApi.getImdbShowIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ExternalIdsApi();
$skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
$take = 56; // Integer | Determines the page size.  (Maximum of 1000)

try {
    $result = $api_instance->getImdbShowIds($skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExternalIdsApi->getImdbShowIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExternalIdsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExternalIdsApi->new();
my $skip = 56; # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
my $take = 56; # Integer | Determines the page size.  (Maximum of 1000)

eval { 
    my $result = $api_instance->getImdbShowIds(skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExternalIdsApi->getImdbShowIds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExternalIdsApi()
skip = 56 # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
take = 56 # Integer | Determines the page size.  (Maximum of 1000)

try: 
    # Returns list of all MovieId, Tmdb Id pairs.
    api_response = api_instance.get_imdb_show_ids(skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExternalIdsApi->getImdbShowIds: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Determines where to start page. Ex: 0 starts at the beginning.
Required
Take*
Integer
Determines the page size. (Maximum of 1000)
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getTivoMovieIds

Returns list of all MovieId, Tivo Id pairs.

Not accessible with a Demo account. **Special permissions needed** for access to this operation. Contact [Sales](mailto:sales@internetvideoarchive.com).


/ExternalIds/RoviMovie

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/ExternalIds/RoviMovie?Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExternalIdsApi;

import java.io.File;
import java.util.*;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[MovieExternalIdMap] result = apiInstance.getTivoMovieIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getTivoMovieIds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExternalIdsApi;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[MovieExternalIdMap] result = apiInstance.getTivoMovieIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getTivoMovieIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Determines where to start page.  Ex: 0 starts at the beginning.
Integer *take = 56; // Determines the page size.  (Maximum of 1000)

ExternalIdsApi *apiInstance = [[ExternalIdsApi alloc] init];

// Returns list of all MovieId, Tivo Id pairs.
[apiInstance getTivoMovieIdsWith:skip
    take:take
              completionHandler: ^(array[MovieExternalIdMap] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ExternalIdsApi()

var skip = 56; // {Integer} Determines where to start page.  Ex: 0 starts at the beginning.

var take = 56; // {Integer} Determines the page size.  (Maximum of 1000)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTivoMovieIds(skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTivoMovieIdsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ExternalIdsApi();
            var skip = 56;  // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
            var take = 56;  // Integer | Determines the page size.  (Maximum of 1000)

            try
            {
                // Returns list of all MovieId, Tivo Id pairs.
                array[MovieExternalIdMap] result = apiInstance.getTivoMovieIds(skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExternalIdsApi.getTivoMovieIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ExternalIdsApi();
$skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
$take = 56; // Integer | Determines the page size.  (Maximum of 1000)

try {
    $result = $api_instance->getTivoMovieIds($skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExternalIdsApi->getTivoMovieIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExternalIdsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExternalIdsApi->new();
my $skip = 56; # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
my $take = 56; # Integer | Determines the page size.  (Maximum of 1000)

eval { 
    my $result = $api_instance->getTivoMovieIds(skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExternalIdsApi->getTivoMovieIds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExternalIdsApi()
skip = 56 # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
take = 56 # Integer | Determines the page size.  (Maximum of 1000)

try: 
    # Returns list of all MovieId, Tivo Id pairs.
    api_response = api_instance.get_tivo_movie_ids(skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExternalIdsApi->getTivoMovieIds: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Determines where to start page. Ex: 0 starts at the beginning.
Required
Take*
Integer
Determines the page size. (Maximum of 1000)
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getTivoShowIds

Returns list of all ShowId, Tivo Id pairs.

Not accessible with a Demo account. **Special permissions needed** for access to this operation. Contact [Sales](mailto:sales@internetvideoarchive.com).


/ExternalIds/RoviShow

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/ExternalIds/RoviShow?Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExternalIdsApi;

import java.io.File;
import java.util.*;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[ShowExternalIdMap] result = apiInstance.getTivoShowIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getTivoShowIds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExternalIdsApi;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[ShowExternalIdMap] result = apiInstance.getTivoShowIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getTivoShowIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Determines where to start page.  Ex: 0 starts at the beginning.
Integer *take = 56; // Determines the page size.  (Maximum of 1000)

ExternalIdsApi *apiInstance = [[ExternalIdsApi alloc] init];

// Returns list of all ShowId, Tivo Id pairs.
[apiInstance getTivoShowIdsWith:skip
    take:take
              completionHandler: ^(array[ShowExternalIdMap] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ExternalIdsApi()

var skip = 56; // {Integer} Determines where to start page.  Ex: 0 starts at the beginning.

var take = 56; // {Integer} Determines the page size.  (Maximum of 1000)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTivoShowIds(skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTivoShowIdsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ExternalIdsApi();
            var skip = 56;  // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
            var take = 56;  // Integer | Determines the page size.  (Maximum of 1000)

            try
            {
                // Returns list of all ShowId, Tivo Id pairs.
                array[ShowExternalIdMap] result = apiInstance.getTivoShowIds(skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExternalIdsApi.getTivoShowIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ExternalIdsApi();
$skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
$take = 56; // Integer | Determines the page size.  (Maximum of 1000)

try {
    $result = $api_instance->getTivoShowIds($skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExternalIdsApi->getTivoShowIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExternalIdsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExternalIdsApi->new();
my $skip = 56; # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
my $take = 56; # Integer | Determines the page size.  (Maximum of 1000)

eval { 
    my $result = $api_instance->getTivoShowIds(skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExternalIdsApi->getTivoShowIds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExternalIdsApi()
skip = 56 # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
take = 56 # Integer | Determines the page size.  (Maximum of 1000)

try: 
    # Returns list of all ShowId, Tivo Id pairs.
    api_response = api_instance.get_tivo_show_ids(skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExternalIdsApi->getTivoShowIds: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Determines where to start page. Ex: 0 starts at the beginning.
Required
Take*
Integer
Determines the page size. (Maximum of 1000)
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getTmdbMovieIds

Returns list of all MovieId, Tmdb Id pairs.

Use to link a TMDB ID to an IVA Movie ID.


/ExternalIds/TmdbMovie

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/ExternalIds/TmdbMovie?Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExternalIdsApi;

import java.io.File;
import java.util.*;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[MovieExternalIdMap] result = apiInstance.getTmdbMovieIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getTmdbMovieIds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExternalIdsApi;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[MovieExternalIdMap] result = apiInstance.getTmdbMovieIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getTmdbMovieIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Determines where to start page.  Ex: 0 starts at the beginning.
Integer *take = 56; // Determines the page size.  (Maximum of 1000)

ExternalIdsApi *apiInstance = [[ExternalIdsApi alloc] init];

// Returns list of all MovieId, Tmdb Id pairs.
[apiInstance getTmdbMovieIdsWith:skip
    take:take
              completionHandler: ^(array[MovieExternalIdMap] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ExternalIdsApi()

var skip = 56; // {Integer} Determines where to start page.  Ex: 0 starts at the beginning.

var take = 56; // {Integer} Determines the page size.  (Maximum of 1000)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTmdbMovieIds(skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTmdbMovieIdsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ExternalIdsApi();
            var skip = 56;  // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
            var take = 56;  // Integer | Determines the page size.  (Maximum of 1000)

            try
            {
                // Returns list of all MovieId, Tmdb Id pairs.
                array[MovieExternalIdMap] result = apiInstance.getTmdbMovieIds(skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExternalIdsApi.getTmdbMovieIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ExternalIdsApi();
$skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
$take = 56; // Integer | Determines the page size.  (Maximum of 1000)

try {
    $result = $api_instance->getTmdbMovieIds($skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExternalIdsApi->getTmdbMovieIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExternalIdsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExternalIdsApi->new();
my $skip = 56; # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
my $take = 56; # Integer | Determines the page size.  (Maximum of 1000)

eval { 
    my $result = $api_instance->getTmdbMovieIds(skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExternalIdsApi->getTmdbMovieIds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExternalIdsApi()
skip = 56 # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
take = 56 # Integer | Determines the page size.  (Maximum of 1000)

try: 
    # Returns list of all MovieId, Tmdb Id pairs.
    api_response = api_instance.get_tmdb_movie_ids(skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExternalIdsApi->getTmdbMovieIds: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Determines where to start page. Ex: 0 starts at the beginning.
Required
Take*
Integer
Determines the page size. (Maximum of 1000)
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getTmdbShowIds

Returns list of all ShowId, TMDB Id pairs.

Use to link a TMDB ID to an IVA Show ID.


/ExternalIds/TmdbShow

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/ExternalIds/TmdbShow?Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExternalIdsApi;

import java.io.File;
import java.util.*;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[ShowExternalIdMap] result = apiInstance.getTmdbShowIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getTmdbShowIds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExternalIdsApi;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[ShowExternalIdMap] result = apiInstance.getTmdbShowIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getTmdbShowIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Determines where to start page.  Ex: 0 starts at the beginning.
Integer *take = 56; // Determines the page size.  (Maximum of 1000)

ExternalIdsApi *apiInstance = [[ExternalIdsApi alloc] init];

// Returns list of all ShowId, TMDB Id pairs.
[apiInstance getTmdbShowIdsWith:skip
    take:take
              completionHandler: ^(array[ShowExternalIdMap] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ExternalIdsApi()

var skip = 56; // {Integer} Determines where to start page.  Ex: 0 starts at the beginning.

var take = 56; // {Integer} Determines the page size.  (Maximum of 1000)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTmdbShowIds(skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTmdbShowIdsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ExternalIdsApi();
            var skip = 56;  // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
            var take = 56;  // Integer | Determines the page size.  (Maximum of 1000)

            try
            {
                // Returns list of all ShowId, TMDB Id pairs.
                array[ShowExternalIdMap] result = apiInstance.getTmdbShowIds(skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExternalIdsApi.getTmdbShowIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ExternalIdsApi();
$skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
$take = 56; // Integer | Determines the page size.  (Maximum of 1000)

try {
    $result = $api_instance->getTmdbShowIds($skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExternalIdsApi->getTmdbShowIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExternalIdsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExternalIdsApi->new();
my $skip = 56; # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
my $take = 56; # Integer | Determines the page size.  (Maximum of 1000)

eval { 
    my $result = $api_instance->getTmdbShowIds(skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExternalIdsApi->getTmdbShowIds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExternalIdsApi()
skip = 56 # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
take = 56 # Integer | Determines the page size.  (Maximum of 1000)

try: 
    # Returns list of all ShowId, TMDB Id pairs.
    api_response = api_instance.get_tmdb_show_ids(skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExternalIdsApi->getTmdbShowIds: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Determines where to start page. Ex: 0 starts at the beginning.
Required
Take*
Integer
Determines the page size. (Maximum of 1000)
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getWebediaMovieIds

Returns list of all MovieId, Webedia Id pairs.

Not accessible with a Demo account. **Special permissions needed** for access to this operation. Contact [Sales](mailto:sales@internetvideoarchive.com).


/ExternalIds/Webedia

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/ExternalIds/Webedia?Skip=&Take="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ExternalIdsApi;

import java.io.File;
import java.util.*;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[MovieExternalIdMap] result = apiInstance.getWebediaMovieIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getWebediaMovieIds");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ExternalIdsApi;

public class ExternalIdsApiExample {

    public static void main(String[] args) {
        ExternalIdsApi apiInstance = new ExternalIdsApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 1000)
        try {
            array[MovieExternalIdMap] result = apiInstance.getWebediaMovieIds(skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ExternalIdsApi#getWebediaMovieIds");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Determines where to start page.  Ex: 0 starts at the beginning.
Integer *take = 56; // Determines the page size.  (Maximum of 1000)

ExternalIdsApi *apiInstance = [[ExternalIdsApi alloc] init];

// Returns list of all MovieId, Webedia Id pairs.
[apiInstance getWebediaMovieIdsWith:skip
    take:take
              completionHandler: ^(array[MovieExternalIdMap] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ExternalIdsApi()

var skip = 56; // {Integer} Determines where to start page.  Ex: 0 starts at the beginning.

var take = 56; // {Integer} Determines the page size.  (Maximum of 1000)


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWebediaMovieIds(skip, take, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getWebediaMovieIdsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ExternalIdsApi();
            var skip = 56;  // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
            var take = 56;  // Integer | Determines the page size.  (Maximum of 1000)

            try
            {
                // Returns list of all MovieId, Webedia Id pairs.
                array[MovieExternalIdMap] result = apiInstance.getWebediaMovieIds(skip, take);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ExternalIdsApi.getWebediaMovieIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ExternalIdsApi();
$skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
$take = 56; // Integer | Determines the page size.  (Maximum of 1000)

try {
    $result = $api_instance->getWebediaMovieIds($skip, $take);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExternalIdsApi->getWebediaMovieIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ExternalIdsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ExternalIdsApi->new();
my $skip = 56; # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
my $take = 56; # Integer | Determines the page size.  (Maximum of 1000)

eval { 
    my $result = $api_instance->getWebediaMovieIds(skip => $skip, take => $take);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ExternalIdsApi->getWebediaMovieIds: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ExternalIdsApi()
skip = 56 # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
take = 56 # Integer | Determines the page size.  (Maximum of 1000)

try: 
    # Returns list of all MovieId, Webedia Id pairs.
    api_response = api_instance.get_webedia_movie_ids(skip, take)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ExternalIdsApi->getWebediaMovieIds: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Determines where to start page. Ex: 0 starts at the beginning.
Required
Take*
Integer
Determines the page size. (Maximum of 1000)
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


Find

findMovie

Find a movie using third party ID.

Use FindMovie with a third party ID like IMDB, TMDB, Gracenote, Tivo, etc. to find the corresponding movie in the IVA database. For a full list of supported ID types see /Movies/AlternateIdTypes. `Recommendation: Use with small data sets or for a proof of concept. `


/Find/Movie/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Find/Movie/?IdType=&Id=&Includes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FindApi;

import java.io.File;
import java.util.*;

public class FindApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        FindApi apiInstance = new FindApi();
        Integer idType = 56; // Integer | Required third party ID type of MovieAlternateId.
        String id = id_example; // String | Required third party ID of Movie.
        array[String] includes = ; // array[String] | List of additional objects to include in the movie object.
        try {
            MovieResponse result = apiInstance.findMovie(idType, id, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FindApi#findMovie");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FindApi;

public class FindApiExample {

    public static void main(String[] args) {
        FindApi apiInstance = new FindApi();
        Integer idType = 56; // Integer | Required third party ID type of MovieAlternateId.
        String id = id_example; // String | Required third party ID of Movie.
        array[String] includes = ; // array[String] | List of additional objects to include in the movie object.
        try {
            MovieResponse result = apiInstance.findMovie(idType, id, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FindApi#findMovie");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *idType = 56; // Required third party ID type of MovieAlternateId.
String *id = id_example; // Required third party ID of Movie.
array[String] *includes = ; // List of additional objects to include in the movie object. (optional)

FindApi *apiInstance = [[FindApi alloc] init];

// Find a movie using third party ID.
[apiInstance findMovieWith:idType
    id:id
    includes:includes
              completionHandler: ^(MovieResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.FindApi()

var idType = 56; // {Integer} Required third party ID type of MovieAlternateId.

var id = id_example; // {String} Required third party ID of Movie.

var opts = { 
  'includes':  // {array[String]} List of additional objects to include in the movie object.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findMovie(idType, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findMovieExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new FindApi();
            var idType = 56;  // Integer | Required third party ID type of MovieAlternateId.
            var id = id_example;  // String | Required third party ID of Movie.
            var includes = new array[String](); // array[String] | List of additional objects to include in the movie object. (optional) 

            try
            {
                // Find a movie using third party ID.
                MovieResponse result = apiInstance.findMovie(idType, id, includes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FindApi.findMovie: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\FindApi();
$idType = 56; // Integer | Required third party ID type of MovieAlternateId.
$id = id_example; // String | Required third party ID of Movie.
$includes = ; // array[String] | List of additional objects to include in the movie object.

try {
    $result = $api_instance->findMovie($idType, $id, $includes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FindApi->findMovie: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FindApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FindApi->new();
my $idType = 56; # Integer | Required third party ID type of MovieAlternateId.
my $id = id_example; # String | Required third party ID of Movie.
my $includes = []; # array[String] | List of additional objects to include in the movie object.

eval { 
    my $result = $api_instance->findMovie(idType => $idType, id => $id, includes => $includes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FindApi->findMovie: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FindApi()
idType = 56 # Integer | Required third party ID type of MovieAlternateId.
id = id_example # String | Required third party ID of Movie.
includes =  # array[String] | List of additional objects to include in the movie object. (optional)

try: 
    # Find a movie using third party ID.
    api_response = api_instance.find_movie(idType, id, includes=includes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FindApi->findMovie: %s\n" % e)

Parameters

Query parameters
Name Description
IdType*
Integer
Required third party ID type of MovieAlternateId.
Required
Id*
String
Required third party ID of Movie.
Required
Includes
array[String]
List of additional objects to include in the movie object.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


findShow

Find a TV show using a third party ID.

Use FindShow with a third party ID like IMDB, TMDB, Gracenote, Tivo, etc. to find the corresponding TV show in the IVA database. For a full list of supported ID types see /Shows/AlternateIdTypes. `Recommendation: Use with small data sets or for a proof of concept. `


/Find/Show/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Find/Show/?IdType=&Id=&Includes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FindApi;

import java.io.File;
import java.util.*;

public class FindApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        FindApi apiInstance = new FindApi();
        Integer idType = 56; // Integer | Required third party ID type of ShowAlternateId.
        String id = id_example; // String | Required third party ID of Show.
        array[String] includes = ; // array[String] | List of additional objects to include in the show response.
        try {
            ShowResponse result = apiInstance.findShow(idType, id, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FindApi#findShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.FindApi;

public class FindApiExample {

    public static void main(String[] args) {
        FindApi apiInstance = new FindApi();
        Integer idType = 56; // Integer | Required third party ID type of ShowAlternateId.
        String id = id_example; // String | Required third party ID of Show.
        array[String] includes = ; // array[String] | List of additional objects to include in the show response.
        try {
            ShowResponse result = apiInstance.findShow(idType, id, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FindApi#findShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *idType = 56; // Required third party ID type of ShowAlternateId.
String *id = id_example; // Required third party ID of Show.
array[String] *includes = ; // List of additional objects to include in the show response. (optional)

FindApi *apiInstance = [[FindApi alloc] init];

// Find a TV show using a third party ID.
[apiInstance findShowWith:idType
    id:id
    includes:includes
              completionHandler: ^(ShowResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.FindApi()

var idType = 56; // {Integer} Required third party ID type of ShowAlternateId.

var id = id_example; // {String} Required third party ID of Show.

var opts = { 
  'includes':  // {array[String]} List of additional objects to include in the show response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.findShow(idType, id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class findShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new FindApi();
            var idType = 56;  // Integer | Required third party ID type of ShowAlternateId.
            var id = id_example;  // String | Required third party ID of Show.
            var includes = new array[String](); // array[String] | List of additional objects to include in the show response. (optional) 

            try
            {
                // Find a TV show using a third party ID.
                ShowResponse result = apiInstance.findShow(idType, id, includes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FindApi.findShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\FindApi();
$idType = 56; // Integer | Required third party ID type of ShowAlternateId.
$id = id_example; // String | Required third party ID of Show.
$includes = ; // array[String] | List of additional objects to include in the show response.

try {
    $result = $api_instance->findShow($idType, $id, $includes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FindApi->findShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FindApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::FindApi->new();
my $idType = 56; # Integer | Required third party ID type of ShowAlternateId.
my $id = id_example; # String | Required third party ID of Show.
my $includes = []; # array[String] | List of additional objects to include in the show response.

eval { 
    my $result = $api_instance->findShow(idType => $idType, id => $id, includes => $includes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FindApi->findShow: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.FindApi()
idType = 56 # Integer | Required third party ID type of ShowAlternateId.
id = id_example # String | Required third party ID of Show.
includes =  # array[String] | List of additional objects to include in the show response. (optional)

try: 
    # Find a TV show using a third party ID.
    api_response = api_instance.find_show(idType, id, includes=includes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FindApi->findShow: %s\n" % e)

Parameters

Query parameters
Name Description
IdType*
Integer
Required third party ID type of ShowAlternateId.
Required
Id*
String
Required third party ID of Show.
Required
Includes
array[String]
List of additional objects to include in the show response.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


Images

getImage

Redirect to an image based on filepath.

Images should be downloaded and stored on the client server. Use /Common/ImageTypes to see a list of available image types. `Note: The swagger U/I does not support redirects.`


/Images/{FilePath}/Redirect

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Images/{FilePath}/Redirect?Redirect="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ImagesApi;

import java.io.File;
import java.util.*;

public class ImagesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ImagesApi apiInstance = new ImagesApi();
        String filePath = filePath_example; // String | Filepath of Image.
        String redirect = redirect_example; // String | Redirect to the image. Default = true
        try {
            ImageRedirectResponse result = apiInstance.getImage(filePath, redirect);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImagesApi#getImage");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImagesApi;

public class ImagesApiExample {

    public static void main(String[] args) {
        ImagesApi apiInstance = new ImagesApi();
        String filePath = filePath_example; // String | Filepath of Image.
        String redirect = redirect_example; // String | Redirect to the image. Default = true
        try {
            ImageRedirectResponse result = apiInstance.getImage(filePath, redirect);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImagesApi#getImage");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *filePath = filePath_example; // Filepath of Image.
String *redirect = redirect_example; // Redirect to the image. Default = true (optional)

ImagesApi *apiInstance = [[ImagesApi alloc] init];

// Redirect to an image based on filepath.
[apiInstance getImageWith:filePath
    redirect:redirect
              completionHandler: ^(ImageRedirectResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ImagesApi()

var filePath = filePath_example; // {String} Filepath of Image.

var opts = { 
  'redirect': redirect_example // {String} Redirect to the image. Default = true
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getImage(filePath, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getImageExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ImagesApi();
            var filePath = filePath_example;  // String | Filepath of Image.
            var redirect = redirect_example;  // String | Redirect to the image. Default = true (optional) 

            try
            {
                // Redirect to an image based on filepath.
                ImageRedirectResponse result = apiInstance.getImage(filePath, redirect);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImagesApi.getImage: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ImagesApi();
$filePath = filePath_example; // String | Filepath of Image.
$redirect = redirect_example; // String | Redirect to the image. Default = true

try {
    $result = $api_instance->getImage($filePath, $redirect);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImagesApi->getImage: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ImagesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ImagesApi->new();
my $filePath = filePath_example; # String | Filepath of Image.
my $redirect = redirect_example; # String | Redirect to the image. Default = true

eval { 
    my $result = $api_instance->getImage(filePath => $filePath, redirect => $redirect);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImagesApi->getImage: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ImagesApi()
filePath = filePath_example # String | Filepath of Image.
redirect = redirect_example # String | Redirect to the image. Default = true (optional)

try: 
    # Redirect to an image based on filepath.
    api_response = api_instance.get_image(filePath, redirect=redirect)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImagesApi->getImage: %s\n" % e)

Parameters

Path parameters
Name Description
FilePath*
String
Filepath of Image.
Required
Query parameters
Name Description
Redirect
String
Redirect to the image. Default = true

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getScreenCapture

Redirect to a screen capture based on filepath.

Requires a valid filepath of a video asset screen capture. `Note: The swagger U/I does not support redirects.`


/Images/ScreenCaptures/Redirect

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Images/ScreenCaptures/Redirect?FilePath=&Redirect="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ImagesApi;

import java.io.File;
import java.util.*;

public class ImagesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ImagesApi apiInstance = new ImagesApi();
        String filePath = filePath_example; // String | Filepath of Image.
        String redirect = redirect_example; // String | Redirect to the image. Default = true
        try {
            ScreenCaptureRedirectResponse result = apiInstance.getScreenCapture(filePath, redirect);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImagesApi#getScreenCapture");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ImagesApi;

public class ImagesApiExample {

    public static void main(String[] args) {
        ImagesApi apiInstance = new ImagesApi();
        String filePath = filePath_example; // String | Filepath of Image.
        String redirect = redirect_example; // String | Redirect to the image. Default = true
        try {
            ScreenCaptureRedirectResponse result = apiInstance.getScreenCapture(filePath, redirect);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ImagesApi#getScreenCapture");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *filePath = filePath_example; // Filepath of Image.
String *redirect = redirect_example; // Redirect to the image. Default = true (optional)

ImagesApi *apiInstance = [[ImagesApi alloc] init];

// Redirect to a screen capture based on filepath.
[apiInstance getScreenCaptureWith:filePath
    redirect:redirect
              completionHandler: ^(ScreenCaptureRedirectResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ImagesApi()

var filePath = filePath_example; // {String} Filepath of Image.

var opts = { 
  'redirect': redirect_example // {String} Redirect to the image. Default = true
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getScreenCapture(filePath, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getScreenCaptureExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ImagesApi();
            var filePath = filePath_example;  // String | Filepath of Image.
            var redirect = redirect_example;  // String | Redirect to the image. Default = true (optional) 

            try
            {
                // Redirect to a screen capture based on filepath.
                ScreenCaptureRedirectResponse result = apiInstance.getScreenCapture(filePath, redirect);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ImagesApi.getScreenCapture: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ImagesApi();
$filePath = filePath_example; // String | Filepath of Image.
$redirect = redirect_example; // String | Redirect to the image. Default = true

try {
    $result = $api_instance->getScreenCapture($filePath, $redirect);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ImagesApi->getScreenCapture: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ImagesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ImagesApi->new();
my $filePath = filePath_example; # String | Filepath of Image.
my $redirect = redirect_example; # String | Redirect to the image. Default = true

eval { 
    my $result = $api_instance->getScreenCapture(filePath => $filePath, redirect => $redirect);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ImagesApi->getScreenCapture: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ImagesApi()
filePath = filePath_example # String | Filepath of Image.
redirect = redirect_example # String | Redirect to the image. Default = true (optional)

try: 
    # Redirect to a screen capture based on filepath.
    api_response = api_instance.get_screen_capture(filePath, redirect=redirect)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ImagesApi->getScreenCapture: %s\n" % e)

Parameters

Query parameters
Name Description
FilePath*
String
Filepath of Image.
Required
Redirect
String
Redirect to the image. Default = true

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


MovieTickets

getMovieTicketsCultures

Get MovieTickets Cultures.

Returns MovieTickets Cultures.


/MovieTickets/Cultures

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/MovieTickets/Cultures"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MovieTicketsApi;

import java.io.File;
import java.util.*;

public class MovieTicketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MovieTicketsApi apiInstance = new MovieTicketsApi();
        try {
            MovieTicketsCulturesResponse result = apiInstance.getMovieTicketsCultures();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MovieTicketsApi#getMovieTicketsCultures");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MovieTicketsApi;

public class MovieTicketsApiExample {

    public static void main(String[] args) {
        MovieTicketsApi apiInstance = new MovieTicketsApi();
        try {
            MovieTicketsCulturesResponse result = apiInstance.getMovieTicketsCultures();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MovieTicketsApi#getMovieTicketsCultures");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];


MovieTicketsApi *apiInstance = [[MovieTicketsApi alloc] init];

// Get MovieTickets Cultures.
[apiInstance getMovieTicketsCulturesWithCompletionHandler: 
              ^(MovieTicketsCulturesResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MovieTicketsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMovieTicketsCultures(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMovieTicketsCulturesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MovieTicketsApi();

            try
            {
                // Get MovieTickets Cultures.
                MovieTicketsCulturesResponse result = apiInstance.getMovieTicketsCultures();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MovieTicketsApi.getMovieTicketsCultures: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MovieTicketsApi();

try {
    $result = $api_instance->getMovieTicketsCultures();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MovieTicketsApi->getMovieTicketsCultures: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MovieTicketsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MovieTicketsApi->new();

eval { 
    my $result = $api_instance->getMovieTicketsCultures();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MovieTicketsApi->getMovieTicketsCultures: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MovieTicketsApi()

try: 
    # Get MovieTickets Cultures.
    api_response = api_instance.get_movie_tickets_cultures()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MovieTicketsApi->getMovieTicketsCultures: %s\n" % e)

Parameters

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getMovieTicketsMoviesComingSoon

Get MovieTickets Movies releasing soon.

Returns MovieTickets Movies releasing soon.


/MovieTickets/Movies/ComingSoon

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/MovieTickets/Movies/ComingSoon?Culture=&PageNumber=&PageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MovieTicketsApi;

import java.io.File;
import java.util.*;

public class MovieTicketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MovieTicketsApi apiInstance = new MovieTicketsApi();
        String culture = culture_example; // String | Culture to retrieve response. Default en-us.
        Integer pageNumber = 56; // Integer | Page number for paging results. Used in conjunction with PageSize.
        Integer pageSize = 56; // Integer | Limits the total items returned. Maximum of 100 per request.
        try {
            MovieTicketsMoviesComingSoonResponse result = apiInstance.getMovieTicketsMoviesComingSoon(culture, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MovieTicketsApi#getMovieTicketsMoviesComingSoon");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MovieTicketsApi;

public class MovieTicketsApiExample {

    public static void main(String[] args) {
        MovieTicketsApi apiInstance = new MovieTicketsApi();
        String culture = culture_example; // String | Culture to retrieve response. Default en-us.
        Integer pageNumber = 56; // Integer | Page number for paging results. Used in conjunction with PageSize.
        Integer pageSize = 56; // Integer | Limits the total items returned. Maximum of 100 per request.
        try {
            MovieTicketsMoviesComingSoonResponse result = apiInstance.getMovieTicketsMoviesComingSoon(culture, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MovieTicketsApi#getMovieTicketsMoviesComingSoon");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *culture = culture_example; // Culture to retrieve response. Default en-us. (optional)
Integer *pageNumber = 56; // Page number for paging results. Used in conjunction with PageSize. (optional)
Integer *pageSize = 56; // Limits the total items returned. Maximum of 100 per request. (optional)

MovieTicketsApi *apiInstance = [[MovieTicketsApi alloc] init];

// Get MovieTickets Movies releasing soon.
[apiInstance getMovieTicketsMoviesComingSoonWith:culture
    pageNumber:pageNumber
    pageSize:pageSize
              completionHandler: ^(MovieTicketsMoviesComingSoonResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MovieTicketsApi()

var opts = { 
  'culture': culture_example, // {String} Culture to retrieve response. Default en-us.
  'pageNumber': 56, // {Integer} Page number for paging results. Used in conjunction with PageSize.
  'pageSize': 56 // {Integer} Limits the total items returned. Maximum of 100 per request.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMovieTicketsMoviesComingSoon(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMovieTicketsMoviesComingSoonExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MovieTicketsApi();
            var culture = culture_example;  // String | Culture to retrieve response. Default en-us. (optional) 
            var pageNumber = 56;  // Integer | Page number for paging results. Used in conjunction with PageSize. (optional) 
            var pageSize = 56;  // Integer | Limits the total items returned. Maximum of 100 per request. (optional) 

            try
            {
                // Get MovieTickets Movies releasing soon.
                MovieTicketsMoviesComingSoonResponse result = apiInstance.getMovieTicketsMoviesComingSoon(culture, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MovieTicketsApi.getMovieTicketsMoviesComingSoon: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MovieTicketsApi();
$culture = culture_example; // String | Culture to retrieve response. Default en-us.
$pageNumber = 56; // Integer | Page number for paging results. Used in conjunction with PageSize.
$pageSize = 56; // Integer | Limits the total items returned. Maximum of 100 per request.

try {
    $result = $api_instance->getMovieTicketsMoviesComingSoon($culture, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MovieTicketsApi->getMovieTicketsMoviesComingSoon: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MovieTicketsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MovieTicketsApi->new();
my $culture = culture_example; # String | Culture to retrieve response. Default en-us.
my $pageNumber = 56; # Integer | Page number for paging results. Used in conjunction with PageSize.
my $pageSize = 56; # Integer | Limits the total items returned. Maximum of 100 per request.

eval { 
    my $result = $api_instance->getMovieTicketsMoviesComingSoon(culture => $culture, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MovieTicketsApi->getMovieTicketsMoviesComingSoon: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MovieTicketsApi()
culture = culture_example # String | Culture to retrieve response. Default en-us. (optional)
pageNumber = 56 # Integer | Page number for paging results. Used in conjunction with PageSize. (optional)
pageSize = 56 # Integer | Limits the total items returned. Maximum of 100 per request. (optional)

try: 
    # Get MovieTickets Movies releasing soon.
    api_response = api_instance.get_movie_tickets_movies_coming_soon(culture=culture, pageNumber=pageNumber, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MovieTicketsApi->getMovieTicketsMoviesComingSoon: %s\n" % e)

Parameters

Query parameters
Name Description
Culture
String
Culture to retrieve response. Default en-us.
PageNumber
Integer
Page number for paging results. Used in conjunction with PageSize.
PageSize
Integer
Limits the total items returned. Maximum of 100 per request.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getMovieTicketsMoviesNowPlaying

Get MovieTickets Movies in theaters.

Returns MovieTickets Movies currently in theaters.


/MovieTickets/Movies/NowPlaying

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/MovieTickets/Movies/NowPlaying?Culture=&PageNumber=&PageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MovieTicketsApi;

import java.io.File;
import java.util.*;

public class MovieTicketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MovieTicketsApi apiInstance = new MovieTicketsApi();
        String culture = culture_example; // String | Culture to retrieve response. Default en-us.
        Integer pageNumber = 56; // Integer | Page number for paging results. Used in conjunction with PageSize.
        Integer pageSize = 56; // Integer | Limits the total items returned. Maximum of 100 per request.
        try {
            MovieTicketsMoviesNowPlayingResponse result = apiInstance.getMovieTicketsMoviesNowPlaying(culture, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MovieTicketsApi#getMovieTicketsMoviesNowPlaying");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MovieTicketsApi;

public class MovieTicketsApiExample {

    public static void main(String[] args) {
        MovieTicketsApi apiInstance = new MovieTicketsApi();
        String culture = culture_example; // String | Culture to retrieve response. Default en-us.
        Integer pageNumber = 56; // Integer | Page number for paging results. Used in conjunction with PageSize.
        Integer pageSize = 56; // Integer | Limits the total items returned. Maximum of 100 per request.
        try {
            MovieTicketsMoviesNowPlayingResponse result = apiInstance.getMovieTicketsMoviesNowPlaying(culture, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MovieTicketsApi#getMovieTicketsMoviesNowPlaying");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *culture = culture_example; // Culture to retrieve response. Default en-us. (optional)
Integer *pageNumber = 56; // Page number for paging results. Used in conjunction with PageSize. (optional)
Integer *pageSize = 56; // Limits the total items returned. Maximum of 100 per request. (optional)

MovieTicketsApi *apiInstance = [[MovieTicketsApi alloc] init];

// Get MovieTickets Movies in theaters.
[apiInstance getMovieTicketsMoviesNowPlayingWith:culture
    pageNumber:pageNumber
    pageSize:pageSize
              completionHandler: ^(MovieTicketsMoviesNowPlayingResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MovieTicketsApi()

var opts = { 
  'culture': culture_example, // {String} Culture to retrieve response. Default en-us.
  'pageNumber': 56, // {Integer} Page number for paging results. Used in conjunction with PageSize.
  'pageSize': 56 // {Integer} Limits the total items returned. Maximum of 100 per request.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMovieTicketsMoviesNowPlaying(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMovieTicketsMoviesNowPlayingExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MovieTicketsApi();
            var culture = culture_example;  // String | Culture to retrieve response. Default en-us. (optional) 
            var pageNumber = 56;  // Integer | Page number for paging results. Used in conjunction with PageSize. (optional) 
            var pageSize = 56;  // Integer | Limits the total items returned. Maximum of 100 per request. (optional) 

            try
            {
                // Get MovieTickets Movies in theaters.
                MovieTicketsMoviesNowPlayingResponse result = apiInstance.getMovieTicketsMoviesNowPlaying(culture, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MovieTicketsApi.getMovieTicketsMoviesNowPlaying: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MovieTicketsApi();
$culture = culture_example; // String | Culture to retrieve response. Default en-us.
$pageNumber = 56; // Integer | Page number for paging results. Used in conjunction with PageSize.
$pageSize = 56; // Integer | Limits the total items returned. Maximum of 100 per request.

try {
    $result = $api_instance->getMovieTicketsMoviesNowPlaying($culture, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MovieTicketsApi->getMovieTicketsMoviesNowPlaying: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MovieTicketsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MovieTicketsApi->new();
my $culture = culture_example; # String | Culture to retrieve response. Default en-us.
my $pageNumber = 56; # Integer | Page number for paging results. Used in conjunction with PageSize.
my $pageSize = 56; # Integer | Limits the total items returned. Maximum of 100 per request.

eval { 
    my $result = $api_instance->getMovieTicketsMoviesNowPlaying(culture => $culture, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MovieTicketsApi->getMovieTicketsMoviesNowPlaying: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MovieTicketsApi()
culture = culture_example # String | Culture to retrieve response. Default en-us. (optional)
pageNumber = 56 # Integer | Page number for paging results. Used in conjunction with PageSize. (optional)
pageSize = 56 # Integer | Limits the total items returned. Maximum of 100 per request. (optional)

try: 
    # Get MovieTickets Movies in theaters.
    api_response = api_instance.get_movie_tickets_movies_now_playing(culture=culture, pageNumber=pageNumber, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MovieTicketsApi->getMovieTicketsMoviesNowPlaying: %s\n" % e)

Parameters

Query parameters
Name Description
Culture
String
Culture to retrieve response. Default en-us.
PageNumber
Integer
Page number for paging results. Used in conjunction with PageSize.
PageSize
Integer
Limits the total items returned. Maximum of 100 per request.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getMovieTicketsPerformances

Get MovieTickets Performances.

Returns MovieTickets Performances by MovieTickets Theater ID, Entertainment Movie ID, and ScheduleDate.


/MovieTickets/Performances

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/MovieTickets/Performances?Culture=&ScheduleDate=&TheaterIds=&EntertainmentMovieIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MovieTicketsApi;

import java.io.File;
import java.util.*;

public class MovieTicketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MovieTicketsApi apiInstance = new MovieTicketsApi();
        String scheduleDate = scheduleDate_example; // String | Date to get scheduled performances.
        String theaterIds = theaterIds_example; // String | Required ID/IDs of MovieTickets Theaters. Comma-seperated for multiple.
        String entertainmentMovieIds = entertainmentMovieIds_example; // String | Required ID/IDs of Entertainment Movies. Comma-seperated for multiple.
        String culture = culture_example; // String | Culture to retrieve response. Default en-us.
        try {
            MovieTicketsPerformancesResponse result = apiInstance.getMovieTicketsPerformances(scheduleDate, theaterIds, entertainmentMovieIds, culture);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MovieTicketsApi#getMovieTicketsPerformances");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MovieTicketsApi;

public class MovieTicketsApiExample {

    public static void main(String[] args) {
        MovieTicketsApi apiInstance = new MovieTicketsApi();
        String scheduleDate = scheduleDate_example; // String | Date to get scheduled performances.
        String theaterIds = theaterIds_example; // String | Required ID/IDs of MovieTickets Theaters. Comma-seperated for multiple.
        String entertainmentMovieIds = entertainmentMovieIds_example; // String | Required ID/IDs of Entertainment Movies. Comma-seperated for multiple.
        String culture = culture_example; // String | Culture to retrieve response. Default en-us.
        try {
            MovieTicketsPerformancesResponse result = apiInstance.getMovieTicketsPerformances(scheduleDate, theaterIds, entertainmentMovieIds, culture);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MovieTicketsApi#getMovieTicketsPerformances");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *scheduleDate = scheduleDate_example; // Date to get scheduled performances.
String *theaterIds = theaterIds_example; // Required ID/IDs of MovieTickets Theaters. Comma-seperated for multiple.
String *entertainmentMovieIds = entertainmentMovieIds_example; // Required ID/IDs of Entertainment Movies. Comma-seperated for multiple.
String *culture = culture_example; // Culture to retrieve response. Default en-us. (optional)

MovieTicketsApi *apiInstance = [[MovieTicketsApi alloc] init];

// Get MovieTickets Performances.
[apiInstance getMovieTicketsPerformancesWith:scheduleDate
    theaterIds:theaterIds
    entertainmentMovieIds:entertainmentMovieIds
    culture:culture
              completionHandler: ^(MovieTicketsPerformancesResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MovieTicketsApi()

var scheduleDate = scheduleDate_example; // {String} Date to get scheduled performances.

var theaterIds = theaterIds_example; // {String} Required ID/IDs of MovieTickets Theaters. Comma-seperated for multiple.

var entertainmentMovieIds = entertainmentMovieIds_example; // {String} Required ID/IDs of Entertainment Movies. Comma-seperated for multiple.

var opts = { 
  'culture': culture_example // {String} Culture to retrieve response. Default en-us.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMovieTicketsPerformances(scheduleDate, theaterIds, entertainmentMovieIds, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMovieTicketsPerformancesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MovieTicketsApi();
            var scheduleDate = scheduleDate_example;  // String | Date to get scheduled performances.
            var theaterIds = theaterIds_example;  // String | Required ID/IDs of MovieTickets Theaters. Comma-seperated for multiple.
            var entertainmentMovieIds = entertainmentMovieIds_example;  // String | Required ID/IDs of Entertainment Movies. Comma-seperated for multiple.
            var culture = culture_example;  // String | Culture to retrieve response. Default en-us. (optional) 

            try
            {
                // Get MovieTickets Performances.
                MovieTicketsPerformancesResponse result = apiInstance.getMovieTicketsPerformances(scheduleDate, theaterIds, entertainmentMovieIds, culture);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MovieTicketsApi.getMovieTicketsPerformances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MovieTicketsApi();
$scheduleDate = scheduleDate_example; // String | Date to get scheduled performances.
$theaterIds = theaterIds_example; // String | Required ID/IDs of MovieTickets Theaters. Comma-seperated for multiple.
$entertainmentMovieIds = entertainmentMovieIds_example; // String | Required ID/IDs of Entertainment Movies. Comma-seperated for multiple.
$culture = culture_example; // String | Culture to retrieve response. Default en-us.

try {
    $result = $api_instance->getMovieTicketsPerformances($scheduleDate, $theaterIds, $entertainmentMovieIds, $culture);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MovieTicketsApi->getMovieTicketsPerformances: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MovieTicketsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MovieTicketsApi->new();
my $scheduleDate = scheduleDate_example; # String | Date to get scheduled performances.
my $theaterIds = theaterIds_example; # String | Required ID/IDs of MovieTickets Theaters. Comma-seperated for multiple.
my $entertainmentMovieIds = entertainmentMovieIds_example; # String | Required ID/IDs of Entertainment Movies. Comma-seperated for multiple.
my $culture = culture_example; # String | Culture to retrieve response. Default en-us.

eval { 
    my $result = $api_instance->getMovieTicketsPerformances(scheduleDate => $scheduleDate, theaterIds => $theaterIds, entertainmentMovieIds => $entertainmentMovieIds, culture => $culture);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MovieTicketsApi->getMovieTicketsPerformances: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MovieTicketsApi()
scheduleDate = scheduleDate_example # String | Date to get scheduled performances.
theaterIds = theaterIds_example # String | Required ID/IDs of MovieTickets Theaters. Comma-seperated for multiple.
entertainmentMovieIds = entertainmentMovieIds_example # String | Required ID/IDs of Entertainment Movies. Comma-seperated for multiple.
culture = culture_example # String | Culture to retrieve response. Default en-us. (optional)

try: 
    # Get MovieTickets Performances.
    api_response = api_instance.get_movie_tickets_performances(scheduleDate, theaterIds, entertainmentMovieIds, culture=culture)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MovieTicketsApi->getMovieTicketsPerformances: %s\n" % e)

Parameters

Query parameters
Name Description
Culture
String
Culture to retrieve response. Default en-us.
ScheduleDate*
String
Date to get scheduled performances.
Required
TheaterIds*
String
Required ID/IDs of MovieTickets Theaters. Comma-seperated for multiple.
Required
EntertainmentMovieIds*
String
Required ID/IDs of Entertainment Movies. Comma-seperated for multiple.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getMovieTicketsTheaters

Get MovieTickets Theaters.

Returns MovieTickets Theaters by postal code.


/MovieTickets/Theaters

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/MovieTickets/Theaters?Culture=&PostalCode=&Longitude=&Latitude=&Distance=&PageNumber=&PageSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MovieTicketsApi;

import java.io.File;
import java.util.*;

public class MovieTicketsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MovieTicketsApi apiInstance = new MovieTicketsApi();
        String distance = distance_example; // String | Required distaince in meters.
        String culture = culture_example; // String | Culture to retrieve response. Default en-us.
        String postalCode = postalCode_example; // String | Postal code. Longitude/Latitude not required if passed.
        String longitude = longitude_example; // String | Longitude coordinate. Used in conjunction with Latitude. Postal code not required if passed.
        String latitude = latitude_example; // String | Latitude coordinate. Used in conjunction with Longitude. Postal code not required if passed.
        Integer pageNumber = 56; // Integer | Page number for paging results. Used in conjunction with PageSize.
        Integer pageSize = 56; // Integer | Limits the total items returned. Maximum of 100 per request.
        try {
            MovieTicketsTheatersResponse result = apiInstance.getMovieTicketsTheaters(distance, culture, postalCode, longitude, latitude, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MovieTicketsApi#getMovieTicketsTheaters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MovieTicketsApi;

public class MovieTicketsApiExample {

    public static void main(String[] args) {
        MovieTicketsApi apiInstance = new MovieTicketsApi();
        String distance = distance_example; // String | Required distaince in meters.
        String culture = culture_example; // String | Culture to retrieve response. Default en-us.
        String postalCode = postalCode_example; // String | Postal code. Longitude/Latitude not required if passed.
        String longitude = longitude_example; // String | Longitude coordinate. Used in conjunction with Latitude. Postal code not required if passed.
        String latitude = latitude_example; // String | Latitude coordinate. Used in conjunction with Longitude. Postal code not required if passed.
        Integer pageNumber = 56; // Integer | Page number for paging results. Used in conjunction with PageSize.
        Integer pageSize = 56; // Integer | Limits the total items returned. Maximum of 100 per request.
        try {
            MovieTicketsTheatersResponse result = apiInstance.getMovieTicketsTheaters(distance, culture, postalCode, longitude, latitude, pageNumber, pageSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MovieTicketsApi#getMovieTicketsTheaters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *distance = distance_example; // Required distaince in meters.
String *culture = culture_example; // Culture to retrieve response. Default en-us. (optional)
String *postalCode = postalCode_example; // Postal code. Longitude/Latitude not required if passed. (optional)
String *longitude = longitude_example; // Longitude coordinate. Used in conjunction with Latitude. Postal code not required if passed. (optional)
String *latitude = latitude_example; // Latitude coordinate. Used in conjunction with Longitude. Postal code not required if passed. (optional)
Integer *pageNumber = 56; // Page number for paging results. Used in conjunction with PageSize. (optional)
Integer *pageSize = 56; // Limits the total items returned. Maximum of 100 per request. (optional)

MovieTicketsApi *apiInstance = [[MovieTicketsApi alloc] init];

// Get MovieTickets Theaters.
[apiInstance getMovieTicketsTheatersWith:distance
    culture:culture
    postalCode:postalCode
    longitude:longitude
    latitude:latitude
    pageNumber:pageNumber
    pageSize:pageSize
              completionHandler: ^(MovieTicketsTheatersResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MovieTicketsApi()

var distance = distance_example; // {String} Required distaince in meters.

var opts = { 
  'culture': culture_example, // {String} Culture to retrieve response. Default en-us.
  'postalCode': postalCode_example, // {String} Postal code. Longitude/Latitude not required if passed.
  'longitude': longitude_example, // {String} Longitude coordinate. Used in conjunction with Latitude. Postal code not required if passed.
  'latitude': latitude_example, // {String} Latitude coordinate. Used in conjunction with Longitude. Postal code not required if passed.
  'pageNumber': 56, // {Integer} Page number for paging results. Used in conjunction with PageSize.
  'pageSize': 56 // {Integer} Limits the total items returned. Maximum of 100 per request.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMovieTicketsTheaters(distance, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMovieTicketsTheatersExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MovieTicketsApi();
            var distance = distance_example;  // String | Required distaince in meters.
            var culture = culture_example;  // String | Culture to retrieve response. Default en-us. (optional) 
            var postalCode = postalCode_example;  // String | Postal code. Longitude/Latitude not required if passed. (optional) 
            var longitude = longitude_example;  // String | Longitude coordinate. Used in conjunction with Latitude. Postal code not required if passed. (optional) 
            var latitude = latitude_example;  // String | Latitude coordinate. Used in conjunction with Longitude. Postal code not required if passed. (optional) 
            var pageNumber = 56;  // Integer | Page number for paging results. Used in conjunction with PageSize. (optional) 
            var pageSize = 56;  // Integer | Limits the total items returned. Maximum of 100 per request. (optional) 

            try
            {
                // Get MovieTickets Theaters.
                MovieTicketsTheatersResponse result = apiInstance.getMovieTicketsTheaters(distance, culture, postalCode, longitude, latitude, pageNumber, pageSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MovieTicketsApi.getMovieTicketsTheaters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MovieTicketsApi();
$distance = distance_example; // String | Required distaince in meters.
$culture = culture_example; // String | Culture to retrieve response. Default en-us.
$postalCode = postalCode_example; // String | Postal code. Longitude/Latitude not required if passed.
$longitude = longitude_example; // String | Longitude coordinate. Used in conjunction with Latitude. Postal code not required if passed.
$latitude = latitude_example; // String | Latitude coordinate. Used in conjunction with Longitude. Postal code not required if passed.
$pageNumber = 56; // Integer | Page number for paging results. Used in conjunction with PageSize.
$pageSize = 56; // Integer | Limits the total items returned. Maximum of 100 per request.

try {
    $result = $api_instance->getMovieTicketsTheaters($distance, $culture, $postalCode, $longitude, $latitude, $pageNumber, $pageSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MovieTicketsApi->getMovieTicketsTheaters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MovieTicketsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MovieTicketsApi->new();
my $distance = distance_example; # String | Required distaince in meters.
my $culture = culture_example; # String | Culture to retrieve response. Default en-us.
my $postalCode = postalCode_example; # String | Postal code. Longitude/Latitude not required if passed.
my $longitude = longitude_example; # String | Longitude coordinate. Used in conjunction with Latitude. Postal code not required if passed.
my $latitude = latitude_example; # String | Latitude coordinate. Used in conjunction with Longitude. Postal code not required if passed.
my $pageNumber = 56; # Integer | Page number for paging results. Used in conjunction with PageSize.
my $pageSize = 56; # Integer | Limits the total items returned. Maximum of 100 per request.

eval { 
    my $result = $api_instance->getMovieTicketsTheaters(distance => $distance, culture => $culture, postalCode => $postalCode, longitude => $longitude, latitude => $latitude, pageNumber => $pageNumber, pageSize => $pageSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MovieTicketsApi->getMovieTicketsTheaters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MovieTicketsApi()
distance = distance_example # String | Required distaince in meters.
culture = culture_example # String | Culture to retrieve response. Default en-us. (optional)
postalCode = postalCode_example # String | Postal code. Longitude/Latitude not required if passed. (optional)
longitude = longitude_example # String | Longitude coordinate. Used in conjunction with Latitude. Postal code not required if passed. (optional)
latitude = latitude_example # String | Latitude coordinate. Used in conjunction with Longitude. Postal code not required if passed. (optional)
pageNumber = 56 # Integer | Page number for paging results. Used in conjunction with PageSize. (optional)
pageSize = 56 # Integer | Limits the total items returned. Maximum of 100 per request. (optional)

try: 
    # Get MovieTickets Theaters.
    api_response = api_instance.get_movie_tickets_theaters(distance, culture=culture, postalCode=postalCode, longitude=longitude, latitude=latitude, pageNumber=pageNumber, pageSize=pageSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MovieTicketsApi->getMovieTicketsTheaters: %s\n" % e)

Parameters

Query parameters
Name Description
Culture
String
Culture to retrieve response. Default en-us.
PostalCode
String
Postal code. Longitude/Latitude not required if passed.
Longitude
String
Longitude coordinate. Used in conjunction with Latitude. Postal code not required if passed.
Latitude
String
Latitude coordinate. Used in conjunction with Longitude. Postal code not required if passed.
Distance*
String
Required distaince in meters.
Required
PageNumber
Integer
Page number for paging results. Used in conjunction with PageSize.
PageSize
Integer
Limits the total items returned. Maximum of 100 per request.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


Movies

getAllMovies

Returns a paged list of all movies.

By default the API will only return basic title information. Additional objects can be included by passing the object in the Includes parameter. `Subscriptions with "Limited" data will only be able to include basic title information and Videos.`


/Movies/All

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Movies/All?Take=&Skip=&Includes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MoviesApi;

import java.io.File;
import java.util.*;

public class MoviesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MoviesApi apiInstance = new MoviesApi();
        Integer take = 56; // Integer | Limits the total items returned. Maximum of 100 per request.
        Integer skip = 56; // Integer | Skips records using for paging results.
        array[String] includes = ; // array[String] | List of additional objects to include in the movie objectSearch movie by OriginalTitle.
        try {
            AllMoviesResponse result = apiInstance.getAllMovies(take, skip, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getAllMovies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MoviesApi;

public class MoviesApiExample {

    public static void main(String[] args) {
        MoviesApi apiInstance = new MoviesApi();
        Integer take = 56; // Integer | Limits the total items returned. Maximum of 100 per request.
        Integer skip = 56; // Integer | Skips records using for paging results.
        array[String] includes = ; // array[String] | List of additional objects to include in the movie objectSearch movie by OriginalTitle.
        try {
            AllMoviesResponse result = apiInstance.getAllMovies(take, skip, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getAllMovies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *take = 56; // Limits the total items returned. Maximum of 100 per request. (optional)
Integer *skip = 56; // Skips records using for paging results. (optional)
array[String] *includes = ; // List of additional objects to include in the movie objectSearch movie by OriginalTitle. (optional)

MoviesApi *apiInstance = [[MoviesApi alloc] init];

// Returns a paged list of all movies.
[apiInstance getAllMoviesWith:take
    skip:skip
    includes:includes
              completionHandler: ^(AllMoviesResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MoviesApi()

var opts = { 
  'take': 56, // {Integer} Limits the total items returned. Maximum of 100 per request.
  'skip': 56, // {Integer} Skips records using for paging results.
  'includes':  // {array[String]} List of additional objects to include in the movie objectSearch movie by OriginalTitle.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllMovies(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllMoviesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MoviesApi();
            var take = 56;  // Integer | Limits the total items returned. Maximum of 100 per request. (optional) 
            var skip = 56;  // Integer | Skips records using for paging results. (optional) 
            var includes = new array[String](); // array[String] | List of additional objects to include in the movie objectSearch movie by OriginalTitle. (optional) 

            try
            {
                // Returns a paged list of all movies.
                AllMoviesResponse result = apiInstance.getAllMovies(take, skip, includes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MoviesApi.getAllMovies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MoviesApi();
$take = 56; // Integer | Limits the total items returned. Maximum of 100 per request.
$skip = 56; // Integer | Skips records using for paging results.
$includes = ; // array[String] | List of additional objects to include in the movie objectSearch movie by OriginalTitle.

try {
    $result = $api_instance->getAllMovies($take, $skip, $includes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MoviesApi->getAllMovies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MoviesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MoviesApi->new();
my $take = 56; # Integer | Limits the total items returned. Maximum of 100 per request.
my $skip = 56; # Integer | Skips records using for paging results.
my $includes = []; # array[String] | List of additional objects to include in the movie objectSearch movie by OriginalTitle.

eval { 
    my $result = $api_instance->getAllMovies(take => $take, skip => $skip, includes => $includes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MoviesApi->getAllMovies: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MoviesApi()
take = 56 # Integer | Limits the total items returned. Maximum of 100 per request. (optional)
skip = 56 # Integer | Skips records using for paging results. (optional)
includes =  # array[String] | List of additional objects to include in the movie objectSearch movie by OriginalTitle. (optional)

try: 
    # Returns a paged list of all movies.
    api_response = api_instance.get_all_movies(take=take, skip=skip, includes=includes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MoviesApi->getAllMovies: %s\n" % e)

Parameters

Query parameters
Name Description
Take
Integer
Limits the total items returned. Maximum of 100 per request.
Skip
Integer
Skips records using for paging results.
Includes
array[String]
List of additional objects to include in the movie objectSearch movie by OriginalTitle.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getMovie

Returns movie data for a specific IVA MovieId.

By default the API will only return basic title information. Additional objects can be included by passing the object in the Includes parameter. `Subscriptions with "Limited" data will only be able to include basic title information and Videos.`


/Movies/{Id}

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Movies/{Id}?Includes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MoviesApi;

import java.io.File;
import java.util.*;

public class MoviesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MoviesApi apiInstance = new MoviesApi();
        Integer id = 56; // Integer | Required ID of Movie.
        array[String] includes = ; // array[String] | List of additional objects to include in the movie response.
        try {
            MovieResponse result = apiInstance.getMovie(id, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getMovie");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MoviesApi;

public class MoviesApiExample {

    public static void main(String[] args) {
        MoviesApi apiInstance = new MoviesApi();
        Integer id = 56; // Integer | Required ID of Movie.
        array[String] includes = ; // array[String] | List of additional objects to include in the movie response.
        try {
            MovieResponse result = apiInstance.getMovie(id, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getMovie");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *id = 56; // Required ID of Movie.
array[String] *includes = ; // List of additional objects to include in the movie response. (optional)

MoviesApi *apiInstance = [[MoviesApi alloc] init];

// Returns movie data for a specific IVA MovieId.
[apiInstance getMovieWith:id
    includes:includes
              completionHandler: ^(MovieResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MoviesApi()

var id = 56; // {Integer} Required ID of Movie.

var opts = { 
  'includes':  // {array[String]} List of additional objects to include in the movie response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMovie(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMovieExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MoviesApi();
            var id = 56;  // Integer | Required ID of Movie.
            var includes = new array[String](); // array[String] | List of additional objects to include in the movie response. (optional) 

            try
            {
                // Returns movie data for a specific IVA MovieId.
                MovieResponse result = apiInstance.getMovie(id, includes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MoviesApi.getMovie: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MoviesApi();
$id = 56; // Integer | Required ID of Movie.
$includes = ; // array[String] | List of additional objects to include in the movie response.

try {
    $result = $api_instance->getMovie($id, $includes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MoviesApi->getMovie: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MoviesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MoviesApi->new();
my $id = 56; # Integer | Required ID of Movie.
my $includes = []; # array[String] | List of additional objects to include in the movie response.

eval { 
    my $result = $api_instance->getMovie(id => $id, includes => $includes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MoviesApi->getMovie: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MoviesApi()
id = 56 # Integer | Required ID of Movie.
includes =  # array[String] | List of additional objects to include in the movie response. (optional)

try: 
    # Returns movie data for a specific IVA MovieId.
    api_response = api_instance.get_movie(id, includes=includes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MoviesApi->getMovie: %s\n" % e)

Parameters

Path parameters
Name Description
Id*
Integer
Required ID of Movie.
Required
Query parameters
Name Description
Includes
array[String]
List of additional objects to include in the movie response.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getMovieAlternateIdTypes

Returns all MovieAlternateIdTypes.

Movie alternate ID types refer to 3rd party IDs that IVA matches its own movie IDs. **EX: IMDB, TMDB**. `Use to get the Id of the ID type to use with /Find/Movie.`


/Movies/AlternateIdTypes

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Movies/AlternateIdTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MoviesApi;

import java.io.File;
import java.util.*;

public class MoviesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MoviesApi apiInstance = new MoviesApi();
        try {
            array[MovieAlternateIdTypeResponse] result = apiInstance.getMovieAlternateIdTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getMovieAlternateIdTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MoviesApi;

public class MoviesApiExample {

    public static void main(String[] args) {
        MoviesApi apiInstance = new MoviesApi();
        try {
            array[MovieAlternateIdTypeResponse] result = apiInstance.getMovieAlternateIdTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getMovieAlternateIdTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];


MoviesApi *apiInstance = [[MoviesApi alloc] init];

// Returns all MovieAlternateIdTypes.
[apiInstance getMovieAlternateIdTypesWithCompletionHandler: 
              ^(array[MovieAlternateIdTypeResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MoviesApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMovieAlternateIdTypes(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMovieAlternateIdTypesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MoviesApi();

            try
            {
                // Returns all MovieAlternateIdTypes.
                array[MovieAlternateIdTypeResponse] result = apiInstance.getMovieAlternateIdTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MoviesApi.getMovieAlternateIdTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MoviesApi();

try {
    $result = $api_instance->getMovieAlternateIdTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MoviesApi->getMovieAlternateIdTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MoviesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MoviesApi->new();

eval { 
    my $result = $api_instance->getMovieAlternateIdTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MoviesApi->getMovieAlternateIdTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MoviesApi()

try: 
    # Returns all MovieAlternateIdTypes.
    api_response = api_instance.get_movie_alternate_id_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MoviesApi->getMovieAlternateIdTypes: %s\n" % e)

Parameters

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getMovieCertifications

Returns all Movie Certifications

Returns all Movie Certifications used in a movie response with the Releases object.


/Movies/MovieCertifications

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Movies/MovieCertifications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MoviesApi;

import java.io.File;
import java.util.*;

public class MoviesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MoviesApi apiInstance = new MoviesApi();
        try {
            array[MovieCertificationResponse] result = apiInstance.getMovieCertifications();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getMovieCertifications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MoviesApi;

public class MoviesApiExample {

    public static void main(String[] args) {
        MoviesApi apiInstance = new MoviesApi();
        try {
            array[MovieCertificationResponse] result = apiInstance.getMovieCertifications();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getMovieCertifications");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];


MoviesApi *apiInstance = [[MoviesApi alloc] init];

// Returns all Movie Certifications
[apiInstance getMovieCertificationsWithCompletionHandler: 
              ^(array[MovieCertificationResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MoviesApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMovieCertifications(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMovieCertificationsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MoviesApi();

            try
            {
                // Returns all Movie Certifications
                array[MovieCertificationResponse] result = apiInstance.getMovieCertifications();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MoviesApi.getMovieCertifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MoviesApi();

try {
    $result = $api_instance->getMovieCertifications();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MoviesApi->getMovieCertifications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MoviesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MoviesApi->new();

eval { 
    my $result = $api_instance->getMovieCertifications();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MoviesApi->getMovieCertifications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MoviesApi()

try: 
    # Returns all Movie Certifications
    api_response = api_instance.get_movie_certifications()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MoviesApi->getMovieCertifications: %s\n" % e)

Parameters

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getMovieGenres

Returns all Movie Genres.

List of all movie genres used in the API.


/Movies/MovieGenres

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Movies/MovieGenres"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MoviesApi;

import java.io.File;
import java.util.*;

public class MoviesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MoviesApi apiInstance = new MoviesApi();
        try {
            array[MovieGenreResponse] result = apiInstance.getMovieGenres();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getMovieGenres");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MoviesApi;

public class MoviesApiExample {

    public static void main(String[] args) {
        MoviesApi apiInstance = new MoviesApi();
        try {
            array[MovieGenreResponse] result = apiInstance.getMovieGenres();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getMovieGenres");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];


MoviesApi *apiInstance = [[MoviesApi alloc] init];

// 
Returns all Movie Genres.
[apiInstance getMovieGenresWithCompletionHandler: 
              ^(array[MovieGenreResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MoviesApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMovieGenres(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMovieGenresExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MoviesApi();

            try
            {
                // 
Returns all Movie Genres.
                array[MovieGenreResponse] result = apiInstance.getMovieGenres();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MoviesApi.getMovieGenres: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MoviesApi();

try {
    $result = $api_instance->getMovieGenres();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MoviesApi->getMovieGenres: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MoviesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MoviesApi->new();

eval { 
    my $result = $api_instance->getMovieGenres();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MoviesApi->getMovieGenres: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MoviesApi()

try: 
    # 
Returns all Movie Genres.
    api_response = api_instance.get_movie_genres()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MoviesApi->getMovieGenres: %s\n" % e)

Parameters

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getMovieReleaseTypes

Returns all Movie ReleaseTypes

Release type refers to the release. **EX: Theatrical, Home Video, etc.**


/Movies/ReleaseTypes

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Movies/ReleaseTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MoviesApi;

import java.io.File;
import java.util.*;

public class MoviesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MoviesApi apiInstance = new MoviesApi();
        try {
            array[MovieReleaseTypeResponse] result = apiInstance.getMovieReleaseTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getMovieReleaseTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MoviesApi;

public class MoviesApiExample {

    public static void main(String[] args) {
        MoviesApi apiInstance = new MoviesApi();
        try {
            array[MovieReleaseTypeResponse] result = apiInstance.getMovieReleaseTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getMovieReleaseTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];


MoviesApi *apiInstance = [[MoviesApi alloc] init];

// Returns all Movie ReleaseTypes
[apiInstance getMovieReleaseTypesWithCompletionHandler: 
              ^(array[MovieReleaseTypeResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MoviesApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMovieReleaseTypes(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMovieReleaseTypesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MoviesApi();

            try
            {
                // Returns all Movie ReleaseTypes
                array[MovieReleaseTypeResponse] result = apiInstance.getMovieReleaseTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MoviesApi.getMovieReleaseTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MoviesApi();

try {
    $result = $api_instance->getMovieReleaseTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MoviesApi->getMovieReleaseTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MoviesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MoviesApi->new();

eval { 
    my $result = $api_instance->getMovieReleaseTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MoviesApi->getMovieReleaseTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MoviesApi()

try: 
    # Returns all Movie ReleaseTypes
    api_response = api_instance.get_movie_release_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MoviesApi->getMovieReleaseTypes: %s\n" % e)

Parameters

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getMoviesComingSoon

Returns list of all Movies coming to US Theaters.

Requires Skip and Take. Maximum page size is 10. By default the API will only return basic title information. Additional objects can be included by passing the object in the Includes parameter in a comma separated list.


/Movies/ComingSoon/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Movies/ComingSoon/?Skip=&Take=&Includes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MoviesApi;

import java.io.File;
import java.util.*;

public class MoviesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MoviesApi apiInstance = new MoviesApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 10)
        array[String] includes = ; // array[String] | List of additional objects to include in the movie response.
        try {
            array[MovieResponse] result = apiInstance.getMoviesComingSoon(skip, take, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getMoviesComingSoon");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MoviesApi;

public class MoviesApiExample {

    public static void main(String[] args) {
        MoviesApi apiInstance = new MoviesApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 10)
        array[String] includes = ; // array[String] | List of additional objects to include in the movie response.
        try {
            array[MovieResponse] result = apiInstance.getMoviesComingSoon(skip, take, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getMoviesComingSoon");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Determines where to start page.  Ex: 0 starts at the beginning.
Integer *take = 56; // Determines the page size.  (Maximum of 10)
array[String] *includes = ; // List of additional objects to include in the movie response. (optional)

MoviesApi *apiInstance = [[MoviesApi alloc] init];

// Returns list of all Movies coming to US Theaters.
[apiInstance getMoviesComingSoonWith:skip
    take:take
    includes:includes
              completionHandler: ^(array[MovieResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MoviesApi()

var skip = 56; // {Integer} Determines where to start page.  Ex: 0 starts at the beginning.

var take = 56; // {Integer} Determines the page size.  (Maximum of 10)

var opts = { 
  'includes':  // {array[String]} List of additional objects to include in the movie response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMoviesComingSoon(skip, take, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMoviesComingSoonExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MoviesApi();
            var skip = 56;  // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
            var take = 56;  // Integer | Determines the page size.  (Maximum of 10)
            var includes = new array[String](); // array[String] | List of additional objects to include in the movie response. (optional) 

            try
            {
                // Returns list of all Movies coming to US Theaters.
                array[MovieResponse] result = apiInstance.getMoviesComingSoon(skip, take, includes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MoviesApi.getMoviesComingSoon: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MoviesApi();
$skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
$take = 56; // Integer | Determines the page size.  (Maximum of 10)
$includes = ; // array[String] | List of additional objects to include in the movie response.

try {
    $result = $api_instance->getMoviesComingSoon($skip, $take, $includes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MoviesApi->getMoviesComingSoon: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MoviesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MoviesApi->new();
my $skip = 56; # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
my $take = 56; # Integer | Determines the page size.  (Maximum of 10)
my $includes = []; # array[String] | List of additional objects to include in the movie response.

eval { 
    my $result = $api_instance->getMoviesComingSoon(skip => $skip, take => $take, includes => $includes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MoviesApi->getMoviesComingSoon: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MoviesApi()
skip = 56 # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
take = 56 # Integer | Determines the page size.  (Maximum of 10)
includes =  # array[String] | List of additional objects to include in the movie response. (optional)

try: 
    # Returns list of all Movies coming to US Theaters.
    api_response = api_instance.get_movies_coming_soon(skip, take, includes=includes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MoviesApi->getMoviesComingSoon: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Determines where to start page. Ex: 0 starts at the beginning.
Required
Take*
Integer
Determines the page size. (Maximum of 10)
Required
Includes
array[String]
List of additional objects to include in the movie response.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getMoviesInTheaters

Returns list of all Movies currently in US Theaters.

Requires Skip and Take. Maximum page size is 10. By default the API will only return basic title information. Additional objects can be included by passing the object in the Includes parameter in a comma separated list.


/Movies/InTheaters/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Movies/InTheaters/?Skip=&Take=&Includes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MoviesApi;

import java.io.File;
import java.util.*;

public class MoviesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MoviesApi apiInstance = new MoviesApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 10)
        array[String] includes = ; // array[String] | List of additional objects to include in the movie response.
        try {
            array[MovieResponse] result = apiInstance.getMoviesInTheaters(skip, take, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getMoviesInTheaters");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MoviesApi;

public class MoviesApiExample {

    public static void main(String[] args) {
        MoviesApi apiInstance = new MoviesApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 10)
        array[String] includes = ; // array[String] | List of additional objects to include in the movie response.
        try {
            array[MovieResponse] result = apiInstance.getMoviesInTheaters(skip, take, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#getMoviesInTheaters");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Determines where to start page.  Ex: 0 starts at the beginning.
Integer *take = 56; // Determines the page size.  (Maximum of 10)
array[String] *includes = ; // List of additional objects to include in the movie response. (optional)

MoviesApi *apiInstance = [[MoviesApi alloc] init];

// Returns list of all Movies currently in US Theaters.
[apiInstance getMoviesInTheatersWith:skip
    take:take
    includes:includes
              completionHandler: ^(array[MovieResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MoviesApi()

var skip = 56; // {Integer} Determines where to start page.  Ex: 0 starts at the beginning.

var take = 56; // {Integer} Determines the page size.  (Maximum of 10)

var opts = { 
  'includes':  // {array[String]} List of additional objects to include in the movie response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMoviesInTheaters(skip, take, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getMoviesInTheatersExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MoviesApi();
            var skip = 56;  // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
            var take = 56;  // Integer | Determines the page size.  (Maximum of 10)
            var includes = new array[String](); // array[String] | List of additional objects to include in the movie response. (optional) 

            try
            {
                // Returns list of all Movies currently in US Theaters.
                array[MovieResponse] result = apiInstance.getMoviesInTheaters(skip, take, includes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MoviesApi.getMoviesInTheaters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MoviesApi();
$skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
$take = 56; // Integer | Determines the page size.  (Maximum of 10)
$includes = ; // array[String] | List of additional objects to include in the movie response.

try {
    $result = $api_instance->getMoviesInTheaters($skip, $take, $includes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MoviesApi->getMoviesInTheaters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MoviesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MoviesApi->new();
my $skip = 56; # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
my $take = 56; # Integer | Determines the page size.  (Maximum of 10)
my $includes = []; # array[String] | List of additional objects to include in the movie response.

eval { 
    my $result = $api_instance->getMoviesInTheaters(skip => $skip, take => $take, includes => $includes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MoviesApi->getMoviesInTheaters: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MoviesApi()
skip = 56 # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
take = 56 # Integer | Determines the page size.  (Maximum of 10)
includes =  # array[String] | List of additional objects to include in the movie response. (optional)

try: 
    # Returns list of all Movies currently in US Theaters.
    api_response = api_instance.get_movies_in_theaters(skip, take, includes=includes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MoviesApi->getMoviesInTheaters: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Determines where to start page. Ex: 0 starts at the beginning.
Required
Take*
Integer
Determines the page size. (Maximum of 10)
Required
Includes
array[String]
List of additional objects to include in the movie response.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


matchToMovie

Perform a match to Entertainment using Title, Year, Cast and Director. Returns best match and score for the match.

Use to match IVA movie data to another data source using title, year, cast etc.


/Movies/Match/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Movies/Match/?Title=&AlternateTitles=&Year=&Cast=&Directors=&StringDistance="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MoviesApi;

import java.io.File;
import java.util.*;

public class MoviesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MoviesApi apiInstance = new MoviesApi();
        String title = title_example; // String | Title of movie to be matched.
        String alternateTitles = alternateTitles_example; // String | Alternate Titles of movie to be matched.
        String year = year_example; // String | Release Year of movie to be matched.
        String cast = cast_example; // String | Cast members of movie to be matched.
        String directors = directors_example; // String | Directors of movie to be matched.
        String stringDistance = stringDistance_example; // String | For fuzzy title match, default is 4, set to 0 for no fuzzy match.
        try {
            MatchToEntertainmentMovieResponse result = apiInstance.matchToMovie(title, alternateTitles, year, cast, directors, stringDistance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#matchToMovie");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MoviesApi;

public class MoviesApiExample {

    public static void main(String[] args) {
        MoviesApi apiInstance = new MoviesApi();
        String title = title_example; // String | Title of movie to be matched.
        String alternateTitles = alternateTitles_example; // String | Alternate Titles of movie to be matched.
        String year = year_example; // String | Release Year of movie to be matched.
        String cast = cast_example; // String | Cast members of movie to be matched.
        String directors = directors_example; // String | Directors of movie to be matched.
        String stringDistance = stringDistance_example; // String | For fuzzy title match, default is 4, set to 0 for no fuzzy match.
        try {
            MatchToEntertainmentMovieResponse result = apiInstance.matchToMovie(title, alternateTitles, year, cast, directors, stringDistance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#matchToMovie");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *title = title_example; // Title of movie to be matched. (optional)
String *alternateTitles = alternateTitles_example; // Alternate Titles of movie to be matched. (optional)
String *year = year_example; // Release Year of movie to be matched. (optional)
String *cast = cast_example; // Cast members of movie to be matched. (optional)
String *directors = directors_example; // Directors of movie to be matched. (optional)
String *stringDistance = stringDistance_example; // For fuzzy title match, default is 4, set to 0 for no fuzzy match. (optional)

MoviesApi *apiInstance = [[MoviesApi alloc] init];

// Perform a match to Entertainment using Title, Year, Cast and Director. Returns best match and score for the match.
[apiInstance matchToMovieWith:title
    alternateTitles:alternateTitles
    year:year
    cast:cast
    directors:directors
    stringDistance:stringDistance
              completionHandler: ^(MatchToEntertainmentMovieResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MoviesApi()

var opts = { 
  'title': title_example, // {String} Title of movie to be matched.
  'alternateTitles': alternateTitles_example, // {String} Alternate Titles of movie to be matched.
  'year': year_example, // {String} Release Year of movie to be matched.
  'cast': cast_example, // {String} Cast members of movie to be matched.
  'directors': directors_example, // {String} Directors of movie to be matched.
  'stringDistance': stringDistance_example // {String} For fuzzy title match, default is 4, set to 0 for no fuzzy match.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.matchToMovie(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class matchToMovieExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MoviesApi();
            var title = title_example;  // String | Title of movie to be matched. (optional) 
            var alternateTitles = alternateTitles_example;  // String | Alternate Titles of movie to be matched. (optional) 
            var year = year_example;  // String | Release Year of movie to be matched. (optional) 
            var cast = cast_example;  // String | Cast members of movie to be matched. (optional) 
            var directors = directors_example;  // String | Directors of movie to be matched. (optional) 
            var stringDistance = stringDistance_example;  // String | For fuzzy title match, default is 4, set to 0 for no fuzzy match. (optional) 

            try
            {
                // Perform a match to Entertainment using Title, Year, Cast and Director. Returns best match and score for the match.
                MatchToEntertainmentMovieResponse result = apiInstance.matchToMovie(title, alternateTitles, year, cast, directors, stringDistance);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MoviesApi.matchToMovie: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MoviesApi();
$title = title_example; // String | Title of movie to be matched.
$alternateTitles = alternateTitles_example; // String | Alternate Titles of movie to be matched.
$year = year_example; // String | Release Year of movie to be matched.
$cast = cast_example; // String | Cast members of movie to be matched.
$directors = directors_example; // String | Directors of movie to be matched.
$stringDistance = stringDistance_example; // String | For fuzzy title match, default is 4, set to 0 for no fuzzy match.

try {
    $result = $api_instance->matchToMovie($title, $alternateTitles, $year, $cast, $directors, $stringDistance);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MoviesApi->matchToMovie: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MoviesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MoviesApi->new();
my $title = title_example; # String | Title of movie to be matched.
my $alternateTitles = alternateTitles_example; # String | Alternate Titles of movie to be matched.
my $year = year_example; # String | Release Year of movie to be matched.
my $cast = cast_example; # String | Cast members of movie to be matched.
my $directors = directors_example; # String | Directors of movie to be matched.
my $stringDistance = stringDistance_example; # String | For fuzzy title match, default is 4, set to 0 for no fuzzy match.

eval { 
    my $result = $api_instance->matchToMovie(title => $title, alternateTitles => $alternateTitles, year => $year, cast => $cast, directors => $directors, stringDistance => $stringDistance);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MoviesApi->matchToMovie: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MoviesApi()
title = title_example # String | Title of movie to be matched. (optional)
alternateTitles = alternateTitles_example # String | Alternate Titles of movie to be matched. (optional)
year = year_example # String | Release Year of movie to be matched. (optional)
cast = cast_example # String | Cast members of movie to be matched. (optional)
directors = directors_example # String | Directors of movie to be matched. (optional)
stringDistance = stringDistance_example # String | For fuzzy title match, default is 4, set to 0 for no fuzzy match. (optional)

try: 
    # Perform a match to Entertainment using Title, Year, Cast and Director. Returns best match and score for the match.
    api_response = api_instance.match_to_movie(title=title, alternateTitles=alternateTitles, year=year, cast=cast, directors=directors, stringDistance=stringDistance)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MoviesApi->matchToMovie: %s\n" % e)

Parameters

Query parameters
Name Description
Title
String
Title of movie to be matched.
AlternateTitles
String
Alternate Titles of movie to be matched.
Year
String
Release Year of movie to be matched.
Cast
String
Cast members of movie to be matched.
Directors
String
Directors of movie to be matched.
StringDistance
String
For fuzzy title match, default is 4, set to 0 for no fuzzy match.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


searchAndDiscoverMovie

Search and discover movies.

Searchable Fields: Title, AlternateTitles, Genres, OriginalReleaseDate, UnitedStatesReleaseDate, GermanyReleaseDate, FranceReleaseDate, UnitedKingdomReleaseDate, ItalyReleaseDate, JapanReleaseDate, Tags, Cast, Directors, Descriptions, Ratings, OriginalLanguage. [Syntax Ref](https://docs.microsoft.com/en-us/rest/api/searchservice/simple-query-syntax-in-azure-search) Filterable Fields: ID, Title, AlternateTitles, Genres, OriginalReleaseDate, UnitedStatesReleaseDate, GermanyReleaseDate, FranceReleaseDate, UnitedKingdomReleaseDate, ItalyReleaseDate, JapanReleaseDate, Year, Tags, Cast, Directors, Descriptions, HasVideo, PosterFilePath, Ratings, OriginalLanguage, Runtime, Budget, Revenue, Created, Modified. [Syntax Ref](https://docs.microsoft.com/en-us/rest/api/searchservice/odata-expression-syntax-for-azure-search)


/Movies/SearchAndDiscover

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Movies/SearchAndDiscover?term=&SelectFields=&SearchFields=&Filter=&OrderBy=&Top=&Skip=&IncludeTotalResultCount=&SearchMode="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MoviesApi;

import java.io.File;
import java.util.*;

public class MoviesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        MoviesApi apiInstance = new MoviesApi();
        String term = term_example; // String | Term to search for. This can be combined with all other options. Use '*' to return any match.
        String selectFields = selectFields_example; // String | List of field names to be returned in the object.
        String searchFields = searchFields_example; // String | List of field names to search using 'term.'
        String filter = filter_example; // String | Expression to filter results.
        String orderBy = orderBy_example; // String | List of field names to sort results.  Default is relevance.
        String top = top_example; // String | Limit results.  Maximum returned is 1000.
        String skip = skip_example; // String | Skip number of results. Use this for paging results.
        String includeTotalResultCount = includeTotalResultCount_example; // String | Includes total results in response. This will have a performance impact.
        String searchMode = searchMode_example; // String | Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match.
        try {
            SearchMovieResponse result = apiInstance.searchAndDiscoverMovie(term, selectFields, searchFields, filter, orderBy, top, skip, includeTotalResultCount, searchMode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#searchAndDiscoverMovie");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.MoviesApi;

public class MoviesApiExample {

    public static void main(String[] args) {
        MoviesApi apiInstance = new MoviesApi();
        String term = term_example; // String | Term to search for. This can be combined with all other options. Use '*' to return any match.
        String selectFields = selectFields_example; // String | List of field names to be returned in the object.
        String searchFields = searchFields_example; // String | List of field names to search using 'term.'
        String filter = filter_example; // String | Expression to filter results.
        String orderBy = orderBy_example; // String | List of field names to sort results.  Default is relevance.
        String top = top_example; // String | Limit results.  Maximum returned is 1000.
        String skip = skip_example; // String | Skip number of results. Use this for paging results.
        String includeTotalResultCount = includeTotalResultCount_example; // String | Includes total results in response. This will have a performance impact.
        String searchMode = searchMode_example; // String | Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match.
        try {
            SearchMovieResponse result = apiInstance.searchAndDiscoverMovie(term, selectFields, searchFields, filter, orderBy, top, skip, includeTotalResultCount, searchMode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MoviesApi#searchAndDiscoverMovie");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *term = term_example; // Term to search for. This can be combined with all other options. Use '*' to return any match. (optional)
String *selectFields = selectFields_example; // List of field names to be returned in the object. (optional)
String *searchFields = searchFields_example; // List of field names to search using 'term.' (optional)
String *filter = filter_example; // Expression to filter results. (optional)
String *orderBy = orderBy_example; // List of field names to sort results.  Default is relevance. (optional)
String *top = top_example; // Limit results.  Maximum returned is 1000. (optional)
String *skip = skip_example; // Skip number of results. Use this for paging results. (optional)
String *includeTotalResultCount = includeTotalResultCount_example; // Includes total results in response. This will have a performance impact. (optional)
String *searchMode = searchMode_example; // Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match. (optional)

MoviesApi *apiInstance = [[MoviesApi alloc] init];

// Search and discover movies.
[apiInstance searchAndDiscoverMovieWith:term
    selectFields:selectFields
    searchFields:searchFields
    filter:filter
    orderBy:orderBy
    top:top
    skip:skip
    includeTotalResultCount:includeTotalResultCount
    searchMode:searchMode
              completionHandler: ^(SearchMovieResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.MoviesApi()

var opts = { 
  'term': term_example, // {String} Term to search for. This can be combined with all other options. Use '*' to return any match.
  'selectFields': selectFields_example, // {String} List of field names to be returned in the object.
  'searchFields': searchFields_example, // {String} List of field names to search using 'term.'
  'filter': filter_example, // {String} Expression to filter results.
  'orderBy': orderBy_example, // {String} List of field names to sort results.  Default is relevance.
  'top': top_example, // {String} Limit results.  Maximum returned is 1000.
  'skip': skip_example, // {String} Skip number of results. Use this for paging results.
  'includeTotalResultCount': includeTotalResultCount_example, // {String} Includes total results in response. This will have a performance impact.
  'searchMode': searchMode_example // {String} Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchAndDiscoverMovie(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchAndDiscoverMovieExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new MoviesApi();
            var term = term_example;  // String | Term to search for. This can be combined with all other options. Use '*' to return any match. (optional) 
            var selectFields = selectFields_example;  // String | List of field names to be returned in the object. (optional) 
            var searchFields = searchFields_example;  // String | List of field names to search using 'term.' (optional) 
            var filter = filter_example;  // String | Expression to filter results. (optional) 
            var orderBy = orderBy_example;  // String | List of field names to sort results.  Default is relevance. (optional) 
            var top = top_example;  // String | Limit results.  Maximum returned is 1000. (optional) 
            var skip = skip_example;  // String | Skip number of results. Use this for paging results. (optional) 
            var includeTotalResultCount = includeTotalResultCount_example;  // String | Includes total results in response. This will have a performance impact. (optional) 
            var searchMode = searchMode_example;  // String | Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match. (optional) 

            try
            {
                // Search and discover movies.
                SearchMovieResponse result = apiInstance.searchAndDiscoverMovie(term, selectFields, searchFields, filter, orderBy, top, skip, includeTotalResultCount, searchMode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MoviesApi.searchAndDiscoverMovie: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\MoviesApi();
$term = term_example; // String | Term to search for. This can be combined with all other options. Use '*' to return any match.
$selectFields = selectFields_example; // String | List of field names to be returned in the object.
$searchFields = searchFields_example; // String | List of field names to search using 'term.'
$filter = filter_example; // String | Expression to filter results.
$orderBy = orderBy_example; // String | List of field names to sort results.  Default is relevance.
$top = top_example; // String | Limit results.  Maximum returned is 1000.
$skip = skip_example; // String | Skip number of results. Use this for paging results.
$includeTotalResultCount = includeTotalResultCount_example; // String | Includes total results in response. This will have a performance impact.
$searchMode = searchMode_example; // String | Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match.

try {
    $result = $api_instance->searchAndDiscoverMovie($term, $selectFields, $searchFields, $filter, $orderBy, $top, $skip, $includeTotalResultCount, $searchMode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MoviesApi->searchAndDiscoverMovie: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::MoviesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::MoviesApi->new();
my $term = term_example; # String | Term to search for. This can be combined with all other options. Use '*' to return any match.
my $selectFields = selectFields_example; # String | List of field names to be returned in the object.
my $searchFields = searchFields_example; # String | List of field names to search using 'term.'
my $filter = filter_example; # String | Expression to filter results.
my $orderBy = orderBy_example; # String | List of field names to sort results.  Default is relevance.
my $top = top_example; # String | Limit results.  Maximum returned is 1000.
my $skip = skip_example; # String | Skip number of results. Use this for paging results.
my $includeTotalResultCount = includeTotalResultCount_example; # String | Includes total results in response. This will have a performance impact.
my $searchMode = searchMode_example; # String | Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match.

eval { 
    my $result = $api_instance->searchAndDiscoverMovie(term => $term, selectFields => $selectFields, searchFields => $searchFields, filter => $filter, orderBy => $orderBy, top => $top, skip => $skip, includeTotalResultCount => $includeTotalResultCount, searchMode => $searchMode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling MoviesApi->searchAndDiscoverMovie: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.MoviesApi()
term = term_example # String | Term to search for. This can be combined with all other options. Use '*' to return any match. (optional)
selectFields = selectFields_example # String | List of field names to be returned in the object. (optional)
searchFields = searchFields_example # String | List of field names to search using 'term.' (optional)
filter = filter_example # String | Expression to filter results. (optional)
orderBy = orderBy_example # String | List of field names to sort results.  Default is relevance. (optional)
top = top_example # String | Limit results.  Maximum returned is 1000. (optional)
skip = skip_example # String | Skip number of results. Use this for paging results. (optional)
includeTotalResultCount = includeTotalResultCount_example # String | Includes total results in response. This will have a performance impact. (optional)
searchMode = searchMode_example # String | Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match. (optional)

try: 
    # Search and discover movies.
    api_response = api_instance.search_and_discover_movie(term=term, selectFields=selectFields, searchFields=searchFields, filter=filter, orderBy=orderBy, top=top, skip=skip, includeTotalResultCount=includeTotalResultCount, searchMode=searchMode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MoviesApi->searchAndDiscoverMovie: %s\n" % e)

Parameters

Query parameters
Name Description
term
String
Term to search for. This can be combined with all other options. Use '*' to return any match.
SelectFields
String
List of field names to be returned in the object.
SearchFields
String
List of field names to search using 'term.'
Filter
String
Expression to filter results.
OrderBy
String
List of field names to sort results. Default is relevance.
Top
String
Limit results. Maximum returned is 1000.
Skip
String
Skip number of results. Use this for paging results.
IncludeTotalResultCount
String
Includes total results in response. This will have a performance impact.
SearchMode
String
Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


People

getPerson

Returns information on a person.

BETA - By default the API will only return basic People information. Additional objects can be included by passing the object in the Includes parameter.


/People/{Id}

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/People/{Id}?Includes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PeopleApi;

import java.io.File;
import java.util.*;

public class PeopleApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        PeopleApi apiInstance = new PeopleApi();
        Integer id = 56; // Integer | Required ID of Person.
        array[String] includes = ; // array[String] | List of additional objects to include in the person response.
        try {
            PersonResponse result = apiInstance.getPerson(id, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeopleApi#getPerson");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PeopleApi;

public class PeopleApiExample {

    public static void main(String[] args) {
        PeopleApi apiInstance = new PeopleApi();
        Integer id = 56; // Integer | Required ID of Person.
        array[String] includes = ; // array[String] | List of additional objects to include in the person response.
        try {
            PersonResponse result = apiInstance.getPerson(id, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PeopleApi#getPerson");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *id = 56; // Required ID of Person.
array[String] *includes = ; // List of additional objects to include in the person response. (optional)

PeopleApi *apiInstance = [[PeopleApi alloc] init];

// Returns information on a person.
[apiInstance getPersonWith:id
    includes:includes
              completionHandler: ^(PersonResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.PeopleApi()

var id = 56; // {Integer} Required ID of Person.

var opts = { 
  'includes':  // {array[String]} List of additional objects to include in the person response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPerson(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getPersonExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new PeopleApi();
            var id = 56;  // Integer | Required ID of Person.
            var includes = new array[String](); // array[String] | List of additional objects to include in the person response. (optional) 

            try
            {
                // Returns information on a person.
                PersonResponse result = apiInstance.getPerson(id, includes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PeopleApi.getPerson: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\PeopleApi();
$id = 56; // Integer | Required ID of Person.
$includes = ; // array[String] | List of additional objects to include in the person response.

try {
    $result = $api_instance->getPerson($id, $includes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PeopleApi->getPerson: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PeopleApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::PeopleApi->new();
my $id = 56; # Integer | Required ID of Person.
my $includes = []; # array[String] | List of additional objects to include in the person response.

eval { 
    my $result = $api_instance->getPerson(id => $id, includes => $includes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PeopleApi->getPerson: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.PeopleApi()
id = 56 # Integer | Required ID of Person.
includes =  # array[String] | List of additional objects to include in the person response. (optional)

try: 
    # Returns information on a person.
    api_response = api_instance.get_person(id, includes=includes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PeopleApi->getPerson: %s\n" % e)

Parameters

Path parameters
Name Description
Id*
Integer
Required ID of Person.
Required
Query parameters
Name Description
Includes
array[String]
List of additional objects to include in the person response.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


SDKs

getSDK

Returns a zip file of client SDK.

Generate and download SDK's for using the API. Requires a subscription key for authorization and a valid client.


/SDKs/{Client}

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/SDKs/{Client}?RedirectToFile="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SDKsApi;

import java.io.File;
import java.util.*;

public class SDKsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        SDKsApi apiInstance = new SDKsApi();
        String client = client_example; // String | Client SDK
        Boolean redirectToFile = true; // Boolean | Redirect to download the zipped SDK.
        try {
            SDKResponse result = apiInstance.getSDK(client, redirectToFile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SDKsApi#getSDK");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SDKsApi;

public class SDKsApiExample {

    public static void main(String[] args) {
        SDKsApi apiInstance = new SDKsApi();
        String client = client_example; // String | Client SDK
        Boolean redirectToFile = true; // Boolean | Redirect to download the zipped SDK.
        try {
            SDKResponse result = apiInstance.getSDK(client, redirectToFile);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SDKsApi#getSDK");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *client = client_example; // Client SDK
Boolean *redirectToFile = true; // Redirect to download the zipped SDK.

SDKsApi *apiInstance = [[SDKsApi alloc] init];

// Returns a zip file of client SDK.
[apiInstance getSDKWith:client
    redirectToFile:redirectToFile
              completionHandler: ^(SDKResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.SDKsApi()

var client = client_example; // {String} Client SDK

var redirectToFile = true; // {Boolean} Redirect to download the zipped SDK.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSDK(client, redirectToFile, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSDKExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new SDKsApi();
            var client = client_example;  // String | Client SDK
            var redirectToFile = true;  // Boolean | Redirect to download the zipped SDK.

            try
            {
                // Returns a zip file of client SDK.
                SDKResponse result = apiInstance.getSDK(client, redirectToFile);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SDKsApi.getSDK: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\SDKsApi();
$client = client_example; // String | Client SDK
$redirectToFile = true; // Boolean | Redirect to download the zipped SDK.

try {
    $result = $api_instance->getSDK($client, $redirectToFile);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SDKsApi->getSDK: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SDKsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::SDKsApi->new();
my $client = client_example; # String | Client SDK
my $redirectToFile = true; # Boolean | Redirect to download the zipped SDK.

eval { 
    my $result = $api_instance->getSDK(client => $client, redirectToFile => $redirectToFile);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SDKsApi->getSDK: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.SDKsApi()
client = client_example # String | Client SDK
redirectToFile = true # Boolean | Redirect to download the zipped SDK.

try: 
    # Returns a zip file of client SDK.
    api_response = api_instance.get_sdk(client, redirectToFile)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SDKsApi->getSDK: %s\n" % e)

Parameters

Path parameters
Name Description
Client*
String
Client SDK
Required
Query parameters
Name Description
RedirectToFile*
Boolean
Redirect to download the zipped SDK.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


Shows

getAllShows

Returns a paged list of all TV shows.

By default the API will only return basic title information. Additional objects can be included by passing the object in the Includes parameter. `Subscriptions with "Limited" data will only be able to include basic title information, Videos, EpisodicVideos, and SeasonVideos.`


/Shows/All

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Shows/All?Take=&Skip=&Includes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShowsApi;

import java.io.File;
import java.util.*;

public class ShowsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ShowsApi apiInstance = new ShowsApi();
        Integer take = 56; // Integer | Limits the total items returned. Maximum of 10 per request.
        Integer skip = 56; // Integer | Skips records using for paging results.
        array[String] includes = ; // array[String] | List of additional objects to include in the show object.
        try {
            AllShowsResponse result = apiInstance.getAllShows(take, skip, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getAllShows");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShowsApi;

public class ShowsApiExample {

    public static void main(String[] args) {
        ShowsApi apiInstance = new ShowsApi();
        Integer take = 56; // Integer | Limits the total items returned. Maximum of 10 per request.
        Integer skip = 56; // Integer | Skips records using for paging results.
        array[String] includes = ; // array[String] | List of additional objects to include in the show object.
        try {
            AllShowsResponse result = apiInstance.getAllShows(take, skip, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getAllShows");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *take = 56; // Limits the total items returned. Maximum of 10 per request. (optional)
Integer *skip = 56; // Skips records using for paging results. (optional)
array[String] *includes = ; // List of additional objects to include in the show object. (optional)

ShowsApi *apiInstance = [[ShowsApi alloc] init];

// Returns a paged list of all TV shows.
[apiInstance getAllShowsWith:take
    skip:skip
    includes:includes
              completionHandler: ^(AllShowsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ShowsApi()

var opts = { 
  'take': 56, // {Integer} Limits the total items returned. Maximum of 10 per request.
  'skip': 56, // {Integer} Skips records using for paging results.
  'includes':  // {array[String]} List of additional objects to include in the show object.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllShows(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllShowsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ShowsApi();
            var take = 56;  // Integer | Limits the total items returned. Maximum of 10 per request. (optional) 
            var skip = 56;  // Integer | Skips records using for paging results. (optional) 
            var includes = new array[String](); // array[String] | List of additional objects to include in the show object. (optional) 

            try
            {
                // Returns a paged list of all TV shows.
                AllShowsResponse result = apiInstance.getAllShows(take, skip, includes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShowsApi.getAllShows: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ShowsApi();
$take = 56; // Integer | Limits the total items returned. Maximum of 10 per request.
$skip = 56; // Integer | Skips records using for paging results.
$includes = ; // array[String] | List of additional objects to include in the show object.

try {
    $result = $api_instance->getAllShows($take, $skip, $includes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShowsApi->getAllShows: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShowsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ShowsApi->new();
my $take = 56; # Integer | Limits the total items returned. Maximum of 10 per request.
my $skip = 56; # Integer | Skips records using for paging results.
my $includes = []; # array[String] | List of additional objects to include in the show object.

eval { 
    my $result = $api_instance->getAllShows(take => $take, skip => $skip, includes => $includes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShowsApi->getAllShows: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ShowsApi()
take = 56 # Integer | Limits the total items returned. Maximum of 10 per request. (optional)
skip = 56 # Integer | Skips records using for paging results. (optional)
includes =  # array[String] | List of additional objects to include in the show object. (optional)

try: 
    # Returns a paged list of all TV shows.
    api_response = api_instance.get_all_shows(take=take, skip=skip, includes=includes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShowsApi->getAllShows: %s\n" % e)

Parameters

Query parameters
Name Description
Take
Integer
Limits the total items returned. Maximum of 10 per request.
Skip
Integer
Skips records using for paging results.
Includes
array[String]
List of additional objects to include in the show object.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getEpisode

Returns an Episode object for a requested Episode ID.

Returns the episode details for a specific episode ID.


/Shows/Seasons/Episodes/{Id}

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Shows/Seasons/Episodes/{Id}?Includes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShowsApi;

import java.io.File;
import java.util.*;

public class ShowsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ShowsApi apiInstance = new ShowsApi();
        Integer id = 56; // Integer | Required ID of an Episode.
        array[String] includes = ; // array[String] | List of additional objects to include in the episode response.
        try {
            EpisodeResponse result = apiInstance.getEpisode(id, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getEpisode");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShowsApi;

public class ShowsApiExample {

    public static void main(String[] args) {
        ShowsApi apiInstance = new ShowsApi();
        Integer id = 56; // Integer | Required ID of an Episode.
        array[String] includes = ; // array[String] | List of additional objects to include in the episode response.
        try {
            EpisodeResponse result = apiInstance.getEpisode(id, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getEpisode");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *id = 56; // Required ID of an Episode.
array[String] *includes = ; // List of additional objects to include in the episode response. (optional)

ShowsApi *apiInstance = [[ShowsApi alloc] init];

// Returns an Episode object for a requested Episode ID.
[apiInstance getEpisodeWith:id
    includes:includes
              completionHandler: ^(EpisodeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ShowsApi()

var id = 56; // {Integer} Required ID of an Episode.

var opts = { 
  'includes':  // {array[String]} List of additional objects to include in the episode response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEpisode(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEpisodeExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ShowsApi();
            var id = 56;  // Integer | Required ID of an Episode.
            var includes = new array[String](); // array[String] | List of additional objects to include in the episode response. (optional) 

            try
            {
                // Returns an Episode object for a requested Episode ID.
                EpisodeResponse result = apiInstance.getEpisode(id, includes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShowsApi.getEpisode: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ShowsApi();
$id = 56; // Integer | Required ID of an Episode.
$includes = ; // array[String] | List of additional objects to include in the episode response.

try {
    $result = $api_instance->getEpisode($id, $includes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShowsApi->getEpisode: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShowsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ShowsApi->new();
my $id = 56; # Integer | Required ID of an Episode.
my $includes = []; # array[String] | List of additional objects to include in the episode response.

eval { 
    my $result = $api_instance->getEpisode(id => $id, includes => $includes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShowsApi->getEpisode: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ShowsApi()
id = 56 # Integer | Required ID of an Episode.
includes =  # array[String] | List of additional objects to include in the episode response. (optional)

try: 
    # Returns an Episode object for a requested Episode ID.
    api_response = api_instance.get_episode(id, includes=includes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShowsApi->getEpisode: %s\n" % e)

Parameters

Path parameters
Name Description
Id*
Integer
Required ID of an Episode.
Required
Query parameters
Name Description
Includes
array[String]
List of additional objects to include in the episode response.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getEpisodeByEpisodeNumber

Get Episode by ShowId, Season Number and Episode Number.

Requires a valid ShowId, Season Number and Episode Number.


/Shows/{Id}/Seasons/{SeasonNumber}/Episodes/{EpisodeNumber}

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Shows/{Id}/Seasons/{SeasonNumber}/Episodes/{EpisodeNumber}?Includes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShowsApi;

import java.io.File;
import java.util.*;

public class ShowsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ShowsApi apiInstance = new ShowsApi();
        Integer id = 56; // Integer | Required Id of the Show.
        Integer seasonNumber = 56; // Integer | Required SeasonNumber.
        Integer episodeNumber = 56; // Integer | Required EpisodeNumber.
        array[String] includes = ; // array[String] | List of additional objects to include in the episode response.
        try {
            EpisodeResponse result = apiInstance.getEpisodeByEpisodeNumber(id, seasonNumber, episodeNumber, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getEpisodeByEpisodeNumber");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShowsApi;

public class ShowsApiExample {

    public static void main(String[] args) {
        ShowsApi apiInstance = new ShowsApi();
        Integer id = 56; // Integer | Required Id of the Show.
        Integer seasonNumber = 56; // Integer | Required SeasonNumber.
        Integer episodeNumber = 56; // Integer | Required EpisodeNumber.
        array[String] includes = ; // array[String] | List of additional objects to include in the episode response.
        try {
            EpisodeResponse result = apiInstance.getEpisodeByEpisodeNumber(id, seasonNumber, episodeNumber, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getEpisodeByEpisodeNumber");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *id = 56; // Required Id of the Show.
Integer *seasonNumber = 56; // Required SeasonNumber.
Integer *episodeNumber = 56; // Required EpisodeNumber.
array[String] *includes = ; // List of additional objects to include in the episode response. (optional)

ShowsApi *apiInstance = [[ShowsApi alloc] init];

// Get Episode by ShowId, Season Number and Episode Number.
[apiInstance getEpisodeByEpisodeNumberWith:id
    seasonNumber:seasonNumber
    episodeNumber:episodeNumber
    includes:includes
              completionHandler: ^(EpisodeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ShowsApi()

var id = 56; // {Integer} Required Id of the Show.

var seasonNumber = 56; // {Integer} Required SeasonNumber.

var episodeNumber = 56; // {Integer} Required EpisodeNumber.

var opts = { 
  'includes':  // {array[String]} List of additional objects to include in the episode response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEpisodeByEpisodeNumber(id, seasonNumber, episodeNumber, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEpisodeByEpisodeNumberExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ShowsApi();
            var id = 56;  // Integer | Required Id of the Show.
            var seasonNumber = 56;  // Integer | Required SeasonNumber.
            var episodeNumber = 56;  // Integer | Required EpisodeNumber.
            var includes = new array[String](); // array[String] | List of additional objects to include in the episode response. (optional) 

            try
            {
                // Get Episode by ShowId, Season Number and Episode Number.
                EpisodeResponse result = apiInstance.getEpisodeByEpisodeNumber(id, seasonNumber, episodeNumber, includes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShowsApi.getEpisodeByEpisodeNumber: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ShowsApi();
$id = 56; // Integer | Required Id of the Show.
$seasonNumber = 56; // Integer | Required SeasonNumber.
$episodeNumber = 56; // Integer | Required EpisodeNumber.
$includes = ; // array[String] | List of additional objects to include in the episode response.

try {
    $result = $api_instance->getEpisodeByEpisodeNumber($id, $seasonNumber, $episodeNumber, $includes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShowsApi->getEpisodeByEpisodeNumber: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShowsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ShowsApi->new();
my $id = 56; # Integer | Required Id of the Show.
my $seasonNumber = 56; # Integer | Required SeasonNumber.
my $episodeNumber = 56; # Integer | Required EpisodeNumber.
my $includes = []; # array[String] | List of additional objects to include in the episode response.

eval { 
    my $result = $api_instance->getEpisodeByEpisodeNumber(id => $id, seasonNumber => $seasonNumber, episodeNumber => $episodeNumber, includes => $includes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShowsApi->getEpisodeByEpisodeNumber: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ShowsApi()
id = 56 # Integer | Required Id of the Show.
seasonNumber = 56 # Integer | Required SeasonNumber.
episodeNumber = 56 # Integer | Required EpisodeNumber.
includes =  # array[String] | List of additional objects to include in the episode response. (optional)

try: 
    # Get Episode by ShowId, Season Number and Episode Number.
    api_response = api_instance.get_episode_by_episode_number(id, seasonNumber, episodeNumber, includes=includes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShowsApi->getEpisodeByEpisodeNumber: %s\n" % e)

Parameters

Path parameters
Name Description
Id*
Integer
Required Id of the Show.
Required
SeasonNumber*
Integer
Required SeasonNumber.
Required
EpisodeNumber*
Integer
Required EpisodeNumber.
Required
Query parameters
Name Description
Includes
array[String]
List of additional objects to include in the episode response.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getEpisodeByNumber

Get Episode by ShowId, Season Number and Episode Number.

Some use cases find it useful to be able to pass a season number and episode number of a known show to get the data for that exact episode.


/Shows/Seasons/Episode/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Shows/Seasons/Episode/?Id=&SeasonNumber=&EpisodeNumber="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShowsApi;

import java.io.File;
import java.util.*;

public class ShowsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ShowsApi apiInstance = new ShowsApi();
        Integer id = 56; // Integer | Required Id of the Show.
        Integer seasonNumber = 56; // Integer | Required SeasonNumber.
        Integer episodeNumber = 56; // Integer | Required EpisodeNumber.
        try {
            EpisodeResponse result = apiInstance.getEpisodeByNumber(id, seasonNumber, episodeNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getEpisodeByNumber");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShowsApi;

public class ShowsApiExample {

    public static void main(String[] args) {
        ShowsApi apiInstance = new ShowsApi();
        Integer id = 56; // Integer | Required Id of the Show.
        Integer seasonNumber = 56; // Integer | Required SeasonNumber.
        Integer episodeNumber = 56; // Integer | Required EpisodeNumber.
        try {
            EpisodeResponse result = apiInstance.getEpisodeByNumber(id, seasonNumber, episodeNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getEpisodeByNumber");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *id = 56; // Required Id of the Show.
Integer *seasonNumber = 56; // Required SeasonNumber.
Integer *episodeNumber = 56; // Required EpisodeNumber.

ShowsApi *apiInstance = [[ShowsApi alloc] init];

// Get Episode by ShowId, Season Number and Episode Number.
[apiInstance getEpisodeByNumberWith:id
    seasonNumber:seasonNumber
    episodeNumber:episodeNumber
              completionHandler: ^(EpisodeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ShowsApi()

var id = 56; // {Integer} Required Id of the Show.

var seasonNumber = 56; // {Integer} Required SeasonNumber.

var episodeNumber = 56; // {Integer} Required EpisodeNumber.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEpisodeByNumber(id, seasonNumber, episodeNumber, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEpisodeByNumberExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ShowsApi();
            var id = 56;  // Integer | Required Id of the Show.
            var seasonNumber = 56;  // Integer | Required SeasonNumber.
            var episodeNumber = 56;  // Integer | Required EpisodeNumber.

            try
            {
                // Get Episode by ShowId, Season Number and Episode Number.
                EpisodeResponse result = apiInstance.getEpisodeByNumber(id, seasonNumber, episodeNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShowsApi.getEpisodeByNumber: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ShowsApi();
$id = 56; // Integer | Required Id of the Show.
$seasonNumber = 56; // Integer | Required SeasonNumber.
$episodeNumber = 56; // Integer | Required EpisodeNumber.

try {
    $result = $api_instance->getEpisodeByNumber($id, $seasonNumber, $episodeNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShowsApi->getEpisodeByNumber: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShowsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ShowsApi->new();
my $id = 56; # Integer | Required Id of the Show.
my $seasonNumber = 56; # Integer | Required SeasonNumber.
my $episodeNumber = 56; # Integer | Required EpisodeNumber.

eval { 
    my $result = $api_instance->getEpisodeByNumber(id => $id, seasonNumber => $seasonNumber, episodeNumber => $episodeNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShowsApi->getEpisodeByNumber: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ShowsApi()
id = 56 # Integer | Required Id of the Show.
seasonNumber = 56 # Integer | Required SeasonNumber.
episodeNumber = 56 # Integer | Required EpisodeNumber.

try: 
    # Get Episode by ShowId, Season Number and Episode Number.
    api_response = api_instance.get_episode_by_number(id, seasonNumber, episodeNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShowsApi->getEpisodeByNumber: %s\n" % e)

Parameters

Query parameters
Name Description
Id*
Integer
Required Id of the Show.
Required
SeasonNumber*
Integer
Required SeasonNumber.
Required
EpisodeNumber*
Integer
Required EpisodeNumber.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getSeason

Get Season by SeasonId.

Use with a SeasonId to return details for a season including any video asset data.


/Shows/Seasons/{Id}

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Shows/Seasons/{Id}?Includes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShowsApi;

import java.io.File;
import java.util.*;

public class ShowsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ShowsApi apiInstance = new ShowsApi();
        Integer id = 56; // Integer | Id of a Season.
        array[String] includes = ; // array[String] | List of additional objects to include in the season response.
        try {
            SeasonResponse result = apiInstance.getSeason(id, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getSeason");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShowsApi;

public class ShowsApiExample {

    public static void main(String[] args) {
        ShowsApi apiInstance = new ShowsApi();
        Integer id = 56; // Integer | Id of a Season.
        array[String] includes = ; // array[String] | List of additional objects to include in the season response.
        try {
            SeasonResponse result = apiInstance.getSeason(id, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getSeason");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *id = 56; // Id of a Season.
array[String] *includes = ; // List of additional objects to include in the season response. (optional)

ShowsApi *apiInstance = [[ShowsApi alloc] init];

// Get Season by SeasonId.
[apiInstance getSeasonWith:id
    includes:includes
              completionHandler: ^(SeasonResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ShowsApi()

var id = 56; // {Integer} Id of a Season.

var opts = { 
  'includes':  // {array[String]} List of additional objects to include in the season response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSeason(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSeasonExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ShowsApi();
            var id = 56;  // Integer | Id of a Season.
            var includes = new array[String](); // array[String] | List of additional objects to include in the season response. (optional) 

            try
            {
                // Get Season by SeasonId.
                SeasonResponse result = apiInstance.getSeason(id, includes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShowsApi.getSeason: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ShowsApi();
$id = 56; // Integer | Id of a Season.
$includes = ; // array[String] | List of additional objects to include in the season response.

try {
    $result = $api_instance->getSeason($id, $includes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShowsApi->getSeason: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShowsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ShowsApi->new();
my $id = 56; # Integer | Id of a Season.
my $includes = []; # array[String] | List of additional objects to include in the season response.

eval { 
    my $result = $api_instance->getSeason(id => $id, includes => $includes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShowsApi->getSeason: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ShowsApi()
id = 56 # Integer | Id of a Season.
includes =  # array[String] | List of additional objects to include in the season response. (optional)

try: 
    # Get Season by SeasonId.
    api_response = api_instance.get_season(id, includes=includes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShowsApi->getSeason: %s\n" % e)

Parameters

Path parameters
Name Description
Id*
Integer
Id of a Season.
Required
Query parameters
Name Description
Includes
array[String]
List of additional objects to include in the season response.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getSeasonByNumber

Get Season by ShowId and Season Number.

Use the IVA ShowId and a season number to get a season details and video asset data.


/Shows/Season/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Shows/Season/?Id=&SeasonNumber="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShowsApi;

import java.io.File;
import java.util.*;

public class ShowsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ShowsApi apiInstance = new ShowsApi();
        Integer id = 56; // Integer | Id of a Show.
        Integer seasonNumber = 56; // Integer | Number of a Season belonging to a Show.
        try {
            SeasonResponse result = apiInstance.getSeasonByNumber(id, seasonNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getSeasonByNumber");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShowsApi;

public class ShowsApiExample {

    public static void main(String[] args) {
        ShowsApi apiInstance = new ShowsApi();
        Integer id = 56; // Integer | Id of a Show.
        Integer seasonNumber = 56; // Integer | Number of a Season belonging to a Show.
        try {
            SeasonResponse result = apiInstance.getSeasonByNumber(id, seasonNumber);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getSeasonByNumber");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *id = 56; // Id of a Show.
Integer *seasonNumber = 56; // Number of a Season belonging to a Show.

ShowsApi *apiInstance = [[ShowsApi alloc] init];

// Get Season by ShowId and Season Number.
[apiInstance getSeasonByNumberWith:id
    seasonNumber:seasonNumber
              completionHandler: ^(SeasonResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ShowsApi()

var id = 56; // {Integer} Id of a Show.

var seasonNumber = 56; // {Integer} Number of a Season belonging to a Show.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSeasonByNumber(id, seasonNumber, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSeasonByNumberExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ShowsApi();
            var id = 56;  // Integer | Id of a Show.
            var seasonNumber = 56;  // Integer | Number of a Season belonging to a Show.

            try
            {
                // Get Season by ShowId and Season Number.
                SeasonResponse result = apiInstance.getSeasonByNumber(id, seasonNumber);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShowsApi.getSeasonByNumber: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ShowsApi();
$id = 56; // Integer | Id of a Show.
$seasonNumber = 56; // Integer | Number of a Season belonging to a Show.

try {
    $result = $api_instance->getSeasonByNumber($id, $seasonNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShowsApi->getSeasonByNumber: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShowsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ShowsApi->new();
my $id = 56; # Integer | Id of a Show.
my $seasonNumber = 56; # Integer | Number of a Season belonging to a Show.

eval { 
    my $result = $api_instance->getSeasonByNumber(id => $id, seasonNumber => $seasonNumber);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShowsApi->getSeasonByNumber: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ShowsApi()
id = 56 # Integer | Id of a Show.
seasonNumber = 56 # Integer | Number of a Season belonging to a Show.

try: 
    # Get Season by ShowId and Season Number.
    api_response = api_instance.get_season_by_number(id, seasonNumber)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShowsApi->getSeasonByNumber: %s\n" % e)

Parameters

Query parameters
Name Description
Id*
Integer
Id of a Show.
Required
SeasonNumber*
Integer
Number of a Season belonging to a Show.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getSeasonBySeasonNumber

Get Season by ShowId and Season Number.

Depreciated. Use GetSeasonBySeasonNumber instead. Requires a valid ShowId and Season Number.


/Shows/{Id}/Seasons/{SeasonNumber}

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Shows/{Id}/Seasons/{SeasonNumber}?Includes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShowsApi;

import java.io.File;
import java.util.*;

public class ShowsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ShowsApi apiInstance = new ShowsApi();
        Integer id = 56; // Integer | Id of a Show.
        Integer seasonNumber = 56; // Integer | Number of a Season belonging to a Show.
        array[String] includes = ; // array[String] | List of additional objects to include in the season response.
        try {
            SeasonResponse result = apiInstance.getSeasonBySeasonNumber(id, seasonNumber, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getSeasonBySeasonNumber");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShowsApi;

public class ShowsApiExample {

    public static void main(String[] args) {
        ShowsApi apiInstance = new ShowsApi();
        Integer id = 56; // Integer | Id of a Show.
        Integer seasonNumber = 56; // Integer | Number of a Season belonging to a Show.
        array[String] includes = ; // array[String] | List of additional objects to include in the season response.
        try {
            SeasonResponse result = apiInstance.getSeasonBySeasonNumber(id, seasonNumber, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getSeasonBySeasonNumber");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *id = 56; // Id of a Show.
Integer *seasonNumber = 56; // Number of a Season belonging to a Show.
array[String] *includes = ; // List of additional objects to include in the season response. (optional)

ShowsApi *apiInstance = [[ShowsApi alloc] init];

// Get Season by ShowId and Season Number.
[apiInstance getSeasonBySeasonNumberWith:id
    seasonNumber:seasonNumber
    includes:includes
              completionHandler: ^(SeasonResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ShowsApi()

var id = 56; // {Integer} Id of a Show.

var seasonNumber = 56; // {Integer} Number of a Season belonging to a Show.

var opts = { 
  'includes':  // {array[String]} List of additional objects to include in the season response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSeasonBySeasonNumber(id, seasonNumber, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSeasonBySeasonNumberExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ShowsApi();
            var id = 56;  // Integer | Id of a Show.
            var seasonNumber = 56;  // Integer | Number of a Season belonging to a Show.
            var includes = new array[String](); // array[String] | List of additional objects to include in the season response. (optional) 

            try
            {
                // Get Season by ShowId and Season Number.
                SeasonResponse result = apiInstance.getSeasonBySeasonNumber(id, seasonNumber, includes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShowsApi.getSeasonBySeasonNumber: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ShowsApi();
$id = 56; // Integer | Id of a Show.
$seasonNumber = 56; // Integer | Number of a Season belonging to a Show.
$includes = ; // array[String] | List of additional objects to include in the season response.

try {
    $result = $api_instance->getSeasonBySeasonNumber($id, $seasonNumber, $includes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShowsApi->getSeasonBySeasonNumber: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShowsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ShowsApi->new();
my $id = 56; # Integer | Id of a Show.
my $seasonNumber = 56; # Integer | Number of a Season belonging to a Show.
my $includes = []; # array[String] | List of additional objects to include in the season response.

eval { 
    my $result = $api_instance->getSeasonBySeasonNumber(id => $id, seasonNumber => $seasonNumber, includes => $includes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShowsApi->getSeasonBySeasonNumber: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ShowsApi()
id = 56 # Integer | Id of a Show.
seasonNumber = 56 # Integer | Number of a Season belonging to a Show.
includes =  # array[String] | List of additional objects to include in the season response. (optional)

try: 
    # Get Season by ShowId and Season Number.
    api_response = api_instance.get_season_by_season_number(id, seasonNumber, includes=includes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShowsApi->getSeasonBySeasonNumber: %s\n" % e)

Parameters

Path parameters
Name Description
Id*
Integer
Id of a Show.
Required
SeasonNumber*
Integer
Number of a Season belonging to a Show.
Required
Query parameters
Name Description
Includes
array[String]
List of additional objects to include in the season response.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getShow

Get Show by Show ID.

By default the API will only return basic title information. Additional objects can be included by passing the object in the Includes parameter. `Subscriptions with "Limited" data will only be able to include basic title information, Videos, EpisodicVideos, and SeasonVideos.`


/Shows/{Id}

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Shows/{Id}?Includes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShowsApi;

import java.io.File;
import java.util.*;

public class ShowsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ShowsApi apiInstance = new ShowsApi();
        Integer id = 56; // Integer | Required ID of Show.
        array[String] includes = ; // array[String] | List of additional objects to include in the show response.
        try {
            ShowResponse result = apiInstance.getShow(id, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShowsApi;

public class ShowsApiExample {

    public static void main(String[] args) {
        ShowsApi apiInstance = new ShowsApi();
        Integer id = 56; // Integer | Required ID of Show.
        array[String] includes = ; // array[String] | List of additional objects to include in the show response.
        try {
            ShowResponse result = apiInstance.getShow(id, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *id = 56; // Required ID of Show.
array[String] *includes = ; // List of additional objects to include in the show response. (optional)

ShowsApi *apiInstance = [[ShowsApi alloc] init];

// Get Show by Show ID.
[apiInstance getShowWith:id
    includes:includes
              completionHandler: ^(ShowResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ShowsApi()

var id = 56; // {Integer} Required ID of Show.

var opts = { 
  'includes':  // {array[String]} List of additional objects to include in the show response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShow(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ShowsApi();
            var id = 56;  // Integer | Required ID of Show.
            var includes = new array[String](); // array[String] | List of additional objects to include in the show response. (optional) 

            try
            {
                // Get Show by Show ID.
                ShowResponse result = apiInstance.getShow(id, includes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShowsApi.getShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ShowsApi();
$id = 56; // Integer | Required ID of Show.
$includes = ; // array[String] | List of additional objects to include in the show response.

try {
    $result = $api_instance->getShow($id, $includes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShowsApi->getShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShowsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ShowsApi->new();
my $id = 56; # Integer | Required ID of Show.
my $includes = []; # array[String] | List of additional objects to include in the show response.

eval { 
    my $result = $api_instance->getShow(id => $id, includes => $includes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShowsApi->getShow: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ShowsApi()
id = 56 # Integer | Required ID of Show.
includes =  # array[String] | List of additional objects to include in the show response. (optional)

try: 
    # Get Show by Show ID.
    api_response = api_instance.get_show(id, includes=includes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShowsApi->getShow: %s\n" % e)

Parameters

Path parameters
Name Description
Id*
Integer
Required ID of Show.
Required
Query parameters
Name Description
Includes
array[String]
List of additional objects to include in the show response.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getShowAlternateIdTypes

Get all AlternateIdTypes.

Alternate Id types refer to the 3rd party ID sets IVA data has matched. **Ex: IMDB**


/Shows/AlternateIdTypes

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Shows/AlternateIdTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShowsApi;

import java.io.File;
import java.util.*;

public class ShowsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ShowsApi apiInstance = new ShowsApi();
        try {
            array[ShowAlternateIdTypeResponse] result = apiInstance.getShowAlternateIdTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getShowAlternateIdTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShowsApi;

public class ShowsApiExample {

    public static void main(String[] args) {
        ShowsApi apiInstance = new ShowsApi();
        try {
            array[ShowAlternateIdTypeResponse] result = apiInstance.getShowAlternateIdTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getShowAlternateIdTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];


ShowsApi *apiInstance = [[ShowsApi alloc] init];

// Get all AlternateIdTypes.
[apiInstance getShowAlternateIdTypesWithCompletionHandler: 
              ^(array[ShowAlternateIdTypeResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ShowsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShowAlternateIdTypes(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getShowAlternateIdTypesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ShowsApi();

            try
            {
                // Get all AlternateIdTypes.
                array[ShowAlternateIdTypeResponse] result = apiInstance.getShowAlternateIdTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShowsApi.getShowAlternateIdTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ShowsApi();

try {
    $result = $api_instance->getShowAlternateIdTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShowsApi->getShowAlternateIdTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShowsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ShowsApi->new();

eval { 
    my $result = $api_instance->getShowAlternateIdTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShowsApi->getShowAlternateIdTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ShowsApi()

try: 
    # Get all AlternateIdTypes.
    api_response = api_instance.get_show_alternate_id_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShowsApi->getShowAlternateIdTypes: %s\n" % e)

Parameters

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getShowCertifications

Returns a list of Show Certifications.

List of Show Certifications and definitions.


/Shows/ShowCertifications

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Shows/ShowCertifications"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShowsApi;

import java.io.File;
import java.util.*;

public class ShowsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ShowsApi apiInstance = new ShowsApi();
        try {
            array[ShowCertificationResponse] result = apiInstance.getShowCertifications();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getShowCertifications");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShowsApi;

public class ShowsApiExample {

    public static void main(String[] args) {
        ShowsApi apiInstance = new ShowsApi();
        try {
            array[ShowCertificationResponse] result = apiInstance.getShowCertifications();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getShowCertifications");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];


ShowsApi *apiInstance = [[ShowsApi alloc] init];

// Returns a list of Show Certifications.
[apiInstance getShowCertificationsWithCompletionHandler: 
              ^(array[ShowCertificationResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ShowsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShowCertifications(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getShowCertificationsExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ShowsApi();

            try
            {
                // Returns a list of Show Certifications.
                array[ShowCertificationResponse] result = apiInstance.getShowCertifications();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShowsApi.getShowCertifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ShowsApi();

try {
    $result = $api_instance->getShowCertifications();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShowsApi->getShowCertifications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShowsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ShowsApi->new();

eval { 
    my $result = $api_instance->getShowCertifications();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShowsApi->getShowCertifications: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ShowsApi()

try: 
    # Returns a list of Show Certifications.
    api_response = api_instance.get_show_certifications()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShowsApi->getShowCertifications: %s\n" % e)

Parameters

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getShowGenres

Get all Show Genres.

Returns a list of all the show genres used in the IVA database.


/Shows/ShowGenres

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Shows/ShowGenres"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShowsApi;

import java.io.File;
import java.util.*;

public class ShowsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ShowsApi apiInstance = new ShowsApi();
        try {
            array[ShowGenreResponse] result = apiInstance.getShowGenres();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getShowGenres");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShowsApi;

public class ShowsApiExample {

    public static void main(String[] args) {
        ShowsApi apiInstance = new ShowsApi();
        try {
            array[ShowGenreResponse] result = apiInstance.getShowGenres();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getShowGenres");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];


ShowsApi *apiInstance = [[ShowsApi alloc] init];

// Get all Show Genres.
[apiInstance getShowGenresWithCompletionHandler: 
              ^(array[ShowGenreResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ShowsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShowGenres(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getShowGenresExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ShowsApi();

            try
            {
                // Get all Show Genres.
                array[ShowGenreResponse] result = apiInstance.getShowGenres();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShowsApi.getShowGenres: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ShowsApi();

try {
    $result = $api_instance->getShowGenres();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShowsApi->getShowGenres: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShowsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ShowsApi->new();

eval { 
    my $result = $api_instance->getShowGenres();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShowsApi->getShowGenres: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ShowsApi()

try: 
    # Get all Show Genres.
    api_response = api_instance.get_show_genres()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShowsApi->getShowGenres: %s\n" % e)

Parameters

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


getShowReleaseTypes

Returns a list of Show Release Types.

Release types refer to the type of release and are used in the releases object for a show.


/Shows/ReleaseTypes

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Shows/ReleaseTypes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShowsApi;

import java.io.File;
import java.util.*;

public class ShowsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ShowsApi apiInstance = new ShowsApi();
        try {
            array[ShowReleaseTypeResponse] result = apiInstance.getShowReleaseTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getShowReleaseTypes");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShowsApi;

public class ShowsApiExample {

    public static void main(String[] args) {
        ShowsApi apiInstance = new ShowsApi();
        try {
            array[ShowReleaseTypeResponse] result = apiInstance.getShowReleaseTypes();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#getShowReleaseTypes");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];


ShowsApi *apiInstance = [[ShowsApi alloc] init];

// Returns a list of Show Release Types.
[apiInstance getShowReleaseTypesWithCompletionHandler: 
              ^(array[ShowReleaseTypeResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ShowsApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getShowReleaseTypes(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getShowReleaseTypesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ShowsApi();

            try
            {
                // Returns a list of Show Release Types.
                array[ShowReleaseTypeResponse] result = apiInstance.getShowReleaseTypes();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShowsApi.getShowReleaseTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ShowsApi();

try {
    $result = $api_instance->getShowReleaseTypes();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShowsApi->getShowReleaseTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShowsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ShowsApi->new();

eval { 
    my $result = $api_instance->getShowReleaseTypes();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShowsApi->getShowReleaseTypes: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ShowsApi()

try: 
    # Returns a list of Show Release Types.
    api_response = api_instance.get_show_release_types()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShowsApi->getShowReleaseTypes: %s\n" % e)

Parameters

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


matchToShow

Perform a match to Entertainment using Title, Year, Cast and Director. Returns best match and score for the match.

Use to match IVA show data to another data source using title, director, cast, etc.


/Shows/Match/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Shows/Match/?Title=&AlternateTitles=&Year=&Cast=&Directors=&StringDistance="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShowsApi;

import java.io.File;
import java.util.*;

public class ShowsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ShowsApi apiInstance = new ShowsApi();
        String title = title_example; // String | Title of Show to be matched.
        String alternateTitles = alternateTitles_example; // String | Alternate Titles of Show to be matched.
        String year = year_example; // String | Release Year of Show to be matched.
        String cast = cast_example; // String | Cast members of Show to be matched.
        String directors = directors_example; // String | Directors of Show to be matched.
        String stringDistance = stringDistance_example; // String | For fuzzy title match, default is 4, set to 0 for no fuzzy match.
        try {
            MatchToEntertainmentShowResponse result = apiInstance.matchToShow(title, alternateTitles, year, cast, directors, stringDistance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#matchToShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShowsApi;

public class ShowsApiExample {

    public static void main(String[] args) {
        ShowsApi apiInstance = new ShowsApi();
        String title = title_example; // String | Title of Show to be matched.
        String alternateTitles = alternateTitles_example; // String | Alternate Titles of Show to be matched.
        String year = year_example; // String | Release Year of Show to be matched.
        String cast = cast_example; // String | Cast members of Show to be matched.
        String directors = directors_example; // String | Directors of Show to be matched.
        String stringDistance = stringDistance_example; // String | For fuzzy title match, default is 4, set to 0 for no fuzzy match.
        try {
            MatchToEntertainmentShowResponse result = apiInstance.matchToShow(title, alternateTitles, year, cast, directors, stringDistance);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#matchToShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *title = title_example; // Title of Show to be matched. (optional)
String *alternateTitles = alternateTitles_example; // Alternate Titles of Show to be matched. (optional)
String *year = year_example; // Release Year of Show to be matched. (optional)
String *cast = cast_example; // Cast members of Show to be matched. (optional)
String *directors = directors_example; // Directors of Show to be matched. (optional)
String *stringDistance = stringDistance_example; // For fuzzy title match, default is 4, set to 0 for no fuzzy match. (optional)

ShowsApi *apiInstance = [[ShowsApi alloc] init];

// Perform a match to Entertainment using Title, Year, Cast and Director. Returns best match and score for the match.
[apiInstance matchToShowWith:title
    alternateTitles:alternateTitles
    year:year
    cast:cast
    directors:directors
    stringDistance:stringDistance
              completionHandler: ^(MatchToEntertainmentShowResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ShowsApi()

var opts = { 
  'title': title_example, // {String} Title of Show to be matched.
  'alternateTitles': alternateTitles_example, // {String} Alternate Titles of Show to be matched.
  'year': year_example, // {String} Release Year of Show to be matched.
  'cast': cast_example, // {String} Cast members of Show to be matched.
  'directors': directors_example, // {String} Directors of Show to be matched.
  'stringDistance': stringDistance_example // {String} For fuzzy title match, default is 4, set to 0 for no fuzzy match.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.matchToShow(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class matchToShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ShowsApi();
            var title = title_example;  // String | Title of Show to be matched. (optional) 
            var alternateTitles = alternateTitles_example;  // String | Alternate Titles of Show to be matched. (optional) 
            var year = year_example;  // String | Release Year of Show to be matched. (optional) 
            var cast = cast_example;  // String | Cast members of Show to be matched. (optional) 
            var directors = directors_example;  // String | Directors of Show to be matched. (optional) 
            var stringDistance = stringDistance_example;  // String | For fuzzy title match, default is 4, set to 0 for no fuzzy match. (optional) 

            try
            {
                // Perform a match to Entertainment using Title, Year, Cast and Director. Returns best match and score for the match.
                MatchToEntertainmentShowResponse result = apiInstance.matchToShow(title, alternateTitles, year, cast, directors, stringDistance);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShowsApi.matchToShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ShowsApi();
$title = title_example; // String | Title of Show to be matched.
$alternateTitles = alternateTitles_example; // String | Alternate Titles of Show to be matched.
$year = year_example; // String | Release Year of Show to be matched.
$cast = cast_example; // String | Cast members of Show to be matched.
$directors = directors_example; // String | Directors of Show to be matched.
$stringDistance = stringDistance_example; // String | For fuzzy title match, default is 4, set to 0 for no fuzzy match.

try {
    $result = $api_instance->matchToShow($title, $alternateTitles, $year, $cast, $directors, $stringDistance);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShowsApi->matchToShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShowsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ShowsApi->new();
my $title = title_example; # String | Title of Show to be matched.
my $alternateTitles = alternateTitles_example; # String | Alternate Titles of Show to be matched.
my $year = year_example; # String | Release Year of Show to be matched.
my $cast = cast_example; # String | Cast members of Show to be matched.
my $directors = directors_example; # String | Directors of Show to be matched.
my $stringDistance = stringDistance_example; # String | For fuzzy title match, default is 4, set to 0 for no fuzzy match.

eval { 
    my $result = $api_instance->matchToShow(title => $title, alternateTitles => $alternateTitles, year => $year, cast => $cast, directors => $directors, stringDistance => $stringDistance);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShowsApi->matchToShow: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ShowsApi()
title = title_example # String | Title of Show to be matched. (optional)
alternateTitles = alternateTitles_example # String | Alternate Titles of Show to be matched. (optional)
year = year_example # String | Release Year of Show to be matched. (optional)
cast = cast_example # String | Cast members of Show to be matched. (optional)
directors = directors_example # String | Directors of Show to be matched. (optional)
stringDistance = stringDistance_example # String | For fuzzy title match, default is 4, set to 0 for no fuzzy match. (optional)

try: 
    # Perform a match to Entertainment using Title, Year, Cast and Director. Returns best match and score for the match.
    api_response = api_instance.match_to_show(title=title, alternateTitles=alternateTitles, year=year, cast=cast, directors=directors, stringDistance=stringDistance)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShowsApi->matchToShow: %s\n" % e)

Parameters

Query parameters
Name Description
Title
String
Title of Show to be matched.
AlternateTitles
String
Alternate Titles of Show to be matched.
Year
String
Release Year of Show to be matched.
Cast
String
Cast members of Show to be matched.
Directors
String
Directors of Show to be matched.
StringDistance
String
For fuzzy title match, default is 4, set to 0 for no fuzzy match.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


searchAndDiscoverShow

Search and discover shows.

Searchable Fields: Title, AlternateTitles, Genres, Tags, Cast, Directors, Descriptions, Ratings, OriginalLanguage. [Syntax Ref](https://docs.microsoft.com/en-us/rest/api/searchservice/simple-query-syntax-in-azure-search) Filterable Fields: Id, Title, AlternateTitles, Genres, OriginalAirDate, Year, Tags, Cast, Directors, Descriptions, HasVideo, ImageFilePath, Ratings, OriginalLanguage, Created, Modified, NumberOfSeasons, NumberOfEpisodes. [Syntax Ref](https://docs.microsoft.com/en-us/rest/api/searchservice/odata-expression-syntax-for-azure-search)


/Shows/SearchAndDiscover

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Shows/SearchAndDiscover?term=&SelectFields=&SearchFields=&Filter=&OrderBy=&Top=&Skip=&IncludeTotalResultCount=&SearchMode="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShowsApi;

import java.io.File;
import java.util.*;

public class ShowsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        ShowsApi apiInstance = new ShowsApi();
        String term = term_example; // String | Term to search for. This can be combined with all other options. Use '*' to return any match.
        String selectFields = selectFields_example; // String | List of field names to be returned in the object.
        String searchFields = searchFields_example; // String | List of field names to search using 'term.'
        String filter = filter_example; // String | Expression to filter results.
        String orderBy = orderBy_example; // String | List of field names to sort results.  Default is relevance.
        String top = top_example; // String | Limit results.  Maximum returned is 1000.
        String skip = skip_example; // String | Skip number of results. Use this for paging results.
        String includeTotalResultCount = includeTotalResultCount_example; // String | Includes total results in response. This will have a performance impact.
        String searchMode = searchMode_example; // String | Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match.
        try {
            SearchShowResponse result = apiInstance.searchAndDiscoverShow(term, selectFields, searchFields, filter, orderBy, top, skip, includeTotalResultCount, searchMode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#searchAndDiscoverShow");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShowsApi;

public class ShowsApiExample {

    public static void main(String[] args) {
        ShowsApi apiInstance = new ShowsApi();
        String term = term_example; // String | Term to search for. This can be combined with all other options. Use '*' to return any match.
        String selectFields = selectFields_example; // String | List of field names to be returned in the object.
        String searchFields = searchFields_example; // String | List of field names to search using 'term.'
        String filter = filter_example; // String | Expression to filter results.
        String orderBy = orderBy_example; // String | List of field names to sort results.  Default is relevance.
        String top = top_example; // String | Limit results.  Maximum returned is 1000.
        String skip = skip_example; // String | Skip number of results. Use this for paging results.
        String includeTotalResultCount = includeTotalResultCount_example; // String | Includes total results in response. This will have a performance impact.
        String searchMode = searchMode_example; // String | Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match.
        try {
            SearchShowResponse result = apiInstance.searchAndDiscoverShow(term, selectFields, searchFields, filter, orderBy, top, skip, includeTotalResultCount, searchMode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShowsApi#searchAndDiscoverShow");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *term = term_example; // Term to search for. This can be combined with all other options. Use '*' to return any match. (optional)
String *selectFields = selectFields_example; // List of field names to be returned in the object. (optional)
String *searchFields = searchFields_example; // List of field names to search using 'term.' (optional)
String *filter = filter_example; // Expression to filter results. (optional)
String *orderBy = orderBy_example; // List of field names to sort results.  Default is relevance. (optional)
String *top = top_example; // Limit results.  Maximum returned is 1000. (optional)
String *skip = skip_example; // Skip number of results. Use this for paging results. (optional)
String *includeTotalResultCount = includeTotalResultCount_example; // Includes total results in response. This will have a performance impact. (optional)
String *searchMode = searchMode_example; // Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match. (optional)

ShowsApi *apiInstance = [[ShowsApi alloc] init];

// Search and discover shows.
[apiInstance searchAndDiscoverShowWith:term
    selectFields:selectFields
    searchFields:searchFields
    filter:filter
    orderBy:orderBy
    top:top
    skip:skip
    includeTotalResultCount:includeTotalResultCount
    searchMode:searchMode
              completionHandler: ^(SearchShowResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.ShowsApi()

var opts = { 
  'term': term_example, // {String} Term to search for. This can be combined with all other options. Use '*' to return any match.
  'selectFields': selectFields_example, // {String} List of field names to be returned in the object.
  'searchFields': searchFields_example, // {String} List of field names to search using 'term.'
  'filter': filter_example, // {String} Expression to filter results.
  'orderBy': orderBy_example, // {String} List of field names to sort results.  Default is relevance.
  'top': top_example, // {String} Limit results.  Maximum returned is 1000.
  'skip': skip_example, // {String} Skip number of results. Use this for paging results.
  'includeTotalResultCount': includeTotalResultCount_example, // {String} Includes total results in response. This will have a performance impact.
  'searchMode': searchMode_example // {String} Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchAndDiscoverShow(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchAndDiscoverShowExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new ShowsApi();
            var term = term_example;  // String | Term to search for. This can be combined with all other options. Use '*' to return any match. (optional) 
            var selectFields = selectFields_example;  // String | List of field names to be returned in the object. (optional) 
            var searchFields = searchFields_example;  // String | List of field names to search using 'term.' (optional) 
            var filter = filter_example;  // String | Expression to filter results. (optional) 
            var orderBy = orderBy_example;  // String | List of field names to sort results.  Default is relevance. (optional) 
            var top = top_example;  // String | Limit results.  Maximum returned is 1000. (optional) 
            var skip = skip_example;  // String | Skip number of results. Use this for paging results. (optional) 
            var includeTotalResultCount = includeTotalResultCount_example;  // String | Includes total results in response. This will have a performance impact. (optional) 
            var searchMode = searchMode_example;  // String | Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match. (optional) 

            try
            {
                // Search and discover shows.
                SearchShowResponse result = apiInstance.searchAndDiscoverShow(term, selectFields, searchFields, filter, orderBy, top, skip, includeTotalResultCount, searchMode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShowsApi.searchAndDiscoverShow: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\ShowsApi();
$term = term_example; // String | Term to search for. This can be combined with all other options. Use '*' to return any match.
$selectFields = selectFields_example; // String | List of field names to be returned in the object.
$searchFields = searchFields_example; // String | List of field names to search using 'term.'
$filter = filter_example; // String | Expression to filter results.
$orderBy = orderBy_example; // String | List of field names to sort results.  Default is relevance.
$top = top_example; // String | Limit results.  Maximum returned is 1000.
$skip = skip_example; // String | Skip number of results. Use this for paging results.
$includeTotalResultCount = includeTotalResultCount_example; // String | Includes total results in response. This will have a performance impact.
$searchMode = searchMode_example; // String | Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match.

try {
    $result = $api_instance->searchAndDiscoverShow($term, $selectFields, $searchFields, $filter, $orderBy, $top, $skip, $includeTotalResultCount, $searchMode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShowsApi->searchAndDiscoverShow: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShowsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ShowsApi->new();
my $term = term_example; # String | Term to search for. This can be combined with all other options. Use '*' to return any match.
my $selectFields = selectFields_example; # String | List of field names to be returned in the object.
my $searchFields = searchFields_example; # String | List of field names to search using 'term.'
my $filter = filter_example; # String | Expression to filter results.
my $orderBy = orderBy_example; # String | List of field names to sort results.  Default is relevance.
my $top = top_example; # String | Limit results.  Maximum returned is 1000.
my $skip = skip_example; # String | Skip number of results. Use this for paging results.
my $includeTotalResultCount = includeTotalResultCount_example; # String | Includes total results in response. This will have a performance impact.
my $searchMode = searchMode_example; # String | Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match.

eval { 
    my $result = $api_instance->searchAndDiscoverShow(term => $term, selectFields => $selectFields, searchFields => $searchFields, filter => $filter, orderBy => $orderBy, top => $top, skip => $skip, includeTotalResultCount => $includeTotalResultCount, searchMode => $searchMode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShowsApi->searchAndDiscoverShow: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ShowsApi()
term = term_example # String | Term to search for. This can be combined with all other options. Use '*' to return any match. (optional)
selectFields = selectFields_example # String | List of field names to be returned in the object. (optional)
searchFields = searchFields_example # String | List of field names to search using 'term.' (optional)
filter = filter_example # String | Expression to filter results. (optional)
orderBy = orderBy_example # String | List of field names to sort results.  Default is relevance. (optional)
top = top_example # String | Limit results.  Maximum returned is 1000. (optional)
skip = skip_example # String | Skip number of results. Use this for paging results. (optional)
includeTotalResultCount = includeTotalResultCount_example # String | Includes total results in response. This will have a performance impact. (optional)
searchMode = searchMode_example # String | Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match. (optional)

try: 
    # Search and discover shows.
    api_response = api_instance.search_and_discover_show(term=term, selectFields=selectFields, searchFields=searchFields, filter=filter, orderBy=orderBy, top=top, skip=skip, includeTotalResultCount=includeTotalResultCount, searchMode=searchMode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShowsApi->searchAndDiscoverShow: %s\n" % e)

Parameters

Query parameters
Name Description
term
String
Term to search for. This can be combined with all other options. Use '*' to return any match.
SelectFields
String
List of field names to be returned in the object.
SearchFields
String
List of field names to search using 'term.'
Filter
String
Expression to filter results.
OrderBy
String
List of field names to sort results. Default is relevance.
Top
String
Limit results. Maximum returned is 1000.
Skip
String
Skip number of results. Use this for paging results.
IncludeTotalResultCount
String
Includes total results in response. This will have a performance impact.
SearchMode
String
Specifies whether ANY or ALL of the search terms must be matched in order to count the item as a match.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


Tests

getTestDateTime

Returns translated time from IVA or an error if invalid.

Entertainment Express APIs use date time format ISO 8601. Use this API to test your date time format to see if it translates to a valid time on our server.


/Tests/TestDateTime/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Tests/TestDateTime/?DateTime="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TestsApi;

import java.io.File;
import java.util.*;

public class TestsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        TestsApi apiInstance = new TestsApi();
        String dateTime = dateTime_example; // String | DateTime to test format from API.
        try {
            TestDateTimeResponse result = apiInstance.getTestDateTime(dateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestsApi#getTestDateTime");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TestsApi;

public class TestsApiExample {

    public static void main(String[] args) {
        TestsApi apiInstance = new TestsApi();
        String dateTime = dateTime_example; // String | DateTime to test format from API.
        try {
            TestDateTimeResponse result = apiInstance.getTestDateTime(dateTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TestsApi#getTestDateTime");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

String *dateTime = dateTime_example; // DateTime to test format from API.

TestsApi *apiInstance = [[TestsApi alloc] init];

// Returns translated time from IVA or an error if invalid.
[apiInstance getTestDateTimeWith:dateTime
              completionHandler: ^(TestDateTimeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.TestsApi()

var dateTime = dateTime_example; // {String} DateTime to test format from API.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTestDateTime(dateTime, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTestDateTimeExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new TestsApi();
            var dateTime = dateTime_example;  // String | DateTime to test format from API.

            try
            {
                // Returns translated time from IVA or an error if invalid.
                TestDateTimeResponse result = apiInstance.getTestDateTime(dateTime);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TestsApi.getTestDateTime: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\TestsApi();
$dateTime = dateTime_example; // String | DateTime to test format from API.

try {
    $result = $api_instance->getTestDateTime($dateTime);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TestsApi->getTestDateTime: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TestsApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TestsApi->new();
my $dateTime = dateTime_example; # String | DateTime to test format from API.

eval { 
    my $result = $api_instance->getTestDateTime(dateTime => $dateTime);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TestsApi->getTestDateTime: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TestsApi()
dateTime = dateTime_example # String | DateTime to test format from API.

try: 
    # Returns translated time from IVA or an error if invalid.
    api_response = api_instance.get_test_date_time(dateTime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TestsApi->getTestDateTime: %s\n" % e)

Parameters

Query parameters
Name Description
DateTime*
String
DateTime to test format from API.
Required

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


TheatricalMovies

getTheatricalMovies

Returns list of all US Theatrical Movie objects.

Deprecated. Use /Movies/InTheaters or /Movies/ComingSoon instead. Returns all movies with a US Theatrical Release Date > today - 60 days. Use the includes parameter to include additional objects related to the movie. The includes parameter takes a comma separated list of objects. **EX: Genres,Descriptions,Videos**


/TheatricalMovies/

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/TheatricalMovies/?Skip=&Take=&Includes="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TheatricalMoviesApi;

import java.io.File;
import java.util.*;

public class TheatricalMoviesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        TheatricalMoviesApi apiInstance = new TheatricalMoviesApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 10)
        array[String] includes = ; // array[String] | List of additional objects to include in the movie response.
        try {
            array[MovieResponse] result = apiInstance.getTheatricalMovies(skip, take, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TheatricalMoviesApi#getTheatricalMovies");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TheatricalMoviesApi;

public class TheatricalMoviesApiExample {

    public static void main(String[] args) {
        TheatricalMoviesApi apiInstance = new TheatricalMoviesApi();
        Integer skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
        Integer take = 56; // Integer | Determines the page size.  (Maximum of 10)
        array[String] includes = ; // array[String] | List of additional objects to include in the movie response.
        try {
            array[MovieResponse] result = apiInstance.getTheatricalMovies(skip, take, includes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TheatricalMoviesApi#getTheatricalMovies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *skip = 56; // Determines where to start page.  Ex: 0 starts at the beginning.
Integer *take = 56; // Determines the page size.  (Maximum of 10)
array[String] *includes = ; // List of additional objects to include in the movie response. (optional)

TheatricalMoviesApi *apiInstance = [[TheatricalMoviesApi alloc] init];

// Returns list of all US Theatrical Movie objects.
[apiInstance getTheatricalMoviesWith:skip
    take:take
    includes:includes
              completionHandler: ^(array[MovieResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.TheatricalMoviesApi()

var skip = 56; // {Integer} Determines where to start page.  Ex: 0 starts at the beginning.

var take = 56; // {Integer} Determines the page size.  (Maximum of 10)

var opts = { 
  'includes':  // {array[String]} List of additional objects to include in the movie response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getTheatricalMovies(skip, take, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getTheatricalMoviesExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new TheatricalMoviesApi();
            var skip = 56;  // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
            var take = 56;  // Integer | Determines the page size.  (Maximum of 10)
            var includes = new array[String](); // array[String] | List of additional objects to include in the movie response. (optional) 

            try
            {
                // Returns list of all US Theatrical Movie objects.
                array[MovieResponse] result = apiInstance.getTheatricalMovies(skip, take, includes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TheatricalMoviesApi.getTheatricalMovies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\TheatricalMoviesApi();
$skip = 56; // Integer | Determines where to start page.  Ex: 0 starts at the beginning.
$take = 56; // Integer | Determines the page size.  (Maximum of 10)
$includes = ; // array[String] | List of additional objects to include in the movie response.

try {
    $result = $api_instance->getTheatricalMovies($skip, $take, $includes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TheatricalMoviesApi->getTheatricalMovies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::TheatricalMoviesApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::TheatricalMoviesApi->new();
my $skip = 56; # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
my $take = 56; # Integer | Determines the page size.  (Maximum of 10)
my $includes = []; # array[String] | List of additional objects to include in the movie response.

eval { 
    my $result = $api_instance->getTheatricalMovies(skip => $skip, take => $take, includes => $includes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TheatricalMoviesApi->getTheatricalMovies: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.TheatricalMoviesApi()
skip = 56 # Integer | Determines where to start page.  Ex: 0 starts at the beginning.
take = 56 # Integer | Determines the page size.  (Maximum of 10)
includes =  # array[String] | List of additional objects to include in the movie response. (optional)

try: 
    # Returns list of all US Theatrical Movie objects.
    api_response = api_instance.get_theatrical_movies(skip, take, includes=includes)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TheatricalMoviesApi->getTheatricalMovies: %s\n" % e)

Parameters

Query parameters
Name Description
Skip*
Integer
Determines where to start page. Ex: 0 starts at the beginning.
Required
Take*
Integer
Determines the page size. (Maximum of 10)
Required
Includes
array[String]
List of additional objects to include in the movie response.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


Videos

getVideo

Returns a URL to a requested video.

Returns a URL to the requested video. [Video Format Specs](https://developer.iva-api.com/docs/v1/video-formats) **Formats:** MP4 = 4, HLS = 11, Dash = 14, HSS = 12, HDS = 13 **MP4 KbRate:** 80, 212, 450, 750, 1500, 2500(HD sources only), 5000 (sources >= 1080p) **Adaptive Min/Max rate:** 212000, 350000, 600000, 1200000, 2000000, 2500000, 3500000 `URLs requested with a Demo account will always return max 750 kbps video. Full commercial account required for higher bitrates.`


/Videos/GetVideo/{Id}

Usage and SDK Samples

curl -X GET -H "Ocp-Apim-Subscription-Key: [[apiKey]]" "https://ee.iva-api.com/Videos/GetVideo/{Id}?Format=&KbRate=&Expires=&ReportTag=&start=&end=&MinRate=&MaxRate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VideosApi;

import java.io.File;
import java.util.*;

public class VideosApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: ApiKeyHeader
        ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
        ApiKeyHeader.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyHeader.setApiKeyPrefix("Token");

        // Configure API key authorization: ApiKeyQuery
        ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
        ApiKeyQuery.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //ApiKeyQuery.setApiKeyPrefix("Token");

        VideosApi apiInstance = new VideosApi();
        Integer id = 56; // Integer | Id of the Video from either MovieVideo, ShowVideo, SeasonVideo, EpisodeVideo object.
        String format = format_example; // String | Video format.
        String expires = expires_example; // String | UTC Time to video link should expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        String kbRate = kbRate_example; // String | Video bitrate required for MP4 content.
        String reportTag = reportTag_example; // String | Report tag used in video analytics.
        Integer start = 56; // Integer | Position in seconds to start video playback.
        Integer end = 56; // Integer | Position in seconds to end video playback.
        String minRate = minRate_example; // String | Adaptive Maximum rate.
        String maxRate = maxRate_example; // String | Adaptive Minimum rate.
        try {
            VideoResponse result = apiInstance.getVideo(id, format, expires, kbRate, reportTag, start, end, minRate, maxRate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideosApi#getVideo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.VideosApi;

public class VideosApiExample {

    public static void main(String[] args) {
        VideosApi apiInstance = new VideosApi();
        Integer id = 56; // Integer | Id of the Video from either MovieVideo, ShowVideo, SeasonVideo, EpisodeVideo object.
        String format = format_example; // String | Video format.
        String expires = expires_example; // String | UTC Time to video link should expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
        String kbRate = kbRate_example; // String | Video bitrate required for MP4 content.
        String reportTag = reportTag_example; // String | Report tag used in video analytics.
        Integer start = 56; // Integer | Position in seconds to start video playback.
        Integer end = 56; // Integer | Position in seconds to end video playback.
        String minRate = minRate_example; // String | Adaptive Maximum rate.
        String maxRate = maxRate_example; // String | Adaptive Minimum rate.
        try {
            VideoResponse result = apiInstance.getVideo(id, format, expires, kbRate, reportTag, start, end, minRate, maxRate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VideosApi#getVideo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: ApiKeyHeader)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Ocp-Apim-Subscription-Key"];

// Configure API key authorization: (authentication scheme: ApiKeyQuery)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"subscription-Key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"subscription-Key"];

Integer *id = 56; // Id of the Video from either MovieVideo, ShowVideo, SeasonVideo, EpisodeVideo object.
String *format = format_example; // Video format.
String *expires = expires_example; // UTC Time to video link should expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
String *kbRate = kbRate_example; // Video bitrate required for MP4 content. (optional)
String *reportTag = reportTag_example; // Report tag used in video analytics. (optional)
Integer *start = 56; // Position in seconds to start video playback. (optional)
Integer *end = 56; // Position in seconds to end video playback. (optional)
String *minRate = minRate_example; // Adaptive Maximum rate. (optional)
String *maxRate = maxRate_example; // Adaptive Minimum rate. (optional)

VideosApi *apiInstance = [[VideosApi alloc] init];

// Returns a URL to a requested video.
[apiInstance getVideoWith:id
    format:format
    expires:expires
    kbRate:kbRate
    reportTag:reportTag
    start:start
    end:end
    minRate:minRate
    maxRate:maxRate
              completionHandler: ^(VideoResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var EntertainmentExpressApi = require('entertainment_express_api');
var defaultClient = EntertainmentExpressApi.ApiClient.instance;

// Configure API key authorization: ApiKeyHeader
var ApiKeyHeader = defaultClient.authentications['ApiKeyHeader'];
ApiKeyHeader.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.apiKeyPrefix['Ocp-Apim-Subscription-Key'] = "Token"

// Configure API key authorization: ApiKeyQuery
var ApiKeyQuery = defaultClient.authentications['ApiKeyQuery'];
ApiKeyQuery.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.apiKeyPrefix['subscription-Key'] = "Token"

var api = new EntertainmentExpressApi.VideosApi()

var id = 56; // {Integer} Id of the Video from either MovieVideo, ShowVideo, SeasonVideo, EpisodeVideo object.

var format = format_example; // {String} Video format.

var expires = expires_example; // {String} UTC Time to video link should expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z

var opts = { 
  'kbRate': kbRate_example, // {String} Video bitrate required for MP4 content.
  'reportTag': reportTag_example, // {String} Report tag used in video analytics.
  'start': 56, // {Integer} Position in seconds to start video playback.
  'end': 56, // {Integer} Position in seconds to end video playback.
  'minRate': minRate_example, // {String} Adaptive Maximum rate.
  'maxRate': maxRate_example // {String} Adaptive Minimum rate.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideo(id, format, expires, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVideoExample
    {
        public void main()
        {
            
            // Configure API key authorization: ApiKeyHeader
            Configuration.Default.ApiKey.Add("Ocp-Apim-Subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Ocp-Apim-Subscription-Key", "Bearer");
            // Configure API key authorization: ApiKeyQuery
            Configuration.Default.ApiKey.Add("subscription-Key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("subscription-Key", "Bearer");

            var apiInstance = new VideosApi();
            var id = 56;  // Integer | Id of the Video from either MovieVideo, ShowVideo, SeasonVideo, EpisodeVideo object.
            var format = format_example;  // String | Video format.
            var expires = expires_example;  // String | UTC Time to video link should expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
            var kbRate = kbRate_example;  // String | Video bitrate required for MP4 content. (optional) 
            var reportTag = reportTag_example;  // String | Report tag used in video analytics. (optional) 
            var start = 56;  // Integer | Position in seconds to start video playback. (optional) 
            var end = 56;  // Integer | Position in seconds to end video playback. (optional) 
            var minRate = minRate_example;  // String | Adaptive Maximum rate. (optional) 
            var maxRate = maxRate_example;  // String | Adaptive Minimum rate. (optional) 

            try
            {
                // Returns a URL to a requested video.
                VideoResponse result = apiInstance.getVideo(id, format, expires, kbRate, reportTag, start, end, minRate, maxRate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VideosApi.getVideo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: ApiKeyHeader
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');
// Configure API key authorization: ApiKeyQuery
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-Key', 'Bearer');

$api_instance = new Swagger\Client\Api\VideosApi();
$id = 56; // Integer | Id of the Video from either MovieVideo, ShowVideo, SeasonVideo, EpisodeVideo object.
$format = format_example; // String | Video format.
$expires = expires_example; // String | UTC Time to video link should expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
$kbRate = kbRate_example; // String | Video bitrate required for MP4 content.
$reportTag = reportTag_example; // String | Report tag used in video analytics.
$start = 56; // Integer | Position in seconds to start video playback.
$end = 56; // Integer | Position in seconds to end video playback.
$minRate = minRate_example; // String | Adaptive Maximum rate.
$maxRate = maxRate_example; // String | Adaptive Minimum rate.

try {
    $result = $api_instance->getVideo($id, $format, $expires, $kbRate, $reportTag, $start, $end, $minRate, $maxRate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VideosApi->getVideo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VideosApi;

# Configure API key authorization: ApiKeyHeader
$WWW::SwaggerClient::Configuration::api_key->{'Ocp-Apim-Subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Ocp-Apim-Subscription-Key'} = "Bearer";
# Configure API key authorization: ApiKeyQuery
$WWW::SwaggerClient::Configuration::api_key->{'subscription-Key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'subscription-Key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::VideosApi->new();
my $id = 56; # Integer | Id of the Video from either MovieVideo, ShowVideo, SeasonVideo, EpisodeVideo object.
my $format = format_example; # String | Video format.
my $expires = expires_example; # String | UTC Time to video link should expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
my $kbRate = kbRate_example; # String | Video bitrate required for MP4 content.
my $reportTag = reportTag_example; # String | Report tag used in video analytics.
my $start = 56; # Integer | Position in seconds to start video playback.
my $end = 56; # Integer | Position in seconds to end video playback.
my $minRate = minRate_example; # String | Adaptive Maximum rate.
my $maxRate = maxRate_example; # String | Adaptive Minimum rate.

eval { 
    my $result = $api_instance->getVideo(id => $id, format => $format, expires => $expires, kbRate => $kbRate, reportTag => $reportTag, start => $start, end => $end, minRate => $minRate, maxRate => $maxRate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VideosApi->getVideo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: ApiKeyHeader
swagger_client.configuration.api_key['Ocp-Apim-Subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['Ocp-Apim-Subscription-Key'] = 'Bearer'
# Configure API key authorization: ApiKeyQuery
swagger_client.configuration.api_key['subscription-Key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['subscription-Key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.VideosApi()
id = 56 # Integer | Id of the Video from either MovieVideo, ShowVideo, SeasonVideo, EpisodeVideo object.
format = format_example # String | Video format.
expires = expires_example # String | UTC Time to video link should expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
kbRate = kbRate_example # String | Video bitrate required for MP4 content. (optional)
reportTag = reportTag_example # String | Report tag used in video analytics. (optional)
start = 56 # Integer | Position in seconds to start video playback. (optional)
end = 56 # Integer | Position in seconds to end video playback. (optional)
minRate = minRate_example # String | Adaptive Maximum rate. (optional)
maxRate = maxRate_example # String | Adaptive Minimum rate. (optional)

try: 
    # Returns a URL to a requested video.
    api_response = api_instance.get_video(id, format, expires, kbRate=kbRate, reportTag=reportTag, start=start, end=end, minRate=minRate, maxRate=maxRate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VideosApi->getVideo: %s\n" % e)

Parameters

Path parameters
Name Description
Id*
Integer
Id of the Video from either MovieVideo, ShowVideo, SeasonVideo, EpisodeVideo object.
Required
Query parameters
Name Description
Format*
String
Video format.
Required
KbRate
String
Video bitrate required for MP4 content.
Expires*
String
UTC Time to video link should expire. ISO 8601 Format: yyyy-mm-dd hh:mm:ss.ffffff0Z
Required
ReportTag
String
Report tag used in video analytics.
start
Integer
Position in seconds to start video playback.
end
Integer
Position in seconds to end video playback.
MinRate
String
Adaptive Maximum rate.
MaxRate
String
Adaptive Minimum rate.

Responses

Status: 200 - OK.

Status: 204 - No content.

Status: 400 - Bad request.

Status: 401 - Unauthorized.

Status: 403 - Forbidden. The subscription key does not have permission to access this method.

Status: 404 - Not found. The item you requested could not be found or has been deleted.

Status: 409 - Conflict.

Status: 429 - Too many requests.

Status: 500 - Internal server error.

Status: 503 - Service unavailable.


Generated 2017-07-27T17:13:37.708Z