Swagger\Client\DefaultApi

All URIs are relative to http://api.vaf.be/api/v1

Method	HTTP request	Description
assetsIdDownloadGet	GET /assets/{id}/download	Returns binary data by asset id
assetsIdGet	GET /assets/{id}	Returns a asset by id
filmsGet	GET /films	Returns all films
filmsIdGet	GET /films/{id}	Returns a film by id
filmsIdPostersGet	GET /films/{id}/posters	Returns posters (assets) for a film
filmsIdStillsGet	GET /films/{id}/stills	Returns stills (assets) for a film
rootGet	GET /	Returns API version info

assetsIdDownloadGet

string assetsIdDownloadGet($id)

Returns binary data by asset id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: apiAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Api-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "id_example"; // string | The ID of the asset

try {
    $result = $apiInstance->assetsIdDownloadGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->assetsIdDownloadGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	The ID of the asset

Return type

string

Authorization

apiAuth

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

assetsIdGet

\Swagger\Client\Model\Asset assetsIdGet($id)

Returns a asset by id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: apiAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Api-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "id_example"; // string | The ID of the asset

try {
    $result = $apiInstance->assetsIdGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->assetsIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	The ID of the asset

Return type

\Swagger\Client\Model\Asset

Authorization

apiAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

filmsGet

\Swagger\Client\Model\Film[] filmsGet()

Returns all films

Returns a array of films, ordered a to z

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: apiAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Api-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->filmsGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->filmsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\Swagger\Client\Model\Film[]

Authorization

apiAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

filmsIdGet

\Swagger\Client\Model\Film filmsIdGet($id)

Returns a film by id

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: apiAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Api-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "id_example"; // string | The ID of the film

try {
    $result = $apiInstance->filmsIdGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->filmsIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	The ID of the film

Return type

\Swagger\Client\Model\Film

Authorization

apiAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

filmsIdPostersGet

\Swagger\Client\Model\Asset[] filmsIdPostersGet($id)

Returns posters (assets) for a film

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: apiAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Api-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "id_example"; // string | The ID of the film

try {
    $result = $apiInstance->filmsIdPostersGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->filmsIdPostersGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	The ID of the film

Return type

\Swagger\Client\Model\Asset[]

Authorization

apiAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

filmsIdStillsGet

\Swagger\Client\Model\Asset[] filmsIdStillsGet($id)

Returns stills (assets) for a film

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: apiAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Api-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "id_example"; // string | The ID of the film

try {
    $result = $apiInstance->filmsIdStillsGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->filmsIdStillsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	The ID of the film

Return type

\Swagger\Client\Model\Asset[]

Authorization

apiAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

rootGet

\Swagger\Client\Model\InlineResponse200 rootGet()

Returns API version info

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: apiAuth
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Api-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Api-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->rootGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->rootGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\Swagger\Client\Model\InlineResponse200

Authorization

apiAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

Swagger\Client\DefaultApi

assetsIdDownloadGet

Example

Parameters

Return type

Authorization

HTTP request headers

assetsIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

filmsGet

Example

Parameters

Return type

Authorization

HTTP request headers

filmsIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

filmsIdPostersGet

Example

Parameters

Return type

Authorization

HTTP request headers

filmsIdStillsGet

Example

Parameters

Return type

Authorization

HTTP request headers

rootGet

Example

Parameters

Return type

Authorization

HTTP request headers