Recubik API

Layout

layoutAdd

Add a Layout

Add a new Layout to the CMS


/layout

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/layout?name=&description=&layoutId=&resolutionId=&returnDraft=&code=&folderId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        String name = name_example; // String | The layout name
        String description = description_example; // String | The layout description
        Integer layoutId = 56; // Integer | If the Layout should be created with a Template, provide the ID, otherwise don't provide
        Integer resolutionId = 56; // Integer | If a Template is not provided, provide the resolutionId for this Layout.
        Boolean returnDraft = true; // Boolean | Should we return the Draft Layout or the Published Layout on Success?
        String code = code_example; // String | Code identifier for this Layout
        Integer folderId = 56; // Integer | Folder ID to which this object should be assigned to
        try {
            apiInstance.layoutAdd(name, description, layoutId, resolutionId, returnDraft, code, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutAdd");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        String name = name_example; // String | The layout name
        String description = description_example; // String | The layout description
        Integer layoutId = 56; // Integer | If the Layout should be created with a Template, provide the ID, otherwise don't provide
        Integer resolutionId = 56; // Integer | If a Template is not provided, provide the resolutionId for this Layout.
        Boolean returnDraft = true; // Boolean | Should we return the Draft Layout or the Published Layout on Success?
        String code = code_example; // String | Code identifier for this Layout
        Integer folderId = 56; // Integer | Folder ID to which this object should be assigned to
        try {
            apiInstance.layoutAdd(name, description, layoutId, resolutionId, returnDraft, code, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutAdd");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // The layout name (optional)
String *description = description_example; // The layout description (optional)
Integer *layoutId = 56; // If the Layout should be created with a Template, provide the ID, otherwise don't provide (optional)
Integer *resolutionId = 56; // If a Template is not provided, provide the resolutionId for this Layout. (optional)
Boolean *returnDraft = true; // Should we return the Draft Layout or the Published Layout on Success? (optional)
String *code = code_example; // Code identifier for this Layout (optional)
Integer *folderId = 56; // Folder ID to which this object should be assigned to (optional)

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

// Add a Layout
[apiInstance layoutAddWith:name
    description:description
    layoutId:layoutId
    resolutionId:resolutionId
    returnDraft:returnDraft
    code:code
    folderId:folderId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var opts = { 
  'name': name_example, // {{String}} The layout name
  'description': description_example, // {{String}} The layout description
  'layoutId': 56, // {{Integer}} If the Layout should be created with a Template, provide the ID, otherwise don't provide
  'resolutionId': 56, // {{Integer}} If a Template is not provided, provide the resolutionId for this Layout.
  'returnDraft': true, // {{Boolean}} Should we return the Draft Layout or the Published Layout on Success?
  'code': code_example, // {{String}} Code identifier for this Layout
  'folderId': 56 // {{Integer}} Folder ID to which this object should be assigned to
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.layoutAdd(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class layoutAddExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var name = name_example;  // String | The layout name (optional) 
            var description = description_example;  // String | The layout description (optional) 
            var layoutId = 56;  // Integer | If the Layout should be created with a Template, provide the ID, otherwise don't provide (optional) 
            var resolutionId = 56;  // Integer | If a Template is not provided, provide the resolutionId for this Layout. (optional) 
            var returnDraft = true;  // Boolean | Should we return the Draft Layout or the Published Layout on Success? (optional) 
            var code = code_example;  // String | Code identifier for this Layout (optional) 
            var folderId = 56;  // Integer | Folder ID to which this object should be assigned to (optional) 

            try
            {
                // Add a Layout
                apiInstance.layoutAdd(name, description, layoutId, resolutionId, returnDraft, code, folderId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutAdd: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$name = name_example; // String | The layout name
$description = description_example; // String | The layout description
$layoutId = 56; // Integer | If the Layout should be created with a Template, provide the ID, otherwise don't provide
$resolutionId = 56; // Integer | If a Template is not provided, provide the resolutionId for this Layout.
$returnDraft = true; // Boolean | Should we return the Draft Layout or the Published Layout on Success?
$code = code_example; // String | Code identifier for this Layout
$folderId = 56; // Integer | Folder ID to which this object should be assigned to

try {
    $api_instance->layoutAdd($name, $description, $layoutId, $resolutionId, $returnDraft, $code, $folderId);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutAdd: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $name = name_example; # String | The layout name
my $description = description_example; # String | The layout description
my $layoutId = 56; # Integer | If the Layout should be created with a Template, provide the ID, otherwise don't provide
my $resolutionId = 56; # Integer | If a Template is not provided, provide the resolutionId for this Layout.
my $returnDraft = true; # Boolean | Should we return the Draft Layout or the Published Layout on Success?
my $code = code_example; # String | Code identifier for this Layout
my $folderId = 56; # Integer | Folder ID to which this object should be assigned to

eval { 
    $api_instance->layoutAdd(name => $name, description => $description, layoutId => $layoutId, resolutionId => $resolutionId, returnDraft => $returnDraft, code => $code, folderId => $folderId);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutAdd: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
name = name_example # String | The layout name (optional)
description = description_example # String | The layout description (optional)
layoutId = 56 # Integer | If the Layout should be created with a Template, provide the ID, otherwise don't provide (optional)
resolutionId = 56 # Integer | If a Template is not provided, provide the resolutionId for this Layout. (optional)
returnDraft = true # Boolean | Should we return the Draft Layout or the Published Layout on Success? (optional)
code = code_example # String | Code identifier for this Layout (optional)
folderId = 56 # Integer | Folder ID to which this object should be assigned to (optional)

try: 
    # Add a Layout
    api_instance.layout_add(name=name, description=description, layoutId=layoutId, resolutionId=resolutionId, returnDraft=returnDraft, code=code, folderId=folderId)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutAdd: %s\n" % e)

Parameters

Query parameters
Name Description
name
String
The layout name
description
String
The layout description
layoutId
Integer
If the Layout should be created with a Template, provide the ID, otherwise don't provide
resolutionId
Integer
If a Template is not provided, provide the resolutionId for this Layout.
returnDraft
Boolean
Should we return the Draft Layout or the Published Layout on Success?
code
String
Code identifier for this Layout
folderId
Integer
Folder ID to which this object should be assigned to

Responses

Status: 201 - successful operation

Name Type Format Description
Location String

layoutAddFullScreen

Add a Full Screen Layout

Add a new full screen Layout with specified Media/Playlist


/layout/fullscreen

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/layout/fullscreen?id=&type=&resolutionId=&backgroundColor=&layoutDuration="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer id = 56; // Integer | The Media or Playlist ID that should be added to this Layout
        String type = type_example; // String | The type of Layout to be created = media or playlist
        Integer resolutionId = 56; // Integer | The Id of the resolution for this Layout, defaults to 1080p for playlist and closest resolution match for Media
        String backgroundColor = backgroundColor_example; // String | A HEX color to use as the background color of this Layout. Default is black #000
        Boolean layoutDuration = true; // Boolean | Use with media type, to specify the duration this Media should play in one loop
        try {
            apiInstance.layoutAddFullScreen(id, type, resolutionId, backgroundColor, layoutDuration);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutAddFullScreen");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer id = 56; // Integer | The Media or Playlist ID that should be added to this Layout
        String type = type_example; // String | The type of Layout to be created = media or playlist
        Integer resolutionId = 56; // Integer | The Id of the resolution for this Layout, defaults to 1080p for playlist and closest resolution match for Media
        String backgroundColor = backgroundColor_example; // String | A HEX color to use as the background color of this Layout. Default is black #000
        Boolean layoutDuration = true; // Boolean | Use with media type, to specify the duration this Media should play in one loop
        try {
            apiInstance.layoutAddFullScreen(id, type, resolutionId, backgroundColor, layoutDuration);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutAddFullScreen");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // The Media or Playlist ID that should be added to this Layout
String *type = type_example; // The type of Layout to be created = media or playlist
Integer *resolutionId = 56; // The Id of the resolution for this Layout, defaults to 1080p for playlist and closest resolution match for Media (optional)
String *backgroundColor = backgroundColor_example; // A HEX color to use as the background color of this Layout. Default is black #000 (optional)
Boolean *layoutDuration = true; // Use with media type, to specify the duration this Media should play in one loop (optional)

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

// Add a Full Screen Layout
[apiInstance layoutAddFullScreenWith:id
    type:type
    resolutionId:resolutionId
    backgroundColor:backgroundColor
    layoutDuration:layoutDuration
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var id = 56; // {{Integer}} The Media or Playlist ID that should be added to this Layout
var type = type_example; // {{String}} The type of Layout to be created = media or playlist
var opts = { 
  'resolutionId': 56, // {{Integer}} The Id of the resolution for this Layout, defaults to 1080p for playlist and closest resolution match for Media
  'backgroundColor': backgroundColor_example, // {{String}} A HEX color to use as the background color of this Layout. Default is black #000
  'layoutDuration': true // {{Boolean}} Use with media type, to specify the duration this Media should play in one loop
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.layoutAddFullScreen(id, type, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class layoutAddFullScreenExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var id = 56;  // Integer | The Media or Playlist ID that should be added to this Layout
            var type = type_example;  // String | The type of Layout to be created = media or playlist
            var resolutionId = 56;  // Integer | The Id of the resolution for this Layout, defaults to 1080p for playlist and closest resolution match for Media (optional) 
            var backgroundColor = backgroundColor_example;  // String | A HEX color to use as the background color of this Layout. Default is black #000 (optional) 
            var layoutDuration = true;  // Boolean | Use with media type, to specify the duration this Media should play in one loop (optional) 

            try
            {
                // Add a Full Screen Layout
                apiInstance.layoutAddFullScreen(id, type, resolutionId, backgroundColor, layoutDuration);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutAddFullScreen: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$id = 56; // Integer | The Media or Playlist ID that should be added to this Layout
$type = type_example; // String | The type of Layout to be created = media or playlist
$resolutionId = 56; // Integer | The Id of the resolution for this Layout, defaults to 1080p for playlist and closest resolution match for Media
$backgroundColor = backgroundColor_example; // String | A HEX color to use as the background color of this Layout. Default is black #000
$layoutDuration = true; // Boolean | Use with media type, to specify the duration this Media should play in one loop

try {
    $api_instance->layoutAddFullScreen($id, $type, $resolutionId, $backgroundColor, $layoutDuration);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutAddFullScreen: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $id = 56; # Integer | The Media or Playlist ID that should be added to this Layout
my $type = type_example; # String | The type of Layout to be created = media or playlist
my $resolutionId = 56; # Integer | The Id of the resolution for this Layout, defaults to 1080p for playlist and closest resolution match for Media
my $backgroundColor = backgroundColor_example; # String | A HEX color to use as the background color of this Layout. Default is black #000
my $layoutDuration = true; # Boolean | Use with media type, to specify the duration this Media should play in one loop

eval { 
    $api_instance->layoutAddFullScreen(id => $id, type => $type, resolutionId => $resolutionId, backgroundColor => $backgroundColor, layoutDuration => $layoutDuration);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutAddFullScreen: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
id = 56 # Integer | The Media or Playlist ID that should be added to this Layout
type = type_example # String | The type of Layout to be created = media or playlist
resolutionId = 56 # Integer | The Id of the resolution for this Layout, defaults to 1080p for playlist and closest resolution match for Media (optional)
backgroundColor = backgroundColor_example # String | A HEX color to use as the background color of this Layout. Default is black #000 (optional)
layoutDuration = true # Boolean | Use with media type, to specify the duration this Media should play in one loop (optional)

try: 
    # Add a Full Screen Layout
    api_instance.layout_add_full_screen(id, type, resolutionId=resolutionId, backgroundColor=backgroundColor, layoutDuration=layoutDuration)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutAddFullScreen: %s\n" % e)

Parameters

Query parameters
Name Description
id*
Integer
The Media or Playlist ID that should be added to this Layout
Required
type*
String
The type of Layout to be created = media or playlist
Required
resolutionId
Integer
The Id of the resolution for this Layout, defaults to 1080p for playlist and closest resolution match for Media
backgroundColor
String
A HEX color to use as the background color of this Layout. Default is black #000
layoutDuration
Boolean
Use with media type, to specify the duration this Media should play in one loop

Responses

Status: 201 - successful operation

Name Type Format Description
Location String

layoutApplyTemplate

Apply Template

Apply a new Template to an existing Layout, replacing it.


/layout/applyTemplate/{layoutId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/layout/applyTemplate/{layoutId}?templateId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | 
        Integer templateId = 56; // Integer | If the Layout should be created with a Template, provide the ID, otherwise don't provide
        try {
            apiInstance.layoutApplyTemplate(layoutId, templateId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutApplyTemplate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | 
        Integer templateId = 56; // Integer | If the Layout should be created with a Template, provide the ID, otherwise don't provide
        try {
            apiInstance.layoutApplyTemplate(layoutId, templateId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutApplyTemplate");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // 
Integer *templateId = 56; // If the Layout should be created with a Template, provide the ID, otherwise don't provide (optional)

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

// Apply Template
[apiInstance layoutApplyTemplateWith:layoutId
    templateId:templateId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} 
var opts = { 
  'templateId': 56 // {{Integer}} If the Layout should be created with a Template, provide the ID, otherwise don't provide
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.layoutApplyTemplate(layoutId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class layoutApplyTemplateExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | 
            var templateId = 56;  // Integer | If the Layout should be created with a Template, provide the ID, otherwise don't provide (optional) 

            try
            {
                // Apply Template
                apiInstance.layoutApplyTemplate(layoutId, templateId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutApplyTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | 
$templateId = 56; // Integer | If the Layout should be created with a Template, provide the ID, otherwise don't provide

try {
    $api_instance->layoutApplyTemplate($layoutId, $templateId);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutApplyTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | 
my $templateId = 56; # Integer | If the Layout should be created with a Template, provide the ID, otherwise don't provide

eval { 
    $api_instance->layoutApplyTemplate(layoutId => $layoutId, templateId => $templateId);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutApplyTemplate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | 
templateId = 56 # Integer | If the Layout should be created with a Template, provide the ID, otherwise don't provide (optional)

try: 
    # Apply Template
    api_instance.layout_apply_template(layoutId, templateId=templateId)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutApplyTemplate: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
Required
Query parameters
Name Description
templateId
Integer
If the Layout should be created with a Template, provide the ID, otherwise don't provide

Responses

Status: 204 - successful operation


layoutCheckout

Checkout Layout

Checkout a Layout so that it can be edited. The original Layout will still be played


/layout/checkout/{layoutId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/layout/checkout/{layoutId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID
        try {
            apiInstance.layoutCheckout(layoutId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutCheckout");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID
        try {
            apiInstance.layoutCheckout(layoutId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutCheckout");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // The Layout ID

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

// Checkout Layout
[apiInstance layoutCheckoutWith:layoutId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} The Layout ID

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

namespace Example
{
    public class layoutCheckoutExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | The Layout ID

            try
            {
                // Checkout Layout
                apiInstance.layoutCheckout(layoutId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutCheckout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | The Layout ID

try {
    $api_instance->layoutCheckout($layoutId);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutCheckout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | The Layout ID

eval { 
    $api_instance->layoutCheckout(layoutId => $layoutId);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutCheckout: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | The Layout ID

try: 
    # Checkout Layout
    api_instance.layout_checkout(layoutId)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutCheckout: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
The Layout ID
Required

Responses

Status: 200 - successful operation


layoutCopy

Copy Layout

Copy a Layout, providing a new name if applicable


/layout/copy/{layoutId}

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/layout/copy/{layoutId}?name=&description=©MediaFiles="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID to Copy
        String name = name_example; // String | The name for the new Layout
        Integer copyMediaFiles = 56; // Integer | Flag indicating whether to make new Copies of all Media Files assigned to the Layout being Copied
        String description = description_example; // String | The Description for the new Layout
        try {
            apiInstance.layoutCopy(layoutId, name, copyMediaFiles, description);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutCopy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID to Copy
        String name = name_example; // String | The name for the new Layout
        Integer copyMediaFiles = 56; // Integer | Flag indicating whether to make new Copies of all Media Files assigned to the Layout being Copied
        String description = description_example; // String | The Description for the new Layout
        try {
            apiInstance.layoutCopy(layoutId, name, copyMediaFiles, description);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutCopy");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // The Layout ID to Copy
String *name = name_example; // The name for the new Layout
Integer *copyMediaFiles = 56; // Flag indicating whether to make new Copies of all Media Files assigned to the Layout being Copied
String *description = description_example; // The Description for the new Layout (optional)

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

// Copy Layout
[apiInstance layoutCopyWith:layoutId
    name:name
    copyMediaFiles:copyMediaFiles
    description:description
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} The Layout ID to Copy
var name = name_example; // {{String}} The name for the new Layout
var copyMediaFiles = 56; // {{Integer}} Flag indicating whether to make new Copies of all Media Files assigned to the Layout being Copied
var opts = { 
  'description': description_example // {{String}} The Description for the new Layout
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.layoutCopy(layoutId, name, copyMediaFiles, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class layoutCopyExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | The Layout ID to Copy
            var name = name_example;  // String | The name for the new Layout
            var copyMediaFiles = 56;  // Integer | Flag indicating whether to make new Copies of all Media Files assigned to the Layout being Copied
            var description = description_example;  // String | The Description for the new Layout (optional) 

            try
            {
                // Copy Layout
                apiInstance.layoutCopy(layoutId, name, copyMediaFiles, description);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutCopy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | The Layout ID to Copy
$name = name_example; // String | The name for the new Layout
$copyMediaFiles = 56; // Integer | Flag indicating whether to make new Copies of all Media Files assigned to the Layout being Copied
$description = description_example; // String | The Description for the new Layout

try {
    $api_instance->layoutCopy($layoutId, $name, $copyMediaFiles, $description);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutCopy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | The Layout ID to Copy
my $name = name_example; # String | The name for the new Layout
my $copyMediaFiles = 56; # Integer | Flag indicating whether to make new Copies of all Media Files assigned to the Layout being Copied
my $description = description_example; # String | The Description for the new Layout

eval { 
    $api_instance->layoutCopy(layoutId => $layoutId, name => $name, copyMediaFiles => $copyMediaFiles, description => $description);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutCopy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | The Layout ID to Copy
name = name_example # String | The name for the new Layout
copyMediaFiles = 56 # Integer | Flag indicating whether to make new Copies of all Media Files assigned to the Layout being Copied
description = description_example # String | The Description for the new Layout (optional)

try: 
    # Copy Layout
    api_instance.layout_copy(layoutId, name, copyMediaFiles, description=description)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutCopy: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
The Layout ID to Copy
Required
Query parameters
Name Description
name*
String
The name for the new Layout
Required
description
String
The Description for the new Layout
copyMediaFiles*
Integer
Flag indicating whether to make new Copies of all Media Files assigned to the Layout being Copied
Required

Responses

Status: 201 - successful operation

Name Type Format Description
Location String

layoutDelete

Delete Layout

Delete a Layout


/layout/{layoutId}

Usage and SDK Samples

curl -X DELETE\
"https://premium.digitalsignagevision.com/api/layout/{layoutId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID to Delete
        try {
            apiInstance.layoutDelete(layoutId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID to Delete
        try {
            apiInstance.layoutDelete(layoutId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutDelete");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // The Layout ID to Delete

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

// Delete Layout
[apiInstance layoutDeleteWith:layoutId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} The Layout ID to Delete

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

namespace Example
{
    public class layoutDeleteExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | The Layout ID to Delete

            try
            {
                // Delete Layout
                apiInstance.layoutDelete(layoutId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | The Layout ID to Delete

try {
    $api_instance->layoutDelete($layoutId);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | The Layout ID to Delete

eval { 
    $api_instance->layoutDelete(layoutId => $layoutId);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | The Layout ID to Delete

try: 
    # Delete Layout
    api_instance.layout_delete(layoutId)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutDelete: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
The Layout ID to Delete
Required

Responses

Status: 204 - successful operation


layoutDiscard

Discard Layout

Discard a Layout restoring the original


/layout/discard/{layoutId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/layout/discard/{layoutId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID
        try {
            apiInstance.layoutDiscard(layoutId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutDiscard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID
        try {
            apiInstance.layoutDiscard(layoutId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutDiscard");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // The Layout ID

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

// Discard Layout
[apiInstance layoutDiscardWith:layoutId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} The Layout ID

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

namespace Example
{
    public class layoutDiscardExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | The Layout ID

            try
            {
                // Discard Layout
                apiInstance.layoutDiscard(layoutId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutDiscard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | The Layout ID

try {
    $api_instance->layoutDiscard($layoutId);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutDiscard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | The Layout ID

eval { 
    $api_instance->layoutDiscard(layoutId => $layoutId);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutDiscard: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | The Layout ID

try: 
    # Discard Layout
    api_instance.layout_discard(layoutId)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutDiscard: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
The Layout ID
Required

Responses

Status: 200 - successful operation


layoutEdit

Edit Layout

Edit a Layout


/layout/{layoutId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/layout/{layoutId}?name=&description=&tags=&retired=&enableStat=&code=&folderId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | 
        String name = name_example; // String | The Layout Name
        String description = description_example; // String | The Layout Description
        String tags = tags_example; // String | A comma separated list of Tags
        Integer retired = 56; // Integer | A flag indicating whether this Layout is retired.
        Integer enableStat = 56; // Integer | Flag indicating whether the Layout stat is enabled
        String code = code_example; // String | Code identifier for this Layout
        Integer folderId = 56; // Integer | Folder ID to which this object should be assigned to
        try {
            apiInstance.layoutEdit(layoutId, name, description, tags, retired, enableStat, code, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutEdit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | 
        String name = name_example; // String | The Layout Name
        String description = description_example; // String | The Layout Description
        String tags = tags_example; // String | A comma separated list of Tags
        Integer retired = 56; // Integer | A flag indicating whether this Layout is retired.
        Integer enableStat = 56; // Integer | Flag indicating whether the Layout stat is enabled
        String code = code_example; // String | Code identifier for this Layout
        Integer folderId = 56; // Integer | Folder ID to which this object should be assigned to
        try {
            apiInstance.layoutEdit(layoutId, name, description, tags, retired, enableStat, code, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutEdit");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // 
String *name = name_example; // The Layout Name
String *description = description_example; // The Layout Description (optional)
String *tags = tags_example; // A comma separated list of Tags (optional)
Integer *retired = 56; // A flag indicating whether this Layout is retired. (optional)
Integer *enableStat = 56; // Flag indicating whether the Layout stat is enabled (optional)
String *code = code_example; // Code identifier for this Layout (optional)
Integer *folderId = 56; // Folder ID to which this object should be assigned to (optional)

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

// Edit Layout
[apiInstance layoutEditWith:layoutId
    name:name
    description:description
    tags:tags
    retired:retired
    enableStat:enableStat
    code:code
    folderId:folderId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} 
var name = name_example; // {{String}} The Layout Name
var opts = { 
  'description': description_example, // {{String}} The Layout Description
  'tags': tags_example, // {{String}} A comma separated list of Tags
  'retired': 56, // {{Integer}} A flag indicating whether this Layout is retired.
  'enableStat': 56, // {{Integer}} Flag indicating whether the Layout stat is enabled
  'code': code_example, // {{String}} Code identifier for this Layout
  'folderId': 56 // {{Integer}} Folder ID to which this object should be assigned to
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.layoutEdit(layoutId, name, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class layoutEditExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | 
            var name = name_example;  // String | The Layout Name
            var description = description_example;  // String | The Layout Description (optional) 
            var tags = tags_example;  // String | A comma separated list of Tags (optional) 
            var retired = 56;  // Integer | A flag indicating whether this Layout is retired. (optional) 
            var enableStat = 56;  // Integer | Flag indicating whether the Layout stat is enabled (optional) 
            var code = code_example;  // String | Code identifier for this Layout (optional) 
            var folderId = 56;  // Integer | Folder ID to which this object should be assigned to (optional) 

            try
            {
                // Edit Layout
                apiInstance.layoutEdit(layoutId, name, description, tags, retired, enableStat, code, folderId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutEdit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | 
$name = name_example; // String | The Layout Name
$description = description_example; // String | The Layout Description
$tags = tags_example; // String | A comma separated list of Tags
$retired = 56; // Integer | A flag indicating whether this Layout is retired.
$enableStat = 56; // Integer | Flag indicating whether the Layout stat is enabled
$code = code_example; // String | Code identifier for this Layout
$folderId = 56; // Integer | Folder ID to which this object should be assigned to

try {
    $api_instance->layoutEdit($layoutId, $name, $description, $tags, $retired, $enableStat, $code, $folderId);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutEdit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | 
my $name = name_example; # String | The Layout Name
my $description = description_example; # String | The Layout Description
my $tags = tags_example; # String | A comma separated list of Tags
my $retired = 56; # Integer | A flag indicating whether this Layout is retired.
my $enableStat = 56; # Integer | Flag indicating whether the Layout stat is enabled
my $code = code_example; # String | Code identifier for this Layout
my $folderId = 56; # Integer | Folder ID to which this object should be assigned to

eval { 
    $api_instance->layoutEdit(layoutId => $layoutId, name => $name, description => $description, tags => $tags, retired => $retired, enableStat => $enableStat, code => $code, folderId => $folderId);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutEdit: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | 
name = name_example # String | The Layout Name
description = description_example # String | The Layout Description (optional)
tags = tags_example # String | A comma separated list of Tags (optional)
retired = 56 # Integer | A flag indicating whether this Layout is retired. (optional)
enableStat = 56 # Integer | Flag indicating whether the Layout stat is enabled (optional)
code = code_example # String | Code identifier for this Layout (optional)
folderId = 56 # Integer | Folder ID to which this object should be assigned to (optional)

try: 
    # Edit Layout
    api_instance.layout_edit(layoutId, name, description=description, tags=tags, retired=retired, enableStat=enableStat, code=code, folderId=folderId)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutEdit: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
Required
Query parameters
Name Description
name*
String
The Layout Name
Required
description
String
The Layout Description
tags
String
A comma separated list of Tags
retired
Integer
A flag indicating whether this Layout is retired.
enableStat
Integer
Flag indicating whether the Layout stat is enabled
code
String
Code identifier for this Layout
folderId
Integer
Folder ID to which this object should be assigned to

Responses

Status: 200 - successful operation


layoutEditBackground

Edit Layout Background

Edit a Layout Background


/layout/background/{layoutId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/layout/background/{layoutId}?backgroundColor=&backgroundImageId=&backgroundzIndex=&resolutionId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | 
        String backgroundColor = backgroundColor_example; // String | A HEX color to use as the background color of this Layout.
        Integer backgroundzIndex = 56; // Integer | The Layer Number to use for the background.
        Integer backgroundImageId = 56; // Integer | A media ID to use as the background image for this Layout.
        Integer resolutionId = 56; // Integer | The Resolution ID to use on this Layout.
        try {
            apiInstance.layoutEditBackground(layoutId, backgroundColor, backgroundzIndex, backgroundImageId, resolutionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutEditBackground");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | 
        String backgroundColor = backgroundColor_example; // String | A HEX color to use as the background color of this Layout.
        Integer backgroundzIndex = 56; // Integer | The Layer Number to use for the background.
        Integer backgroundImageId = 56; // Integer | A media ID to use as the background image for this Layout.
        Integer resolutionId = 56; // Integer | The Resolution ID to use on this Layout.
        try {
            apiInstance.layoutEditBackground(layoutId, backgroundColor, backgroundzIndex, backgroundImageId, resolutionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutEditBackground");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // 
String *backgroundColor = backgroundColor_example; // A HEX color to use as the background color of this Layout.
Integer *backgroundzIndex = 56; // The Layer Number to use for the background.
Integer *backgroundImageId = 56; // A media ID to use as the background image for this Layout. (optional)
Integer *resolutionId = 56; // The Resolution ID to use on this Layout. (optional)

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

// Edit Layout Background
[apiInstance layoutEditBackgroundWith:layoutId
    backgroundColor:backgroundColor
    backgroundzIndex:backgroundzIndex
    backgroundImageId:backgroundImageId
    resolutionId:resolutionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} 
var backgroundColor = backgroundColor_example; // {{String}} A HEX color to use as the background color of this Layout.
var backgroundzIndex = 56; // {{Integer}} The Layer Number to use for the background.
var opts = { 
  'backgroundImageId': 56, // {{Integer}} A media ID to use as the background image for this Layout.
  'resolutionId': 56 // {{Integer}} The Resolution ID to use on this Layout.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.layoutEditBackground(layoutId, backgroundColor, backgroundzIndex, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class layoutEditBackgroundExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | 
            var backgroundColor = backgroundColor_example;  // String | A HEX color to use as the background color of this Layout.
            var backgroundzIndex = 56;  // Integer | The Layer Number to use for the background.
            var backgroundImageId = 56;  // Integer | A media ID to use as the background image for this Layout. (optional) 
            var resolutionId = 56;  // Integer | The Resolution ID to use on this Layout. (optional) 

            try
            {
                // Edit Layout Background
                apiInstance.layoutEditBackground(layoutId, backgroundColor, backgroundzIndex, backgroundImageId, resolutionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutEditBackground: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | 
$backgroundColor = backgroundColor_example; // String | A HEX color to use as the background color of this Layout.
$backgroundzIndex = 56; // Integer | The Layer Number to use for the background.
$backgroundImageId = 56; // Integer | A media ID to use as the background image for this Layout.
$resolutionId = 56; // Integer | The Resolution ID to use on this Layout.

try {
    $api_instance->layoutEditBackground($layoutId, $backgroundColor, $backgroundzIndex, $backgroundImageId, $resolutionId);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutEditBackground: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | 
my $backgroundColor = backgroundColor_example; # String | A HEX color to use as the background color of this Layout.
my $backgroundzIndex = 56; # Integer | The Layer Number to use for the background.
my $backgroundImageId = 56; # Integer | A media ID to use as the background image for this Layout.
my $resolutionId = 56; # Integer | The Resolution ID to use on this Layout.

eval { 
    $api_instance->layoutEditBackground(layoutId => $layoutId, backgroundColor => $backgroundColor, backgroundzIndex => $backgroundzIndex, backgroundImageId => $backgroundImageId, resolutionId => $resolutionId);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutEditBackground: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | 
backgroundColor = backgroundColor_example # String | A HEX color to use as the background color of this Layout.
backgroundzIndex = 56 # Integer | The Layer Number to use for the background.
backgroundImageId = 56 # Integer | A media ID to use as the background image for this Layout. (optional)
resolutionId = 56 # Integer | The Resolution ID to use on this Layout. (optional)

try: 
    # Edit Layout Background
    api_instance.layout_edit_background(layoutId, backgroundColor, backgroundzIndex, backgroundImageId=backgroundImageId, resolutionId=resolutionId)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutEditBackground: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
Required
Query parameters
Name Description
backgroundColor*
String
A HEX color to use as the background color of this Layout.
Required
backgroundImageId
Integer
A media ID to use as the background image for this Layout.
backgroundzIndex*
Integer
The Layer Number to use for the background.
Required
resolutionId
Integer
The Resolution ID to use on this Layout.

Responses

Status: 200 - successful operation


layoutPublish

Publish Layout

Publish a Layout, discarding the original


/layout/publish/{layoutId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/layout/publish/{layoutId}?publishNow=&publishDate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID
        Integer publishNow = 56; // Integer | Flag, indicating whether to publish layout now
        String publishDate = publishDate_example; // String | The date/time at which layout should be published
        try {
            apiInstance.layoutPublish(layoutId, publishNow, publishDate);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutPublish");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID
        Integer publishNow = 56; // Integer | Flag, indicating whether to publish layout now
        String publishDate = publishDate_example; // String | The date/time at which layout should be published
        try {
            apiInstance.layoutPublish(layoutId, publishNow, publishDate);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutPublish");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // The Layout ID
Integer *publishNow = 56; // Flag, indicating whether to publish layout now (optional)
String *publishDate = publishDate_example; // The date/time at which layout should be published (optional)

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

// Publish Layout
[apiInstance layoutPublishWith:layoutId
    publishNow:publishNow
    publishDate:publishDate
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} The Layout ID
var opts = { 
  'publishNow': 56, // {{Integer}} Flag, indicating whether to publish layout now
  'publishDate': publishDate_example // {{String}} The date/time at which layout should be published
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.layoutPublish(layoutId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class layoutPublishExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | The Layout ID
            var publishNow = 56;  // Integer | Flag, indicating whether to publish layout now (optional) 
            var publishDate = publishDate_example;  // String | The date/time at which layout should be published (optional) 

            try
            {
                // Publish Layout
                apiInstance.layoutPublish(layoutId, publishNow, publishDate);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutPublish: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | The Layout ID
$publishNow = 56; // Integer | Flag, indicating whether to publish layout now
$publishDate = publishDate_example; // String | The date/time at which layout should be published

try {
    $api_instance->layoutPublish($layoutId, $publishNow, $publishDate);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutPublish: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | The Layout ID
my $publishNow = 56; # Integer | Flag, indicating whether to publish layout now
my $publishDate = publishDate_example; # String | The date/time at which layout should be published

eval { 
    $api_instance->layoutPublish(layoutId => $layoutId, publishNow => $publishNow, publishDate => $publishDate);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutPublish: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | The Layout ID
publishNow = 56 # Integer | Flag, indicating whether to publish layout now (optional)
publishDate = publishDate_example # String | The date/time at which layout should be published (optional)

try: 
    # Publish Layout
    api_instance.layout_publish(layoutId, publishNow=publishNow, publishDate=publishDate)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutPublish: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
The Layout ID
Required
Query parameters
Name Description
publishNow
Integer
Flag, indicating whether to publish layout now
publishDate
String
The date/time at which layout should be published

Responses

Status: 200 - successful operation


layoutRetire

Retire Layout

Retire a Layout so that it isn't available to Schedule. Existing Layouts will still be played


/layout/retire/{layoutId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/layout/retire/{layoutId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID
        try {
            apiInstance.layoutRetire(layoutId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutRetire");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID
        try {
            apiInstance.layoutRetire(layoutId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutRetire");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // The Layout ID

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

// Retire Layout
[apiInstance layoutRetireWith:layoutId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} The Layout ID

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

namespace Example
{
    public class layoutRetireExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | The Layout ID

            try
            {
                // Retire Layout
                apiInstance.layoutRetire(layoutId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutRetire: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | The Layout ID

try {
    $api_instance->layoutRetire($layoutId);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutRetire: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | The Layout ID

eval { 
    $api_instance->layoutRetire(layoutId => $layoutId);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutRetire: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | The Layout ID

try: 
    # Retire Layout
    api_instance.layout_retire(layoutId)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutRetire: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
The Layout ID
Required

Responses

Status: 204 - successful operation


layoutSearch

Search Layouts

Search for Layouts viewable by this user


/layout

Usage and SDK Samples

curl -X GET\
"https://premium.digitalsignagevision.com/api/layout?layoutId=&parentId=&showDrafts=&layout=&userId=&retired=&tags=&exactTags=&logicalOperator=&ownerUserGroupId=&publishedStatusId=&embed=&campaignId=&folderId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | Filter by Layout Id
        Integer parentId = 56; // Integer | Filter by parent Id
        Integer showDrafts = 56; // Integer | Flag indicating whether to show drafts
        String layout = layout_example; // String | Filter by partial Layout name
        Integer userId = 56; // Integer | Filter by user Id
        Integer retired = 56; // Integer | Filter by retired flag
        String tags = tags_example; // String | Filter by Tags
        Integer exactTags = 56; // Integer | A flag indicating whether to treat the tags filter as an exact match
        String logicalOperator = logicalOperator_example; // String | When filtering by multiple Tags, which logical operator should be used? AND|OR
        Integer ownerUserGroupId = 56; // Integer | Filter by users in this UserGroupId
        Integer publishedStatusId = 56; // Integer | Filter by published status id, 1 - Published, 2 - Draft
        String embed = embed_example; // String | Embed related data such as regions, playlists, widgets, tags, campaigns, permissions
        Integer campaignId = 56; // Integer | Get all Layouts for a given campaignId
        Integer folderId = 56; // Integer | Filter by Folder ID
        try {
            apiInstance.layoutSearch(layoutId, parentId, showDrafts, layout, userId, retired, tags, exactTags, logicalOperator, ownerUserGroupId, publishedStatusId, embed, campaignId, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | Filter by Layout Id
        Integer parentId = 56; // Integer | Filter by parent Id
        Integer showDrafts = 56; // Integer | Flag indicating whether to show drafts
        String layout = layout_example; // String | Filter by partial Layout name
        Integer userId = 56; // Integer | Filter by user Id
        Integer retired = 56; // Integer | Filter by retired flag
        String tags = tags_example; // String | Filter by Tags
        Integer exactTags = 56; // Integer | A flag indicating whether to treat the tags filter as an exact match
        String logicalOperator = logicalOperator_example; // String | When filtering by multiple Tags, which logical operator should be used? AND|OR
        Integer ownerUserGroupId = 56; // Integer | Filter by users in this UserGroupId
        Integer publishedStatusId = 56; // Integer | Filter by published status id, 1 - Published, 2 - Draft
        String embed = embed_example; // String | Embed related data such as regions, playlists, widgets, tags, campaigns, permissions
        Integer campaignId = 56; // Integer | Get all Layouts for a given campaignId
        Integer folderId = 56; // Integer | Filter by Folder ID
        try {
            apiInstance.layoutSearch(layoutId, parentId, showDrafts, layout, userId, retired, tags, exactTags, logicalOperator, ownerUserGroupId, publishedStatusId, embed, campaignId, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutSearch");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // Filter by Layout Id (optional)
Integer *parentId = 56; // Filter by parent Id (optional)
Integer *showDrafts = 56; // Flag indicating whether to show drafts (optional)
String *layout = layout_example; // Filter by partial Layout name (optional)
Integer *userId = 56; // Filter by user Id (optional)
Integer *retired = 56; // Filter by retired flag (optional)
String *tags = tags_example; // Filter by Tags (optional)
Integer *exactTags = 56; // A flag indicating whether to treat the tags filter as an exact match (optional)
String *logicalOperator = logicalOperator_example; // When filtering by multiple Tags, which logical operator should be used? AND|OR (optional)
Integer *ownerUserGroupId = 56; // Filter by users in this UserGroupId (optional)
Integer *publishedStatusId = 56; // Filter by published status id, 1 - Published, 2 - Draft (optional)
String *embed = embed_example; // Embed related data such as regions, playlists, widgets, tags, campaigns, permissions (optional)
Integer *campaignId = 56; // Get all Layouts for a given campaignId (optional)
Integer *folderId = 56; // Filter by Folder ID (optional)

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

// Search Layouts
[apiInstance layoutSearchWith:layoutId
    parentId:parentId
    showDrafts:showDrafts
    layout:layout
    userId:userId
    retired:retired
    tags:tags
    exactTags:exactTags
    logicalOperator:logicalOperator
    ownerUserGroupId:ownerUserGroupId
    publishedStatusId:publishedStatusId
    embed:embed
    campaignId:campaignId
    folderId:folderId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var opts = { 
  'layoutId': 56, // {{Integer}} Filter by Layout Id
  'parentId': 56, // {{Integer}} Filter by parent Id
  'showDrafts': 56, // {{Integer}} Flag indicating whether to show drafts
  'layout': layout_example, // {{String}} Filter by partial Layout name
  'userId': 56, // {{Integer}} Filter by user Id
  'retired': 56, // {{Integer}} Filter by retired flag
  'tags': tags_example, // {{String}} Filter by Tags
  'exactTags': 56, // {{Integer}} A flag indicating whether to treat the tags filter as an exact match
  'logicalOperator': logicalOperator_example, // {{String}} When filtering by multiple Tags, which logical operator should be used? AND|OR
  'ownerUserGroupId': 56, // {{Integer}} Filter by users in this UserGroupId
  'publishedStatusId': 56, // {{Integer}} Filter by published status id, 1 - Published, 2 - Draft
  'embed': embed_example, // {{String}} Embed related data such as regions, playlists, widgets, tags, campaigns, permissions
  'campaignId': 56, // {{Integer}} Get all Layouts for a given campaignId
  'folderId': 56 // {{Integer}} Filter by Folder ID
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.layoutSearch(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class layoutSearchExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | Filter by Layout Id (optional) 
            var parentId = 56;  // Integer | Filter by parent Id (optional) 
            var showDrafts = 56;  // Integer | Flag indicating whether to show drafts (optional) 
            var layout = layout_example;  // String | Filter by partial Layout name (optional) 
            var userId = 56;  // Integer | Filter by user Id (optional) 
            var retired = 56;  // Integer | Filter by retired flag (optional) 
            var tags = tags_example;  // String | Filter by Tags (optional) 
            var exactTags = 56;  // Integer | A flag indicating whether to treat the tags filter as an exact match (optional) 
            var logicalOperator = logicalOperator_example;  // String | When filtering by multiple Tags, which logical operator should be used? AND|OR (optional) 
            var ownerUserGroupId = 56;  // Integer | Filter by users in this UserGroupId (optional) 
            var publishedStatusId = 56;  // Integer | Filter by published status id, 1 - Published, 2 - Draft (optional) 
            var embed = embed_example;  // String | Embed related data such as regions, playlists, widgets, tags, campaigns, permissions (optional) 
            var campaignId = 56;  // Integer | Get all Layouts for a given campaignId (optional) 
            var folderId = 56;  // Integer | Filter by Folder ID (optional) 

            try
            {
                // Search Layouts
                apiInstance.layoutSearch(layoutId, parentId, showDrafts, layout, userId, retired, tags, exactTags, logicalOperator, ownerUserGroupId, publishedStatusId, embed, campaignId, folderId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | Filter by Layout Id
$parentId = 56; // Integer | Filter by parent Id
$showDrafts = 56; // Integer | Flag indicating whether to show drafts
$layout = layout_example; // String | Filter by partial Layout name
$userId = 56; // Integer | Filter by user Id
$retired = 56; // Integer | Filter by retired flag
$tags = tags_example; // String | Filter by Tags
$exactTags = 56; // Integer | A flag indicating whether to treat the tags filter as an exact match
$logicalOperator = logicalOperator_example; // String | When filtering by multiple Tags, which logical operator should be used? AND|OR
$ownerUserGroupId = 56; // Integer | Filter by users in this UserGroupId
$publishedStatusId = 56; // Integer | Filter by published status id, 1 - Published, 2 - Draft
$embed = embed_example; // String | Embed related data such as regions, playlists, widgets, tags, campaigns, permissions
$campaignId = 56; // Integer | Get all Layouts for a given campaignId
$folderId = 56; // Integer | Filter by Folder ID

try {
    $api_instance->layoutSearch($layoutId, $parentId, $showDrafts, $layout, $userId, $retired, $tags, $exactTags, $logicalOperator, $ownerUserGroupId, $publishedStatusId, $embed, $campaignId, $folderId);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | Filter by Layout Id
my $parentId = 56; # Integer | Filter by parent Id
my $showDrafts = 56; # Integer | Flag indicating whether to show drafts
my $layout = layout_example; # String | Filter by partial Layout name
my $userId = 56; # Integer | Filter by user Id
my $retired = 56; # Integer | Filter by retired flag
my $tags = tags_example; # String | Filter by Tags
my $exactTags = 56; # Integer | A flag indicating whether to treat the tags filter as an exact match
my $logicalOperator = logicalOperator_example; # String | When filtering by multiple Tags, which logical operator should be used? AND|OR
my $ownerUserGroupId = 56; # Integer | Filter by users in this UserGroupId
my $publishedStatusId = 56; # Integer | Filter by published status id, 1 - Published, 2 - Draft
my $embed = embed_example; # String | Embed related data such as regions, playlists, widgets, tags, campaigns, permissions
my $campaignId = 56; # Integer | Get all Layouts for a given campaignId
my $folderId = 56; # Integer | Filter by Folder ID

eval { 
    $api_instance->layoutSearch(layoutId => $layoutId, parentId => $parentId, showDrafts => $showDrafts, layout => $layout, userId => $userId, retired => $retired, tags => $tags, exactTags => $exactTags, logicalOperator => $logicalOperator, ownerUserGroupId => $ownerUserGroupId, publishedStatusId => $publishedStatusId, embed => $embed, campaignId => $campaignId, folderId => $folderId);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutSearch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | Filter by Layout Id (optional)
parentId = 56 # Integer | Filter by parent Id (optional)
showDrafts = 56 # Integer | Flag indicating whether to show drafts (optional)
layout = layout_example # String | Filter by partial Layout name (optional)
userId = 56 # Integer | Filter by user Id (optional)
retired = 56 # Integer | Filter by retired flag (optional)
tags = tags_example # String | Filter by Tags (optional)
exactTags = 56 # Integer | A flag indicating whether to treat the tags filter as an exact match (optional)
logicalOperator = logicalOperator_example # String | When filtering by multiple Tags, which logical operator should be used? AND|OR (optional)
ownerUserGroupId = 56 # Integer | Filter by users in this UserGroupId (optional)
publishedStatusId = 56 # Integer | Filter by published status id, 1 - Published, 2 - Draft (optional)
embed = embed_example # String | Embed related data such as regions, playlists, widgets, tags, campaigns, permissions (optional)
campaignId = 56 # Integer | Get all Layouts for a given campaignId (optional)
folderId = 56 # Integer | Filter by Folder ID (optional)

try: 
    # Search Layouts
    api_instance.layout_search(layoutId=layoutId, parentId=parentId, showDrafts=showDrafts, layout=layout, userId=userId, retired=retired, tags=tags, exactTags=exactTags, logicalOperator=logicalOperator, ownerUserGroupId=ownerUserGroupId, publishedStatusId=publishedStatusId, embed=embed, campaignId=campaignId, folderId=folderId)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutSearch: %s\n" % e)

Parameters

Query parameters
Name Description
layoutId
Integer
Filter by Layout Id
parentId
Integer
Filter by parent Id
showDrafts
Integer
Flag indicating whether to show drafts
layout
String
Filter by partial Layout name
userId
Integer
Filter by user Id
retired
Integer
Filter by retired flag
tags
String
Filter by Tags
exactTags
Integer
A flag indicating whether to treat the tags filter as an exact match
logicalOperator
String
When filtering by multiple Tags, which logical operator should be used? AND|OR
ownerUserGroupId
Integer
Filter by users in this UserGroupId
publishedStatusId
Integer
Filter by published status id, 1 - Published, 2 - Draft
embed
String
Embed related data such as regions, playlists, widgets, tags, campaigns, permissions
campaignId
Integer
Get all Layouts for a given campaignId
folderId
Integer
Filter by Folder ID

Responses

Status: 200 - successful operation


layoutSetEnableStat

Enable Stats Collection

Set Enable Stats Collection? to use for the collection of Proof of Play statistics for a Layout.


/layout/setenablestat/{layoutId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/layout/setenablestat/{layoutId}?enableStat="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID
        Integer enableStat = 56; // Integer | Flag indicating whether the Layout stat is enabled
        try {
            apiInstance.layoutSetEnableStat(layoutId, enableStat);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutSetEnableStat");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID
        Integer enableStat = 56; // Integer | Flag indicating whether the Layout stat is enabled
        try {
            apiInstance.layoutSetEnableStat(layoutId, enableStat);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutSetEnableStat");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // The Layout ID
Integer *enableStat = 56; // Flag indicating whether the Layout stat is enabled

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

// Enable Stats Collection
[apiInstance layoutSetEnableStatWith:layoutId
    enableStat:enableStat
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} The Layout ID
var enableStat = 56; // {{Integer}} Flag indicating whether the Layout stat is enabled

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.layoutSetEnableStat(layoutId, enableStat, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class layoutSetEnableStatExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | The Layout ID
            var enableStat = 56;  // Integer | Flag indicating whether the Layout stat is enabled

            try
            {
                // Enable Stats Collection
                apiInstance.layoutSetEnableStat(layoutId, enableStat);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutSetEnableStat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | The Layout ID
$enableStat = 56; // Integer | Flag indicating whether the Layout stat is enabled

try {
    $api_instance->layoutSetEnableStat($layoutId, $enableStat);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutSetEnableStat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | The Layout ID
my $enableStat = 56; # Integer | Flag indicating whether the Layout stat is enabled

eval { 
    $api_instance->layoutSetEnableStat(layoutId => $layoutId, enableStat => $enableStat);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutSetEnableStat: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | The Layout ID
enableStat = 56 # Integer | Flag indicating whether the Layout stat is enabled

try: 
    # Enable Stats Collection
    api_instance.layout_set_enable_stat(layoutId, enableStat)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutSetEnableStat: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
The Layout ID
Required
Query parameters
Name Description
enableStat*
Integer
Flag indicating whether the Layout stat is enabled
Required

Responses

Status: 204 - successful operation


layoutStatus

Layout Status

Calculate the Layout status and return a Layout


/layout/status/{layoutId}

Usage and SDK Samples

curl -X GET\
"https://premium.digitalsignagevision.com/api/layout/status/{layoutId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout Id to get the status
        try {
            apiInstance.layoutStatus(layoutId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout Id to get the status
        try {
            apiInstance.layoutStatus(layoutId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutStatus");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // The Layout Id to get the status

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

// Layout Status
[apiInstance layoutStatusWith:layoutId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} The Layout Id to get the status

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

namespace Example
{
    public class layoutStatusExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | The Layout Id to get the status

            try
            {
                // Layout Status
                apiInstance.layoutStatus(layoutId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | The Layout Id to get the status

try {
    $api_instance->layoutStatus($layoutId);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | The Layout Id to get the status

eval { 
    $api_instance->layoutStatus(layoutId => $layoutId);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutStatus: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | The Layout Id to get the status

try: 
    # Layout Status
    api_instance.layout_status(layoutId)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutStatus: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
The Layout Id to get the status
Required

Responses

Status: 200 - successful operation


layoutTag

Tag Layout

Tag a Layout with one or more tags


/layout/{layoutId}/tag

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/layout/{layoutId}/tag?tag="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout Id to Tag
        array[String] tag = ; // array[String] | An array of tags
        try {
            apiInstance.layoutTag(layoutId, tag);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutTag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout Id to Tag
        array[String] tag = ; // array[String] | An array of tags
        try {
            apiInstance.layoutTag(layoutId, tag);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutTag");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // The Layout Id to Tag
array[String] *tag = ; // An array of tags

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

// Tag Layout
[apiInstance layoutTagWith:layoutId
    tag:tag
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} The Layout Id to Tag
var tag = ; // {{array[String]}} An array of tags

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.layoutTag(layoutId, tag, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class layoutTagExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | The Layout Id to Tag
            var tag = new array[String](); // array[String] | An array of tags

            try
            {
                // Tag Layout
                apiInstance.layoutTag(layoutId, tag);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutTag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | The Layout Id to Tag
$tag = ; // array[String] | An array of tags

try {
    $api_instance->layoutTag($layoutId, $tag);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutTag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | The Layout Id to Tag
my $tag = []; # array[String] | An array of tags

eval { 
    $api_instance->layoutTag(layoutId => $layoutId, tag => $tag);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutTag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | The Layout Id to Tag
tag =  # array[String] | An array of tags

try: 
    # Tag Layout
    api_instance.layout_tag(layoutId, tag)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutTag: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
The Layout Id to Tag
Required
Query parameters
Name Description
tag*
array[String]
An array of tags
Required

Responses

Status: 200 - successful operation


layoutUnretire

Unretire Layout

Retire a Layout so that it isn't available to Schedule. Existing Layouts will still be played


/layout/unretire/{layoutId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/layout/unretire/{layoutId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID
        try {
            apiInstance.layoutUnretire(layoutId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutUnretire");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID
        try {
            apiInstance.layoutUnretire(layoutId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutUnretire");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // The Layout ID

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

// Unretire Layout
[apiInstance layoutUnretireWith:layoutId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} The Layout ID

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

namespace Example
{
    public class layoutUnretireExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | The Layout ID

            try
            {
                // Unretire Layout
                apiInstance.layoutUnretire(layoutId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutUnretire: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | The Layout ID

try {
    $api_instance->layoutUnretire($layoutId);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutUnretire: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | The Layout ID

eval { 
    $api_instance->layoutUnretire(layoutId => $layoutId);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutUnretire: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | The Layout ID

try: 
    # Unretire Layout
    api_instance.layout_unretire(layoutId)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutUnretire: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
The Layout ID
Required

Responses

Status: 204 - successful operation


layoutUntag

Untag Layout

Untag a Layout with one or more tags


/layout/{layoutId}/untag

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/layout/{layoutId}/untag?tag="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout Id to Untag
        array[String] tag = ; // array[String] | An array of tags
        try {
            apiInstance.layoutUntag(layoutId, tag);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutUntag");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout Id to Untag
        array[String] tag = ; // array[String] | An array of tags
        try {
            apiInstance.layoutUntag(layoutId, tag);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#layoutUntag");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // The Layout Id to Untag
array[String] *tag = ; // An array of tags

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

// Untag Layout
[apiInstance layoutUntagWith:layoutId
    tag:tag
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} The Layout Id to Untag
var tag = ; // {{array[String]}} An array of tags

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.layoutUntag(layoutId, tag, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class layoutUntagExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | The Layout Id to Untag
            var tag = new array[String](); // array[String] | An array of tags

            try
            {
                // Untag Layout
                apiInstance.layoutUntag(layoutId, tag);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.layoutUntag: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | The Layout Id to Untag
$tag = ; // array[String] | An array of tags

try {
    $api_instance->layoutUntag($layoutId, $tag);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->layoutUntag: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | The Layout Id to Untag
my $tag = []; # array[String] | An array of tags

eval { 
    $api_instance->layoutUntag(layoutId => $layoutId, tag => $tag);
};
if ($@) {
    warn "Exception when calling LayoutApi->layoutUntag: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | The Layout Id to Untag
tag =  # array[String] | An array of tags

try: 
    # Untag Layout
    api_instance.layout_untag(layoutId, tag)
except ApiException as e:
    print("Exception when calling LayoutApi->layoutUntag: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
The Layout Id to Untag
Required
Query parameters
Name Description
tag*
array[String]
An array of tags
Required

Responses

Status: 200 - successful operation


regionAdd

Add Region

Add a Region to a Layout


/region/{id}

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/region/{id}?type=&width=&height=&top=&left="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer id = 56; // Integer | The Layout ID to add the Region to
        String type = type_example; // String | The type of region this should be, zone, frame, playlist or canvas. Default = frame.
        Integer width = 56; // Integer | The Width, default 250
        Integer height = 56; // Integer | The Height
        Integer top = 56; // Integer | The Top Coordinate
        Integer left = 56; // Integer | The Left Coordinate
        try {
            apiInstance.regionAdd(id, type, width, height, top, left);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#regionAdd");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer id = 56; // Integer | The Layout ID to add the Region to
        String type = type_example; // String | The type of region this should be, zone, frame, playlist or canvas. Default = frame.
        Integer width = 56; // Integer | The Width, default 250
        Integer height = 56; // Integer | The Height
        Integer top = 56; // Integer | The Top Coordinate
        Integer left = 56; // Integer | The Left Coordinate
        try {
            apiInstance.regionAdd(id, type, width, height, top, left);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#regionAdd");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // The Layout ID to add the Region to
String *type = type_example; // The type of region this should be, zone, frame, playlist or canvas. Default = frame. (optional)
Integer *width = 56; // The Width, default 250 (optional)
Integer *height = 56; // The Height (optional)
Integer *top = 56; // The Top Coordinate (optional)
Integer *left = 56; // The Left Coordinate (optional)

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

// Add Region
[apiInstance regionAddWith:id
    type:type
    width:width
    height:height
    top:top
    left:left
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var id = 56; // {{Integer}} The Layout ID to add the Region to
var opts = { 
  'type': type_example, // {{String}} The type of region this should be, zone, frame, playlist or canvas. Default = frame.
  'width': 56, // {{Integer}} The Width, default 250
  'height': 56, // {{Integer}} The Height
  'top': 56, // {{Integer}} The Top Coordinate
  'left': 56 // {{Integer}} The Left Coordinate
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.regionAdd(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class regionAddExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var id = 56;  // Integer | The Layout ID to add the Region to
            var type = type_example;  // String | The type of region this should be, zone, frame, playlist or canvas. Default = frame. (optional) 
            var width = 56;  // Integer | The Width, default 250 (optional) 
            var height = 56;  // Integer | The Height (optional) 
            var top = 56;  // Integer | The Top Coordinate (optional) 
            var left = 56;  // Integer | The Left Coordinate (optional) 

            try
            {
                // Add Region
                apiInstance.regionAdd(id, type, width, height, top, left);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.regionAdd: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$id = 56; // Integer | The Layout ID to add the Region to
$type = type_example; // String | The type of region this should be, zone, frame, playlist or canvas. Default = frame.
$width = 56; // Integer | The Width, default 250
$height = 56; // Integer | The Height
$top = 56; // Integer | The Top Coordinate
$left = 56; // Integer | The Left Coordinate

try {
    $api_instance->regionAdd($id, $type, $width, $height, $top, $left);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->regionAdd: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $id = 56; # Integer | The Layout ID to add the Region to
my $type = type_example; # String | The type of region this should be, zone, frame, playlist or canvas. Default = frame.
my $width = 56; # Integer | The Width, default 250
my $height = 56; # Integer | The Height
my $top = 56; # Integer | The Top Coordinate
my $left = 56; # Integer | The Left Coordinate

eval { 
    $api_instance->regionAdd(id => $id, type => $type, width => $width, height => $height, top => $top, left => $left);
};
if ($@) {
    warn "Exception when calling LayoutApi->regionAdd: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
id = 56 # Integer | The Layout ID to add the Region to
type = type_example # String | The type of region this should be, zone, frame, playlist or canvas. Default = frame. (optional)
width = 56 # Integer | The Width, default 250 (optional)
height = 56 # Integer | The Height (optional)
top = 56 # Integer | The Top Coordinate (optional)
left = 56 # Integer | The Left Coordinate (optional)

try: 
    # Add Region
    api_instance.region_add(id, type=type, width=width, height=height, top=top, left=left)
except ApiException as e:
    print("Exception when calling LayoutApi->regionAdd: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
The Layout ID to add the Region to
Required
Query parameters
Name Description
type
String
The type of region this should be, zone, frame, playlist or canvas. Default = frame.
width
Integer
The Width, default 250
height
Integer
The Height
top
Integer
The Top Coordinate
left
Integer
The Left Coordinate

Responses

Status: 201 - successful operation

Name Type Format Description
Location String

regionDelete

Region Delete

Delete an existing region


/region/{regionId}

Usage and SDK Samples

curl -X DELETE\
"https://premium.digitalsignagevision.com/api/region/{regionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer regionId = 56; // Integer | The Region ID to Delete
        try {
            apiInstance.regionDelete(regionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#regionDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer regionId = 56; // Integer | The Region ID to Delete
        try {
            apiInstance.regionDelete(regionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#regionDelete");
            e.printStackTrace();
        }
    }
}
Integer *regionId = 56; // The Region ID to Delete

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

// Region Delete
[apiInstance regionDeleteWith:regionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var regionId = 56; // {{Integer}} The Region ID to Delete

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

namespace Example
{
    public class regionDeleteExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var regionId = 56;  // Integer | The Region ID to Delete

            try
            {
                // Region Delete
                apiInstance.regionDelete(regionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.regionDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$regionId = 56; // Integer | The Region ID to Delete

try {
    $api_instance->regionDelete($regionId);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->regionDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $regionId = 56; # Integer | The Region ID to Delete

eval { 
    $api_instance->regionDelete(regionId => $regionId);
};
if ($@) {
    warn "Exception when calling LayoutApi->regionDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
regionId = 56 # Integer | The Region ID to Delete

try: 
    # Region Delete
    api_instance.region_delete(regionId)
except ApiException as e:
    print("Exception when calling LayoutApi->regionDelete: %s\n" % e)

Parameters

Path parameters
Name Description
regionId*
Integer
The Region ID to Delete
Required

Responses

Status: 204 - successful operation


regionDrawerAdd

Add drawer Region

Add a drawer Region to a Layout


/region/drawer/{id}

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/region/drawer/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer id = 56; // Integer | The Layout ID to add the Region to
        try {
            apiInstance.regionDrawerAdd(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#regionDrawerAdd");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer id = 56; // Integer | The Layout ID to add the Region to
        try {
            apiInstance.regionDrawerAdd(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#regionDrawerAdd");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // The Layout ID to add the Region to

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

// Add drawer Region
[apiInstance regionDrawerAddWith:id
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var id = 56; // {{Integer}} The Layout ID to add the Region to

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

namespace Example
{
    public class regionDrawerAddExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var id = 56;  // Integer | The Layout ID to add the Region to

            try
            {
                // Add drawer Region
                apiInstance.regionDrawerAdd(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.regionDrawerAdd: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$id = 56; // Integer | The Layout ID to add the Region to

try {
    $api_instance->regionDrawerAdd($id);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->regionDrawerAdd: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $id = 56; # Integer | The Layout ID to add the Region to

eval { 
    $api_instance->regionDrawerAdd(id => $id);
};
if ($@) {
    warn "Exception when calling LayoutApi->regionDrawerAdd: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
id = 56 # Integer | The Layout ID to add the Region to

try: 
    # Add drawer Region
    api_instance.region_drawer_add(id)
except ApiException as e:
    print("Exception when calling LayoutApi->regionDrawerAdd: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
The Layout ID to add the Region to
Required

Responses

Status: 201 - successful operation

Name Type Format Description
Location String

regionDrawerSave

Save Drawer

Save Drawer


/region/drawer/{id}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/region/drawer/{id}?width=&height="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer id = 56; // Integer | The Drawer ID to Save
        Integer width = 56; // Integer | The Width, default 250
        Integer height = 56; // Integer | The Height
        try {
            apiInstance.regionDrawerSave(id, width, height);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#regionDrawerSave");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer id = 56; // Integer | The Drawer ID to Save
        Integer width = 56; // Integer | The Width, default 250
        Integer height = 56; // Integer | The Height
        try {
            apiInstance.regionDrawerSave(id, width, height);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#regionDrawerSave");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // The Drawer ID to Save
Integer *width = 56; // The Width, default 250 (optional)
Integer *height = 56; // The Height (optional)

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

// Save Drawer
[apiInstance regionDrawerSaveWith:id
    width:width
    height:height
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var id = 56; // {{Integer}} The Drawer ID to Save
var opts = { 
  'width': 56, // {{Integer}} The Width, default 250
  'height': 56 // {{Integer}} The Height
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.regionDrawerSave(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class regionDrawerSaveExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var id = 56;  // Integer | The Drawer ID to Save
            var width = 56;  // Integer | The Width, default 250 (optional) 
            var height = 56;  // Integer | The Height (optional) 

            try
            {
                // Save Drawer
                apiInstance.regionDrawerSave(id, width, height);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.regionDrawerSave: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$id = 56; // Integer | The Drawer ID to Save
$width = 56; // Integer | The Width, default 250
$height = 56; // Integer | The Height

try {
    $api_instance->regionDrawerSave($id, $width, $height);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->regionDrawerSave: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $id = 56; # Integer | The Drawer ID to Save
my $width = 56; # Integer | The Width, default 250
my $height = 56; # Integer | The Height

eval { 
    $api_instance->regionDrawerSave(id => $id, width => $width, height => $height);
};
if ($@) {
    warn "Exception when calling LayoutApi->regionDrawerSave: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
id = 56 # Integer | The Drawer ID to Save
width = 56 # Integer | The Width, default 250 (optional)
height = 56 # Integer | The Height (optional)

try: 
    # Save Drawer
    api_instance.region_drawer_save(id, width=width, height=height)
except ApiException as e:
    print("Exception when calling LayoutApi->regionDrawerSave: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
The Drawer ID to Save
Required
Query parameters
Name Description
width
Integer
The Width, default 250
height
Integer
The Height

Responses

Status: 200 - successful operation


regionEdit

Edit Region

Edit Region


/region/{id}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/region/{id}?width=&height=&top=&left=&zIndex=&transitionType=&transitionDuration=&transitionDirection=&loop="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer id = 56; // Integer | The Region ID to Edit
        Integer loop = 56; // Integer | Flag indicating whether this region should loop if there is only 1 media item in the timeline
        Integer width = 56; // Integer | The Width, default 250
        Integer height = 56; // Integer | The Height
        Integer top = 56; // Integer | The Top Coordinate
        Integer left = 56; // Integer | The Left Coordinate
        Integer zIndex = 56; // Integer | The Layer for this Region
        String transitionType = transitionType_example; // String | The Transition Type. Must be a valid transition code as returned by /transition
        Integer transitionDuration = 56; // Integer | The transition duration in milliseconds if required by the transition type
        String transitionDirection = transitionDirection_example; // String | The transition direction if required by the transition type.
        try {
            apiInstance.regionEdit(id, loop, width, height, top, left, zIndex, transitionType, transitionDuration, transitionDirection);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#regionEdit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer id = 56; // Integer | The Region ID to Edit
        Integer loop = 56; // Integer | Flag indicating whether this region should loop if there is only 1 media item in the timeline
        Integer width = 56; // Integer | The Width, default 250
        Integer height = 56; // Integer | The Height
        Integer top = 56; // Integer | The Top Coordinate
        Integer left = 56; // Integer | The Left Coordinate
        Integer zIndex = 56; // Integer | The Layer for this Region
        String transitionType = transitionType_example; // String | The Transition Type. Must be a valid transition code as returned by /transition
        Integer transitionDuration = 56; // Integer | The transition duration in milliseconds if required by the transition type
        String transitionDirection = transitionDirection_example; // String | The transition direction if required by the transition type.
        try {
            apiInstance.regionEdit(id, loop, width, height, top, left, zIndex, transitionType, transitionDuration, transitionDirection);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#regionEdit");
            e.printStackTrace();
        }
    }
}
Integer *id = 56; // The Region ID to Edit
Integer *loop = 56; // Flag indicating whether this region should loop if there is only 1 media item in the timeline
Integer *width = 56; // The Width, default 250 (optional)
Integer *height = 56; // The Height (optional)
Integer *top = 56; // The Top Coordinate (optional)
Integer *left = 56; // The Left Coordinate (optional)
Integer *zIndex = 56; // The Layer for this Region (optional)
String *transitionType = transitionType_example; // The Transition Type. Must be a valid transition code as returned by /transition (optional)
Integer *transitionDuration = 56; // The transition duration in milliseconds if required by the transition type (optional)
String *transitionDirection = transitionDirection_example; // The transition direction if required by the transition type. (optional)

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

// Edit Region
[apiInstance regionEditWith:id
    loop:loop
    width:width
    height:height
    top:top
    left:left
    zIndex:zIndex
    transitionType:transitionType
    transitionDuration:transitionDuration
    transitionDirection:transitionDirection
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var id = 56; // {{Integer}} The Region ID to Edit
var loop = 56; // {{Integer}} Flag indicating whether this region should loop if there is only 1 media item in the timeline
var opts = { 
  'width': 56, // {{Integer}} The Width, default 250
  'height': 56, // {{Integer}} The Height
  'top': 56, // {{Integer}} The Top Coordinate
  'left': 56, // {{Integer}} The Left Coordinate
  'zIndex': 56, // {{Integer}} The Layer for this Region
  'transitionType': transitionType_example, // {{String}} The Transition Type. Must be a valid transition code as returned by /transition
  'transitionDuration': 56, // {{Integer}} The transition duration in milliseconds if required by the transition type
  'transitionDirection': transitionDirection_example // {{String}} The transition direction if required by the transition type.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.regionEdit(id, loop, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class regionEditExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var id = 56;  // Integer | The Region ID to Edit
            var loop = 56;  // Integer | Flag indicating whether this region should loop if there is only 1 media item in the timeline
            var width = 56;  // Integer | The Width, default 250 (optional) 
            var height = 56;  // Integer | The Height (optional) 
            var top = 56;  // Integer | The Top Coordinate (optional) 
            var left = 56;  // Integer | The Left Coordinate (optional) 
            var zIndex = 56;  // Integer | The Layer for this Region (optional) 
            var transitionType = transitionType_example;  // String | The Transition Type. Must be a valid transition code as returned by /transition (optional) 
            var transitionDuration = 56;  // Integer | The transition duration in milliseconds if required by the transition type (optional) 
            var transitionDirection = transitionDirection_example;  // String | The transition direction if required by the transition type. (optional) 

            try
            {
                // Edit Region
                apiInstance.regionEdit(id, loop, width, height, top, left, zIndex, transitionType, transitionDuration, transitionDirection);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.regionEdit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$id = 56; // Integer | The Region ID to Edit
$loop = 56; // Integer | Flag indicating whether this region should loop if there is only 1 media item in the timeline
$width = 56; // Integer | The Width, default 250
$height = 56; // Integer | The Height
$top = 56; // Integer | The Top Coordinate
$left = 56; // Integer | The Left Coordinate
$zIndex = 56; // Integer | The Layer for this Region
$transitionType = transitionType_example; // String | The Transition Type. Must be a valid transition code as returned by /transition
$transitionDuration = 56; // Integer | The transition duration in milliseconds if required by the transition type
$transitionDirection = transitionDirection_example; // String | The transition direction if required by the transition type.

try {
    $api_instance->regionEdit($id, $loop, $width, $height, $top, $left, $zIndex, $transitionType, $transitionDuration, $transitionDirection);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->regionEdit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $id = 56; # Integer | The Region ID to Edit
my $loop = 56; # Integer | Flag indicating whether this region should loop if there is only 1 media item in the timeline
my $width = 56; # Integer | The Width, default 250
my $height = 56; # Integer | The Height
my $top = 56; # Integer | The Top Coordinate
my $left = 56; # Integer | The Left Coordinate
my $zIndex = 56; # Integer | The Layer for this Region
my $transitionType = transitionType_example; # String | The Transition Type. Must be a valid transition code as returned by /transition
my $transitionDuration = 56; # Integer | The transition duration in milliseconds if required by the transition type
my $transitionDirection = transitionDirection_example; # String | The transition direction if required by the transition type.

eval { 
    $api_instance->regionEdit(id => $id, loop => $loop, width => $width, height => $height, top => $top, left => $left, zIndex => $zIndex, transitionType => $transitionType, transitionDuration => $transitionDuration, transitionDirection => $transitionDirection);
};
if ($@) {
    warn "Exception when calling LayoutApi->regionEdit: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
id = 56 # Integer | The Region ID to Edit
loop = 56 # Integer | Flag indicating whether this region should loop if there is only 1 media item in the timeline
width = 56 # Integer | The Width, default 250 (optional)
height = 56 # Integer | The Height (optional)
top = 56 # Integer | The Top Coordinate (optional)
left = 56 # Integer | The Left Coordinate (optional)
zIndex = 56 # Integer | The Layer for this Region (optional)
transitionType = transitionType_example # String | The Transition Type. Must be a valid transition code as returned by /transition (optional)
transitionDuration = 56 # Integer | The transition duration in milliseconds if required by the transition type (optional)
transitionDirection = transitionDirection_example # String | The transition direction if required by the transition type. (optional)

try: 
    # Edit Region
    api_instance.region_edit(id, loop, width=width, height=height, top=top, left=left, zIndex=zIndex, transitionType=transitionType, transitionDuration=transitionDuration, transitionDirection=transitionDirection)
except ApiException as e:
    print("Exception when calling LayoutApi->regionEdit: %s\n" % e)

Parameters

Path parameters
Name Description
id*
Integer
The Region ID to Edit
Required
Query parameters
Name Description
width
Integer
The Width, default 250
height
Integer
The Height
top
Integer
The Top Coordinate
left
Integer
The Left Coordinate
zIndex
Integer
The Layer for this Region
transitionType
String
The Transition Type. Must be a valid transition code as returned by /transition
transitionDuration
Integer
The transition duration in milliseconds if required by the transition type
transitionDirection
String
The transition direction if required by the transition type.
loop*
Integer
Flag indicating whether this region should loop if there is only 1 media item in the timeline
Required

Responses

Status: 200 - successful operation


regionPositionAll

Position Regions

Position all regions for a Layout


/region/position/all/{layoutId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/region/position/all/{layoutId}?regions="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LayoutApi;

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

public class LayoutApiExample {

    public static void main(String[] args) {
        
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID
        array[String] regions = ; // array[String] | Array of regions and their new positions. Each array element should be json encoded and have regionId, top, left, width and height.
        try {
            apiInstance.regionPositionAll(layoutId, regions);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#regionPositionAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LayoutApi;

public class LayoutApiExample {

    public static void main(String[] args) {
        LayoutApi apiInstance = new LayoutApi();
        Integer layoutId = 56; // Integer | The Layout ID
        array[String] regions = ; // array[String] | Array of regions and their new positions. Each array element should be json encoded and have regionId, top, left, width and height.
        try {
            apiInstance.regionPositionAll(layoutId, regions);
        } catch (ApiException e) {
            System.err.println("Exception when calling LayoutApi#regionPositionAll");
            e.printStackTrace();
        }
    }
}
Integer *layoutId = 56; // The Layout ID
array[String] *regions = ; // Array of regions and their new positions. Each array element should be json encoded and have regionId, top, left, width and height.

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

// Position Regions
[apiInstance regionPositionAllWith:layoutId
    regions:regions
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LayoutApi()
var layoutId = 56; // {{Integer}} The Layout ID
var regions = ; // {{array[String]}} Array of regions and their new positions. Each array element should be json encoded and have regionId, top, left, width and height.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.regionPositionAll(layoutId, regions, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class regionPositionAllExample
    {
        public void main()
        {

            var apiInstance = new LayoutApi();
            var layoutId = 56;  // Integer | The Layout ID
            var regions = new array[String](); // array[String] | Array of regions and their new positions. Each array element should be json encoded and have regionId, top, left, width and height.

            try
            {
                // Position Regions
                apiInstance.regionPositionAll(layoutId, regions);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LayoutApi.regionPositionAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLayoutApi();
$layoutId = 56; // Integer | The Layout ID
$regions = ; // array[String] | Array of regions and their new positions. Each array element should be json encoded and have regionId, top, left, width and height.

try {
    $api_instance->regionPositionAll($layoutId, $regions);
} catch (Exception $e) {
    echo 'Exception when calling LayoutApi->regionPositionAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LayoutApi;

my $api_instance = WWW::SwaggerClient::LayoutApi->new();
my $layoutId = 56; # Integer | The Layout ID
my $regions = []; # array[String] | Array of regions and their new positions. Each array element should be json encoded and have regionId, top, left, width and height.

eval { 
    $api_instance->regionPositionAll(layoutId => $layoutId, regions => $regions);
};
if ($@) {
    warn "Exception when calling LayoutApi->regionPositionAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LayoutApi()
layoutId = 56 # Integer | The Layout ID
regions =  # array[String] | Array of regions and their new positions. Each array element should be json encoded and have regionId, top, left, width and height.

try: 
    # Position Regions
    api_instance.region_position_all(layoutId, regions)
except ApiException as e:
    print("Exception when calling LayoutApi->regionPositionAll: %s\n" % e)

Parameters

Path parameters
Name Description
layoutId*
Integer
The Layout ID
Required
Query parameters
Name Description
regions*
array[String]
Array of regions and their new positions. Each array element should be json encoded and have regionId, top, left, width and height.
Required

Responses

Status: 200 - successful operation


Library

libraryAdd

Add Media

Add Media to the Library, optionally replacing an existing media item, optionally adding to a playlist.


/library

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/library?files=&name=&oldMediaId=&updateInLayouts=&deleteOldRevisions=&tags=&expires=&playlistId=&widgetFromDt=&widgetToDt=&deleteOnExpiry=&applyToMedia=&folderId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibraryApi;

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

public class LibraryApiExample {

    public static void main(String[] args) {
        
        LibraryApi apiInstance = new LibraryApi();
        String files = files_example; // String | The Uploaded File
        String name = name_example; // String | Optional Media Name
        Integer oldMediaId = 56; // Integer | Id of an existing media file which should be replaced with the new upload
        Integer updateInLayouts = 56; // Integer | Flag (0, 1), set to 1 to update this media in all layouts (use with oldMediaId) 
        Integer deleteOldRevisions = 56; // Integer | Flag (0 , 1), to either remove or leave the old file revisions (use with oldMediaId)
        String tags = tags_example; // String | Comma separated string of Tags that should be assigned to uploaded Media
        String expires = expires_example; // String | Date in Y-m-d H:i:s format, will set expiration date on the uploaded Media
        Integer playlistId = 56; // Integer | A playlistId to add this uploaded media to
        String widgetFromDt = widgetFromDt_example; // String | Date in Y-m-d H:i:s format, will set widget start date. Requires a playlistId.
        String widgetToDt = widgetToDt_example; // String | Date in Y-m-d H:i:s format, will set widget end date. Requires a playlistId.
        Integer deleteOnExpiry = 56; // Integer | Flag (0, 1), set to 1 to remove the Widget from the Playlist when the widgetToDt has been reached
        Integer applyToMedia = 56; // Integer | Flag (0, 1), set to 1 to apply the widgetFromDt as the expiry date on the Media
        Integer folderId = 56; // Integer | Folder ID to which this object should be assigned to
        try {
            apiInstance.libraryAdd(files, name, oldMediaId, updateInLayouts, deleteOldRevisions, tags, expires, playlistId, widgetFromDt, widgetToDt, deleteOnExpiry, applyToMedia, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#libraryAdd");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibraryApi;

public class LibraryApiExample {

    public static void main(String[] args) {
        LibraryApi apiInstance = new LibraryApi();
        String files = files_example; // String | The Uploaded File
        String name = name_example; // String | Optional Media Name
        Integer oldMediaId = 56; // Integer | Id of an existing media file which should be replaced with the new upload
        Integer updateInLayouts = 56; // Integer | Flag (0, 1), set to 1 to update this media in all layouts (use with oldMediaId) 
        Integer deleteOldRevisions = 56; // Integer | Flag (0 , 1), to either remove or leave the old file revisions (use with oldMediaId)
        String tags = tags_example; // String | Comma separated string of Tags that should be assigned to uploaded Media
        String expires = expires_example; // String | Date in Y-m-d H:i:s format, will set expiration date on the uploaded Media
        Integer playlistId = 56; // Integer | A playlistId to add this uploaded media to
        String widgetFromDt = widgetFromDt_example; // String | Date in Y-m-d H:i:s format, will set widget start date. Requires a playlistId.
        String widgetToDt = widgetToDt_example; // String | Date in Y-m-d H:i:s format, will set widget end date. Requires a playlistId.
        Integer deleteOnExpiry = 56; // Integer | Flag (0, 1), set to 1 to remove the Widget from the Playlist when the widgetToDt has been reached
        Integer applyToMedia = 56; // Integer | Flag (0, 1), set to 1 to apply the widgetFromDt as the expiry date on the Media
        Integer folderId = 56; // Integer | Folder ID to which this object should be assigned to
        try {
            apiInstance.libraryAdd(files, name, oldMediaId, updateInLayouts, deleteOldRevisions, tags, expires, playlistId, widgetFromDt, widgetToDt, deleteOnExpiry, applyToMedia, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#libraryAdd");
            e.printStackTrace();
        }
    }
}
String *files = files_example; // The Uploaded File
String *name = name_example; // Optional Media Name (optional)
Integer *oldMediaId = 56; // Id of an existing media file which should be replaced with the new upload (optional)
Integer *updateInLayouts = 56; // Flag (0, 1), set to 1 to update this media in all layouts (use with oldMediaId)  (optional)
Integer *deleteOldRevisions = 56; // Flag (0 , 1), to either remove or leave the old file revisions (use with oldMediaId) (optional)
String *tags = tags_example; // Comma separated string of Tags that should be assigned to uploaded Media (optional)
String *expires = expires_example; // Date in Y-m-d H:i:s format, will set expiration date on the uploaded Media (optional)
Integer *playlistId = 56; // A playlistId to add this uploaded media to (optional)
String *widgetFromDt = widgetFromDt_example; // Date in Y-m-d H:i:s format, will set widget start date. Requires a playlistId. (optional)
String *widgetToDt = widgetToDt_example; // Date in Y-m-d H:i:s format, will set widget end date. Requires a playlistId. (optional)
Integer *deleteOnExpiry = 56; // Flag (0, 1), set to 1 to remove the Widget from the Playlist when the widgetToDt has been reached (optional)
Integer *applyToMedia = 56; // Flag (0, 1), set to 1 to apply the widgetFromDt as the expiry date on the Media (optional)
Integer *folderId = 56; // Folder ID to which this object should be assigned to (optional)

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

// Add Media
[apiInstance libraryAddWith:files
    name:name
    oldMediaId:oldMediaId
    updateInLayouts:updateInLayouts
    deleteOldRevisions:deleteOldRevisions
    tags:tags
    expires:expires
    playlistId:playlistId
    widgetFromDt:widgetFromDt
    widgetToDt:widgetToDt
    deleteOnExpiry:deleteOnExpiry
    applyToMedia:applyToMedia
    folderId:folderId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LibraryApi()
var files = files_example; // {{String}} The Uploaded File
var opts = { 
  'name': name_example, // {{String}} Optional Media Name
  'oldMediaId': 56, // {{Integer}} Id of an existing media file which should be replaced with the new upload
  'updateInLayouts': 56, // {{Integer}} Flag (0, 1), set to 1 to update this media in all layouts (use with oldMediaId) 
  'deleteOldRevisions': 56, // {{Integer}} Flag (0 , 1), to either remove or leave the old file revisions (use with oldMediaId)
  'tags': tags_example, // {{String}} Comma separated string of Tags that should be assigned to uploaded Media
  'expires': expires_example, // {{String}} Date in Y-m-d H:i:s format, will set expiration date on the uploaded Media
  'playlistId': 56, // {{Integer}} A playlistId to add this uploaded media to
  'widgetFromDt': widgetFromDt_example, // {{String}} Date in Y-m-d H:i:s format, will set widget start date. Requires a playlistId.
  'widgetToDt': widgetToDt_example, // {{String}} Date in Y-m-d H:i:s format, will set widget end date. Requires a playlistId.
  'deleteOnExpiry': 56, // {{Integer}} Flag (0, 1), set to 1 to remove the Widget from the Playlist when the widgetToDt has been reached
  'applyToMedia': 56, // {{Integer}} Flag (0, 1), set to 1 to apply the widgetFromDt as the expiry date on the Media
  'folderId': 56 // {{Integer}} Folder ID to which this object should be assigned to
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.libraryAdd(files, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class libraryAddExample
    {
        public void main()
        {

            var apiInstance = new LibraryApi();
            var files = files_example;  // String | The Uploaded File
            var name = name_example;  // String | Optional Media Name (optional) 
            var oldMediaId = 56;  // Integer | Id of an existing media file which should be replaced with the new upload (optional) 
            var updateInLayouts = 56;  // Integer | Flag (0, 1), set to 1 to update this media in all layouts (use with oldMediaId)  (optional) 
            var deleteOldRevisions = 56;  // Integer | Flag (0 , 1), to either remove or leave the old file revisions (use with oldMediaId) (optional) 
            var tags = tags_example;  // String | Comma separated string of Tags that should be assigned to uploaded Media (optional) 
            var expires = expires_example;  // String | Date in Y-m-d H:i:s format, will set expiration date on the uploaded Media (optional) 
            var playlistId = 56;  // Integer | A playlistId to add this uploaded media to (optional) 
            var widgetFromDt = widgetFromDt_example;  // String | Date in Y-m-d H:i:s format, will set widget start date. Requires a playlistId. (optional) 
            var widgetToDt = widgetToDt_example;  // String | Date in Y-m-d H:i:s format, will set widget end date. Requires a playlistId. (optional) 
            var deleteOnExpiry = 56;  // Integer | Flag (0, 1), set to 1 to remove the Widget from the Playlist when the widgetToDt has been reached (optional) 
            var applyToMedia = 56;  // Integer | Flag (0, 1), set to 1 to apply the widgetFromDt as the expiry date on the Media (optional) 
            var folderId = 56;  // Integer | Folder ID to which this object should be assigned to (optional) 

            try
            {
                // Add Media
                apiInstance.libraryAdd(files, name, oldMediaId, updateInLayouts, deleteOldRevisions, tags, expires, playlistId, widgetFromDt, widgetToDt, deleteOnExpiry, applyToMedia, folderId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibraryApi.libraryAdd: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLibraryApi();
$files = files_example; // String | The Uploaded File
$name = name_example; // String | Optional Media Name
$oldMediaId = 56; // Integer | Id of an existing media file which should be replaced with the new upload
$updateInLayouts = 56; // Integer | Flag (0, 1), set to 1 to update this media in all layouts (use with oldMediaId) 
$deleteOldRevisions = 56; // Integer | Flag (0 , 1), to either remove or leave the old file revisions (use with oldMediaId)
$tags = tags_example; // String | Comma separated string of Tags that should be assigned to uploaded Media
$expires = expires_example; // String | Date in Y-m-d H:i:s format, will set expiration date on the uploaded Media
$playlistId = 56; // Integer | A playlistId to add this uploaded media to
$widgetFromDt = widgetFromDt_example; // String | Date in Y-m-d H:i:s format, will set widget start date. Requires a playlistId.
$widgetToDt = widgetToDt_example; // String | Date in Y-m-d H:i:s format, will set widget end date. Requires a playlistId.
$deleteOnExpiry = 56; // Integer | Flag (0, 1), set to 1 to remove the Widget from the Playlist when the widgetToDt has been reached
$applyToMedia = 56; // Integer | Flag (0, 1), set to 1 to apply the widgetFromDt as the expiry date on the Media
$folderId = 56; // Integer | Folder ID to which this object should be assigned to

try {
    $api_instance->libraryAdd($files, $name, $oldMediaId, $updateInLayouts, $deleteOldRevisions, $tags, $expires, $playlistId, $widgetFromDt, $widgetToDt, $deleteOnExpiry, $applyToMedia, $folderId);
} catch (Exception $e) {
    echo 'Exception when calling LibraryApi->libraryAdd: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibraryApi;

my $api_instance = WWW::SwaggerClient::LibraryApi->new();
my $files = files_example; # String | The Uploaded File
my $name = name_example; # String | Optional Media Name
my $oldMediaId = 56; # Integer | Id of an existing media file which should be replaced with the new upload
my $updateInLayouts = 56; # Integer | Flag (0, 1), set to 1 to update this media in all layouts (use with oldMediaId) 
my $deleteOldRevisions = 56; # Integer | Flag (0 , 1), to either remove or leave the old file revisions (use with oldMediaId)
my $tags = tags_example; # String | Comma separated string of Tags that should be assigned to uploaded Media
my $expires = expires_example; # String | Date in Y-m-d H:i:s format, will set expiration date on the uploaded Media
my $playlistId = 56; # Integer | A playlistId to add this uploaded media to
my $widgetFromDt = widgetFromDt_example; # String | Date in Y-m-d H:i:s format, will set widget start date. Requires a playlistId.
my $widgetToDt = widgetToDt_example; # String | Date in Y-m-d H:i:s format, will set widget end date. Requires a playlistId.
my $deleteOnExpiry = 56; # Integer | Flag (0, 1), set to 1 to remove the Widget from the Playlist when the widgetToDt has been reached
my $applyToMedia = 56; # Integer | Flag (0, 1), set to 1 to apply the widgetFromDt as the expiry date on the Media
my $folderId = 56; # Integer | Folder ID to which this object should be assigned to

eval { 
    $api_instance->libraryAdd(files => $files, name => $name, oldMediaId => $oldMediaId, updateInLayouts => $updateInLayouts, deleteOldRevisions => $deleteOldRevisions, tags => $tags, expires => $expires, playlistId => $playlistId, widgetFromDt => $widgetFromDt, widgetToDt => $widgetToDt, deleteOnExpiry => $deleteOnExpiry, applyToMedia => $applyToMedia, folderId => $folderId);
};
if ($@) {
    warn "Exception when calling LibraryApi->libraryAdd: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibraryApi()
files = files_example # String | The Uploaded File
name = name_example # String | Optional Media Name (optional)
oldMediaId = 56 # Integer | Id of an existing media file which should be replaced with the new upload (optional)
updateInLayouts = 56 # Integer | Flag (0, 1), set to 1 to update this media in all layouts (use with oldMediaId)  (optional)
deleteOldRevisions = 56 # Integer | Flag (0 , 1), to either remove or leave the old file revisions (use with oldMediaId) (optional)
tags = tags_example # String | Comma separated string of Tags that should be assigned to uploaded Media (optional)
expires = expires_example # String | Date in Y-m-d H:i:s format, will set expiration date on the uploaded Media (optional)
playlistId = 56 # Integer | A playlistId to add this uploaded media to (optional)
widgetFromDt = widgetFromDt_example # String | Date in Y-m-d H:i:s format, will set widget start date. Requires a playlistId. (optional)
widgetToDt = widgetToDt_example # String | Date in Y-m-d H:i:s format, will set widget end date. Requires a playlistId. (optional)
deleteOnExpiry = 56 # Integer | Flag (0, 1), set to 1 to remove the Widget from the Playlist when the widgetToDt has been reached (optional)
applyToMedia = 56 # Integer | Flag (0, 1), set to 1 to apply the widgetFromDt as the expiry date on the Media (optional)
folderId = 56 # Integer | Folder ID to which this object should be assigned to (optional)

try: 
    # Add Media
    api_instance.library_add(files, name=name, oldMediaId=oldMediaId, updateInLayouts=updateInLayouts, deleteOldRevisions=deleteOldRevisions, tags=tags, expires=expires, playlistId=playlistId, widgetFromDt=widgetFromDt, widgetToDt=widgetToDt, deleteOnExpiry=deleteOnExpiry, applyToMedia=applyToMedia, folderId=folderId)
except ApiException as e:
    print("Exception when calling LibraryApi->libraryAdd: %s\n" % e)

Parameters

Query parameters
Name Description
files*
String
The Uploaded File
Required
name
String
Optional Media Name
oldMediaId
Integer
Id of an existing media file which should be replaced with the new upload
updateInLayouts
Integer
Flag (0, 1), set to 1 to update this media in all layouts (use with oldMediaId)
deleteOldRevisions
Integer
Flag (0 , 1), to either remove or leave the old file revisions (use with oldMediaId)
tags
String
Comma separated string of Tags that should be assigned to uploaded Media
expires
String
Date in Y-m-d H:i:s format, will set expiration date on the uploaded Media
playlistId
Integer
A playlistId to add this uploaded media to
widgetFromDt
String
Date in Y-m-d H:i:s format, will set widget start date. Requires a playlistId.
widgetToDt
String
Date in Y-m-d H:i:s format, will set widget end date. Requires a playlistId.
deleteOnExpiry
Integer
Flag (0, 1), set to 1 to remove the Widget from the Playlist when the widgetToDt has been reached
applyToMedia
Integer
Flag (0, 1), set to 1 to apply the widgetFromDt as the expiry date on the Media
folderId
Integer
Folder ID to which this object should be assigned to

Responses

Status: 200 - successful operation


libraryDelete

Delete Media

Delete Media from the Library


/library/{mediaId}

Usage and SDK Samples

curl -X DELETE\
"https://premium.digitalsignagevision.com/api/library/{mediaId}?forceDelete=&purge="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibraryApi;

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

public class LibraryApiExample {

    public static void main(String[] args) {
        
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The Media ID to Delete
        Integer forceDelete = 56; // Integer | If the media item has been used should it be force removed from items that uses it?
        Integer purge = 56; // Integer | Should this Media be added to the Purge List for all Displays?
        try {
            apiInstance.libraryDelete(mediaId, forceDelete, purge);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#libraryDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibraryApi;

public class LibraryApiExample {

    public static void main(String[] args) {
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The Media ID to Delete
        Integer forceDelete = 56; // Integer | If the media item has been used should it be force removed from items that uses it?
        Integer purge = 56; // Integer | Should this Media be added to the Purge List for all Displays?
        try {
            apiInstance.libraryDelete(mediaId, forceDelete, purge);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#libraryDelete");
            e.printStackTrace();
        }
    }
}
Integer *mediaId = 56; // The Media ID to Delete
Integer *forceDelete = 56; // If the media item has been used should it be force removed from items that uses it?
Integer *purge = 56; // Should this Media be added to the Purge List for all Displays? (optional)

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

// Delete Media
[apiInstance libraryDeleteWith:mediaId
    forceDelete:forceDelete
    purge:purge
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LibraryApi()
var mediaId = 56; // {{Integer}} The Media ID to Delete
var forceDelete = 56; // {{Integer}} If the media item has been used should it be force removed from items that uses it?
var opts = { 
  'purge': 56 // {{Integer}} Should this Media be added to the Purge List for all Displays?
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.libraryDelete(mediaId, forceDelete, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class libraryDeleteExample
    {
        public void main()
        {

            var apiInstance = new LibraryApi();
            var mediaId = 56;  // Integer | The Media ID to Delete
            var forceDelete = 56;  // Integer | If the media item has been used should it be force removed from items that uses it?
            var purge = 56;  // Integer | Should this Media be added to the Purge List for all Displays? (optional) 

            try
            {
                // Delete Media
                apiInstance.libraryDelete(mediaId, forceDelete, purge);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibraryApi.libraryDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLibraryApi();
$mediaId = 56; // Integer | The Media ID to Delete
$forceDelete = 56; // Integer | If the media item has been used should it be force removed from items that uses it?
$purge = 56; // Integer | Should this Media be added to the Purge List for all Displays?

try {
    $api_instance->libraryDelete($mediaId, $forceDelete, $purge);
} catch (Exception $e) {
    echo 'Exception when calling LibraryApi->libraryDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibraryApi;

my $api_instance = WWW::SwaggerClient::LibraryApi->new();
my $mediaId = 56; # Integer | The Media ID to Delete
my $forceDelete = 56; # Integer | If the media item has been used should it be force removed from items that uses it?
my $purge = 56; # Integer | Should this Media be added to the Purge List for all Displays?

eval { 
    $api_instance->libraryDelete(mediaId => $mediaId, forceDelete => $forceDelete, purge => $purge);
};
if ($@) {
    warn "Exception when calling LibraryApi->libraryDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibraryApi()
mediaId = 56 # Integer | The Media ID to Delete
forceDelete = 56 # Integer | If the media item has been used should it be force removed from items that uses it?
purge = 56 # Integer | Should this Media be added to the Purge List for all Displays? (optional)

try: 
    # Delete Media
    api_instance.library_delete(mediaId, forceDelete, purge=purge)
except ApiException as e:
    print("Exception when calling LibraryApi->libraryDelete: %s\n" % e)

Parameters

Path parameters
Name Description
mediaId*
Integer
The Media ID to Delete
Required
Query parameters
Name Description
forceDelete*
Integer
If the media item has been used should it be force removed from items that uses it?
Required
purge
Integer
Should this Media be added to the Purge List for all Displays?

Responses

Status: 204 - successful operation


libraryDownload

Download Media

Download a Media file from the Library


/library/download/{mediaId}/{type}

Usage and SDK Samples

curl -X GET\
"https://premium.digitalsignagevision.com/api/library/download/{mediaId}/{type}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibraryApi;

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

public class LibraryApiExample {

    public static void main(String[] args) {
        
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The Media ID to Download
        String type = type_example; // String | The Module Type of the Download
        try {
            apiInstance.libraryDownload(mediaId, type);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#libraryDownload");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibraryApi;

public class LibraryApiExample {

    public static void main(String[] args) {
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The Media ID to Download
        String type = type_example; // String | The Module Type of the Download
        try {
            apiInstance.libraryDownload(mediaId, type);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#libraryDownload");
            e.printStackTrace();
        }
    }
}
Integer *mediaId = 56; // The Media ID to Download
String *type = type_example; // The Module Type of the Download

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

// Download Media
[apiInstance libraryDownloadWith:mediaId
    type:type
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LibraryApi()
var mediaId = 56; // {{Integer}} The Media ID to Download
var type = type_example; // {{String}} The Module Type of the Download

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.libraryDownload(mediaId, type, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class libraryDownloadExample
    {
        public void main()
        {

            var apiInstance = new LibraryApi();
            var mediaId = 56;  // Integer | The Media ID to Download
            var type = type_example;  // String | The Module Type of the Download

            try
            {
                // Download Media
                apiInstance.libraryDownload(mediaId, type);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibraryApi.libraryDownload: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLibraryApi();
$mediaId = 56; // Integer | The Media ID to Download
$type = type_example; // String | The Module Type of the Download

try {
    $api_instance->libraryDownload($mediaId, $type);
} catch (Exception $e) {
    echo 'Exception when calling LibraryApi->libraryDownload: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibraryApi;

my $api_instance = WWW::SwaggerClient::LibraryApi->new();
my $mediaId = 56; # Integer | The Media ID to Download
my $type = type_example; # String | The Module Type of the Download

eval { 
    $api_instance->libraryDownload(mediaId => $mediaId, type => $type);
};
if ($@) {
    warn "Exception when calling LibraryApi->libraryDownload: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibraryApi()
mediaId = 56 # Integer | The Media ID to Download
type = type_example # String | The Module Type of the Download

try: 
    # Download Media
    api_instance.library_download(mediaId, type)
except ApiException as e:
    print("Exception when calling LibraryApi->libraryDownload: %s\n" % e)

Parameters

Path parameters
Name Description
mediaId*
Integer
The Media ID to Download
Required
type*
String
The Module Type of the Download
Required

Responses

Status: 200 - successful operation

Name Type Format Description
X-Sendfile String
X-Accel-Redirect String

libraryEdit

Edit Media

Edit a Media Item in the Library


/library/{mediaId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/library/{mediaId}?name=&duration=&retired=&tags=&updateInLayouts=&expires=&folderId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibraryApi;

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

public class LibraryApiExample {

    public static void main(String[] args) {
        
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The Media ID to Edit
        String name = name_example; // String | Media Item Name
        Integer duration = 56; // Integer | The duration in seconds for this Media Item
        Integer retired = 56; // Integer | Flag indicating if this media is retired
        String tags = tags_example; // String | Comma separated list of Tags
        Integer updateInLayouts = 56; // Integer | Flag indicating whether to update the duration in all Layouts the Media is assigned to
        String expires = expires_example; // String | Date in Y-m-d H:i:s format, will set expiration date on the Media item
        Integer folderId = 56; // Integer | Folder ID to which this media should be assigned to
        try {
            apiInstance.libraryEdit(mediaId, name, duration, retired, tags, updateInLayouts, expires, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#libraryEdit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibraryApi;

public class LibraryApiExample {

    public static void main(String[] args) {
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The Media ID to Edit
        String name = name_example; // String | Media Item Name
        Integer duration = 56; // Integer | The duration in seconds for this Media Item
        Integer retired = 56; // Integer | Flag indicating if this media is retired
        String tags = tags_example; // String | Comma separated list of Tags
        Integer updateInLayouts = 56; // Integer | Flag indicating whether to update the duration in all Layouts the Media is assigned to
        String expires = expires_example; // String | Date in Y-m-d H:i:s format, will set expiration date on the Media item
        Integer folderId = 56; // Integer | Folder ID to which this media should be assigned to
        try {
            apiInstance.libraryEdit(mediaId, name, duration, retired, tags, updateInLayouts, expires, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#libraryEdit");
            e.printStackTrace();
        }
    }
}
Integer *mediaId = 56; // The Media ID to Edit
String *name = name_example; // Media Item Name
Integer *duration = 56; // The duration in seconds for this Media Item
Integer *retired = 56; // Flag indicating if this media is retired
String *tags = tags_example; // Comma separated list of Tags (optional)
Integer *updateInLayouts = 56; // Flag indicating whether to update the duration in all Layouts the Media is assigned to (optional)
String *expires = expires_example; // Date in Y-m-d H:i:s format, will set expiration date on the Media item (optional)
Integer *folderId = 56; // Folder ID to which this media should be assigned to (optional)

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

// Edit Media
[apiInstance libraryEditWith:mediaId
    name:name
    duration:duration
    retired:retired
    tags:tags
    updateInLayouts:updateInLayouts
    expires:expires
    folderId:folderId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LibraryApi()
var mediaId = 56; // {{Integer}} The Media ID to Edit
var name = name_example; // {{String}} Media Item Name
var duration = 56; // {{Integer}} The duration in seconds for this Media Item
var retired = 56; // {{Integer}} Flag indicating if this media is retired
var opts = { 
  'tags': tags_example, // {{String}} Comma separated list of Tags
  'updateInLayouts': 56, // {{Integer}} Flag indicating whether to update the duration in all Layouts the Media is assigned to
  'expires': expires_example, // {{String}} Date in Y-m-d H:i:s format, will set expiration date on the Media item
  'folderId': 56 // {{Integer}} Folder ID to which this media should be assigned to
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.libraryEdit(mediaId, name, duration, retired, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class libraryEditExample
    {
        public void main()
        {

            var apiInstance = new LibraryApi();
            var mediaId = 56;  // Integer | The Media ID to Edit
            var name = name_example;  // String | Media Item Name
            var duration = 56;  // Integer | The duration in seconds for this Media Item
            var retired = 56;  // Integer | Flag indicating if this media is retired
            var tags = tags_example;  // String | Comma separated list of Tags (optional) 
            var updateInLayouts = 56;  // Integer | Flag indicating whether to update the duration in all Layouts the Media is assigned to (optional) 
            var expires = expires_example;  // String | Date in Y-m-d H:i:s format, will set expiration date on the Media item (optional) 
            var folderId = 56;  // Integer | Folder ID to which this media should be assigned to (optional) 

            try
            {
                // Edit Media
                apiInstance.libraryEdit(mediaId, name, duration, retired, tags, updateInLayouts, expires, folderId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibraryApi.libraryEdit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLibraryApi();
$mediaId = 56; // Integer | The Media ID to Edit
$name = name_example; // String | Media Item Name
$duration = 56; // Integer | The duration in seconds for this Media Item
$retired = 56; // Integer | Flag indicating if this media is retired
$tags = tags_example; // String | Comma separated list of Tags
$updateInLayouts = 56; // Integer | Flag indicating whether to update the duration in all Layouts the Media is assigned to
$expires = expires_example; // String | Date in Y-m-d H:i:s format, will set expiration date on the Media item
$folderId = 56; // Integer | Folder ID to which this media should be assigned to

try {
    $api_instance->libraryEdit($mediaId, $name, $duration, $retired, $tags, $updateInLayouts, $expires, $folderId);
} catch (Exception $e) {
    echo 'Exception when calling LibraryApi->libraryEdit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibraryApi;

my $api_instance = WWW::SwaggerClient::LibraryApi->new();
my $mediaId = 56; # Integer | The Media ID to Edit
my $name = name_example; # String | Media Item Name
my $duration = 56; # Integer | The duration in seconds for this Media Item
my $retired = 56; # Integer | Flag indicating if this media is retired
my $tags = tags_example; # String | Comma separated list of Tags
my $updateInLayouts = 56; # Integer | Flag indicating whether to update the duration in all Layouts the Media is assigned to
my $expires = expires_example; # String | Date in Y-m-d H:i:s format, will set expiration date on the Media item
my $folderId = 56; # Integer | Folder ID to which this media should be assigned to

eval { 
    $api_instance->libraryEdit(mediaId => $mediaId, name => $name, duration => $duration, retired => $retired, tags => $tags, updateInLayouts => $updateInLayouts, expires => $expires, folderId => $folderId);
};
if ($@) {
    warn "Exception when calling LibraryApi->libraryEdit: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibraryApi()
mediaId = 56 # Integer | The Media ID to Edit
name = name_example # String | Media Item Name
duration = 56 # Integer | The duration in seconds for this Media Item
retired = 56 # Integer | Flag indicating if this media is retired
tags = tags_example # String | Comma separated list of Tags (optional)
updateInLayouts = 56 # Integer | Flag indicating whether to update the duration in all Layouts the Media is assigned to (optional)
expires = expires_example # String | Date in Y-m-d H:i:s format, will set expiration date on the Media item (optional)
folderId = 56 # Integer | Folder ID to which this media should be assigned to (optional)

try: 
    # Edit Media
    api_instance.library_edit(mediaId, name, duration, retired, tags=tags, updateInLayouts=updateInLayouts, expires=expires, folderId=folderId)
except ApiException as e:
    print("Exception when calling LibraryApi->libraryEdit: %s\n" % e)

Parameters

Path parameters
Name Description
mediaId*
Integer
The Media ID to Edit
Required
Query parameters
Name Description
name*
String
Media Item Name
Required
duration*
Integer
The duration in seconds for this Media Item
Required
retired*
Integer
Flag indicating if this media is retired
Required
tags
String
Comma separated list of Tags
updateInLayouts
Integer
Flag indicating whether to update the duration in all Layouts the Media is assigned to
expires
String
Date in Y-m-d H:i:s format, will set expiration date on the Media item
folderId
Integer
Folder ID to which this media should be assigned to

Responses

Status: 200 - successful operation


librarySearch

Library Search

Search the Library for this user


/library

Usage and SDK Samples

curl -X GET\
"https://premium.digitalsignagevision.com/api/library?mediaId=&media=&type=&ownerId=&retired=&tags=&exactTags=&logicalOperator=&duration=&fileSize=&ownerUserGroupId=&folderId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibraryApi;

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

public class LibraryApiExample {

    public static void main(String[] args) {
        
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | Filter by Media Id
        String media = media_example; // String | Filter by Media Name
        String type = type_example; // String | Filter by Media Type
        Integer ownerId = 56; // Integer | Filter by Owner Id
        Integer retired = 56; // Integer | Filter by Retired
        String tags = tags_example; // String | Filter by Tags - comma seperated
        Integer exactTags = 56; // Integer | A flag indicating whether to treat the tags filter as an exact match
        String logicalOperator = logicalOperator_example; // String | When filtering by multiple Tags, which logical operator should be used? AND|OR
        String duration = duration_example; // String | Filter by Duration - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number
        String fileSize = fileSize_example; // String | Filter by File Size - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number
        Integer ownerUserGroupId = 56; // Integer | Filter by users in this UserGroupId
        Integer folderId = 56; // Integer | Filter by Folder ID
        try {
            apiInstance.librarySearch(mediaId, media, type, ownerId, retired, tags, exactTags, logicalOperator, duration, fileSize, ownerUserGroupId, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#librarySearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibraryApi;

public class LibraryApiExample {

    public static void main(String[] args) {
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | Filter by Media Id
        String media = media_example; // String | Filter by Media Name
        String type = type_example; // String | Filter by Media Type
        Integer ownerId = 56; // Integer | Filter by Owner Id
        Integer retired = 56; // Integer | Filter by Retired
        String tags = tags_example; // String | Filter by Tags - comma seperated
        Integer exactTags = 56; // Integer | A flag indicating whether to treat the tags filter as an exact match
        String logicalOperator = logicalOperator_example; // String | When filtering by multiple Tags, which logical operator should be used? AND|OR
        String duration = duration_example; // String | Filter by Duration - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number
        String fileSize = fileSize_example; // String | Filter by File Size - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number
        Integer ownerUserGroupId = 56; // Integer | Filter by users in this UserGroupId
        Integer folderId = 56; // Integer | Filter by Folder ID
        try {
            apiInstance.librarySearch(mediaId, media, type, ownerId, retired, tags, exactTags, logicalOperator, duration, fileSize, ownerUserGroupId, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#librarySearch");
            e.printStackTrace();
        }
    }
}
Integer *mediaId = 56; // Filter by Media Id (optional)
String *media = media_example; // Filter by Media Name (optional)
String *type = type_example; // Filter by Media Type (optional)
Integer *ownerId = 56; // Filter by Owner Id (optional)
Integer *retired = 56; // Filter by Retired (optional)
String *tags = tags_example; // Filter by Tags - comma seperated (optional)
Integer *exactTags = 56; // A flag indicating whether to treat the tags filter as an exact match (optional)
String *logicalOperator = logicalOperator_example; // When filtering by multiple Tags, which logical operator should be used? AND|OR (optional)
String *duration = duration_example; // Filter by Duration - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number (optional)
String *fileSize = fileSize_example; // Filter by File Size - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number (optional)
Integer *ownerUserGroupId = 56; // Filter by users in this UserGroupId (optional)
Integer *folderId = 56; // Filter by Folder ID (optional)

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

// Library Search
[apiInstance librarySearchWith:mediaId
    media:media
    type:type
    ownerId:ownerId
    retired:retired
    tags:tags
    exactTags:exactTags
    logicalOperator:logicalOperator
    duration:duration
    fileSize:fileSize
    ownerUserGroupId:ownerUserGroupId
    folderId:folderId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LibraryApi()
var opts = { 
  'mediaId': 56, // {{Integer}} Filter by Media Id
  'media': media_example, // {{String}} Filter by Media Name
  'type': type_example, // {{String}} Filter by Media Type
  'ownerId': 56, // {{Integer}} Filter by Owner Id
  'retired': 56, // {{Integer}} Filter by Retired
  'tags': tags_example, // {{String}} Filter by Tags - comma seperated
  'exactTags': 56, // {{Integer}} A flag indicating whether to treat the tags filter as an exact match
  'logicalOperator': logicalOperator_example, // {{String}} When filtering by multiple Tags, which logical operator should be used? AND|OR
  'duration': duration_example, // {{String}} Filter by Duration - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number
  'fileSize': fileSize_example, // {{String}} Filter by File Size - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number
  'ownerUserGroupId': 56, // {{Integer}} Filter by users in this UserGroupId
  'folderId': 56 // {{Integer}} Filter by Folder ID
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.librarySearch(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class librarySearchExample
    {
        public void main()
        {

            var apiInstance = new LibraryApi();
            var mediaId = 56;  // Integer | Filter by Media Id (optional) 
            var media = media_example;  // String | Filter by Media Name (optional) 
            var type = type_example;  // String | Filter by Media Type (optional) 
            var ownerId = 56;  // Integer | Filter by Owner Id (optional) 
            var retired = 56;  // Integer | Filter by Retired (optional) 
            var tags = tags_example;  // String | Filter by Tags - comma seperated (optional) 
            var exactTags = 56;  // Integer | A flag indicating whether to treat the tags filter as an exact match (optional) 
            var logicalOperator = logicalOperator_example;  // String | When filtering by multiple Tags, which logical operator should be used? AND|OR (optional) 
            var duration = duration_example;  // String | Filter by Duration - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number (optional) 
            var fileSize = fileSize_example;  // String | Filter by File Size - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number (optional) 
            var ownerUserGroupId = 56;  // Integer | Filter by users in this UserGroupId (optional) 
            var folderId = 56;  // Integer | Filter by Folder ID (optional) 

            try
            {
                // Library Search
                apiInstance.librarySearch(mediaId, media, type, ownerId, retired, tags, exactTags, logicalOperator, duration, fileSize, ownerUserGroupId, folderId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibraryApi.librarySearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLibraryApi();
$mediaId = 56; // Integer | Filter by Media Id
$media = media_example; // String | Filter by Media Name
$type = type_example; // String | Filter by Media Type
$ownerId = 56; // Integer | Filter by Owner Id
$retired = 56; // Integer | Filter by Retired
$tags = tags_example; // String | Filter by Tags - comma seperated
$exactTags = 56; // Integer | A flag indicating whether to treat the tags filter as an exact match
$logicalOperator = logicalOperator_example; // String | When filtering by multiple Tags, which logical operator should be used? AND|OR
$duration = duration_example; // String | Filter by Duration - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number
$fileSize = fileSize_example; // String | Filter by File Size - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number
$ownerUserGroupId = 56; // Integer | Filter by users in this UserGroupId
$folderId = 56; // Integer | Filter by Folder ID

try {
    $api_instance->librarySearch($mediaId, $media, $type, $ownerId, $retired, $tags, $exactTags, $logicalOperator, $duration, $fileSize, $ownerUserGroupId, $folderId);
} catch (Exception $e) {
    echo 'Exception when calling LibraryApi->librarySearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibraryApi;

my $api_instance = WWW::SwaggerClient::LibraryApi->new();
my $mediaId = 56; # Integer | Filter by Media Id
my $media = media_example; # String | Filter by Media Name
my $type = type_example; # String | Filter by Media Type
my $ownerId = 56; # Integer | Filter by Owner Id
my $retired = 56; # Integer | Filter by Retired
my $tags = tags_example; # String | Filter by Tags - comma seperated
my $exactTags = 56; # Integer | A flag indicating whether to treat the tags filter as an exact match
my $logicalOperator = logicalOperator_example; # String | When filtering by multiple Tags, which logical operator should be used? AND|OR
my $duration = duration_example; # String | Filter by Duration - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number
my $fileSize = fileSize_example; # String | Filter by File Size - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number
my $ownerUserGroupId = 56; # Integer | Filter by users in this UserGroupId
my $folderId = 56; # Integer | Filter by Folder ID

eval { 
    $api_instance->librarySearch(mediaId => $mediaId, media => $media, type => $type, ownerId => $ownerId, retired => $retired, tags => $tags, exactTags => $exactTags, logicalOperator => $logicalOperator, duration => $duration, fileSize => $fileSize, ownerUserGroupId => $ownerUserGroupId, folderId => $folderId);
};
if ($@) {
    warn "Exception when calling LibraryApi->librarySearch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibraryApi()
mediaId = 56 # Integer | Filter by Media Id (optional)
media = media_example # String | Filter by Media Name (optional)
type = type_example # String | Filter by Media Type (optional)
ownerId = 56 # Integer | Filter by Owner Id (optional)
retired = 56 # Integer | Filter by Retired (optional)
tags = tags_example # String | Filter by Tags - comma seperated (optional)
exactTags = 56 # Integer | A flag indicating whether to treat the tags filter as an exact match (optional)
logicalOperator = logicalOperator_example # String | When filtering by multiple Tags, which logical operator should be used? AND|OR (optional)
duration = duration_example # String | Filter by Duration - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number (optional)
fileSize = fileSize_example # String | Filter by File Size - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number (optional)
ownerUserGroupId = 56 # Integer | Filter by users in this UserGroupId (optional)
folderId = 56 # Integer | Filter by Folder ID (optional)

try: 
    # Library Search
    api_instance.library_search(mediaId=mediaId, media=media, type=type, ownerId=ownerId, retired=retired, tags=tags, exactTags=exactTags, logicalOperator=logicalOperator, duration=duration, fileSize=fileSize, ownerUserGroupId=ownerUserGroupId, folderId=folderId)
except ApiException as e:
    print("Exception when calling LibraryApi->librarySearch: %s\n" % e)

Parameters

Query parameters
Name Description
mediaId
Integer
Filter by Media Id
media
String
Filter by Media Name
type
String
Filter by Media Type
ownerId
Integer
Filter by Owner Id
retired
Integer
Filter by Retired
tags
String
Filter by Tags - comma seperated
exactTags
Integer
A flag indicating whether to treat the tags filter as an exact match
logicalOperator
String
When filtering by multiple Tags, which logical operator should be used? AND|OR
duration
String
Filter by Duration - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number
fileSize
String
Filter by File Size - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number
ownerUserGroupId
Integer
Filter by users in this UserGroupId
folderId
Integer
Filter by Folder ID

Responses

Status: 200 - successful operation


librarySearchAll

Library Search All

Search all library files from local and connectors


/library/search

Usage and SDK Samples

curl -X GET\
"https://premium.digitalsignagevision.com/api/library/search"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibraryApi;

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

public class LibraryApiExample {

    public static void main(String[] args) {
        
        LibraryApi apiInstance = new LibraryApi();
        try {
            apiInstance.librarySearchAll();
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#librarySearchAll");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibraryApi;

public class LibraryApiExample {

    public static void main(String[] args) {
        LibraryApi apiInstance = new LibraryApi();
        try {
            apiInstance.librarySearchAll();
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#librarySearchAll");
            e.printStackTrace();
        }
    }
}

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

// Library Search All
[apiInstance librarySearchAllWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LibraryApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.librarySearchAll(callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class librarySearchAllExample
    {
        public void main()
        {

            var apiInstance = new LibraryApi();

            try
            {
                // Library Search All
                apiInstance.librarySearchAll();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibraryApi.librarySearchAll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLibraryApi();

try {
    $api_instance->librarySearchAll();
} catch (Exception $e) {
    echo 'Exception when calling LibraryApi->librarySearchAll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibraryApi;

my $api_instance = WWW::SwaggerClient::LibraryApi->new();

eval { 
    $api_instance->librarySearchAll();
};
if ($@) {
    warn "Exception when calling LibraryApi->librarySearchAll: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibraryApi()

try: 
    # Library Search All
    api_instance.library_search_all()
except ApiException as e:
    print("Exception when calling LibraryApi->librarySearchAll: %s\n" % e)

Parameters

Responses

Status: 200 - successful operation


libraryTidy

Tidy Library

Routine tidy of the library, removing unused files.


/library/tidy

Usage and SDK Samples

curl -X DELETE\
"https://premium.digitalsignagevision.com/api/library/tidy?tidyGenericFiles="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibraryApi;

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

public class LibraryApiExample {

    public static void main(String[] args) {
        
        LibraryApi apiInstance = new LibraryApi();
        Integer tidyGenericFiles = 56; // Integer | Also delete generic files?
        try {
            apiInstance.libraryTidy(tidyGenericFiles);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#libraryTidy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibraryApi;

public class LibraryApiExample {

    public static void main(String[] args) {
        LibraryApi apiInstance = new LibraryApi();
        Integer tidyGenericFiles = 56; // Integer | Also delete generic files?
        try {
            apiInstance.libraryTidy(tidyGenericFiles);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#libraryTidy");
            e.printStackTrace();
        }
    }
}
Integer *tidyGenericFiles = 56; // Also delete generic files? (optional)

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

// Tidy Library
[apiInstance libraryTidyWith:tidyGenericFiles
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LibraryApi()
var opts = { 
  'tidyGenericFiles': 56 // {{Integer}} Also delete generic files?
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.libraryTidy(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class libraryTidyExample
    {
        public void main()
        {

            var apiInstance = new LibraryApi();
            var tidyGenericFiles = 56;  // Integer | Also delete generic files? (optional) 

            try
            {
                // Tidy Library
                apiInstance.libraryTidy(tidyGenericFiles);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibraryApi.libraryTidy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLibraryApi();
$tidyGenericFiles = 56; // Integer | Also delete generic files?

try {
    $api_instance->libraryTidy($tidyGenericFiles);
} catch (Exception $e) {
    echo 'Exception when calling LibraryApi->libraryTidy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibraryApi;

my $api_instance = WWW::SwaggerClient::LibraryApi->new();
my $tidyGenericFiles = 56; # Integer | Also delete generic files?

eval { 
    $api_instance->libraryTidy(tidyGenericFiles => $tidyGenericFiles);
};
if ($@) {
    warn "Exception when calling LibraryApi->libraryTidy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibraryApi()
tidyGenericFiles = 56 # Integer | Also delete generic files? (optional)

try: 
    # Tidy Library
    api_instance.library_tidy(tidyGenericFiles=tidyGenericFiles)
except ApiException as e:
    print("Exception when calling LibraryApi->libraryTidy: %s\n" % e)

Parameters

Query parameters
Name Description
tidyGenericFiles
Integer
Also delete generic files?

Responses

Status: 200 - successful operation


libraryUsageLayoutsReport

Get Library Item Usage Report for Layouts

Get the records for the library item usage report for Layouts


/library/usage/layouts/{mediaId}

Usage and SDK Samples

curl -X GET\
"https://premium.digitalsignagevision.com/api/library/usage/layouts/{mediaId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibraryApi;

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

public class LibraryApiExample {

    public static void main(String[] args) {
        
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The Media Id
        try {
            apiInstance.libraryUsageLayoutsReport(mediaId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#libraryUsageLayoutsReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibraryApi;

public class LibraryApiExample {

    public static void main(String[] args) {
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The Media Id
        try {
            apiInstance.libraryUsageLayoutsReport(mediaId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#libraryUsageLayoutsReport");
            e.printStackTrace();
        }
    }
}
Integer *mediaId = 56; // The Media Id

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

// Get Library Item Usage Report for Layouts
[apiInstance libraryUsageLayoutsReportWith:mediaId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LibraryApi()
var mediaId = 56; // {{Integer}} The Media Id

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

namespace Example
{
    public class libraryUsageLayoutsReportExample
    {
        public void main()
        {

            var apiInstance = new LibraryApi();
            var mediaId = 56;  // Integer | The Media Id

            try
            {
                // Get Library Item Usage Report for Layouts
                apiInstance.libraryUsageLayoutsReport(mediaId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibraryApi.libraryUsageLayoutsReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLibraryApi();
$mediaId = 56; // Integer | The Media Id

try {
    $api_instance->libraryUsageLayoutsReport($mediaId);
} catch (Exception $e) {
    echo 'Exception when calling LibraryApi->libraryUsageLayoutsReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibraryApi;

my $api_instance = WWW::SwaggerClient::LibraryApi->new();
my $mediaId = 56; # Integer | The Media Id

eval { 
    $api_instance->libraryUsageLayoutsReport(mediaId => $mediaId);
};
if ($@) {
    warn "Exception when calling LibraryApi->libraryUsageLayoutsReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibraryApi()
mediaId = 56 # Integer | The Media Id

try: 
    # Get Library Item Usage Report for Layouts
    api_instance.library_usage_layouts_report(mediaId)
except ApiException as e:
    print("Exception when calling LibraryApi->libraryUsageLayoutsReport: %s\n" % e)

Parameters

Path parameters
Name Description
mediaId*
Integer
The Media Id
Required

Responses

Status: 200 - successful operation


libraryUsageReport

Get Library Item Usage Report

Get the records for the library item usage report


/library/usage/{mediaId}

Usage and SDK Samples

curl -X GET\
"https://premium.digitalsignagevision.com/api/library/usage/{mediaId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibraryApi;

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

public class LibraryApiExample {

    public static void main(String[] args) {
        
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The Media Id
        try {
            apiInstance.libraryUsageReport(mediaId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#libraryUsageReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibraryApi;

public class LibraryApiExample {

    public static void main(String[] args) {
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The Media Id
        try {
            apiInstance.libraryUsageReport(mediaId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#libraryUsageReport");
            e.printStackTrace();
        }
    }
}
Integer *mediaId = 56; // The Media Id

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

// Get Library Item Usage Report
[apiInstance libraryUsageReportWith:mediaId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LibraryApi()
var mediaId = 56; // {{Integer}} The Media Id

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

namespace Example
{
    public class libraryUsageReportExample
    {
        public void main()
        {

            var apiInstance = new LibraryApi();
            var mediaId = 56;  // Integer | The Media Id

            try
            {
                // Get Library Item Usage Report
                apiInstance.libraryUsageReport(mediaId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibraryApi.libraryUsageReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLibraryApi();
$mediaId = 56; // Integer | The Media Id

try {
    $api_instance->libraryUsageReport($mediaId);
} catch (Exception $e) {
    echo 'Exception when calling LibraryApi->libraryUsageReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibraryApi;

my $api_instance = WWW::SwaggerClient::LibraryApi->new();
my $mediaId = 56; # Integer | The Media Id

eval { 
    $api_instance->libraryUsageReport(mediaId => $mediaId);
};
if ($@) {
    warn "Exception when calling LibraryApi->libraryUsageReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibraryApi()
mediaId = 56 # Integer | The Media Id

try: 
    # Get Library Item Usage Report
    api_instance.library_usage_report(mediaId)
except ApiException as e:
    print("Exception when calling LibraryApi->libraryUsageReport: %s\n" % e)

Parameters

Path parameters
Name Description
mediaId*
Integer
The Media Id
Required

Responses

Status: 200 - successful operation


mediaCopy

Copy Media

Copy a Media, providing a new name and tags if applicable


/library/copy/{mediaId}

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/library/copy/{mediaId}?name=&tags="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibraryApi;

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

public class LibraryApiExample {

    public static void main(String[] args) {
        
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The media ID to Copy
        String name = name_example; // String | The name for the new Media
        String tags = tags_example; // String | The Optional tags for new Media
        try {
            apiInstance.mediaCopy(mediaId, name, tags);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#mediaCopy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibraryApi;

public class LibraryApiExample {

    public static void main(String[] args) {
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The media ID to Copy
        String name = name_example; // String | The name for the new Media
        String tags = tags_example; // String | The Optional tags for new Media
        try {
            apiInstance.mediaCopy(mediaId, name, tags);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#mediaCopy");
            e.printStackTrace();
        }
    }
}
Integer *mediaId = 56; // The media ID to Copy
String *name = name_example; // The name for the new Media
String *tags = tags_example; // The Optional tags for new Media (optional)

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

// Copy Media
[apiInstance mediaCopyWith:mediaId
    name:name
    tags:tags
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LibraryApi()
var mediaId = 56; // {{Integer}} The media ID to Copy
var name = name_example; // {{String}} The name for the new Media
var opts = { 
  'tags': tags_example // {{String}} The Optional tags for new Media
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.mediaCopy(mediaId, name, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class mediaCopyExample
    {
        public void main()
        {

            var apiInstance = new LibraryApi();
            var mediaId = 56;  // Integer | The media ID to Copy
            var name = name_example;  // String | The name for the new Media
            var tags = tags_example;  // String | The Optional tags for new Media (optional) 

            try
            {
                // Copy Media
                apiInstance.mediaCopy(mediaId, name, tags);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibraryApi.mediaCopy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLibraryApi();
$mediaId = 56; // Integer | The media ID to Copy
$name = name_example; // String | The name for the new Media
$tags = tags_example; // String | The Optional tags for new Media

try {
    $api_instance->mediaCopy($mediaId, $name, $tags);
} catch (Exception $e) {
    echo 'Exception when calling LibraryApi->mediaCopy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibraryApi;

my $api_instance = WWW::SwaggerClient::LibraryApi->new();
my $mediaId = 56; # Integer | The media ID to Copy
my $name = name_example; # String | The name for the new Media
my $tags = tags_example; # String | The Optional tags for new Media

eval { 
    $api_instance->mediaCopy(mediaId => $mediaId, name => $name, tags => $tags);
};
if ($@) {
    warn "Exception when calling LibraryApi->mediaCopy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibraryApi()
mediaId = 56 # Integer | The media ID to Copy
name = name_example # String | The name for the new Media
tags = tags_example # String | The Optional tags for new Media (optional)

try: 
    # Copy Media
    api_instance.media_copy(mediaId, name, tags=tags)
except ApiException as e:
    print("Exception when calling LibraryApi->mediaCopy: %s\n" % e)

Parameters

Path parameters
Name Description
mediaId*
Integer
The media ID to Copy
Required
Query parameters
Name Description
name*
String
The name for the new Media
Required
tags
String
The Optional tags for new Media

Responses

Status: 201 - successful operation

Name Type Format Description
Location String

mediaIsUsed

Media usage check

Checks if a Media is being used


/library/{mediaId}/isused/

Usage and SDK Samples

curl -X GET\
"https://premium.digitalsignagevision.com/api/library/{mediaId}/isused/"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibraryApi;

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

public class LibraryApiExample {

    public static void main(String[] args) {
        
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The Media Id
        try {
            apiInstance.mediaIsUsed(mediaId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#mediaIsUsed");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibraryApi;

public class LibraryApiExample {

    public static void main(String[] args) {
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The Media Id
        try {
            apiInstance.mediaIsUsed(mediaId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#mediaIsUsed");
            e.printStackTrace();
        }
    }
}
Integer *mediaId = 56; // The Media Id

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

// Media usage check
[apiInstance mediaIsUsedWith:mediaId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LibraryApi()
var mediaId = 56; // {{Integer}} The Media Id

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

namespace Example
{
    public class mediaIsUsedExample
    {
        public void main()
        {

            var apiInstance = new LibraryApi();
            var mediaId = 56;  // Integer | The Media Id

            try
            {
                // Media usage check
                apiInstance.mediaIsUsed(mediaId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibraryApi.mediaIsUsed: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLibraryApi();
$mediaId = 56; // Integer | The Media Id

try {
    $api_instance->mediaIsUsed($mediaId);
} catch (Exception $e) {
    echo 'Exception when calling LibraryApi->mediaIsUsed: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibraryApi;

my $api_instance = WWW::SwaggerClient::LibraryApi->new();
my $mediaId = 56; # Integer | The Media Id

eval { 
    $api_instance->mediaIsUsed(mediaId => $mediaId);
};
if ($@) {
    warn "Exception when calling LibraryApi->mediaIsUsed: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibraryApi()
mediaId = 56 # Integer | The Media Id

try: 
    # Media usage check
    api_instance.media_is_used(mediaId)
except ApiException as e:
    print("Exception when calling LibraryApi->mediaIsUsed: %s\n" % e)

Parameters

Path parameters
Name Description
mediaId*
Integer
The Media Id
Required

Responses

Status: 200 - successful operation


mediaSetEnableStat

Enable Stats Collection

Set Enable Stats Collection? to use for the collection of Proof of Play statistics for a media.


/library/setenablestat/{mediaId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/library/setenablestat/{mediaId}?enableStat="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibraryApi;

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

public class LibraryApiExample {

    public static void main(String[] args) {
        
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The Media ID
        String enableStat = enableStat_example; // String | The option to enable the collection of Media Proof of Play statistics
        try {
            apiInstance.mediaSetEnableStat(mediaId, enableStat);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#mediaSetEnableStat");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibraryApi;

public class LibraryApiExample {

    public static void main(String[] args) {
        LibraryApi apiInstance = new LibraryApi();
        Integer mediaId = 56; // Integer | The Media ID
        String enableStat = enableStat_example; // String | The option to enable the collection of Media Proof of Play statistics
        try {
            apiInstance.mediaSetEnableStat(mediaId, enableStat);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#mediaSetEnableStat");
            e.printStackTrace();
        }
    }
}
Integer *mediaId = 56; // The Media ID
String *enableStat = enableStat_example; // The option to enable the collection of Media Proof of Play statistics

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

// Enable Stats Collection
[apiInstance mediaSetEnableStatWith:mediaId
    enableStat:enableStat
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LibraryApi()
var mediaId = 56; // {{Integer}} The Media ID
var enableStat = enableStat_example; // {{String}} The option to enable the collection of Media Proof of Play statistics

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.mediaSetEnableStat(mediaId, enableStat, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class mediaSetEnableStatExample
    {
        public void main()
        {

            var apiInstance = new LibraryApi();
            var mediaId = 56;  // Integer | The Media ID
            var enableStat = enableStat_example;  // String | The option to enable the collection of Media Proof of Play statistics

            try
            {
                // Enable Stats Collection
                apiInstance.mediaSetEnableStat(mediaId, enableStat);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibraryApi.mediaSetEnableStat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLibraryApi();
$mediaId = 56; // Integer | The Media ID
$enableStat = enableStat_example; // String | The option to enable the collection of Media Proof of Play statistics

try {
    $api_instance->mediaSetEnableStat($mediaId, $enableStat);
} catch (Exception $e) {
    echo 'Exception when calling LibraryApi->mediaSetEnableStat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibraryApi;

my $api_instance = WWW::SwaggerClient::LibraryApi->new();
my $mediaId = 56; # Integer | The Media ID
my $enableStat = enableStat_example; # String | The option to enable the collection of Media Proof of Play statistics

eval { 
    $api_instance->mediaSetEnableStat(mediaId => $mediaId, enableStat => $enableStat);
};
if ($@) {
    warn "Exception when calling LibraryApi->mediaSetEnableStat: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibraryApi()
mediaId = 56 # Integer | The Media ID
enableStat = enableStat_example # String | The option to enable the collection of Media Proof of Play statistics

try: 
    # Enable Stats Collection
    api_instance.media_set_enable_stat(mediaId, enableStat)
except ApiException as e:
    print("Exception when calling LibraryApi->mediaSetEnableStat: %s\n" % e)

Parameters

Path parameters
Name Description
mediaId*
Integer
The Media ID
Required
Query parameters
Name Description
enableStat*
String
The option to enable the collection of Media Proof of Play statistics
Required

Responses

Status: 204 - successful operation


uploadFromUrl

Upload Media from URL

Upload Media to CMS library from an external URL


/library/uploadUrl

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/library/uploadUrl?url=&type=&extension=&enableStat=&optionalName=&expires=&folderId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LibraryApi;

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

public class LibraryApiExample {

    public static void main(String[] args) {
        
        LibraryApi apiInstance = new LibraryApi();
        String url = url_example; // String | The URL to the media
        String type = type_example; // String | The type of the media, image, video etc
        String extension = extension_example; // String | Optional extension of the media, jpg, png etc. If not set in the request it will be retrieved from the headers
        String enableStat = enableStat_example; // String | The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.
        String optionalName = optionalName_example; // String | An optional name for this media file, if left empty it will default to the file name
        String expires = expires_example; // String | Date in Y-m-d H:i:s format, will set expiration date on the Media item
        Integer folderId = 56; // Integer | Folder ID to which this media should be assigned to
        try {
            apiInstance.uploadFromUrl(url, type, extension, enableStat, optionalName, expires, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#uploadFromUrl");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.LibraryApi;

public class LibraryApiExample {

    public static void main(String[] args) {
        LibraryApi apiInstance = new LibraryApi();
        String url = url_example; // String | The URL to the media
        String type = type_example; // String | The type of the media, image, video etc
        String extension = extension_example; // String | Optional extension of the media, jpg, png etc. If not set in the request it will be retrieved from the headers
        String enableStat = enableStat_example; // String | The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.
        String optionalName = optionalName_example; // String | An optional name for this media file, if left empty it will default to the file name
        String expires = expires_example; // String | Date in Y-m-d H:i:s format, will set expiration date on the Media item
        Integer folderId = 56; // Integer | Folder ID to which this media should be assigned to
        try {
            apiInstance.uploadFromUrl(url, type, extension, enableStat, optionalName, expires, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling LibraryApi#uploadFromUrl");
            e.printStackTrace();
        }
    }
}
String *url = url_example; // The URL to the media
String *type = type_example; // The type of the media, image, video etc
String *extension = extension_example; // Optional extension of the media, jpg, png etc. If not set in the request it will be retrieved from the headers (optional)
String *enableStat = enableStat_example; // The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit. (optional)
String *optionalName = optionalName_example; // An optional name for this media file, if left empty it will default to the file name (optional)
String *expires = expires_example; // Date in Y-m-d H:i:s format, will set expiration date on the Media item (optional)
Integer *folderId = 56; // Folder ID to which this media should be assigned to (optional)

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

// Upload Media from URL
[apiInstance uploadFromUrlWith:url
    type:type
    extension:extension
    enableStat:enableStat
    optionalName:optionalName
    expires:expires
    folderId:folderId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.LibraryApi()
var url = url_example; // {{String}} The URL to the media
var type = type_example; // {{String}} The type of the media, image, video etc
var opts = { 
  'extension': extension_example, // {{String}} Optional extension of the media, jpg, png etc. If not set in the request it will be retrieved from the headers
  'enableStat': enableStat_example, // {{String}} The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.
  'optionalName': optionalName_example, // {{String}} An optional name for this media file, if left empty it will default to the file name
  'expires': expires_example, // {{String}} Date in Y-m-d H:i:s format, will set expiration date on the Media item
  'folderId': 56 // {{Integer}} Folder ID to which this media should be assigned to
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.uploadFromUrl(url, type, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class uploadFromUrlExample
    {
        public void main()
        {

            var apiInstance = new LibraryApi();
            var url = url_example;  // String | The URL to the media
            var type = type_example;  // String | The type of the media, image, video etc
            var extension = extension_example;  // String | Optional extension of the media, jpg, png etc. If not set in the request it will be retrieved from the headers (optional) 
            var enableStat = enableStat_example;  // String | The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit. (optional) 
            var optionalName = optionalName_example;  // String | An optional name for this media file, if left empty it will default to the file name (optional) 
            var expires = expires_example;  // String | Date in Y-m-d H:i:s format, will set expiration date on the Media item (optional) 
            var folderId = 56;  // Integer | Folder ID to which this media should be assigned to (optional) 

            try
            {
                // Upload Media from URL
                apiInstance.uploadFromUrl(url, type, extension, enableStat, optionalName, expires, folderId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LibraryApi.uploadFromUrl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiLibraryApi();
$url = url_example; // String | The URL to the media
$type = type_example; // String | The type of the media, image, video etc
$extension = extension_example; // String | Optional extension of the media, jpg, png etc. If not set in the request it will be retrieved from the headers
$enableStat = enableStat_example; // String | The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.
$optionalName = optionalName_example; // String | An optional name for this media file, if left empty it will default to the file name
$expires = expires_example; // String | Date in Y-m-d H:i:s format, will set expiration date on the Media item
$folderId = 56; // Integer | Folder ID to which this media should be assigned to

try {
    $api_instance->uploadFromUrl($url, $type, $extension, $enableStat, $optionalName, $expires, $folderId);
} catch (Exception $e) {
    echo 'Exception when calling LibraryApi->uploadFromUrl: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::LibraryApi;

my $api_instance = WWW::SwaggerClient::LibraryApi->new();
my $url = url_example; # String | The URL to the media
my $type = type_example; # String | The type of the media, image, video etc
my $extension = extension_example; # String | Optional extension of the media, jpg, png etc. If not set in the request it will be retrieved from the headers
my $enableStat = enableStat_example; # String | The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.
my $optionalName = optionalName_example; # String | An optional name for this media file, if left empty it will default to the file name
my $expires = expires_example; # String | Date in Y-m-d H:i:s format, will set expiration date on the Media item
my $folderId = 56; # Integer | Folder ID to which this media should be assigned to

eval { 
    $api_instance->uploadFromUrl(url => $url, type => $type, extension => $extension, enableStat => $enableStat, optionalName => $optionalName, expires => $expires, folderId => $folderId);
};
if ($@) {
    warn "Exception when calling LibraryApi->uploadFromUrl: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.LibraryApi()
url = url_example # String | The URL to the media
type = type_example # String | The type of the media, image, video etc
extension = extension_example # String | Optional extension of the media, jpg, png etc. If not set in the request it will be retrieved from the headers (optional)
enableStat = enableStat_example # String | The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit. (optional)
optionalName = optionalName_example # String | An optional name for this media file, if left empty it will default to the file name (optional)
expires = expires_example # String | Date in Y-m-d H:i:s format, will set expiration date on the Media item (optional)
folderId = 56 # Integer | Folder ID to which this media should be assigned to (optional)

try: 
    # Upload Media from URL
    api_instance.upload_from_url(url, type, extension=extension, enableStat=enableStat, optionalName=optionalName, expires=expires, folderId=folderId)
except ApiException as e:
    print("Exception when calling LibraryApi->uploadFromUrl: %s\n" % e)

Parameters

Query parameters
Name Description
url*
String
The URL to the media
Required
type*
String
The type of the media, image, video etc
Required
extension
String
Optional extension of the media, jpg, png etc. If not set in the request it will be retrieved from the headers
enableStat
String
The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.
optionalName
String
An optional name for this media file, if left empty it will default to the file name
expires
String
Date in Y-m-d H:i:s format, will set expiration date on the Media item
folderId
Integer
Folder ID to which this media should be assigned to

Responses

Status: 201 - successful operation

Name Type Format Description
Location String

Playlist

playlistAdd

Add a Playlist

Add a new Playlist


/playlist

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/playlist?name=&tags=&isDynamic=&filterMediaName=&logicalOperatorName=&filterMediaTag=&exactTags=&logicalOperator=&maxNumberOfItems=&folderId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaylistApi;

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

public class PlaylistApiExample {

    public static void main(String[] args) {
        
        PlaylistApi apiInstance = new PlaylistApi();
        String name = name_example; // String | The Name for this Playlist
        Integer isDynamic = 56; // Integer | Is this Playlist Dynamic?
        String tags = tags_example; // String | Tags
        String filterMediaName = filterMediaName_example; // String | Add Library Media matching the name filter provided
        String logicalOperatorName = logicalOperatorName_example; // String | When filtering by multiple names in name filter, which logical operator should be used? AND|OR
        String filterMediaTag = filterMediaTag_example; // String | Add Library Media matching the tag filter provided
        Integer exactTags = 56; // Integer | When filtering by Tags, should we use exact match?
        String logicalOperator = logicalOperator_example; // String | When filtering by Tags, which logical operator should be used? AND|OR
        Integer maxNumberOfItems = 56; // Integer | Maximum number of items that can be assigned to this Playlist (dynamic Playlist only)
        Integer folderId = 56; // Integer | Folder ID to which this object should be assigned to
        try {
            apiInstance.playlistAdd(name, isDynamic, tags, filterMediaName, logicalOperatorName, filterMediaTag, exactTags, logicalOperator, maxNumberOfItems, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistAdd");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaylistApi;

public class PlaylistApiExample {

    public static void main(String[] args) {
        PlaylistApi apiInstance = new PlaylistApi();
        String name = name_example; // String | The Name for this Playlist
        Integer isDynamic = 56; // Integer | Is this Playlist Dynamic?
        String tags = tags_example; // String | Tags
        String filterMediaName = filterMediaName_example; // String | Add Library Media matching the name filter provided
        String logicalOperatorName = logicalOperatorName_example; // String | When filtering by multiple names in name filter, which logical operator should be used? AND|OR
        String filterMediaTag = filterMediaTag_example; // String | Add Library Media matching the tag filter provided
        Integer exactTags = 56; // Integer | When filtering by Tags, should we use exact match?
        String logicalOperator = logicalOperator_example; // String | When filtering by Tags, which logical operator should be used? AND|OR
        Integer maxNumberOfItems = 56; // Integer | Maximum number of items that can be assigned to this Playlist (dynamic Playlist only)
        Integer folderId = 56; // Integer | Folder ID to which this object should be assigned to
        try {
            apiInstance.playlistAdd(name, isDynamic, tags, filterMediaName, logicalOperatorName, filterMediaTag, exactTags, logicalOperator, maxNumberOfItems, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistAdd");
            e.printStackTrace();
        }
    }
}
String *name = name_example; // The Name for this Playlist
Integer *isDynamic = 56; // Is this Playlist Dynamic?
String *tags = tags_example; // Tags (optional)
String *filterMediaName = filterMediaName_example; // Add Library Media matching the name filter provided (optional)
String *logicalOperatorName = logicalOperatorName_example; // When filtering by multiple names in name filter, which logical operator should be used? AND|OR (optional)
String *filterMediaTag = filterMediaTag_example; // Add Library Media matching the tag filter provided (optional)
Integer *exactTags = 56; // When filtering by Tags, should we use exact match? (optional)
String *logicalOperator = logicalOperator_example; // When filtering by Tags, which logical operator should be used? AND|OR (optional)
Integer *maxNumberOfItems = 56; // Maximum number of items that can be assigned to this Playlist (dynamic Playlist only) (optional)
Integer *folderId = 56; // Folder ID to which this object should be assigned to (optional)

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

// Add a Playlist
[apiInstance playlistAddWith:name
    isDynamic:isDynamic
    tags:tags
    filterMediaName:filterMediaName
    logicalOperatorName:logicalOperatorName
    filterMediaTag:filterMediaTag
    exactTags:exactTags
    logicalOperator:logicalOperator
    maxNumberOfItems:maxNumberOfItems
    folderId:folderId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.PlaylistApi()
var name = name_example; // {{String}} The Name for this Playlist
var isDynamic = 56; // {{Integer}} Is this Playlist Dynamic?
var opts = { 
  'tags': tags_example, // {{String}} Tags
  'filterMediaName': filterMediaName_example, // {{String}} Add Library Media matching the name filter provided
  'logicalOperatorName': logicalOperatorName_example, // {{String}} When filtering by multiple names in name filter, which logical operator should be used? AND|OR
  'filterMediaTag': filterMediaTag_example, // {{String}} Add Library Media matching the tag filter provided
  'exactTags': 56, // {{Integer}} When filtering by Tags, should we use exact match?
  'logicalOperator': logicalOperator_example, // {{String}} When filtering by Tags, which logical operator should be used? AND|OR
  'maxNumberOfItems': 56, // {{Integer}} Maximum number of items that can be assigned to this Playlist (dynamic Playlist only)
  'folderId': 56 // {{Integer}} Folder ID to which this object should be assigned to
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.playlistAdd(name, isDynamic, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class playlistAddExample
    {
        public void main()
        {

            var apiInstance = new PlaylistApi();
            var name = name_example;  // String | The Name for this Playlist
            var isDynamic = 56;  // Integer | Is this Playlist Dynamic?
            var tags = tags_example;  // String | Tags (optional) 
            var filterMediaName = filterMediaName_example;  // String | Add Library Media matching the name filter provided (optional) 
            var logicalOperatorName = logicalOperatorName_example;  // String | When filtering by multiple names in name filter, which logical operator should be used? AND|OR (optional) 
            var filterMediaTag = filterMediaTag_example;  // String | Add Library Media matching the tag filter provided (optional) 
            var exactTags = 56;  // Integer | When filtering by Tags, should we use exact match? (optional) 
            var logicalOperator = logicalOperator_example;  // String | When filtering by Tags, which logical operator should be used? AND|OR (optional) 
            var maxNumberOfItems = 56;  // Integer | Maximum number of items that can be assigned to this Playlist (dynamic Playlist only) (optional) 
            var folderId = 56;  // Integer | Folder ID to which this object should be assigned to (optional) 

            try
            {
                // Add a Playlist
                apiInstance.playlistAdd(name, isDynamic, tags, filterMediaName, logicalOperatorName, filterMediaTag, exactTags, logicalOperator, maxNumberOfItems, folderId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaylistApi.playlistAdd: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPlaylistApi();
$name = name_example; // String | The Name for this Playlist
$isDynamic = 56; // Integer | Is this Playlist Dynamic?
$tags = tags_example; // String | Tags
$filterMediaName = filterMediaName_example; // String | Add Library Media matching the name filter provided
$logicalOperatorName = logicalOperatorName_example; // String | When filtering by multiple names in name filter, which logical operator should be used? AND|OR
$filterMediaTag = filterMediaTag_example; // String | Add Library Media matching the tag filter provided
$exactTags = 56; // Integer | When filtering by Tags, should we use exact match?
$logicalOperator = logicalOperator_example; // String | When filtering by Tags, which logical operator should be used? AND|OR
$maxNumberOfItems = 56; // Integer | Maximum number of items that can be assigned to this Playlist (dynamic Playlist only)
$folderId = 56; // Integer | Folder ID to which this object should be assigned to

try {
    $api_instance->playlistAdd($name, $isDynamic, $tags, $filterMediaName, $logicalOperatorName, $filterMediaTag, $exactTags, $logicalOperator, $maxNumberOfItems, $folderId);
} catch (Exception $e) {
    echo 'Exception when calling PlaylistApi->playlistAdd: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaylistApi;

my $api_instance = WWW::SwaggerClient::PlaylistApi->new();
my $name = name_example; # String | The Name for this Playlist
my $isDynamic = 56; # Integer | Is this Playlist Dynamic?
my $tags = tags_example; # String | Tags
my $filterMediaName = filterMediaName_example; # String | Add Library Media matching the name filter provided
my $logicalOperatorName = logicalOperatorName_example; # String | When filtering by multiple names in name filter, which logical operator should be used? AND|OR
my $filterMediaTag = filterMediaTag_example; # String | Add Library Media matching the tag filter provided
my $exactTags = 56; # Integer | When filtering by Tags, should we use exact match?
my $logicalOperator = logicalOperator_example; # String | When filtering by Tags, which logical operator should be used? AND|OR
my $maxNumberOfItems = 56; # Integer | Maximum number of items that can be assigned to this Playlist (dynamic Playlist only)
my $folderId = 56; # Integer | Folder ID to which this object should be assigned to

eval { 
    $api_instance->playlistAdd(name => $name, isDynamic => $isDynamic, tags => $tags, filterMediaName => $filterMediaName, logicalOperatorName => $logicalOperatorName, filterMediaTag => $filterMediaTag, exactTags => $exactTags, logicalOperator => $logicalOperator, maxNumberOfItems => $maxNumberOfItems, folderId => $folderId);
};
if ($@) {
    warn "Exception when calling PlaylistApi->playlistAdd: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PlaylistApi()
name = name_example # String | The Name for this Playlist
isDynamic = 56 # Integer | Is this Playlist Dynamic?
tags = tags_example # String | Tags (optional)
filterMediaName = filterMediaName_example # String | Add Library Media matching the name filter provided (optional)
logicalOperatorName = logicalOperatorName_example # String | When filtering by multiple names in name filter, which logical operator should be used? AND|OR (optional)
filterMediaTag = filterMediaTag_example # String | Add Library Media matching the tag filter provided (optional)
exactTags = 56 # Integer | When filtering by Tags, should we use exact match? (optional)
logicalOperator = logicalOperator_example # String | When filtering by Tags, which logical operator should be used? AND|OR (optional)
maxNumberOfItems = 56 # Integer | Maximum number of items that can be assigned to this Playlist (dynamic Playlist only) (optional)
folderId = 56 # Integer | Folder ID to which this object should be assigned to (optional)

try: 
    # Add a Playlist
    api_instance.playlist_add(name, isDynamic, tags=tags, filterMediaName=filterMediaName, logicalOperatorName=logicalOperatorName, filterMediaTag=filterMediaTag, exactTags=exactTags, logicalOperator=logicalOperator, maxNumberOfItems=maxNumberOfItems, folderId=folderId)
except ApiException as e:
    print("Exception when calling PlaylistApi->playlistAdd: %s\n" % e)

Parameters

Query parameters
Name Description
name*
String
The Name for this Playlist
Required
tags
String
Tags
isDynamic*
Integer
Is this Playlist Dynamic?
Required
filterMediaName
String
Add Library Media matching the name filter provided
logicalOperatorName
String
When filtering by multiple names in name filter, which logical operator should be used? AND|OR
filterMediaTag
String
Add Library Media matching the tag filter provided
exactTags
Integer
When filtering by Tags, should we use exact match?
logicalOperator
String
When filtering by Tags, which logical operator should be used? AND|OR
maxNumberOfItems
Integer
Maximum number of items that can be assigned to this Playlist (dynamic Playlist only)
folderId
Integer
Folder ID to which this object should be assigned to

Responses

Status: 201 - successful operation


playlistCopy

Copy Playlist

Copy a Playlist, providing a new name if applicable


/playlist/copy/{playlistId}

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/playlist/copy/{playlistId}?name=©MediaFiles="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaylistApi;

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

public class PlaylistApiExample {

    public static void main(String[] args) {
        
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The Playlist ID to Copy
        String name = name_example; // String | The name for the new Playlist
        Integer copyMediaFiles = 56; // Integer | Flag indicating whether to make new Copies of all Media Files assigned to the Playlist being Copied
        try {
            apiInstance.playlistCopy(playlistId, name, copyMediaFiles);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistCopy");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaylistApi;

public class PlaylistApiExample {

    public static void main(String[] args) {
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The Playlist ID to Copy
        String name = name_example; // String | The name for the new Playlist
        Integer copyMediaFiles = 56; // Integer | Flag indicating whether to make new Copies of all Media Files assigned to the Playlist being Copied
        try {
            apiInstance.playlistCopy(playlistId, name, copyMediaFiles);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistCopy");
            e.printStackTrace();
        }
    }
}
Integer *playlistId = 56; // The Playlist ID to Copy
String *name = name_example; // The name for the new Playlist
Integer *copyMediaFiles = 56; // Flag indicating whether to make new Copies of all Media Files assigned to the Playlist being Copied

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

// Copy Playlist
[apiInstance playlistCopyWith:playlistId
    name:name
    copyMediaFiles:copyMediaFiles
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.PlaylistApi()
var playlistId = 56; // {{Integer}} The Playlist ID to Copy
var name = name_example; // {{String}} The name for the new Playlist
var copyMediaFiles = 56; // {{Integer}} Flag indicating whether to make new Copies of all Media Files assigned to the Playlist being Copied

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.playlistCopy(playlistId, name, copyMediaFiles, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class playlistCopyExample
    {
        public void main()
        {

            var apiInstance = new PlaylistApi();
            var playlistId = 56;  // Integer | The Playlist ID to Copy
            var name = name_example;  // String | The name for the new Playlist
            var copyMediaFiles = 56;  // Integer | Flag indicating whether to make new Copies of all Media Files assigned to the Playlist being Copied

            try
            {
                // Copy Playlist
                apiInstance.playlistCopy(playlistId, name, copyMediaFiles);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaylistApi.playlistCopy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPlaylistApi();
$playlistId = 56; // Integer | The Playlist ID to Copy
$name = name_example; // String | The name for the new Playlist
$copyMediaFiles = 56; // Integer | Flag indicating whether to make new Copies of all Media Files assigned to the Playlist being Copied

try {
    $api_instance->playlistCopy($playlistId, $name, $copyMediaFiles);
} catch (Exception $e) {
    echo 'Exception when calling PlaylistApi->playlistCopy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaylistApi;

my $api_instance = WWW::SwaggerClient::PlaylistApi->new();
my $playlistId = 56; # Integer | The Playlist ID to Copy
my $name = name_example; # String | The name for the new Playlist
my $copyMediaFiles = 56; # Integer | Flag indicating whether to make new Copies of all Media Files assigned to the Playlist being Copied

eval { 
    $api_instance->playlistCopy(playlistId => $playlistId, name => $name, copyMediaFiles => $copyMediaFiles);
};
if ($@) {
    warn "Exception when calling PlaylistApi->playlistCopy: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PlaylistApi()
playlistId = 56 # Integer | The Playlist ID to Copy
name = name_example # String | The name for the new Playlist
copyMediaFiles = 56 # Integer | Flag indicating whether to make new Copies of all Media Files assigned to the Playlist being Copied

try: 
    # Copy Playlist
    api_instance.playlist_copy(playlistId, name, copyMediaFiles)
except ApiException as e:
    print("Exception when calling PlaylistApi->playlistCopy: %s\n" % e)

Parameters

Path parameters
Name Description
playlistId*
Integer
The Playlist ID to Copy
Required
Query parameters
Name Description
name*
String
The name for the new Playlist
Required
copyMediaFiles*
Integer
Flag indicating whether to make new Copies of all Media Files assigned to the Playlist being Copied
Required

Responses

Status: 201 - successful operation

Name Type Format Description
Location String

playlistDelete

Delete a Playlist

Delete a Playlist


/playlist/{playlistId}

Usage and SDK Samples

curl -X DELETE\
"https://premium.digitalsignagevision.com/api/playlist/{playlistId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaylistApi;

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

public class PlaylistApiExample {

    public static void main(String[] args) {
        
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The PlaylistId to delete
        try {
            apiInstance.playlistDelete(playlistId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaylistApi;

public class PlaylistApiExample {

    public static void main(String[] args) {
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The PlaylistId to delete
        try {
            apiInstance.playlistDelete(playlistId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistDelete");
            e.printStackTrace();
        }
    }
}
Integer *playlistId = 56; // The PlaylistId to delete

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

// Delete a Playlist
[apiInstance playlistDeleteWith:playlistId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.PlaylistApi()
var playlistId = 56; // {{Integer}} The PlaylistId to delete

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

namespace Example
{
    public class playlistDeleteExample
    {
        public void main()
        {

            var apiInstance = new PlaylistApi();
            var playlistId = 56;  // Integer | The PlaylistId to delete

            try
            {
                // Delete a Playlist
                apiInstance.playlistDelete(playlistId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaylistApi.playlistDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPlaylistApi();
$playlistId = 56; // Integer | The PlaylistId to delete

try {
    $api_instance->playlistDelete($playlistId);
} catch (Exception $e) {
    echo 'Exception when calling PlaylistApi->playlistDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaylistApi;

my $api_instance = WWW::SwaggerClient::PlaylistApi->new();
my $playlistId = 56; # Integer | The PlaylistId to delete

eval { 
    $api_instance->playlistDelete(playlistId => $playlistId);
};
if ($@) {
    warn "Exception when calling PlaylistApi->playlistDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PlaylistApi()
playlistId = 56 # Integer | The PlaylistId to delete

try: 
    # Delete a Playlist
    api_instance.playlist_delete(playlistId)
except ApiException as e:
    print("Exception when calling PlaylistApi->playlistDelete: %s\n" % e)

Parameters

Path parameters
Name Description
playlistId*
Integer
The PlaylistId to delete
Required

Responses

Status: 204 - successful operation


playlistEdit

Edit a Playlist

Edit a Playlist


/playlist/{playlistId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/playlist/{playlistId}?name=&tags=&isDynamic=&filterMediaName=&logicalOperatorName=&filterMediaTag=&exactTags=&logicalOperator=&maxNumberOfItems=&folderId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaylistApi;

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

public class PlaylistApiExample {

    public static void main(String[] args) {
        
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The PlaylistId to Edit
        String name = name_example; // String | The Name for this Playlist
        Integer isDynamic = 56; // Integer | Is this Playlist Dynamic?
        String tags = tags_example; // String | Tags
        String filterMediaName = filterMediaName_example; // String | Add Library Media matching the name filter provided
        String logicalOperatorName = logicalOperatorName_example; // String | When filtering by multiple names in name filter, which logical operator should be used? AND|OR
        String filterMediaTag = filterMediaTag_example; // String | Add Library Media matching the tag filter provided
        Integer exactTags = 56; // Integer | When filtering by Tags, should we use exact match?
        String logicalOperator = logicalOperator_example; // String | When filtering by Tags, which logical operator should be used? AND|OR
        Integer maxNumberOfItems = 56; // Integer | Maximum number of items that can be assigned to this Playlist (dynamic Playlist only)
        Integer folderId = 56; // Integer | Folder ID to which this object should be assigned to
        try {
            apiInstance.playlistEdit(playlistId, name, isDynamic, tags, filterMediaName, logicalOperatorName, filterMediaTag, exactTags, logicalOperator, maxNumberOfItems, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistEdit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaylistApi;

public class PlaylistApiExample {

    public static void main(String[] args) {
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The PlaylistId to Edit
        String name = name_example; // String | The Name for this Playlist
        Integer isDynamic = 56; // Integer | Is this Playlist Dynamic?
        String tags = tags_example; // String | Tags
        String filterMediaName = filterMediaName_example; // String | Add Library Media matching the name filter provided
        String logicalOperatorName = logicalOperatorName_example; // String | When filtering by multiple names in name filter, which logical operator should be used? AND|OR
        String filterMediaTag = filterMediaTag_example; // String | Add Library Media matching the tag filter provided
        Integer exactTags = 56; // Integer | When filtering by Tags, should we use exact match?
        String logicalOperator = logicalOperator_example; // String | When filtering by Tags, which logical operator should be used? AND|OR
        Integer maxNumberOfItems = 56; // Integer | Maximum number of items that can be assigned to this Playlist (dynamic Playlist only)
        Integer folderId = 56; // Integer | Folder ID to which this object should be assigned to
        try {
            apiInstance.playlistEdit(playlistId, name, isDynamic, tags, filterMediaName, logicalOperatorName, filterMediaTag, exactTags, logicalOperator, maxNumberOfItems, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistEdit");
            e.printStackTrace();
        }
    }
}
Integer *playlistId = 56; // The PlaylistId to Edit
String *name = name_example; // The Name for this Playlist
Integer *isDynamic = 56; // Is this Playlist Dynamic?
String *tags = tags_example; // Tags (optional)
String *filterMediaName = filterMediaName_example; // Add Library Media matching the name filter provided (optional)
String *logicalOperatorName = logicalOperatorName_example; // When filtering by multiple names in name filter, which logical operator should be used? AND|OR (optional)
String *filterMediaTag = filterMediaTag_example; // Add Library Media matching the tag filter provided (optional)
Integer *exactTags = 56; // When filtering by Tags, should we use exact match? (optional)
String *logicalOperator = logicalOperator_example; // When filtering by Tags, which logical operator should be used? AND|OR (optional)
Integer *maxNumberOfItems = 56; // Maximum number of items that can be assigned to this Playlist (dynamic Playlist only) (optional)
Integer *folderId = 56; // Folder ID to which this object should be assigned to (optional)

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

// Edit a Playlist
[apiInstance playlistEditWith:playlistId
    name:name
    isDynamic:isDynamic
    tags:tags
    filterMediaName:filterMediaName
    logicalOperatorName:logicalOperatorName
    filterMediaTag:filterMediaTag
    exactTags:exactTags
    logicalOperator:logicalOperator
    maxNumberOfItems:maxNumberOfItems
    folderId:folderId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.PlaylistApi()
var playlistId = 56; // {{Integer}} The PlaylistId to Edit
var name = name_example; // {{String}} The Name for this Playlist
var isDynamic = 56; // {{Integer}} Is this Playlist Dynamic?
var opts = { 
  'tags': tags_example, // {{String}} Tags
  'filterMediaName': filterMediaName_example, // {{String}} Add Library Media matching the name filter provided
  'logicalOperatorName': logicalOperatorName_example, // {{String}} When filtering by multiple names in name filter, which logical operator should be used? AND|OR
  'filterMediaTag': filterMediaTag_example, // {{String}} Add Library Media matching the tag filter provided
  'exactTags': 56, // {{Integer}} When filtering by Tags, should we use exact match?
  'logicalOperator': logicalOperator_example, // {{String}} When filtering by Tags, which logical operator should be used? AND|OR
  'maxNumberOfItems': 56, // {{Integer}} Maximum number of items that can be assigned to this Playlist (dynamic Playlist only)
  'folderId': 56 // {{Integer}} Folder ID to which this object should be assigned to
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.playlistEdit(playlistId, name, isDynamic, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class playlistEditExample
    {
        public void main()
        {

            var apiInstance = new PlaylistApi();
            var playlistId = 56;  // Integer | The PlaylistId to Edit
            var name = name_example;  // String | The Name for this Playlist
            var isDynamic = 56;  // Integer | Is this Playlist Dynamic?
            var tags = tags_example;  // String | Tags (optional) 
            var filterMediaName = filterMediaName_example;  // String | Add Library Media matching the name filter provided (optional) 
            var logicalOperatorName = logicalOperatorName_example;  // String | When filtering by multiple names in name filter, which logical operator should be used? AND|OR (optional) 
            var filterMediaTag = filterMediaTag_example;  // String | Add Library Media matching the tag filter provided (optional) 
            var exactTags = 56;  // Integer | When filtering by Tags, should we use exact match? (optional) 
            var logicalOperator = logicalOperator_example;  // String | When filtering by Tags, which logical operator should be used? AND|OR (optional) 
            var maxNumberOfItems = 56;  // Integer | Maximum number of items that can be assigned to this Playlist (dynamic Playlist only) (optional) 
            var folderId = 56;  // Integer | Folder ID to which this object should be assigned to (optional) 

            try
            {
                // Edit a Playlist
                apiInstance.playlistEdit(playlistId, name, isDynamic, tags, filterMediaName, logicalOperatorName, filterMediaTag, exactTags, logicalOperator, maxNumberOfItems, folderId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaylistApi.playlistEdit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPlaylistApi();
$playlistId = 56; // Integer | The PlaylistId to Edit
$name = name_example; // String | The Name for this Playlist
$isDynamic = 56; // Integer | Is this Playlist Dynamic?
$tags = tags_example; // String | Tags
$filterMediaName = filterMediaName_example; // String | Add Library Media matching the name filter provided
$logicalOperatorName = logicalOperatorName_example; // String | When filtering by multiple names in name filter, which logical operator should be used? AND|OR
$filterMediaTag = filterMediaTag_example; // String | Add Library Media matching the tag filter provided
$exactTags = 56; // Integer | When filtering by Tags, should we use exact match?
$logicalOperator = logicalOperator_example; // String | When filtering by Tags, which logical operator should be used? AND|OR
$maxNumberOfItems = 56; // Integer | Maximum number of items that can be assigned to this Playlist (dynamic Playlist only)
$folderId = 56; // Integer | Folder ID to which this object should be assigned to

try {
    $api_instance->playlistEdit($playlistId, $name, $isDynamic, $tags, $filterMediaName, $logicalOperatorName, $filterMediaTag, $exactTags, $logicalOperator, $maxNumberOfItems, $folderId);
} catch (Exception $e) {
    echo 'Exception when calling PlaylistApi->playlistEdit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaylistApi;

my $api_instance = WWW::SwaggerClient::PlaylistApi->new();
my $playlistId = 56; # Integer | The PlaylistId to Edit
my $name = name_example; # String | The Name for this Playlist
my $isDynamic = 56; # Integer | Is this Playlist Dynamic?
my $tags = tags_example; # String | Tags
my $filterMediaName = filterMediaName_example; # String | Add Library Media matching the name filter provided
my $logicalOperatorName = logicalOperatorName_example; # String | When filtering by multiple names in name filter, which logical operator should be used? AND|OR
my $filterMediaTag = filterMediaTag_example; # String | Add Library Media matching the tag filter provided
my $exactTags = 56; # Integer | When filtering by Tags, should we use exact match?
my $logicalOperator = logicalOperator_example; # String | When filtering by Tags, which logical operator should be used? AND|OR
my $maxNumberOfItems = 56; # Integer | Maximum number of items that can be assigned to this Playlist (dynamic Playlist only)
my $folderId = 56; # Integer | Folder ID to which this object should be assigned to

eval { 
    $api_instance->playlistEdit(playlistId => $playlistId, name => $name, isDynamic => $isDynamic, tags => $tags, filterMediaName => $filterMediaName, logicalOperatorName => $logicalOperatorName, filterMediaTag => $filterMediaTag, exactTags => $exactTags, logicalOperator => $logicalOperator, maxNumberOfItems => $maxNumberOfItems, folderId => $folderId);
};
if ($@) {
    warn "Exception when calling PlaylistApi->playlistEdit: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PlaylistApi()
playlistId = 56 # Integer | The PlaylistId to Edit
name = name_example # String | The Name for this Playlist
isDynamic = 56 # Integer | Is this Playlist Dynamic?
tags = tags_example # String | Tags (optional)
filterMediaName = filterMediaName_example # String | Add Library Media matching the name filter provided (optional)
logicalOperatorName = logicalOperatorName_example # String | When filtering by multiple names in name filter, which logical operator should be used? AND|OR (optional)
filterMediaTag = filterMediaTag_example # String | Add Library Media matching the tag filter provided (optional)
exactTags = 56 # Integer | When filtering by Tags, should we use exact match? (optional)
logicalOperator = logicalOperator_example # String | When filtering by Tags, which logical operator should be used? AND|OR (optional)
maxNumberOfItems = 56 # Integer | Maximum number of items that can be assigned to this Playlist (dynamic Playlist only) (optional)
folderId = 56 # Integer | Folder ID to which this object should be assigned to (optional)

try: 
    # Edit a Playlist
    api_instance.playlist_edit(playlistId, name, isDynamic, tags=tags, filterMediaName=filterMediaName, logicalOperatorName=logicalOperatorName, filterMediaTag=filterMediaTag, exactTags=exactTags, logicalOperator=logicalOperator, maxNumberOfItems=maxNumberOfItems, folderId=folderId)
except ApiException as e:
    print("Exception when calling PlaylistApi->playlistEdit: %s\n" % e)

Parameters

Path parameters
Name Description
playlistId*
Integer
The PlaylistId to Edit
Required
Query parameters
Name Description
name*
String
The Name for this Playlist
Required
tags
String
Tags
isDynamic*
Integer
Is this Playlist Dynamic?
Required
filterMediaName
String
Add Library Media matching the name filter provided
logicalOperatorName
String
When filtering by multiple names in name filter, which logical operator should be used? AND|OR
filterMediaTag
String
Add Library Media matching the tag filter provided
exactTags
Integer
When filtering by Tags, should we use exact match?
logicalOperator
String
When filtering by Tags, which logical operator should be used? AND|OR
maxNumberOfItems
Integer
Maximum number of items that can be assigned to this Playlist (dynamic Playlist only)
folderId
Integer
Folder ID to which this object should be assigned to

Responses

Status: 204 - successful operation


playlistLibraryAssign

Assign Library Items

Assign Media from the Library to this Playlist


/playlist/library/assign/{playlistId}

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/playlist/library/assign/{playlistId}?media=&duration=&useDuration=&displayOrder="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaylistApi;

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

public class PlaylistApiExample {

    public static void main(String[] args) {
        
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The Playlist ID to assign to
        array[Integer] media = ; // array[Integer] | Array of Media IDs to assign
        Integer duration = 56; // Integer | Optional duration for all Media in this assignment to use on the Widget
        Integer useDuration = 56; // Integer | Optional flag indicating whether to enable the useDuration field
        Integer displayOrder = 56; // Integer | Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one.
        try {
            apiInstance.playlistLibraryAssign(playlistId, media, duration, useDuration, displayOrder);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistLibraryAssign");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaylistApi;

public class PlaylistApiExample {

    public static void main(String[] args) {
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The Playlist ID to assign to
        array[Integer] media = ; // array[Integer] | Array of Media IDs to assign
        Integer duration = 56; // Integer | Optional duration for all Media in this assignment to use on the Widget
        Integer useDuration = 56; // Integer | Optional flag indicating whether to enable the useDuration field
        Integer displayOrder = 56; // Integer | Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one.
        try {
            apiInstance.playlistLibraryAssign(playlistId, media, duration, useDuration, displayOrder);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistLibraryAssign");
            e.printStackTrace();
        }
    }
}
Integer *playlistId = 56; // The Playlist ID to assign to
array[Integer] *media = ; // Array of Media IDs to assign
Integer *duration = 56; // Optional duration for all Media in this assignment to use on the Widget (optional)
Integer *useDuration = 56; // Optional flag indicating whether to enable the useDuration field (optional)
Integer *displayOrder = 56; // Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one. (optional)

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

// Assign Library Items
[apiInstance playlistLibraryAssignWith:playlistId
    media:media
    duration:duration
    useDuration:useDuration
    displayOrder:displayOrder
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.PlaylistApi()
var playlistId = 56; // {{Integer}} The Playlist ID to assign to
var media = ; // {{array[Integer]}} Array of Media IDs to assign
var opts = { 
  'duration': 56, // {{Integer}} Optional duration for all Media in this assignment to use on the Widget
  'useDuration': 56, // {{Integer}} Optional flag indicating whether to enable the useDuration field
  'displayOrder': 56 // {{Integer}} Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.playlistLibraryAssign(playlistId, media, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class playlistLibraryAssignExample
    {
        public void main()
        {

            var apiInstance = new PlaylistApi();
            var playlistId = 56;  // Integer | The Playlist ID to assign to
            var media = new array[Integer](); // array[Integer] | Array of Media IDs to assign
            var duration = 56;  // Integer | Optional duration for all Media in this assignment to use on the Widget (optional) 
            var useDuration = 56;  // Integer | Optional flag indicating whether to enable the useDuration field (optional) 
            var displayOrder = 56;  // Integer | Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one. (optional) 

            try
            {
                // Assign Library Items
                apiInstance.playlistLibraryAssign(playlistId, media, duration, useDuration, displayOrder);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaylistApi.playlistLibraryAssign: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPlaylistApi();
$playlistId = 56; // Integer | The Playlist ID to assign to
$media = ; // array[Integer] | Array of Media IDs to assign
$duration = 56; // Integer | Optional duration for all Media in this assignment to use on the Widget
$useDuration = 56; // Integer | Optional flag indicating whether to enable the useDuration field
$displayOrder = 56; // Integer | Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one.

try {
    $api_instance->playlistLibraryAssign($playlistId, $media, $duration, $useDuration, $displayOrder);
} catch (Exception $e) {
    echo 'Exception when calling PlaylistApi->playlistLibraryAssign: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaylistApi;

my $api_instance = WWW::SwaggerClient::PlaylistApi->new();
my $playlistId = 56; # Integer | The Playlist ID to assign to
my $media = []; # array[Integer] | Array of Media IDs to assign
my $duration = 56; # Integer | Optional duration for all Media in this assignment to use on the Widget
my $useDuration = 56; # Integer | Optional flag indicating whether to enable the useDuration field
my $displayOrder = 56; # Integer | Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one.

eval { 
    $api_instance->playlistLibraryAssign(playlistId => $playlistId, media => $media, duration => $duration, useDuration => $useDuration, displayOrder => $displayOrder);
};
if ($@) {
    warn "Exception when calling PlaylistApi->playlistLibraryAssign: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PlaylistApi()
playlistId = 56 # Integer | The Playlist ID to assign to
media =  # array[Integer] | Array of Media IDs to assign
duration = 56 # Integer | Optional duration for all Media in this assignment to use on the Widget (optional)
useDuration = 56 # Integer | Optional flag indicating whether to enable the useDuration field (optional)
displayOrder = 56 # Integer | Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one. (optional)

try: 
    # Assign Library Items
    api_instance.playlist_library_assign(playlistId, media, duration=duration, useDuration=useDuration, displayOrder=displayOrder)
except ApiException as e:
    print("Exception when calling PlaylistApi->playlistLibraryAssign: %s\n" % e)

Parameters

Path parameters
Name Description
playlistId*
Integer
The Playlist ID to assign to
Required
Query parameters
Name Description
media*
array[Integer]
Array of Media IDs to assign
Required
duration
Integer
Optional duration for all Media in this assignment to use on the Widget
useDuration
Integer
Optional flag indicating whether to enable the useDuration field
displayOrder
Integer
Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one.

Responses

Status: 200 - successful operation


playlistOrder

Order Widgets

Set the order of widgets in the Playlist


/playlist/order/{playlistId}

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/playlist/order/{playlistId}?widgets="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaylistApi;

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

public class PlaylistApiExample {

    public static void main(String[] args) {
        
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The Playlist ID to Order
        array[#/definitions/PlaylistWidgetList] widgets = ; // array[#/definitions/PlaylistWidgetList] | Array of widgetIds and positions - all widgetIds present in the playlist need to be passed in the call with their positions
        try {
            apiInstance.playlistOrder(playlistId, widgets);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistOrder");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaylistApi;

public class PlaylistApiExample {

    public static void main(String[] args) {
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The Playlist ID to Order
        array[#/definitions/PlaylistWidgetList] widgets = ; // array[#/definitions/PlaylistWidgetList] | Array of widgetIds and positions - all widgetIds present in the playlist need to be passed in the call with their positions
        try {
            apiInstance.playlistOrder(playlistId, widgets);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistOrder");
            e.printStackTrace();
        }
    }
}
Integer *playlistId = 56; // The Playlist ID to Order
array[#/definitions/PlaylistWidgetList] *widgets = ; // Array of widgetIds and positions - all widgetIds present in the playlist need to be passed in the call with their positions

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

// Order Widgets
[apiInstance playlistOrderWith:playlistId
    widgets:widgets
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.PlaylistApi()
var playlistId = 56; // {{Integer}} The Playlist ID to Order
var widgets = ; // {{array[#/definitions/PlaylistWidgetList]}} Array of widgetIds and positions - all widgetIds present in the playlist need to be passed in the call with their positions

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.playlistOrder(playlistId, widgets, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class playlistOrderExample
    {
        public void main()
        {

            var apiInstance = new PlaylistApi();
            var playlistId = 56;  // Integer | The Playlist ID to Order
            var widgets = new array[#/definitions/PlaylistWidgetList](); // array[#/definitions/PlaylistWidgetList] | Array of widgetIds and positions - all widgetIds present in the playlist need to be passed in the call with their positions

            try
            {
                // Order Widgets
                apiInstance.playlistOrder(playlistId, widgets);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaylistApi.playlistOrder: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPlaylistApi();
$playlistId = 56; // Integer | The Playlist ID to Order
$widgets = ; // array[#/definitions/PlaylistWidgetList] | Array of widgetIds and positions - all widgetIds present in the playlist need to be passed in the call with their positions

try {
    $api_instance->playlistOrder($playlistId, $widgets);
} catch (Exception $e) {
    echo 'Exception when calling PlaylistApi->playlistOrder: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaylistApi;

my $api_instance = WWW::SwaggerClient::PlaylistApi->new();
my $playlistId = 56; # Integer | The Playlist ID to Order
my $widgets = []; # array[#/definitions/PlaylistWidgetList] | Array of widgetIds and positions - all widgetIds present in the playlist need to be passed in the call with their positions

eval { 
    $api_instance->playlistOrder(playlistId => $playlistId, widgets => $widgets);
};
if ($@) {
    warn "Exception when calling PlaylistApi->playlistOrder: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PlaylistApi()
playlistId = 56 # Integer | The Playlist ID to Order
widgets =  # array[#/definitions/PlaylistWidgetList] | Array of widgetIds and positions - all widgetIds present in the playlist need to be passed in the call with their positions

try: 
    # Order Widgets
    api_instance.playlist_order(playlistId, widgets)
except ApiException as e:
    print("Exception when calling PlaylistApi->playlistOrder: %s\n" % e)

Parameters

Path parameters
Name Description
playlistId*
Integer
The Playlist ID to Order
Required
Query parameters
Name Description
widgets*
array[#/definitions/PlaylistWidgetList]
Array of widgetIds and positions - all widgetIds present in the playlist need to be passed in the call with their positions
Required

Responses

Status: 200 - successful operation


playlistSearch

Search Playlists

Search for Playlists viewable by this user


/playlist

Usage and SDK Samples

curl -X GET\
"https://premium.digitalsignagevision.com/api/playlist?playlistId=&name=&userId=&tags=&exactTags=&logicalOperator=&ownerUserGroupId=&embed=&folderId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaylistApi;

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

public class PlaylistApiExample {

    public static void main(String[] args) {
        
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | Filter by Playlist Id
        String name = name_example; // String | Filter by partial Playlist name
        Integer userId = 56; // Integer | Filter by user Id
        String tags = tags_example; // String | Filter by tags
        Integer exactTags = 56; // Integer | A flag indicating whether to treat the tags filter as an exact match
        String logicalOperator = logicalOperator_example; // String | When filtering by multiple Tags, which logical operator should be used? AND|OR
        Integer ownerUserGroupId = 56; // Integer | Filter by users in this UserGroupId
        String embed = embed_example; // String | Embed related data such as regions, widgets, permissions, tags
        Integer folderId = 56; // Integer | Filter by Folder ID
        try {
            apiInstance.playlistSearch(playlistId, name, userId, tags, exactTags, logicalOperator, ownerUserGroupId, embed, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaylistApi;

public class PlaylistApiExample {

    public static void main(String[] args) {
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | Filter by Playlist Id
        String name = name_example; // String | Filter by partial Playlist name
        Integer userId = 56; // Integer | Filter by user Id
        String tags = tags_example; // String | Filter by tags
        Integer exactTags = 56; // Integer | A flag indicating whether to treat the tags filter as an exact match
        String logicalOperator = logicalOperator_example; // String | When filtering by multiple Tags, which logical operator should be used? AND|OR
        Integer ownerUserGroupId = 56; // Integer | Filter by users in this UserGroupId
        String embed = embed_example; // String | Embed related data such as regions, widgets, permissions, tags
        Integer folderId = 56; // Integer | Filter by Folder ID
        try {
            apiInstance.playlistSearch(playlistId, name, userId, tags, exactTags, logicalOperator, ownerUserGroupId, embed, folderId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistSearch");
            e.printStackTrace();
        }
    }
}
Integer *playlistId = 56; // Filter by Playlist Id (optional)
String *name = name_example; // Filter by partial Playlist name (optional)
Integer *userId = 56; // Filter by user Id (optional)
String *tags = tags_example; // Filter by tags (optional)
Integer *exactTags = 56; // A flag indicating whether to treat the tags filter as an exact match (optional)
String *logicalOperator = logicalOperator_example; // When filtering by multiple Tags, which logical operator should be used? AND|OR (optional)
Integer *ownerUserGroupId = 56; // Filter by users in this UserGroupId (optional)
String *embed = embed_example; // Embed related data such as regions, widgets, permissions, tags (optional)
Integer *folderId = 56; // Filter by Folder ID (optional)

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

// Search Playlists
[apiInstance playlistSearchWith:playlistId
    name:name
    userId:userId
    tags:tags
    exactTags:exactTags
    logicalOperator:logicalOperator
    ownerUserGroupId:ownerUserGroupId
    embed:embed
    folderId:folderId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.PlaylistApi()
var opts = { 
  'playlistId': 56, // {{Integer}} Filter by Playlist Id
  'name': name_example, // {{String}} Filter by partial Playlist name
  'userId': 56, // {{Integer}} Filter by user Id
  'tags': tags_example, // {{String}} Filter by tags
  'exactTags': 56, // {{Integer}} A flag indicating whether to treat the tags filter as an exact match
  'logicalOperator': logicalOperator_example, // {{String}} When filtering by multiple Tags, which logical operator should be used? AND|OR
  'ownerUserGroupId': 56, // {{Integer}} Filter by users in this UserGroupId
  'embed': embed_example, // {{String}} Embed related data such as regions, widgets, permissions, tags
  'folderId': 56 // {{Integer}} Filter by Folder ID
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.playlistSearch(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class playlistSearchExample
    {
        public void main()
        {

            var apiInstance = new PlaylistApi();
            var playlistId = 56;  // Integer | Filter by Playlist Id (optional) 
            var name = name_example;  // String | Filter by partial Playlist name (optional) 
            var userId = 56;  // Integer | Filter by user Id (optional) 
            var tags = tags_example;  // String | Filter by tags (optional) 
            var exactTags = 56;  // Integer | A flag indicating whether to treat the tags filter as an exact match (optional) 
            var logicalOperator = logicalOperator_example;  // String | When filtering by multiple Tags, which logical operator should be used? AND|OR (optional) 
            var ownerUserGroupId = 56;  // Integer | Filter by users in this UserGroupId (optional) 
            var embed = embed_example;  // String | Embed related data such as regions, widgets, permissions, tags (optional) 
            var folderId = 56;  // Integer | Filter by Folder ID (optional) 

            try
            {
                // Search Playlists
                apiInstance.playlistSearch(playlistId, name, userId, tags, exactTags, logicalOperator, ownerUserGroupId, embed, folderId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaylistApi.playlistSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPlaylistApi();
$playlistId = 56; // Integer | Filter by Playlist Id
$name = name_example; // String | Filter by partial Playlist name
$userId = 56; // Integer | Filter by user Id
$tags = tags_example; // String | Filter by tags
$exactTags = 56; // Integer | A flag indicating whether to treat the tags filter as an exact match
$logicalOperator = logicalOperator_example; // String | When filtering by multiple Tags, which logical operator should be used? AND|OR
$ownerUserGroupId = 56; // Integer | Filter by users in this UserGroupId
$embed = embed_example; // String | Embed related data such as regions, widgets, permissions, tags
$folderId = 56; // Integer | Filter by Folder ID

try {
    $api_instance->playlistSearch($playlistId, $name, $userId, $tags, $exactTags, $logicalOperator, $ownerUserGroupId, $embed, $folderId);
} catch (Exception $e) {
    echo 'Exception when calling PlaylistApi->playlistSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaylistApi;

my $api_instance = WWW::SwaggerClient::PlaylistApi->new();
my $playlistId = 56; # Integer | Filter by Playlist Id
my $name = name_example; # String | Filter by partial Playlist name
my $userId = 56; # Integer | Filter by user Id
my $tags = tags_example; # String | Filter by tags
my $exactTags = 56; # Integer | A flag indicating whether to treat the tags filter as an exact match
my $logicalOperator = logicalOperator_example; # String | When filtering by multiple Tags, which logical operator should be used? AND|OR
my $ownerUserGroupId = 56; # Integer | Filter by users in this UserGroupId
my $embed = embed_example; # String | Embed related data such as regions, widgets, permissions, tags
my $folderId = 56; # Integer | Filter by Folder ID

eval { 
    $api_instance->playlistSearch(playlistId => $playlistId, name => $name, userId => $userId, tags => $tags, exactTags => $exactTags, logicalOperator => $logicalOperator, ownerUserGroupId => $ownerUserGroupId, embed => $embed, folderId => $folderId);
};
if ($@) {
    warn "Exception when calling PlaylistApi->playlistSearch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PlaylistApi()
playlistId = 56 # Integer | Filter by Playlist Id (optional)
name = name_example # String | Filter by partial Playlist name (optional)
userId = 56 # Integer | Filter by user Id (optional)
tags = tags_example # String | Filter by tags (optional)
exactTags = 56 # Integer | A flag indicating whether to treat the tags filter as an exact match (optional)
logicalOperator = logicalOperator_example # String | When filtering by multiple Tags, which logical operator should be used? AND|OR (optional)
ownerUserGroupId = 56 # Integer | Filter by users in this UserGroupId (optional)
embed = embed_example # String | Embed related data such as regions, widgets, permissions, tags (optional)
folderId = 56 # Integer | Filter by Folder ID (optional)

try: 
    # Search Playlists
    api_instance.playlist_search(playlistId=playlistId, name=name, userId=userId, tags=tags, exactTags=exactTags, logicalOperator=logicalOperator, ownerUserGroupId=ownerUserGroupId, embed=embed, folderId=folderId)
except ApiException as e:
    print("Exception when calling PlaylistApi->playlistSearch: %s\n" % e)

Parameters

Query parameters
Name Description
playlistId
Integer
Filter by Playlist Id
name
String
Filter by partial Playlist name
userId
Integer
Filter by user Id
tags
String
Filter by tags
exactTags
Integer
A flag indicating whether to treat the tags filter as an exact match
logicalOperator
String
When filtering by multiple Tags, which logical operator should be used? AND|OR
ownerUserGroupId
Integer
Filter by users in this UserGroupId
embed
String
Embed related data such as regions, widgets, permissions, tags
folderId
Integer
Filter by Folder ID

Responses

Status: 200 - successful operation


playlistSetEnableStat

Enable Stats Collection

Set Enable Stats Collection? to use for the collection of Proof of Play statistics for a Playlist.


/playlist/setenablestat/{playlistId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/playlist/setenablestat/{playlistId}?enableStat="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaylistApi;

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

public class PlaylistApiExample {

    public static void main(String[] args) {
        
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The Playlist ID
        String enableStat = enableStat_example; // String | The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.
        try {
            apiInstance.playlistSetEnableStat(playlistId, enableStat);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistSetEnableStat");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaylistApi;

public class PlaylistApiExample {

    public static void main(String[] args) {
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The Playlist ID
        String enableStat = enableStat_example; // String | The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.
        try {
            apiInstance.playlistSetEnableStat(playlistId, enableStat);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistSetEnableStat");
            e.printStackTrace();
        }
    }
}
Integer *playlistId = 56; // The Playlist ID
String *enableStat = enableStat_example; // The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.

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

// Enable Stats Collection
[apiInstance playlistSetEnableStatWith:playlistId
    enableStat:enableStat
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.PlaylistApi()
var playlistId = 56; // {{Integer}} The Playlist ID
var enableStat = enableStat_example; // {{String}} The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.playlistSetEnableStat(playlistId, enableStat, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class playlistSetEnableStatExample
    {
        public void main()
        {

            var apiInstance = new PlaylistApi();
            var playlistId = 56;  // Integer | The Playlist ID
            var enableStat = enableStat_example;  // String | The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.

            try
            {
                // Enable Stats Collection
                apiInstance.playlistSetEnableStat(playlistId, enableStat);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaylistApi.playlistSetEnableStat: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPlaylistApi();
$playlistId = 56; // Integer | The Playlist ID
$enableStat = enableStat_example; // String | The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.

try {
    $api_instance->playlistSetEnableStat($playlistId, $enableStat);
} catch (Exception $e) {
    echo 'Exception when calling PlaylistApi->playlistSetEnableStat: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaylistApi;

my $api_instance = WWW::SwaggerClient::PlaylistApi->new();
my $playlistId = 56; # Integer | The Playlist ID
my $enableStat = enableStat_example; # String | The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.

eval { 
    $api_instance->playlistSetEnableStat(playlistId => $playlistId, enableStat => $enableStat);
};
if ($@) {
    warn "Exception when calling PlaylistApi->playlistSetEnableStat: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PlaylistApi()
playlistId = 56 # Integer | The Playlist ID
enableStat = enableStat_example # String | The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.

try: 
    # Enable Stats Collection
    api_instance.playlist_set_enable_stat(playlistId, enableStat)
except ApiException as e:
    print("Exception when calling PlaylistApi->playlistSetEnableStat: %s\n" % e)

Parameters

Path parameters
Name Description
playlistId*
Integer
The Playlist ID
Required
Query parameters
Name Description
enableStat*
String
The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.
Required

Responses

Status: 204 - successful operation


playlistUsageLayoutsReport

Get Playlist Item Usage Report for Layouts

Get the records for the playlist item usage report for Layouts


/playlist/usage/layouts/{playlistId}

Usage and SDK Samples

curl -X GET\
"https://premium.digitalsignagevision.com/api/playlist/usage/layouts/{playlistId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaylistApi;

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

public class PlaylistApiExample {

    public static void main(String[] args) {
        
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The Playlist Id
        try {
            apiInstance.playlistUsageLayoutsReport(playlistId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistUsageLayoutsReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaylistApi;

public class PlaylistApiExample {

    public static void main(String[] args) {
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The Playlist Id
        try {
            apiInstance.playlistUsageLayoutsReport(playlistId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistUsageLayoutsReport");
            e.printStackTrace();
        }
    }
}
Integer *playlistId = 56; // The Playlist Id

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

// Get Playlist Item Usage Report for Layouts
[apiInstance playlistUsageLayoutsReportWith:playlistId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.PlaylistApi()
var playlistId = 56; // {{Integer}} The Playlist Id

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

namespace Example
{
    public class playlistUsageLayoutsReportExample
    {
        public void main()
        {

            var apiInstance = new PlaylistApi();
            var playlistId = 56;  // Integer | The Playlist Id

            try
            {
                // Get Playlist Item Usage Report for Layouts
                apiInstance.playlistUsageLayoutsReport(playlistId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaylistApi.playlistUsageLayoutsReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPlaylistApi();
$playlistId = 56; // Integer | The Playlist Id

try {
    $api_instance->playlistUsageLayoutsReport($playlistId);
} catch (Exception $e) {
    echo 'Exception when calling PlaylistApi->playlistUsageLayoutsReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaylistApi;

my $api_instance = WWW::SwaggerClient::PlaylistApi->new();
my $playlistId = 56; # Integer | The Playlist Id

eval { 
    $api_instance->playlistUsageLayoutsReport(playlistId => $playlistId);
};
if ($@) {
    warn "Exception when calling PlaylistApi->playlistUsageLayoutsReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PlaylistApi()
playlistId = 56 # Integer | The Playlist Id

try: 
    # Get Playlist Item Usage Report for Layouts
    api_instance.playlist_usage_layouts_report(playlistId)
except ApiException as e:
    print("Exception when calling PlaylistApi->playlistUsageLayoutsReport: %s\n" % e)

Parameters

Path parameters
Name Description
playlistId*
Integer
The Playlist Id
Required

Responses

Status: 200 - successful operation


playlistUsageReport

Get Playlist Item Usage Report

Get the records for the playlist item usage report


/playlist/usage/{playlistId}

Usage and SDK Samples

curl -X GET\
"https://premium.digitalsignagevision.com/api/playlist/usage/{playlistId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PlaylistApi;

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

public class PlaylistApiExample {

    public static void main(String[] args) {
        
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The Playlist Id
        try {
            apiInstance.playlistUsageReport(playlistId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistUsageReport");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.PlaylistApi;

public class PlaylistApiExample {

    public static void main(String[] args) {
        PlaylistApi apiInstance = new PlaylistApi();
        Integer playlistId = 56; // Integer | The Playlist Id
        try {
            apiInstance.playlistUsageReport(playlistId);
        } catch (ApiException e) {
            System.err.println("Exception when calling PlaylistApi#playlistUsageReport");
            e.printStackTrace();
        }
    }
}
Integer *playlistId = 56; // The Playlist Id

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

// Get Playlist Item Usage Report
[apiInstance playlistUsageReportWith:playlistId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.PlaylistApi()
var playlistId = 56; // {{Integer}} The Playlist Id

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

namespace Example
{
    public class playlistUsageReportExample
    {
        public void main()
        {

            var apiInstance = new PlaylistApi();
            var playlistId = 56;  // Integer | The Playlist Id

            try
            {
                // Get Playlist Item Usage Report
                apiInstance.playlistUsageReport(playlistId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PlaylistApi.playlistUsageReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiPlaylistApi();
$playlistId = 56; // Integer | The Playlist Id

try {
    $api_instance->playlistUsageReport($playlistId);
} catch (Exception $e) {
    echo 'Exception when calling PlaylistApi->playlistUsageReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::PlaylistApi;

my $api_instance = WWW::SwaggerClient::PlaylistApi->new();
my $playlistId = 56; # Integer | The Playlist Id

eval { 
    $api_instance->playlistUsageReport(playlistId => $playlistId);
};
if ($@) {
    warn "Exception when calling PlaylistApi->playlistUsageReport: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.PlaylistApi()
playlistId = 56 # Integer | The Playlist Id

try: 
    # Get Playlist Item Usage Report
    api_instance.playlist_usage_report(playlistId)
except ApiException as e:
    print("Exception when calling PlaylistApi->playlistUsageReport: %s\n" % e)

Parameters

Path parameters
Name Description
playlistId*
Integer
The Playlist Id
Required

Responses

Status: 200 - successful operation


Schedule

scheduleAdd

Add Schedule Event

Add a new scheduled event for a Campaign/Layout to be shown on a Display Group/Display.


/schedule

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/schedule?eventTypeId=&campaignId=&fullScreenCampaignId=&commandId=&displayOrder=&isPriority=&displayGroupIds=&dayPartId=&syncTimezone=&fromDt=&toDt=&recurrenceType=&recurrenceDetail=&recurrenceRange=&recurrenceRepeatsOn=&scheduleReminders=&isGeoAware=&geoLocation=&geoLocationJson=&actionType=&actionTriggerCode=&actionLayoutCode="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScheduleApi;

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

public class ScheduleApiExample {

    public static void main(String[] args) {
        
        ScheduleApi apiInstance = new ScheduleApi();
        Integer eventTypeId = 56; // Integer | The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
        Integer displayOrder = 56; // Integer | The display order for this event. 
        Integer isPriority = 56; // Integer | An integer indicating the priority of this event. Normal events have a priority of 0.
        array[Integer] displayGroupIds = ; // array[Integer] | The Display Group IDs for this event. Display specific Group IDs should be used to schedule on single displays.
        String fromDt = fromDt_example; // String | The from date for this event.
        Integer campaignId = 56; // Integer | The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used.
        Integer fullScreenCampaignId = 56; // Integer | For Media or Playlist eventyType. The Layout specific Campaign ID to use for this Event.
     * This needs to be the Layout created with layout/fullscreen function
        Integer commandId = 56; // Integer | The Command ID to use for this Event.
        Integer dayPartId = 56; // Integer | The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.
        Integer syncTimezone = 56; // Integer | Should this schedule be synced to the resulting Display timezone?
        String toDt = toDt_example; // String | The to date for this event.
        String recurrenceType = recurrenceType_example; // String | The type of recurrence to apply to this event.
        Integer recurrenceDetail = 56; // Integer | The interval for the recurrence.
        String recurrenceRange = recurrenceRange_example; // String | The end date for this events recurrence.
        String recurrenceRepeatsOn = recurrenceRepeatsOn_example; // String | The days of the week that this event repeats - weekly only
        array[#/definitions/ScheduleReminderArray] scheduleReminders = ; // array[#/definitions/ScheduleReminderArray] | Array of Reminders for this event
        Integer isGeoAware = 56; // Integer | Flag (0-1), whether this event is using Geo Location
        array[String] geoLocation = ; // array[String] | Array of comma separated strings each with comma separated pair of coordinates
        String geoLocationJson = geoLocationJson_example; // String | Valid GeoJSON string, use as an alternative to geoLocation parameter
        String actionType = actionType_example; // String | For Action eventTypeId, the type of the action - command or navLayout
        String actionTriggerCode = actionTriggerCode_example; // String | For Action eventTypeId, the webhook trigger code for the Action
        String actionLayoutCode = actionLayoutCode_example; // String | For Action eventTypeId and navLayout actionType, the Layout Code identifier
        try {
            apiInstance.scheduleAdd(eventTypeId, displayOrder, isPriority, displayGroupIds, fromDt, campaignId, fullScreenCampaignId, commandId, dayPartId, syncTimezone, toDt, recurrenceType, recurrenceDetail, recurrenceRange, recurrenceRepeatsOn, scheduleReminders, isGeoAware, geoLocation, geoLocationJson, actionType, actionTriggerCode, actionLayoutCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduleApi#scheduleAdd");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScheduleApi;

public class ScheduleApiExample {

    public static void main(String[] args) {
        ScheduleApi apiInstance = new ScheduleApi();
        Integer eventTypeId = 56; // Integer | The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
        Integer displayOrder = 56; // Integer | The display order for this event. 
        Integer isPriority = 56; // Integer | An integer indicating the priority of this event. Normal events have a priority of 0.
        array[Integer] displayGroupIds = ; // array[Integer] | The Display Group IDs for this event. Display specific Group IDs should be used to schedule on single displays.
        String fromDt = fromDt_example; // String | The from date for this event.
        Integer campaignId = 56; // Integer | The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used.
        Integer fullScreenCampaignId = 56; // Integer | For Media or Playlist eventyType. The Layout specific Campaign ID to use for this Event.
     * This needs to be the Layout created with layout/fullscreen function
        Integer commandId = 56; // Integer | The Command ID to use for this Event.
        Integer dayPartId = 56; // Integer | The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.
        Integer syncTimezone = 56; // Integer | Should this schedule be synced to the resulting Display timezone?
        String toDt = toDt_example; // String | The to date for this event.
        String recurrenceType = recurrenceType_example; // String | The type of recurrence to apply to this event.
        Integer recurrenceDetail = 56; // Integer | The interval for the recurrence.
        String recurrenceRange = recurrenceRange_example; // String | The end date for this events recurrence.
        String recurrenceRepeatsOn = recurrenceRepeatsOn_example; // String | The days of the week that this event repeats - weekly only
        array[#/definitions/ScheduleReminderArray] scheduleReminders = ; // array[#/definitions/ScheduleReminderArray] | Array of Reminders for this event
        Integer isGeoAware = 56; // Integer | Flag (0-1), whether this event is using Geo Location
        array[String] geoLocation = ; // array[String] | Array of comma separated strings each with comma separated pair of coordinates
        String geoLocationJson = geoLocationJson_example; // String | Valid GeoJSON string, use as an alternative to geoLocation parameter
        String actionType = actionType_example; // String | For Action eventTypeId, the type of the action - command or navLayout
        String actionTriggerCode = actionTriggerCode_example; // String | For Action eventTypeId, the webhook trigger code for the Action
        String actionLayoutCode = actionLayoutCode_example; // String | For Action eventTypeId and navLayout actionType, the Layout Code identifier
        try {
            apiInstance.scheduleAdd(eventTypeId, displayOrder, isPriority, displayGroupIds, fromDt, campaignId, fullScreenCampaignId, commandId, dayPartId, syncTimezone, toDt, recurrenceType, recurrenceDetail, recurrenceRange, recurrenceRepeatsOn, scheduleReminders, isGeoAware, geoLocation, geoLocationJson, actionType, actionTriggerCode, actionLayoutCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduleApi#scheduleAdd");
            e.printStackTrace();
        }
    }
}
Integer *eventTypeId = 56; // The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
Integer *displayOrder = 56; // The display order for this event. 
Integer *isPriority = 56; // An integer indicating the priority of this event. Normal events have a priority of 0.
array[Integer] *displayGroupIds = ; // The Display Group IDs for this event. Display specific Group IDs should be used to schedule on single displays.
String *fromDt = fromDt_example; // The from date for this event.
Integer *campaignId = 56; // The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used. (optional)
Integer *fullScreenCampaignId = 56; // For Media or Playlist eventyType. The Layout specific Campaign ID to use for this Event.
     * This needs to be the Layout created with layout/fullscreen function (optional)
Integer *commandId = 56; // The Command ID to use for this Event. (optional)
Integer *dayPartId = 56; // The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0. (optional)
Integer *syncTimezone = 56; // Should this schedule be synced to the resulting Display timezone? (optional)
String *toDt = toDt_example; // The to date for this event. (optional)
String *recurrenceType = recurrenceType_example; // The type of recurrence to apply to this event. (optional)
Integer *recurrenceDetail = 56; // The interval for the recurrence. (optional)
String *recurrenceRange = recurrenceRange_example; // The end date for this events recurrence. (optional)
String *recurrenceRepeatsOn = recurrenceRepeatsOn_example; // The days of the week that this event repeats - weekly only (optional)
array[#/definitions/ScheduleReminderArray] *scheduleReminders = ; // Array of Reminders for this event (optional)
Integer *isGeoAware = 56; // Flag (0-1), whether this event is using Geo Location (optional)
array[String] *geoLocation = ; // Array of comma separated strings each with comma separated pair of coordinates (optional)
String *geoLocationJson = geoLocationJson_example; // Valid GeoJSON string, use as an alternative to geoLocation parameter (optional)
String *actionType = actionType_example; // For Action eventTypeId, the type of the action - command or navLayout (optional)
String *actionTriggerCode = actionTriggerCode_example; // For Action eventTypeId, the webhook trigger code for the Action (optional)
String *actionLayoutCode = actionLayoutCode_example; // For Action eventTypeId and navLayout actionType, the Layout Code identifier (optional)

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

// Add Schedule Event
[apiInstance scheduleAddWith:eventTypeId
    displayOrder:displayOrder
    isPriority:isPriority
    displayGroupIds:displayGroupIds
    fromDt:fromDt
    campaignId:campaignId
    fullScreenCampaignId:fullScreenCampaignId
    commandId:commandId
    dayPartId:dayPartId
    syncTimezone:syncTimezone
    toDt:toDt
    recurrenceType:recurrenceType
    recurrenceDetail:recurrenceDetail
    recurrenceRange:recurrenceRange
    recurrenceRepeatsOn:recurrenceRepeatsOn
    scheduleReminders:scheduleReminders
    isGeoAware:isGeoAware
    geoLocation:geoLocation
    geoLocationJson:geoLocationJson
    actionType:actionType
    actionTriggerCode:actionTriggerCode
    actionLayoutCode:actionLayoutCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.ScheduleApi()
var eventTypeId = 56; // {{Integer}} The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
var displayOrder = 56; // {{Integer}} The display order for this event. 
var isPriority = 56; // {{Integer}} An integer indicating the priority of this event. Normal events have a priority of 0.
var displayGroupIds = ; // {{array[Integer]}} The Display Group IDs for this event. Display specific Group IDs should be used to schedule on single displays.
var fromDt = fromDt_example; // {{String}} The from date for this event.
var opts = { 
  'campaignId': 56, // {{Integer}} The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used.
  'fullScreenCampaignId': 56, // {{Integer}} For Media or Playlist eventyType. The Layout specific Campaign ID to use for this Event.
     * This needs to be the Layout created with layout/fullscreen function
  'commandId': 56, // {{Integer}} The Command ID to use for this Event.
  'dayPartId': 56, // {{Integer}} The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.
  'syncTimezone': 56, // {{Integer}} Should this schedule be synced to the resulting Display timezone?
  'toDt': toDt_example, // {{String}} The to date for this event.
  'recurrenceType': recurrenceType_example, // {{String}} The type of recurrence to apply to this event.
  'recurrenceDetail': 56, // {{Integer}} The interval for the recurrence.
  'recurrenceRange': recurrenceRange_example, // {{String}} The end date for this events recurrence.
  'recurrenceRepeatsOn': recurrenceRepeatsOn_example, // {{String}} The days of the week that this event repeats - weekly only
  'scheduleReminders': , // {{array[#/definitions/ScheduleReminderArray]}} Array of Reminders for this event
  'isGeoAware': 56, // {{Integer}} Flag (0-1), whether this event is using Geo Location
  'geoLocation': , // {{array[String]}} Array of comma separated strings each with comma separated pair of coordinates
  'geoLocationJson': geoLocationJson_example, // {{String}} Valid GeoJSON string, use as an alternative to geoLocation parameter
  'actionType': actionType_example, // {{String}} For Action eventTypeId, the type of the action - command or navLayout
  'actionTriggerCode': actionTriggerCode_example, // {{String}} For Action eventTypeId, the webhook trigger code for the Action
  'actionLayoutCode': actionLayoutCode_example // {{String}} For Action eventTypeId and navLayout actionType, the Layout Code identifier
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.scheduleAdd(eventTypeId, displayOrder, isPriority, displayGroupIds, fromDt, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class scheduleAddExample
    {
        public void main()
        {

            var apiInstance = new ScheduleApi();
            var eventTypeId = 56;  // Integer | The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
            var displayOrder = 56;  // Integer | The display order for this event. 
            var isPriority = 56;  // Integer | An integer indicating the priority of this event. Normal events have a priority of 0.
            var displayGroupIds = new array[Integer](); // array[Integer] | The Display Group IDs for this event. Display specific Group IDs should be used to schedule on single displays.
            var fromDt = fromDt_example;  // String | The from date for this event.
            var campaignId = 56;  // Integer | The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used. (optional) 
            var fullScreenCampaignId = 56;  // Integer | For Media or Playlist eventyType. The Layout specific Campaign ID to use for this Event.
     * This needs to be the Layout created with layout/fullscreen function (optional) 
            var commandId = 56;  // Integer | The Command ID to use for this Event. (optional) 
            var dayPartId = 56;  // Integer | The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0. (optional) 
            var syncTimezone = 56;  // Integer | Should this schedule be synced to the resulting Display timezone? (optional) 
            var toDt = toDt_example;  // String | The to date for this event. (optional) 
            var recurrenceType = recurrenceType_example;  // String | The type of recurrence to apply to this event. (optional) 
            var recurrenceDetail = 56;  // Integer | The interval for the recurrence. (optional) 
            var recurrenceRange = recurrenceRange_example;  // String | The end date for this events recurrence. (optional) 
            var recurrenceRepeatsOn = recurrenceRepeatsOn_example;  // String | The days of the week that this event repeats - weekly only (optional) 
            var scheduleReminders = new array[#/definitions/ScheduleReminderArray](); // array[#/definitions/ScheduleReminderArray] | Array of Reminders for this event (optional) 
            var isGeoAware = 56;  // Integer | Flag (0-1), whether this event is using Geo Location (optional) 
            var geoLocation = new array[String](); // array[String] | Array of comma separated strings each with comma separated pair of coordinates (optional) 
            var geoLocationJson = geoLocationJson_example;  // String | Valid GeoJSON string, use as an alternative to geoLocation parameter (optional) 
            var actionType = actionType_example;  // String | For Action eventTypeId, the type of the action - command or navLayout (optional) 
            var actionTriggerCode = actionTriggerCode_example;  // String | For Action eventTypeId, the webhook trigger code for the Action (optional) 
            var actionLayoutCode = actionLayoutCode_example;  // String | For Action eventTypeId and navLayout actionType, the Layout Code identifier (optional) 

            try
            {
                // Add Schedule Event
                apiInstance.scheduleAdd(eventTypeId, displayOrder, isPriority, displayGroupIds, fromDt, campaignId, fullScreenCampaignId, commandId, dayPartId, syncTimezone, toDt, recurrenceType, recurrenceDetail, recurrenceRange, recurrenceRepeatsOn, scheduleReminders, isGeoAware, geoLocation, geoLocationJson, actionType, actionTriggerCode, actionLayoutCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScheduleApi.scheduleAdd: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiScheduleApi();
$eventTypeId = 56; // Integer | The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
$displayOrder = 56; // Integer | The display order for this event. 
$isPriority = 56; // Integer | An integer indicating the priority of this event. Normal events have a priority of 0.
$displayGroupIds = ; // array[Integer] | The Display Group IDs for this event. Display specific Group IDs should be used to schedule on single displays.
$fromDt = fromDt_example; // String | The from date for this event.
$campaignId = 56; // Integer | The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used.
$fullScreenCampaignId = 56; // Integer | For Media or Playlist eventyType. The Layout specific Campaign ID to use for this Event.
     * This needs to be the Layout created with layout/fullscreen function
$commandId = 56; // Integer | The Command ID to use for this Event.
$dayPartId = 56; // Integer | The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.
$syncTimezone = 56; // Integer | Should this schedule be synced to the resulting Display timezone?
$toDt = toDt_example; // String | The to date for this event.
$recurrenceType = recurrenceType_example; // String | The type of recurrence to apply to this event.
$recurrenceDetail = 56; // Integer | The interval for the recurrence.
$recurrenceRange = recurrenceRange_example; // String | The end date for this events recurrence.
$recurrenceRepeatsOn = recurrenceRepeatsOn_example; // String | The days of the week that this event repeats - weekly only
$scheduleReminders = ; // array[#/definitions/ScheduleReminderArray] | Array of Reminders for this event
$isGeoAware = 56; // Integer | Flag (0-1), whether this event is using Geo Location
$geoLocation = ; // array[String] | Array of comma separated strings each with comma separated pair of coordinates
$geoLocationJson = geoLocationJson_example; // String | Valid GeoJSON string, use as an alternative to geoLocation parameter
$actionType = actionType_example; // String | For Action eventTypeId, the type of the action - command or navLayout
$actionTriggerCode = actionTriggerCode_example; // String | For Action eventTypeId, the webhook trigger code for the Action
$actionLayoutCode = actionLayoutCode_example; // String | For Action eventTypeId and navLayout actionType, the Layout Code identifier

try {
    $api_instance->scheduleAdd($eventTypeId, $displayOrder, $isPriority, $displayGroupIds, $fromDt, $campaignId, $fullScreenCampaignId, $commandId, $dayPartId, $syncTimezone, $toDt, $recurrenceType, $recurrenceDetail, $recurrenceRange, $recurrenceRepeatsOn, $scheduleReminders, $isGeoAware, $geoLocation, $geoLocationJson, $actionType, $actionTriggerCode, $actionLayoutCode);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->scheduleAdd: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScheduleApi;

my $api_instance = WWW::SwaggerClient::ScheduleApi->new();
my $eventTypeId = 56; # Integer | The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
my $displayOrder = 56; # Integer | The display order for this event. 
my $isPriority = 56; # Integer | An integer indicating the priority of this event. Normal events have a priority of 0.
my $displayGroupIds = []; # array[Integer] | The Display Group IDs for this event. Display specific Group IDs should be used to schedule on single displays.
my $fromDt = fromDt_example; # String | The from date for this event.
my $campaignId = 56; # Integer | The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used.
my $fullScreenCampaignId = 56; # Integer | For Media or Playlist eventyType. The Layout specific Campaign ID to use for this Event.
     * This needs to be the Layout created with layout/fullscreen function
my $commandId = 56; # Integer | The Command ID to use for this Event.
my $dayPartId = 56; # Integer | The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.
my $syncTimezone = 56; # Integer | Should this schedule be synced to the resulting Display timezone?
my $toDt = toDt_example; # String | The to date for this event.
my $recurrenceType = recurrenceType_example; # String | The type of recurrence to apply to this event.
my $recurrenceDetail = 56; # Integer | The interval for the recurrence.
my $recurrenceRange = recurrenceRange_example; # String | The end date for this events recurrence.
my $recurrenceRepeatsOn = recurrenceRepeatsOn_example; # String | The days of the week that this event repeats - weekly only
my $scheduleReminders = []; # array[#/definitions/ScheduleReminderArray] | Array of Reminders for this event
my $isGeoAware = 56; # Integer | Flag (0-1), whether this event is using Geo Location
my $geoLocation = []; # array[String] | Array of comma separated strings each with comma separated pair of coordinates
my $geoLocationJson = geoLocationJson_example; # String | Valid GeoJSON string, use as an alternative to geoLocation parameter
my $actionType = actionType_example; # String | For Action eventTypeId, the type of the action - command or navLayout
my $actionTriggerCode = actionTriggerCode_example; # String | For Action eventTypeId, the webhook trigger code for the Action
my $actionLayoutCode = actionLayoutCode_example; # String | For Action eventTypeId and navLayout actionType, the Layout Code identifier

eval { 
    $api_instance->scheduleAdd(eventTypeId => $eventTypeId, displayOrder => $displayOrder, isPriority => $isPriority, displayGroupIds => $displayGroupIds, fromDt => $fromDt, campaignId => $campaignId, fullScreenCampaignId => $fullScreenCampaignId, commandId => $commandId, dayPartId => $dayPartId, syncTimezone => $syncTimezone, toDt => $toDt, recurrenceType => $recurrenceType, recurrenceDetail => $recurrenceDetail, recurrenceRange => $recurrenceRange, recurrenceRepeatsOn => $recurrenceRepeatsOn, scheduleReminders => $scheduleReminders, isGeoAware => $isGeoAware, geoLocation => $geoLocation, geoLocationJson => $geoLocationJson, actionType => $actionType, actionTriggerCode => $actionTriggerCode, actionLayoutCode => $actionLayoutCode);
};
if ($@) {
    warn "Exception when calling ScheduleApi->scheduleAdd: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ScheduleApi()
eventTypeId = 56 # Integer | The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
displayOrder = 56 # Integer | The display order for this event. 
isPriority = 56 # Integer | An integer indicating the priority of this event. Normal events have a priority of 0.
displayGroupIds =  # array[Integer] | The Display Group IDs for this event. Display specific Group IDs should be used to schedule on single displays.
fromDt = fromDt_example # String | The from date for this event.
campaignId = 56 # Integer | The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used. (optional)
fullScreenCampaignId = 56 # Integer | For Media or Playlist eventyType. The Layout specific Campaign ID to use for this Event.
     * This needs to be the Layout created with layout/fullscreen function (optional)
commandId = 56 # Integer | The Command ID to use for this Event. (optional)
dayPartId = 56 # Integer | The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0. (optional)
syncTimezone = 56 # Integer | Should this schedule be synced to the resulting Display timezone? (optional)
toDt = toDt_example # String | The to date for this event. (optional)
recurrenceType = recurrenceType_example # String | The type of recurrence to apply to this event. (optional)
recurrenceDetail = 56 # Integer | The interval for the recurrence. (optional)
recurrenceRange = recurrenceRange_example # String | The end date for this events recurrence. (optional)
recurrenceRepeatsOn = recurrenceRepeatsOn_example # String | The days of the week that this event repeats - weekly only (optional)
scheduleReminders =  # array[#/definitions/ScheduleReminderArray] | Array of Reminders for this event (optional)
isGeoAware = 56 # Integer | Flag (0-1), whether this event is using Geo Location (optional)
geoLocation =  # array[String] | Array of comma separated strings each with comma separated pair of coordinates (optional)
geoLocationJson = geoLocationJson_example # String | Valid GeoJSON string, use as an alternative to geoLocation parameter (optional)
actionType = actionType_example # String | For Action eventTypeId, the type of the action - command or navLayout (optional)
actionTriggerCode = actionTriggerCode_example # String | For Action eventTypeId, the webhook trigger code for the Action (optional)
actionLayoutCode = actionLayoutCode_example # String | For Action eventTypeId and navLayout actionType, the Layout Code identifier (optional)

try: 
    # Add Schedule Event
    api_instance.schedule_add(eventTypeId, displayOrder, isPriority, displayGroupIds, fromDt, campaignId=campaignId, fullScreenCampaignId=fullScreenCampaignId, commandId=commandId, dayPartId=dayPartId, syncTimezone=syncTimezone, toDt=toDt, recurrenceType=recurrenceType, recurrenceDetail=recurrenceDetail, recurrenceRange=recurrenceRange, recurrenceRepeatsOn=recurrenceRepeatsOn, scheduleReminders=scheduleReminders, isGeoAware=isGeoAware, geoLocation=geoLocation, geoLocationJson=geoLocationJson, actionType=actionType, actionTriggerCode=actionTriggerCode, actionLayoutCode=actionLayoutCode)
except ApiException as e:
    print("Exception when calling ScheduleApi->scheduleAdd: %s\n" % e)

Parameters

Query parameters
Name Description
eventTypeId*
Integer
The Event Type Id to use for this Event. * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
Required
campaignId
Integer
The Campaign ID to use for this Event. * If a Layout is needed then the Campaign specific ID for that Layout should be used.
fullScreenCampaignId
Integer
For Media or Playlist eventyType. The Layout specific Campaign ID to use for this Event. * This needs to be the Layout created with layout/fullscreen function
commandId
Integer
The Command ID to use for this Event.
displayOrder*
Integer
The display order for this event.
Required
isPriority*
Integer
An integer indicating the priority of this event. Normal events have a priority of 0.
Required
displayGroupIds*
array[Integer]
The Display Group IDs for this event. Display specific Group IDs should be used to schedule on single displays.
Required
dayPartId
Integer
The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.
syncTimezone
Integer
Should this schedule be synced to the resulting Display timezone?
fromDt*
String
The from date for this event.
Required
toDt
String
The to date for this event.
recurrenceType
String
The type of recurrence to apply to this event.
recurrenceDetail
Integer
The interval for the recurrence.
recurrenceRange
String
The end date for this events recurrence.
recurrenceRepeatsOn
String
The days of the week that this event repeats - weekly only
scheduleReminders
array[#/definitions/ScheduleReminderArray]
Array of Reminders for this event
isGeoAware
Integer
Flag (0-1), whether this event is using Geo Location
geoLocation
array[String]
Array of comma separated strings each with comma separated pair of coordinates
geoLocationJson
String
Valid GeoJSON string, use as an alternative to geoLocation parameter
actionType
String
For Action eventTypeId, the type of the action - command or navLayout
actionTriggerCode
String
For Action eventTypeId, the webhook trigger code for the Action
actionLayoutCode
String
For Action eventTypeId and navLayout actionType, the Layout Code identifier

Responses

Status: 201 - successful operation

Name Type Format Description
Location String

scheduleCalendarData

Generates the calendar that we draw events on


/schedule/data/events

Usage and SDK Samples

curl -X GET\
"https://premium.digitalsignagevision.com/api/schedule/data/events?displayGroupIds=&from=&to="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScheduleApi;

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

public class ScheduleApiExample {

    public static void main(String[] args) {
        
        ScheduleApi apiInstance = new ScheduleApi();
        array[Integer] displayGroupIds = ; // array[Integer] | The DisplayGroupIds to return the schedule for. [-1] for All.
        String from = from_example; // String | From Date in Y-m-d H:i:s format, if not provided defaults to start of the current month
        String to = to_example; // String | To Date in Y-m-d H:i:s format, if not provided defaults to start of the next month
        try {
            apiInstance.scheduleCalendarData(displayGroupIds, from, to);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduleApi#scheduleCalendarData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScheduleApi;

public class ScheduleApiExample {

    public static void main(String[] args) {
        ScheduleApi apiInstance = new ScheduleApi();
        array[Integer] displayGroupIds = ; // array[Integer] | The DisplayGroupIds to return the schedule for. [-1] for All.
        String from = from_example; // String | From Date in Y-m-d H:i:s format, if not provided defaults to start of the current month
        String to = to_example; // String | To Date in Y-m-d H:i:s format, if not provided defaults to start of the next month
        try {
            apiInstance.scheduleCalendarData(displayGroupIds, from, to);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduleApi#scheduleCalendarData");
            e.printStackTrace();
        }
    }
}
array[Integer] *displayGroupIds = ; // The DisplayGroupIds to return the schedule for. [-1] for All.
String *from = from_example; // From Date in Y-m-d H:i:s format, if not provided defaults to start of the current month (optional)
String *to = to_example; // To Date in Y-m-d H:i:s format, if not provided defaults to start of the next month (optional)

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

// Generates the calendar that we draw events on
[apiInstance scheduleCalendarDataWith:displayGroupIds
    from:from
    to:to
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.ScheduleApi()
var displayGroupIds = ; // {{array[Integer]}} The DisplayGroupIds to return the schedule for. [-1] for All.
var opts = { 
  'from': from_example, // {{String}} From Date in Y-m-d H:i:s format, if not provided defaults to start of the current month
  'to': to_example // {{String}} To Date in Y-m-d H:i:s format, if not provided defaults to start of the next month
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.scheduleCalendarData(displayGroupIds, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class scheduleCalendarDataExample
    {
        public void main()
        {

            var apiInstance = new ScheduleApi();
            var displayGroupIds = new array[Integer](); // array[Integer] | The DisplayGroupIds to return the schedule for. [-1] for All.
            var from = from_example;  // String | From Date in Y-m-d H:i:s format, if not provided defaults to start of the current month (optional) 
            var to = to_example;  // String | To Date in Y-m-d H:i:s format, if not provided defaults to start of the next month (optional) 

            try
            {
                // Generates the calendar that we draw events on
                apiInstance.scheduleCalendarData(displayGroupIds, from, to);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScheduleApi.scheduleCalendarData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiScheduleApi();
$displayGroupIds = ; // array[Integer] | The DisplayGroupIds to return the schedule for. [-1] for All.
$from = from_example; // String | From Date in Y-m-d H:i:s format, if not provided defaults to start of the current month
$to = to_example; // String | To Date in Y-m-d H:i:s format, if not provided defaults to start of the next month

try {
    $api_instance->scheduleCalendarData($displayGroupIds, $from, $to);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->scheduleCalendarData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScheduleApi;

my $api_instance = WWW::SwaggerClient::ScheduleApi->new();
my $displayGroupIds = []; # array[Integer] | The DisplayGroupIds to return the schedule for. [-1] for All.
my $from = from_example; # String | From Date in Y-m-d H:i:s format, if not provided defaults to start of the current month
my $to = to_example; # String | To Date in Y-m-d H:i:s format, if not provided defaults to start of the next month

eval { 
    $api_instance->scheduleCalendarData(displayGroupIds => $displayGroupIds, from => $from, to => $to);
};
if ($@) {
    warn "Exception when calling ScheduleApi->scheduleCalendarData: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ScheduleApi()
displayGroupIds =  # array[Integer] | The DisplayGroupIds to return the schedule for. [-1] for All.
from = from_example # String | From Date in Y-m-d H:i:s format, if not provided defaults to start of the current month (optional)
to = to_example # String | To Date in Y-m-d H:i:s format, if not provided defaults to start of the next month (optional)

try: 
    # Generates the calendar that we draw events on
    api_instance.schedule_calendar_data(displayGroupIds, from=from, to=to)
except ApiException as e:
    print("Exception when calling ScheduleApi->scheduleCalendarData: %s\n" % e)

Parameters

Query parameters
Name Description
displayGroupIds*
array[Integer]
The DisplayGroupIds to return the schedule for. [-1] for All.
Required
from
String
From Date in Y-m-d H:i:s format, if not provided defaults to start of the current month
to
String
To Date in Y-m-d H:i:s format, if not provided defaults to start of the next month

Responses

Status: 200 - successful response


scheduleCalendarDataDisplayGroup

Event List


/schedule/{displayGroupId}/events

Usage and SDK Samples

curl -X GET\
"https://premium.digitalsignagevision.com/api/schedule/{displayGroupId}/events?date="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScheduleApi;

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

public class ScheduleApiExample {

    public static void main(String[] args) {
        
        ScheduleApi apiInstance = new ScheduleApi();
        Integer displayGroupId = 56; // Integer | The DisplayGroupId to return the event list for.
        String date = date_example; // String | Date in Y-m-d H:i:s
        try {
            apiInstance.scheduleCalendarDataDisplayGroup(displayGroupId, date);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduleApi#scheduleCalendarDataDisplayGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScheduleApi;

public class ScheduleApiExample {

    public static void main(String[] args) {
        ScheduleApi apiInstance = new ScheduleApi();
        Integer displayGroupId = 56; // Integer | The DisplayGroupId to return the event list for.
        String date = date_example; // String | Date in Y-m-d H:i:s
        try {
            apiInstance.scheduleCalendarDataDisplayGroup(displayGroupId, date);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduleApi#scheduleCalendarDataDisplayGroup");
            e.printStackTrace();
        }
    }
}
Integer *displayGroupId = 56; // The DisplayGroupId to return the event list for.
String *date = date_example; // Date in Y-m-d H:i:s

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

// Event List
[apiInstance scheduleCalendarDataDisplayGroupWith:displayGroupId
    date:date
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.ScheduleApi()
var displayGroupId = 56; // {{Integer}} The DisplayGroupId to return the event list for.
var date = date_example; // {{String}} Date in Y-m-d H:i:s

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

namespace Example
{
    public class scheduleCalendarDataDisplayGroupExample
    {
        public void main()
        {

            var apiInstance = new ScheduleApi();
            var displayGroupId = 56;  // Integer | The DisplayGroupId to return the event list for.
            var date = date_example;  // String | Date in Y-m-d H:i:s

            try
            {
                // Event List
                apiInstance.scheduleCalendarDataDisplayGroup(displayGroupId, date);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScheduleApi.scheduleCalendarDataDisplayGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiScheduleApi();
$displayGroupId = 56; // Integer | The DisplayGroupId to return the event list for.
$date = date_example; // String | Date in Y-m-d H:i:s

try {
    $api_instance->scheduleCalendarDataDisplayGroup($displayGroupId, $date);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->scheduleCalendarDataDisplayGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScheduleApi;

my $api_instance = WWW::SwaggerClient::ScheduleApi->new();
my $displayGroupId = 56; # Integer | The DisplayGroupId to return the event list for.
my $date = date_example; # String | Date in Y-m-d H:i:s

eval { 
    $api_instance->scheduleCalendarDataDisplayGroup(displayGroupId => $displayGroupId, date => $date);
};
if ($@) {
    warn "Exception when calling ScheduleApi->scheduleCalendarDataDisplayGroup: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ScheduleApi()
displayGroupId = 56 # Integer | The DisplayGroupId to return the event list for.
date = date_example # String | Date in Y-m-d H:i:s

try: 
    # Event List
    api_instance.schedule_calendar_data_display_group(displayGroupId, date)
except ApiException as e:
    print("Exception when calling ScheduleApi->scheduleCalendarDataDisplayGroup: %s\n" % e)

Parameters

Path parameters
Name Description
displayGroupId*
Integer
The DisplayGroupId to return the event list for.
Required
Query parameters
Name Description
date*
String
Date in Y-m-d H:i:s
Required

Responses

Status: 200 - successful response


scheduleDelete

Delete Event

Delete a Scheduled Event


/schedule/{eventId}

Usage and SDK Samples

curl -X DELETE\
"https://premium.digitalsignagevision.com/api/schedule/{eventId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScheduleApi;

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

public class ScheduleApiExample {

    public static void main(String[] args) {
        
        ScheduleApi apiInstance = new ScheduleApi();
        Integer eventId = 56; // Integer | The Scheduled Event ID
        try {
            apiInstance.scheduleDelete(eventId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduleApi#scheduleDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScheduleApi;

public class ScheduleApiExample {

    public static void main(String[] args) {
        ScheduleApi apiInstance = new ScheduleApi();
        Integer eventId = 56; // Integer | The Scheduled Event ID
        try {
            apiInstance.scheduleDelete(eventId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduleApi#scheduleDelete");
            e.printStackTrace();
        }
    }
}
Integer *eventId = 56; // The Scheduled Event ID

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

// Delete Event
[apiInstance scheduleDeleteWith:eventId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.ScheduleApi()
var eventId = 56; // {{Integer}} The Scheduled Event ID

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

namespace Example
{
    public class scheduleDeleteExample
    {
        public void main()
        {

            var apiInstance = new ScheduleApi();
            var eventId = 56;  // Integer | The Scheduled Event ID

            try
            {
                // Delete Event
                apiInstance.scheduleDelete(eventId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScheduleApi.scheduleDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiScheduleApi();
$eventId = 56; // Integer | The Scheduled Event ID

try {
    $api_instance->scheduleDelete($eventId);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->scheduleDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScheduleApi;

my $api_instance = WWW::SwaggerClient::ScheduleApi->new();
my $eventId = 56; # Integer | The Scheduled Event ID

eval { 
    $api_instance->scheduleDelete(eventId => $eventId);
};
if ($@) {
    warn "Exception when calling ScheduleApi->scheduleDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ScheduleApi()
eventId = 56 # Integer | The Scheduled Event ID

try: 
    # Delete Event
    api_instance.schedule_delete(eventId)
except ApiException as e:
    print("Exception when calling ScheduleApi->scheduleDelete: %s\n" % e)

Parameters

Path parameters
Name Description
eventId*
Integer
The Scheduled Event ID
Required

Responses

Status: 204 - successful operation


scheduleEdit

Edit Schedule Event

Edit a scheduled event for a Campaign/Layout to be shown on a Display Group/Display.


/schedule/{eventId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/schedule/{eventId}?eventTypeId=&campaignId=&commandId=&displayOrder=&isPriority=&displayGroupIds=&dayPartId=&syncTimezone=&fromDt=&toDt=&recurrenceType=&recurrenceDetail=&recurrenceRange=&recurrenceRepeatsOn=&scheduleReminders=&isGeoAware=&geoLocation=&geoLocationJson=&actionType=&actionTriggerCode=&actionLayoutCode="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScheduleApi;

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

public class ScheduleApiExample {

    public static void main(String[] args) {
        
        ScheduleApi apiInstance = new ScheduleApi();
        Integer eventId = 56; // Integer | The Scheduled Event ID
        Integer eventTypeId = 56; // Integer | The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action
        Integer displayOrder = 56; // Integer | The display order for this event. 
        Integer isPriority = 56; // Integer | An integer indicating the priority of this event. Normal events have a priority of 0.
        array[Integer] displayGroupIds = ; // array[Integer] | The Display Group IDs for this event.
     * Display specific Group IDs should be used to schedule on single displays.
        String fromDt = fromDt_example; // String | The from date for this event.
        Integer campaignId = 56; // Integer | The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used.
        Integer commandId = 56; // Integer | The Command ID to use for this Event.
        Integer dayPartId = 56; // Integer | The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.
        Integer syncTimezone = 56; // Integer | Should this schedule be synced to the resulting Display timezone?
        String toDt = toDt_example; // String | The to date for this event.
        String recurrenceType = recurrenceType_example; // String | The type of recurrence to apply to this event.
        Integer recurrenceDetail = 56; // Integer | The interval for the recurrence.
        String recurrenceRange = recurrenceRange_example; // String | The end date for this events recurrence.
        String recurrenceRepeatsOn = recurrenceRepeatsOn_example; // String | The days of the week that this event repeats - weekly only
        array[#/definitions/ScheduleReminderArray] scheduleReminders = ; // array[#/definitions/ScheduleReminderArray] | Array of Reminders for this event
        Integer isGeoAware = 56; // Integer | Flag (0-1), whether this event is using Geo Location
        array[String] geoLocation = ; // array[String] | Array of comma separated strings each with comma separated pair of coordinates
        String geoLocationJson = geoLocationJson_example; // String | Valid GeoJSON string, use as an alternative to geoLocation parameter
        String actionType = actionType_example; // String | For Action eventTypeId, the type of the action - command or navLayout
        String actionTriggerCode = actionTriggerCode_example; // String | For Action eventTypeId, the webhook trigger code for the Action
        String actionLayoutCode = actionLayoutCode_example; // String | For Action eventTypeId and navLayout actionType, the Layout Code identifier
        try {
            apiInstance.scheduleEdit(eventId, eventTypeId, displayOrder, isPriority, displayGroupIds, fromDt, campaignId, commandId, dayPartId, syncTimezone, toDt, recurrenceType, recurrenceDetail, recurrenceRange, recurrenceRepeatsOn, scheduleReminders, isGeoAware, geoLocation, geoLocationJson, actionType, actionTriggerCode, actionLayoutCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduleApi#scheduleEdit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScheduleApi;

public class ScheduleApiExample {

    public static void main(String[] args) {
        ScheduleApi apiInstance = new ScheduleApi();
        Integer eventId = 56; // Integer | The Scheduled Event ID
        Integer eventTypeId = 56; // Integer | The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action
        Integer displayOrder = 56; // Integer | The display order for this event. 
        Integer isPriority = 56; // Integer | An integer indicating the priority of this event. Normal events have a priority of 0.
        array[Integer] displayGroupIds = ; // array[Integer] | The Display Group IDs for this event.
     * Display specific Group IDs should be used to schedule on single displays.
        String fromDt = fromDt_example; // String | The from date for this event.
        Integer campaignId = 56; // Integer | The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used.
        Integer commandId = 56; // Integer | The Command ID to use for this Event.
        Integer dayPartId = 56; // Integer | The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.
        Integer syncTimezone = 56; // Integer | Should this schedule be synced to the resulting Display timezone?
        String toDt = toDt_example; // String | The to date for this event.
        String recurrenceType = recurrenceType_example; // String | The type of recurrence to apply to this event.
        Integer recurrenceDetail = 56; // Integer | The interval for the recurrence.
        String recurrenceRange = recurrenceRange_example; // String | The end date for this events recurrence.
        String recurrenceRepeatsOn = recurrenceRepeatsOn_example; // String | The days of the week that this event repeats - weekly only
        array[#/definitions/ScheduleReminderArray] scheduleReminders = ; // array[#/definitions/ScheduleReminderArray] | Array of Reminders for this event
        Integer isGeoAware = 56; // Integer | Flag (0-1), whether this event is using Geo Location
        array[String] geoLocation = ; // array[String] | Array of comma separated strings each with comma separated pair of coordinates
        String geoLocationJson = geoLocationJson_example; // String | Valid GeoJSON string, use as an alternative to geoLocation parameter
        String actionType = actionType_example; // String | For Action eventTypeId, the type of the action - command or navLayout
        String actionTriggerCode = actionTriggerCode_example; // String | For Action eventTypeId, the webhook trigger code for the Action
        String actionLayoutCode = actionLayoutCode_example; // String | For Action eventTypeId and navLayout actionType, the Layout Code identifier
        try {
            apiInstance.scheduleEdit(eventId, eventTypeId, displayOrder, isPriority, displayGroupIds, fromDt, campaignId, commandId, dayPartId, syncTimezone, toDt, recurrenceType, recurrenceDetail, recurrenceRange, recurrenceRepeatsOn, scheduleReminders, isGeoAware, geoLocation, geoLocationJson, actionType, actionTriggerCode, actionLayoutCode);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduleApi#scheduleEdit");
            e.printStackTrace();
        }
    }
}
Integer *eventId = 56; // The Scheduled Event ID
Integer *eventTypeId = 56; // The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action
Integer *displayOrder = 56; // The display order for this event. 
Integer *isPriority = 56; // An integer indicating the priority of this event. Normal events have a priority of 0.
array[Integer] *displayGroupIds = ; // The Display Group IDs for this event.
     * Display specific Group IDs should be used to schedule on single displays.
String *fromDt = fromDt_example; // The from date for this event.
Integer *campaignId = 56; // The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used. (optional)
Integer *commandId = 56; // The Command ID to use for this Event. (optional)
Integer *dayPartId = 56; // The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0. (optional)
Integer *syncTimezone = 56; // Should this schedule be synced to the resulting Display timezone? (optional)
String *toDt = toDt_example; // The to date for this event. (optional)
String *recurrenceType = recurrenceType_example; // The type of recurrence to apply to this event. (optional)
Integer *recurrenceDetail = 56; // The interval for the recurrence. (optional)
String *recurrenceRange = recurrenceRange_example; // The end date for this events recurrence. (optional)
String *recurrenceRepeatsOn = recurrenceRepeatsOn_example; // The days of the week that this event repeats - weekly only (optional)
array[#/definitions/ScheduleReminderArray] *scheduleReminders = ; // Array of Reminders for this event (optional)
Integer *isGeoAware = 56; // Flag (0-1), whether this event is using Geo Location (optional)
array[String] *geoLocation = ; // Array of comma separated strings each with comma separated pair of coordinates (optional)
String *geoLocationJson = geoLocationJson_example; // Valid GeoJSON string, use as an alternative to geoLocation parameter (optional)
String *actionType = actionType_example; // For Action eventTypeId, the type of the action - command or navLayout (optional)
String *actionTriggerCode = actionTriggerCode_example; // For Action eventTypeId, the webhook trigger code for the Action (optional)
String *actionLayoutCode = actionLayoutCode_example; // For Action eventTypeId and navLayout actionType, the Layout Code identifier (optional)

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

// Edit Schedule Event
[apiInstance scheduleEditWith:eventId
    eventTypeId:eventTypeId
    displayOrder:displayOrder
    isPriority:isPriority
    displayGroupIds:displayGroupIds
    fromDt:fromDt
    campaignId:campaignId
    commandId:commandId
    dayPartId:dayPartId
    syncTimezone:syncTimezone
    toDt:toDt
    recurrenceType:recurrenceType
    recurrenceDetail:recurrenceDetail
    recurrenceRange:recurrenceRange
    recurrenceRepeatsOn:recurrenceRepeatsOn
    scheduleReminders:scheduleReminders
    isGeoAware:isGeoAware
    geoLocation:geoLocation
    geoLocationJson:geoLocationJson
    actionType:actionType
    actionTriggerCode:actionTriggerCode
    actionLayoutCode:actionLayoutCode
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.ScheduleApi()
var eventId = 56; // {{Integer}} The Scheduled Event ID
var eventTypeId = 56; // {{Integer}} The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action
var displayOrder = 56; // {{Integer}} The display order for this event. 
var isPriority = 56; // {{Integer}} An integer indicating the priority of this event. Normal events have a priority of 0.
var displayGroupIds = ; // {{array[Integer]}} The Display Group IDs for this event.
     * Display specific Group IDs should be used to schedule on single displays.
var fromDt = fromDt_example; // {{String}} The from date for this event.
var opts = { 
  'campaignId': 56, // {{Integer}} The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used.
  'commandId': 56, // {{Integer}} The Command ID to use for this Event.
  'dayPartId': 56, // {{Integer}} The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.
  'syncTimezone': 56, // {{Integer}} Should this schedule be synced to the resulting Display timezone?
  'toDt': toDt_example, // {{String}} The to date for this event.
  'recurrenceType': recurrenceType_example, // {{String}} The type of recurrence to apply to this event.
  'recurrenceDetail': 56, // {{Integer}} The interval for the recurrence.
  'recurrenceRange': recurrenceRange_example, // {{String}} The end date for this events recurrence.
  'recurrenceRepeatsOn': recurrenceRepeatsOn_example, // {{String}} The days of the week that this event repeats - weekly only
  'scheduleReminders': , // {{array[#/definitions/ScheduleReminderArray]}} Array of Reminders for this event
  'isGeoAware': 56, // {{Integer}} Flag (0-1), whether this event is using Geo Location
  'geoLocation': , // {{array[String]}} Array of comma separated strings each with comma separated pair of coordinates
  'geoLocationJson': geoLocationJson_example, // {{String}} Valid GeoJSON string, use as an alternative to geoLocation parameter
  'actionType': actionType_example, // {{String}} For Action eventTypeId, the type of the action - command or navLayout
  'actionTriggerCode': actionTriggerCode_example, // {{String}} For Action eventTypeId, the webhook trigger code for the Action
  'actionLayoutCode': actionLayoutCode_example // {{String}} For Action eventTypeId and navLayout actionType, the Layout Code identifier
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.scheduleEdit(eventId, eventTypeId, displayOrder, isPriority, displayGroupIds, fromDt, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class scheduleEditExample
    {
        public void main()
        {

            var apiInstance = new ScheduleApi();
            var eventId = 56;  // Integer | The Scheduled Event ID
            var eventTypeId = 56;  // Integer | The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action
            var displayOrder = 56;  // Integer | The display order for this event. 
            var isPriority = 56;  // Integer | An integer indicating the priority of this event. Normal events have a priority of 0.
            var displayGroupIds = new array[Integer](); // array[Integer] | The Display Group IDs for this event.
     * Display specific Group IDs should be used to schedule on single displays.
            var fromDt = fromDt_example;  // String | The from date for this event.
            var campaignId = 56;  // Integer | The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used. (optional) 
            var commandId = 56;  // Integer | The Command ID to use for this Event. (optional) 
            var dayPartId = 56;  // Integer | The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0. (optional) 
            var syncTimezone = 56;  // Integer | Should this schedule be synced to the resulting Display timezone? (optional) 
            var toDt = toDt_example;  // String | The to date for this event. (optional) 
            var recurrenceType = recurrenceType_example;  // String | The type of recurrence to apply to this event. (optional) 
            var recurrenceDetail = 56;  // Integer | The interval for the recurrence. (optional) 
            var recurrenceRange = recurrenceRange_example;  // String | The end date for this events recurrence. (optional) 
            var recurrenceRepeatsOn = recurrenceRepeatsOn_example;  // String | The days of the week that this event repeats - weekly only (optional) 
            var scheduleReminders = new array[#/definitions/ScheduleReminderArray](); // array[#/definitions/ScheduleReminderArray] | Array of Reminders for this event (optional) 
            var isGeoAware = 56;  // Integer | Flag (0-1), whether this event is using Geo Location (optional) 
            var geoLocation = new array[String](); // array[String] | Array of comma separated strings each with comma separated pair of coordinates (optional) 
            var geoLocationJson = geoLocationJson_example;  // String | Valid GeoJSON string, use as an alternative to geoLocation parameter (optional) 
            var actionType = actionType_example;  // String | For Action eventTypeId, the type of the action - command or navLayout (optional) 
            var actionTriggerCode = actionTriggerCode_example;  // String | For Action eventTypeId, the webhook trigger code for the Action (optional) 
            var actionLayoutCode = actionLayoutCode_example;  // String | For Action eventTypeId and navLayout actionType, the Layout Code identifier (optional) 

            try
            {
                // Edit Schedule Event
                apiInstance.scheduleEdit(eventId, eventTypeId, displayOrder, isPriority, displayGroupIds, fromDt, campaignId, commandId, dayPartId, syncTimezone, toDt, recurrenceType, recurrenceDetail, recurrenceRange, recurrenceRepeatsOn, scheduleReminders, isGeoAware, geoLocation, geoLocationJson, actionType, actionTriggerCode, actionLayoutCode);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScheduleApi.scheduleEdit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiScheduleApi();
$eventId = 56; // Integer | The Scheduled Event ID
$eventTypeId = 56; // Integer | The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action
$displayOrder = 56; // Integer | The display order for this event. 
$isPriority = 56; // Integer | An integer indicating the priority of this event. Normal events have a priority of 0.
$displayGroupIds = ; // array[Integer] | The Display Group IDs for this event.
     * Display specific Group IDs should be used to schedule on single displays.
$fromDt = fromDt_example; // String | The from date for this event.
$campaignId = 56; // Integer | The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used.
$commandId = 56; // Integer | The Command ID to use for this Event.
$dayPartId = 56; // Integer | The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.
$syncTimezone = 56; // Integer | Should this schedule be synced to the resulting Display timezone?
$toDt = toDt_example; // String | The to date for this event.
$recurrenceType = recurrenceType_example; // String | The type of recurrence to apply to this event.
$recurrenceDetail = 56; // Integer | The interval for the recurrence.
$recurrenceRange = recurrenceRange_example; // String | The end date for this events recurrence.
$recurrenceRepeatsOn = recurrenceRepeatsOn_example; // String | The days of the week that this event repeats - weekly only
$scheduleReminders = ; // array[#/definitions/ScheduleReminderArray] | Array of Reminders for this event
$isGeoAware = 56; // Integer | Flag (0-1), whether this event is using Geo Location
$geoLocation = ; // array[String] | Array of comma separated strings each with comma separated pair of coordinates
$geoLocationJson = geoLocationJson_example; // String | Valid GeoJSON string, use as an alternative to geoLocation parameter
$actionType = actionType_example; // String | For Action eventTypeId, the type of the action - command or navLayout
$actionTriggerCode = actionTriggerCode_example; // String | For Action eventTypeId, the webhook trigger code for the Action
$actionLayoutCode = actionLayoutCode_example; // String | For Action eventTypeId and navLayout actionType, the Layout Code identifier

try {
    $api_instance->scheduleEdit($eventId, $eventTypeId, $displayOrder, $isPriority, $displayGroupIds, $fromDt, $campaignId, $commandId, $dayPartId, $syncTimezone, $toDt, $recurrenceType, $recurrenceDetail, $recurrenceRange, $recurrenceRepeatsOn, $scheduleReminders, $isGeoAware, $geoLocation, $geoLocationJson, $actionType, $actionTriggerCode, $actionLayoutCode);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->scheduleEdit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScheduleApi;

my $api_instance = WWW::SwaggerClient::ScheduleApi->new();
my $eventId = 56; # Integer | The Scheduled Event ID
my $eventTypeId = 56; # Integer | The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action
my $displayOrder = 56; # Integer | The display order for this event. 
my $isPriority = 56; # Integer | An integer indicating the priority of this event. Normal events have a priority of 0.
my $displayGroupIds = []; # array[Integer] | The Display Group IDs for this event.
     * Display specific Group IDs should be used to schedule on single displays.
my $fromDt = fromDt_example; # String | The from date for this event.
my $campaignId = 56; # Integer | The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used.
my $commandId = 56; # Integer | The Command ID to use for this Event.
my $dayPartId = 56; # Integer | The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.
my $syncTimezone = 56; # Integer | Should this schedule be synced to the resulting Display timezone?
my $toDt = toDt_example; # String | The to date for this event.
my $recurrenceType = recurrenceType_example; # String | The type of recurrence to apply to this event.
my $recurrenceDetail = 56; # Integer | The interval for the recurrence.
my $recurrenceRange = recurrenceRange_example; # String | The end date for this events recurrence.
my $recurrenceRepeatsOn = recurrenceRepeatsOn_example; # String | The days of the week that this event repeats - weekly only
my $scheduleReminders = []; # array[#/definitions/ScheduleReminderArray] | Array of Reminders for this event
my $isGeoAware = 56; # Integer | Flag (0-1), whether this event is using Geo Location
my $geoLocation = []; # array[String] | Array of comma separated strings each with comma separated pair of coordinates
my $geoLocationJson = geoLocationJson_example; # String | Valid GeoJSON string, use as an alternative to geoLocation parameter
my $actionType = actionType_example; # String | For Action eventTypeId, the type of the action - command or navLayout
my $actionTriggerCode = actionTriggerCode_example; # String | For Action eventTypeId, the webhook trigger code for the Action
my $actionLayoutCode = actionLayoutCode_example; # String | For Action eventTypeId and navLayout actionType, the Layout Code identifier

eval { 
    $api_instance->scheduleEdit(eventId => $eventId, eventTypeId => $eventTypeId, displayOrder => $displayOrder, isPriority => $isPriority, displayGroupIds => $displayGroupIds, fromDt => $fromDt, campaignId => $campaignId, commandId => $commandId, dayPartId => $dayPartId, syncTimezone => $syncTimezone, toDt => $toDt, recurrenceType => $recurrenceType, recurrenceDetail => $recurrenceDetail, recurrenceRange => $recurrenceRange, recurrenceRepeatsOn => $recurrenceRepeatsOn, scheduleReminders => $scheduleReminders, isGeoAware => $isGeoAware, geoLocation => $geoLocation, geoLocationJson => $geoLocationJson, actionType => $actionType, actionTriggerCode => $actionTriggerCode, actionLayoutCode => $actionLayoutCode);
};
if ($@) {
    warn "Exception when calling ScheduleApi->scheduleEdit: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ScheduleApi()
eventId = 56 # Integer | The Scheduled Event ID
eventTypeId = 56 # Integer | The Event Type Id to use for this Event.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action
displayOrder = 56 # Integer | The display order for this event. 
isPriority = 56 # Integer | An integer indicating the priority of this event. Normal events have a priority of 0.
displayGroupIds =  # array[Integer] | The Display Group IDs for this event.
     * Display specific Group IDs should be used to schedule on single displays.
fromDt = fromDt_example # String | The from date for this event.
campaignId = 56 # Integer | The Campaign ID to use for this Event.
     * If a Layout is needed then the Campaign specific ID for that Layout should be used. (optional)
commandId = 56 # Integer | The Command ID to use for this Event. (optional)
dayPartId = 56 # Integer | The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0. (optional)
syncTimezone = 56 # Integer | Should this schedule be synced to the resulting Display timezone? (optional)
toDt = toDt_example # String | The to date for this event. (optional)
recurrenceType = recurrenceType_example # String | The type of recurrence to apply to this event. (optional)
recurrenceDetail = 56 # Integer | The interval for the recurrence. (optional)
recurrenceRange = recurrenceRange_example # String | The end date for this events recurrence. (optional)
recurrenceRepeatsOn = recurrenceRepeatsOn_example # String | The days of the week that this event repeats - weekly only (optional)
scheduleReminders =  # array[#/definitions/ScheduleReminderArray] | Array of Reminders for this event (optional)
isGeoAware = 56 # Integer | Flag (0-1), whether this event is using Geo Location (optional)
geoLocation =  # array[String] | Array of comma separated strings each with comma separated pair of coordinates (optional)
geoLocationJson = geoLocationJson_example # String | Valid GeoJSON string, use as an alternative to geoLocation parameter (optional)
actionType = actionType_example # String | For Action eventTypeId, the type of the action - command or navLayout (optional)
actionTriggerCode = actionTriggerCode_example # String | For Action eventTypeId, the webhook trigger code for the Action (optional)
actionLayoutCode = actionLayoutCode_example # String | For Action eventTypeId and navLayout actionType, the Layout Code identifier (optional)

try: 
    # Edit Schedule Event
    api_instance.schedule_edit(eventId, eventTypeId, displayOrder, isPriority, displayGroupIds, fromDt, campaignId=campaignId, commandId=commandId, dayPartId=dayPartId, syncTimezone=syncTimezone, toDt=toDt, recurrenceType=recurrenceType, recurrenceDetail=recurrenceDetail, recurrenceRange=recurrenceRange, recurrenceRepeatsOn=recurrenceRepeatsOn, scheduleReminders=scheduleReminders, isGeoAware=isGeoAware, geoLocation=geoLocation, geoLocationJson=geoLocationJson, actionType=actionType, actionTriggerCode=actionTriggerCode, actionLayoutCode=actionLayoutCode)
except ApiException as e:
    print("Exception when calling ScheduleApi->scheduleEdit: %s\n" % e)

Parameters

Path parameters
Name Description
eventId*
Integer
The Scheduled Event ID
Required
Query parameters
Name Description
eventTypeId*
Integer
The Event Type Id to use for this Event. * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action
Required
campaignId
Integer
The Campaign ID to use for this Event. * If a Layout is needed then the Campaign specific ID for that Layout should be used.
commandId
Integer
The Command ID to use for this Event.
displayOrder*
Integer
The display order for this event.
Required
isPriority*
Integer
An integer indicating the priority of this event. Normal events have a priority of 0.
Required
displayGroupIds*
array[Integer]
The Display Group IDs for this event. * Display specific Group IDs should be used to schedule on single displays.
Required
dayPartId
Integer
The Day Part for this event. Overrides supported are 0(custom) and 1(always). Defaulted to 0.
syncTimezone
Integer
Should this schedule be synced to the resulting Display timezone?
fromDt*
String
The from date for this event.
Required
toDt
String
The to date for this event.
recurrenceType
String
The type of recurrence to apply to this event.
recurrenceDetail
Integer
The interval for the recurrence.
recurrenceRange
String
The end date for this events recurrence.
recurrenceRepeatsOn
String
The days of the week that this event repeats - weekly only
scheduleReminders
array[#/definitions/ScheduleReminderArray]
Array of Reminders for this event
isGeoAware
Integer
Flag (0-1), whether this event is using Geo Location
geoLocation
array[String]
Array of comma separated strings each with comma separated pair of coordinates
geoLocationJson
String
Valid GeoJSON string, use as an alternative to geoLocation parameter
actionType
String
For Action eventTypeId, the type of the action - command or navLayout
actionTriggerCode
String
For Action eventTypeId, the webhook trigger code for the Action
actionLayoutCode
String
For Action eventTypeId and navLayout actionType, the Layout Code identifier

Responses

Status: 200 - successful operation


scheduleSearch

Generates the Schedule events grid


/schedule

Usage and SDK Samples

curl -X GET\
"https://premium.digitalsignagevision.com/api/schedule?eventTypeId=&fromDt=&toDt=&geoAware=&recurring=&campaignId=&displayGroupIds="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScheduleApi;

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

public class ScheduleApiExample {

    public static void main(String[] args) {
        
        ScheduleApi apiInstance = new ScheduleApi();
        Integer eventTypeId = 56; // Integer | Filter grid by eventTypeId.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
        String fromDt = fromDt_example; // String | From Date in Y-m-d H:i:s format
        String toDt = toDt_example; // String | To Date in Y-m-d H:i:s format
        Integer geoAware = 56; // Integer | Flag (0-1), whether to return events using Geo Location
        Integer recurring = 56; // Integer | Flag (0-1), whether to return Recurring events
        Integer campaignId = 56; // Integer | Filter events by specific campaignId
        array[Integer] displayGroupIds = ; // array[Integer] | Filter events by an array of Display Group Ids
        try {
            apiInstance.scheduleSearch(eventTypeId, fromDt, toDt, geoAware, recurring, campaignId, displayGroupIds);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduleApi#scheduleSearch");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScheduleApi;

public class ScheduleApiExample {

    public static void main(String[] args) {
        ScheduleApi apiInstance = new ScheduleApi();
        Integer eventTypeId = 56; // Integer | Filter grid by eventTypeId.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
        String fromDt = fromDt_example; // String | From Date in Y-m-d H:i:s format
        String toDt = toDt_example; // String | To Date in Y-m-d H:i:s format
        Integer geoAware = 56; // Integer | Flag (0-1), whether to return events using Geo Location
        Integer recurring = 56; // Integer | Flag (0-1), whether to return Recurring events
        Integer campaignId = 56; // Integer | Filter events by specific campaignId
        array[Integer] displayGroupIds = ; // array[Integer] | Filter events by an array of Display Group Ids
        try {
            apiInstance.scheduleSearch(eventTypeId, fromDt, toDt, geoAware, recurring, campaignId, displayGroupIds);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduleApi#scheduleSearch");
            e.printStackTrace();
        }
    }
}
Integer *eventTypeId = 56; // Filter grid by eventTypeId.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist (optional)
String *fromDt = fromDt_example; // From Date in Y-m-d H:i:s format (optional)
String *toDt = toDt_example; // To Date in Y-m-d H:i:s format (optional)
Integer *geoAware = 56; // Flag (0-1), whether to return events using Geo Location (optional)
Integer *recurring = 56; // Flag (0-1), whether to return Recurring events (optional)
Integer *campaignId = 56; // Filter events by specific campaignId (optional)
array[Integer] *displayGroupIds = ; // Filter events by an array of Display Group Ids (optional)

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

// Generates the Schedule events grid
[apiInstance scheduleSearchWith:eventTypeId
    fromDt:fromDt
    toDt:toDt
    geoAware:geoAware
    recurring:recurring
    campaignId:campaignId
    displayGroupIds:displayGroupIds
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.ScheduleApi()
var opts = { 
  'eventTypeId': 56, // {{Integer}} Filter grid by eventTypeId.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
  'fromDt': fromDt_example, // {{String}} From Date in Y-m-d H:i:s format
  'toDt': toDt_example, // {{String}} To Date in Y-m-d H:i:s format
  'geoAware': 56, // {{Integer}} Flag (0-1), whether to return events using Geo Location
  'recurring': 56, // {{Integer}} Flag (0-1), whether to return Recurring events
  'campaignId': 56, // {{Integer}} Filter events by specific campaignId
  'displayGroupIds':  // {{array[Integer]}} Filter events by an array of Display Group Ids
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.scheduleSearch(opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class scheduleSearchExample
    {
        public void main()
        {

            var apiInstance = new ScheduleApi();
            var eventTypeId = 56;  // Integer | Filter grid by eventTypeId.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist (optional) 
            var fromDt = fromDt_example;  // String | From Date in Y-m-d H:i:s format (optional) 
            var toDt = toDt_example;  // String | To Date in Y-m-d H:i:s format (optional) 
            var geoAware = 56;  // Integer | Flag (0-1), whether to return events using Geo Location (optional) 
            var recurring = 56;  // Integer | Flag (0-1), whether to return Recurring events (optional) 
            var campaignId = 56;  // Integer | Filter events by specific campaignId (optional) 
            var displayGroupIds = new array[Integer](); // array[Integer] | Filter events by an array of Display Group Ids (optional) 

            try
            {
                // Generates the Schedule events grid
                apiInstance.scheduleSearch(eventTypeId, fromDt, toDt, geoAware, recurring, campaignId, displayGroupIds);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScheduleApi.scheduleSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiScheduleApi();
$eventTypeId = 56; // Integer | Filter grid by eventTypeId.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
$fromDt = fromDt_example; // String | From Date in Y-m-d H:i:s format
$toDt = toDt_example; // String | To Date in Y-m-d H:i:s format
$geoAware = 56; // Integer | Flag (0-1), whether to return events using Geo Location
$recurring = 56; // Integer | Flag (0-1), whether to return Recurring events
$campaignId = 56; // Integer | Filter events by specific campaignId
$displayGroupIds = ; // array[Integer] | Filter events by an array of Display Group Ids

try {
    $api_instance->scheduleSearch($eventTypeId, $fromDt, $toDt, $geoAware, $recurring, $campaignId, $displayGroupIds);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->scheduleSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScheduleApi;

my $api_instance = WWW::SwaggerClient::ScheduleApi->new();
my $eventTypeId = 56; # Integer | Filter grid by eventTypeId.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
my $fromDt = fromDt_example; # String | From Date in Y-m-d H:i:s format
my $toDt = toDt_example; # String | To Date in Y-m-d H:i:s format
my $geoAware = 56; # Integer | Flag (0-1), whether to return events using Geo Location
my $recurring = 56; # Integer | Flag (0-1), whether to return Recurring events
my $campaignId = 56; # Integer | Filter events by specific campaignId
my $displayGroupIds = []; # array[Integer] | Filter events by an array of Display Group Ids

eval { 
    $api_instance->scheduleSearch(eventTypeId => $eventTypeId, fromDt => $fromDt, toDt => $toDt, geoAware => $geoAware, recurring => $recurring, campaignId => $campaignId, displayGroupIds => $displayGroupIds);
};
if ($@) {
    warn "Exception when calling ScheduleApi->scheduleSearch: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ScheduleApi()
eventTypeId = 56 # Integer | Filter grid by eventTypeId.
     * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist (optional)
fromDt = fromDt_example # String | From Date in Y-m-d H:i:s format (optional)
toDt = toDt_example # String | To Date in Y-m-d H:i:s format (optional)
geoAware = 56 # Integer | Flag (0-1), whether to return events using Geo Location (optional)
recurring = 56 # Integer | Flag (0-1), whether to return Recurring events (optional)
campaignId = 56 # Integer | Filter events by specific campaignId (optional)
displayGroupIds =  # array[Integer] | Filter events by an array of Display Group Ids (optional)

try: 
    # Generates the Schedule events grid
    api_instance.schedule_search(eventTypeId=eventTypeId, fromDt=fromDt, toDt=toDt, geoAware=geoAware, recurring=recurring, campaignId=campaignId, displayGroupIds=displayGroupIds)
except ApiException as e:
    print("Exception when calling ScheduleApi->scheduleSearch: %s\n" % e)

Parameters

Query parameters
Name Description
eventTypeId
Integer
Filter grid by eventTypeId. * 1=Layout, 2=Command, 3=Overlay, 4=Interrupt, 5=Campaign, 6=Action, 7=Media Library, 8=Playlist
fromDt
String
From Date in Y-m-d H:i:s format
toDt
String
To Date in Y-m-d H:i:s format
geoAware
Integer
Flag (0-1), whether to return events using Geo Location
recurring
Integer
Flag (0-1), whether to return Recurring events
campaignId
Integer
Filter events by specific campaignId
displayGroupIds
array[Integer]
Filter events by an array of Display Group Ids

Responses

Status: 200 - successful operation


schedulerecurrenceDelete

Delete a Recurring Event

Delete a Recurring Event of a Scheduled Event


/schedulerecurrence/{eventId}

Usage and SDK Samples

curl -X DELETE\
"https://premium.digitalsignagevision.com/api/schedulerecurrence/{eventId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScheduleApi;

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

public class ScheduleApiExample {

    public static void main(String[] args) {
        
        ScheduleApi apiInstance = new ScheduleApi();
        Integer eventId = 56; // Integer | The Scheduled Event ID
        try {
            apiInstance.schedulerecurrenceDelete(eventId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduleApi#schedulerecurrenceDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ScheduleApi;

public class ScheduleApiExample {

    public static void main(String[] args) {
        ScheduleApi apiInstance = new ScheduleApi();
        Integer eventId = 56; // Integer | The Scheduled Event ID
        try {
            apiInstance.schedulerecurrenceDelete(eventId);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScheduleApi#schedulerecurrenceDelete");
            e.printStackTrace();
        }
    }
}
Integer *eventId = 56; // The Scheduled Event ID

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

// Delete a Recurring Event
[apiInstance schedulerecurrenceDeleteWith:eventId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.ScheduleApi()
var eventId = 56; // {{Integer}} The Scheduled Event ID

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

namespace Example
{
    public class schedulerecurrenceDeleteExample
    {
        public void main()
        {

            var apiInstance = new ScheduleApi();
            var eventId = 56;  // Integer | The Scheduled Event ID

            try
            {
                // Delete a Recurring Event
                apiInstance.schedulerecurrenceDelete(eventId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScheduleApi.schedulerecurrenceDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiScheduleApi();
$eventId = 56; // Integer | The Scheduled Event ID

try {
    $api_instance->schedulerecurrenceDelete($eventId);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->schedulerecurrenceDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScheduleApi;

my $api_instance = WWW::SwaggerClient::ScheduleApi->new();
my $eventId = 56; # Integer | The Scheduled Event ID

eval { 
    $api_instance->schedulerecurrenceDelete(eventId => $eventId);
};
if ($@) {
    warn "Exception when calling ScheduleApi->schedulerecurrenceDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ScheduleApi()
eventId = 56 # Integer | The Scheduled Event ID

try: 
    # Delete a Recurring Event
    api_instance.schedulerecurrence_delete(eventId)
except ApiException as e:
    print("Exception when calling ScheduleApi->schedulerecurrenceDelete: %s\n" % e)

Parameters

Path parameters
Name Description
eventId*
Integer
The Scheduled Event ID
Required

Responses

Status: 204 - successful operation


Widget

addWidget

Add a Widget to a Playlist

Add a new Widget to a Playlist


/playlist/widget/{type}/{playlistId}

Usage and SDK Samples

curl -X POST\
"https://premium.digitalsignagevision.com/api/playlist/widget/{type}/{playlistId}?displayOrder=&templateId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WidgetApi;

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

public class WidgetApiExample {

    public static void main(String[] args) {
        
        WidgetApi apiInstance = new WidgetApi();
        String type = type_example; // String | The type of the Widget e.g. text. Media based Widgets like Image are added via POST /playlist/library/assign/{playlistId} call.
        Integer playlistId = 56; // Integer | The Playlist ID
        Integer displayOrder = 56; // Integer | Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one.
        String templateId = templateId_example; // String | If the module type provided has a dataType then provide the templateId to use.
        try {
            apiInstance.addWidget(type, playlistId, displayOrder, templateId);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#addWidget");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WidgetApi;

public class WidgetApiExample {

    public static void main(String[] args) {
        WidgetApi apiInstance = new WidgetApi();
        String type = type_example; // String | The type of the Widget e.g. text. Media based Widgets like Image are added via POST /playlist/library/assign/{playlistId} call.
        Integer playlistId = 56; // Integer | The Playlist ID
        Integer displayOrder = 56; // Integer | Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one.
        String templateId = templateId_example; // String | If the module type provided has a dataType then provide the templateId to use.
        try {
            apiInstance.addWidget(type, playlistId, displayOrder, templateId);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#addWidget");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // The type of the Widget e.g. text. Media based Widgets like Image are added via POST /playlist/library/assign/{playlistId} call.
Integer *playlistId = 56; // The Playlist ID
Integer *displayOrder = 56; // Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one. (optional)
String *templateId = templateId_example; // If the module type provided has a dataType then provide the templateId to use. (optional)

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

// Add a Widget to a Playlist
[apiInstance addWidgetWith:type
    playlistId:playlistId
    displayOrder:displayOrder
    templateId:templateId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.WidgetApi()
var type = type_example; // {{String}} The type of the Widget e.g. text. Media based Widgets like Image are added via POST /playlist/library/assign/{playlistId} call.
var playlistId = 56; // {{Integer}} The Playlist ID
var opts = { 
  'displayOrder': 56, // {{Integer}} Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one.
  'templateId': templateId_example // {{String}} If the module type provided has a dataType then provide the templateId to use.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addWidget(type, playlistId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class addWidgetExample
    {
        public void main()
        {

            var apiInstance = new WidgetApi();
            var type = type_example;  // String | The type of the Widget e.g. text. Media based Widgets like Image are added via POST /playlist/library/assign/{playlistId} call.
            var playlistId = 56;  // Integer | The Playlist ID
            var displayOrder = 56;  // Integer | Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one. (optional) 
            var templateId = templateId_example;  // String | If the module type provided has a dataType then provide the templateId to use. (optional) 

            try
            {
                // Add a Widget to a Playlist
                apiInstance.addWidget(type, playlistId, displayOrder, templateId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WidgetApi.addWidget: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiWidgetApi();
$type = type_example; // String | The type of the Widget e.g. text. Media based Widgets like Image are added via POST /playlist/library/assign/{playlistId} call.
$playlistId = 56; // Integer | The Playlist ID
$displayOrder = 56; // Integer | Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one.
$templateId = templateId_example; // String | If the module type provided has a dataType then provide the templateId to use.

try {
    $api_instance->addWidget($type, $playlistId, $displayOrder, $templateId);
} catch (Exception $e) {
    echo 'Exception when calling WidgetApi->addWidget: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WidgetApi;

my $api_instance = WWW::SwaggerClient::WidgetApi->new();
my $type = type_example; # String | The type of the Widget e.g. text. Media based Widgets like Image are added via POST /playlist/library/assign/{playlistId} call.
my $playlistId = 56; # Integer | The Playlist ID
my $displayOrder = 56; # Integer | Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one.
my $templateId = templateId_example; # String | If the module type provided has a dataType then provide the templateId to use.

eval { 
    $api_instance->addWidget(type => $type, playlistId => $playlistId, displayOrder => $displayOrder, templateId => $templateId);
};
if ($@) {
    warn "Exception when calling WidgetApi->addWidget: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WidgetApi()
type = type_example # String | The type of the Widget e.g. text. Media based Widgets like Image are added via POST /playlist/library/assign/{playlistId} call.
playlistId = 56 # Integer | The Playlist ID
displayOrder = 56 # Integer | Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one. (optional)
templateId = templateId_example # String | If the module type provided has a dataType then provide the templateId to use. (optional)

try: 
    # Add a Widget to a Playlist
    api_instance.add_widget(type, playlistId, displayOrder=displayOrder, templateId=templateId)
except ApiException as e:
    print("Exception when calling WidgetApi->addWidget: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
The type of the Widget e.g. text. Media based Widgets like Image are added via POST /playlist/library/assign/{playlistId} call.
Required
playlistId*
Integer
The Playlist ID
Required
Query parameters
Name Description
displayOrder
Integer
Optional integer to say which position this assignment should occupy in the list. If more than one media item is being added, this will be the position of the first one.
templateId
String
If the module type provided has a dataType then provide the templateId to use.

Responses

Status: 201 - successful operation

Name Type Format Description
Location String

editWidget

Edit a Widget

Edit a widget providing new properties to set on it


/playlist/widget/{id}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/playlist/widget/{id}?useDuration=&duration=&name=&enableStat=&isRepeatData=&properties="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WidgetApi;

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

public class WidgetApiExample {

    public static void main(String[] args) {
        
        WidgetApi apiInstance = new WidgetApi();
        String id = id_example; // String | The ID of the Widget
        Integer useDuration = 56; // Integer | Set a duration on this widget, if unchecked the default or library duration will be used.
        Integer duration = 56; // Integer | Duration to use on this widget
        String name = name_example; // String | An optional name for this widget
        String enableStat = enableStat_example; // String | Should stats be enabled? On|Off|Inherit 
        Integer isRepeatData = 56; // Integer | If this widget requires data, should that data be repeated to meet the number of items requested?
        Integer properties = 56; // Integer | Add an additional parameter for each of the properties required this module and its template. Use the moduleProperties and moduleTemplateProperties calls to get a list of properties needed
        try {
            apiInstance.editWidget(id, useDuration, duration, name, enableStat, isRepeatData, properties);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#editWidget");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WidgetApi;

public class WidgetApiExample {

    public static void main(String[] args) {
        WidgetApi apiInstance = new WidgetApi();
        String id = id_example; // String | The ID of the Widget
        Integer useDuration = 56; // Integer | Set a duration on this widget, if unchecked the default or library duration will be used.
        Integer duration = 56; // Integer | Duration to use on this widget
        String name = name_example; // String | An optional name for this widget
        String enableStat = enableStat_example; // String | Should stats be enabled? On|Off|Inherit 
        Integer isRepeatData = 56; // Integer | If this widget requires data, should that data be repeated to meet the number of items requested?
        Integer properties = 56; // Integer | Add an additional parameter for each of the properties required this module and its template. Use the moduleProperties and moduleTemplateProperties calls to get a list of properties needed
        try {
            apiInstance.editWidget(id, useDuration, duration, name, enableStat, isRepeatData, properties);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#editWidget");
            e.printStackTrace();
        }
    }
}
String *id = id_example; // The ID of the Widget
Integer *useDuration = 56; // Set a duration on this widget, if unchecked the default or library duration will be used. (optional)
Integer *duration = 56; // Duration to use on this widget (optional)
String *name = name_example; // An optional name for this widget (optional)
String *enableStat = enableStat_example; // Should stats be enabled? On|Off|Inherit  (optional)
Integer *isRepeatData = 56; // If this widget requires data, should that data be repeated to meet the number of items requested? (optional)
Integer *properties = 56; // Add an additional parameter for each of the properties required this module and its template. Use the moduleProperties and moduleTemplateProperties calls to get a list of properties needed (optional)

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

// Edit a Widget
[apiInstance editWidgetWith:id
    useDuration:useDuration
    duration:duration
    name:name
    enableStat:enableStat
    isRepeatData:isRepeatData
    properties:properties
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.WidgetApi()
var id = id_example; // {{String}} The ID of the Widget
var opts = { 
  'useDuration': 56, // {{Integer}} Set a duration on this widget, if unchecked the default or library duration will be used.
  'duration': 56, // {{Integer}} Duration to use on this widget
  'name': name_example, // {{String}} An optional name for this widget
  'enableStat': enableStat_example, // {{String}} Should stats be enabled? On|Off|Inherit 
  'isRepeatData': 56, // {{Integer}} If this widget requires data, should that data be repeated to meet the number of items requested?
  'properties': 56 // {{Integer}} Add an additional parameter for each of the properties required this module and its template. Use the moduleProperties and moduleTemplateProperties calls to get a list of properties needed
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.editWidget(id, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class editWidgetExample
    {
        public void main()
        {

            var apiInstance = new WidgetApi();
            var id = id_example;  // String | The ID of the Widget
            var useDuration = 56;  // Integer | Set a duration on this widget, if unchecked the default or library duration will be used. (optional) 
            var duration = 56;  // Integer | Duration to use on this widget (optional) 
            var name = name_example;  // String | An optional name for this widget (optional) 
            var enableStat = enableStat_example;  // String | Should stats be enabled? On|Off|Inherit  (optional) 
            var isRepeatData = 56;  // Integer | If this widget requires data, should that data be repeated to meet the number of items requested? (optional) 
            var properties = 56;  // Integer | Add an additional parameter for each of the properties required this module and its template. Use the moduleProperties and moduleTemplateProperties calls to get a list of properties needed (optional) 

            try
            {
                // Edit a Widget
                apiInstance.editWidget(id, useDuration, duration, name, enableStat, isRepeatData, properties);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WidgetApi.editWidget: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiWidgetApi();
$id = id_example; // String | The ID of the Widget
$useDuration = 56; // Integer | Set a duration on this widget, if unchecked the default or library duration will be used.
$duration = 56; // Integer | Duration to use on this widget
$name = name_example; // String | An optional name for this widget
$enableStat = enableStat_example; // String | Should stats be enabled? On|Off|Inherit 
$isRepeatData = 56; // Integer | If this widget requires data, should that data be repeated to meet the number of items requested?
$properties = 56; // Integer | Add an additional parameter for each of the properties required this module and its template. Use the moduleProperties and moduleTemplateProperties calls to get a list of properties needed

try {
    $api_instance->editWidget($id, $useDuration, $duration, $name, $enableStat, $isRepeatData, $properties);
} catch (Exception $e) {
    echo 'Exception when calling WidgetApi->editWidget: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WidgetApi;

my $api_instance = WWW::SwaggerClient::WidgetApi->new();
my $id = id_example; # String | The ID of the Widget
my $useDuration = 56; # Integer | Set a duration on this widget, if unchecked the default or library duration will be used.
my $duration = 56; # Integer | Duration to use on this widget
my $name = name_example; # String | An optional name for this widget
my $enableStat = enableStat_example; # String | Should stats be enabled? On|Off|Inherit 
my $isRepeatData = 56; # Integer | If this widget requires data, should that data be repeated to meet the number of items requested?
my $properties = 56; # Integer | Add an additional parameter for each of the properties required this module and its template. Use the moduleProperties and moduleTemplateProperties calls to get a list of properties needed

eval { 
    $api_instance->editWidget(id => $id, useDuration => $useDuration, duration => $duration, name => $name, enableStat => $enableStat, isRepeatData => $isRepeatData, properties => $properties);
};
if ($@) {
    warn "Exception when calling WidgetApi->editWidget: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WidgetApi()
id = id_example # String | The ID of the Widget
useDuration = 56 # Integer | Set a duration on this widget, if unchecked the default or library duration will be used. (optional)
duration = 56 # Integer | Duration to use on this widget (optional)
name = name_example # String | An optional name for this widget (optional)
enableStat = enableStat_example # String | Should stats be enabled? On|Off|Inherit  (optional)
isRepeatData = 56 # Integer | If this widget requires data, should that data be repeated to meet the number of items requested? (optional)
properties = 56 # Integer | Add an additional parameter for each of the properties required this module and its template. Use the moduleProperties and moduleTemplateProperties calls to get a list of properties needed (optional)

try: 
    # Edit a Widget
    api_instance.edit_widget(id, useDuration=useDuration, duration=duration, name=name, enableStat=enableStat, isRepeatData=isRepeatData, properties=properties)
except ApiException as e:
    print("Exception when calling WidgetApi->editWidget: %s\n" % e)

Parameters

Path parameters
Name Description
id*
String
The ID of the Widget
Required
Query parameters
Name Description
useDuration
Integer
Set a duration on this widget, if unchecked the default or library duration will be used.
duration
Integer
Duration to use on this widget
name
String
An optional name for this widget
enableStat
String
Should stats be enabled? On|Off|Inherit
isRepeatData
Integer
If this widget requires data, should that data be repeated to meet the number of items requested?
properties
Integer
Add an additional parameter for each of the properties required this module and its template. Use the moduleProperties and moduleTemplateProperties calls to get a list of properties needed

Responses

Status: 204 - successful operation


widgetAssignedAudioEdit

Parameters for edting/adding audio file to a specific widget

Parameters for edting/adding audio file to a specific widget


/playlist/widget/{widgetId}/audio

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/playlist/widget/{widgetId}/audio?mediaId=&volume=&loop="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WidgetApi;

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

public class WidgetApiExample {

    public static void main(String[] args) {
        
        WidgetApi apiInstance = new WidgetApi();
        Integer widgetId = 56; // Integer | Id of a widget to which you want to add audio or edit existing audio
        Integer mediaId = 56; // Integer | Id of a audio file in CMS library you wish to add to a widget
        Integer volume = 56; // Integer | Volume percentage(0-100) for this audio to play at
        Integer loop = 56; // Integer | Flag (0, 1) Should the audio loop if it finishes before the widget has finished?
        try {
            apiInstance.widgetAssignedAudioEdit(widgetId, mediaId, volume, loop);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#widgetAssignedAudioEdit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WidgetApi;

public class WidgetApiExample {

    public static void main(String[] args) {
        WidgetApi apiInstance = new WidgetApi();
        Integer widgetId = 56; // Integer | Id of a widget to which you want to add audio or edit existing audio
        Integer mediaId = 56; // Integer | Id of a audio file in CMS library you wish to add to a widget
        Integer volume = 56; // Integer | Volume percentage(0-100) for this audio to play at
        Integer loop = 56; // Integer | Flag (0, 1) Should the audio loop if it finishes before the widget has finished?
        try {
            apiInstance.widgetAssignedAudioEdit(widgetId, mediaId, volume, loop);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#widgetAssignedAudioEdit");
            e.printStackTrace();
        }
    }
}
Integer *widgetId = 56; // Id of a widget to which you want to add audio or edit existing audio
Integer *mediaId = 56; // Id of a audio file in CMS library you wish to add to a widget (optional)
Integer *volume = 56; // Volume percentage(0-100) for this audio to play at (optional)
Integer *loop = 56; // Flag (0, 1) Should the audio loop if it finishes before the widget has finished? (optional)

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

// Parameters for edting/adding audio file to a specific widget
[apiInstance widgetAssignedAudioEditWith:widgetId
    mediaId:mediaId
    volume:volume
    loop:loop
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.WidgetApi()
var widgetId = 56; // {{Integer}} Id of a widget to which you want to add audio or edit existing audio
var opts = { 
  'mediaId': 56, // {{Integer}} Id of a audio file in CMS library you wish to add to a widget
  'volume': 56, // {{Integer}} Volume percentage(0-100) for this audio to play at
  'loop': 56 // {{Integer}} Flag (0, 1) Should the audio loop if it finishes before the widget has finished?
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.widgetAssignedAudioEdit(widgetId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class widgetAssignedAudioEditExample
    {
        public void main()
        {

            var apiInstance = new WidgetApi();
            var widgetId = 56;  // Integer | Id of a widget to which you want to add audio or edit existing audio
            var mediaId = 56;  // Integer | Id of a audio file in CMS library you wish to add to a widget (optional) 
            var volume = 56;  // Integer | Volume percentage(0-100) for this audio to play at (optional) 
            var loop = 56;  // Integer | Flag (0, 1) Should the audio loop if it finishes before the widget has finished? (optional) 

            try
            {
                // Parameters for edting/adding audio file to a specific widget
                apiInstance.widgetAssignedAudioEdit(widgetId, mediaId, volume, loop);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WidgetApi.widgetAssignedAudioEdit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiWidgetApi();
$widgetId = 56; // Integer | Id of a widget to which you want to add audio or edit existing audio
$mediaId = 56; // Integer | Id of a audio file in CMS library you wish to add to a widget
$volume = 56; // Integer | Volume percentage(0-100) for this audio to play at
$loop = 56; // Integer | Flag (0, 1) Should the audio loop if it finishes before the widget has finished?

try {
    $api_instance->widgetAssignedAudioEdit($widgetId, $mediaId, $volume, $loop);
} catch (Exception $e) {
    echo 'Exception when calling WidgetApi->widgetAssignedAudioEdit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WidgetApi;

my $api_instance = WWW::SwaggerClient::WidgetApi->new();
my $widgetId = 56; # Integer | Id of a widget to which you want to add audio or edit existing audio
my $mediaId = 56; # Integer | Id of a audio file in CMS library you wish to add to a widget
my $volume = 56; # Integer | Volume percentage(0-100) for this audio to play at
my $loop = 56; # Integer | Flag (0, 1) Should the audio loop if it finishes before the widget has finished?

eval { 
    $api_instance->widgetAssignedAudioEdit(widgetId => $widgetId, mediaId => $mediaId, volume => $volume, loop => $loop);
};
if ($@) {
    warn "Exception when calling WidgetApi->widgetAssignedAudioEdit: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WidgetApi()
widgetId = 56 # Integer | Id of a widget to which you want to add audio or edit existing audio
mediaId = 56 # Integer | Id of a audio file in CMS library you wish to add to a widget (optional)
volume = 56 # Integer | Volume percentage(0-100) for this audio to play at (optional)
loop = 56 # Integer | Flag (0, 1) Should the audio loop if it finishes before the widget has finished? (optional)

try: 
    # Parameters for edting/adding audio file to a specific widget
    api_instance.widget_assigned_audio_edit(widgetId, mediaId=mediaId, volume=volume, loop=loop)
except ApiException as e:
    print("Exception when calling WidgetApi->widgetAssignedAudioEdit: %s\n" % e)

Parameters

Path parameters
Name Description
widgetId*
Integer
Id of a widget to which you want to add audio or edit existing audio
Required
Query parameters
Name Description
mediaId
Integer
Id of a audio file in CMS library you wish to add to a widget
volume
Integer
Volume percentage(0-100) for this audio to play at
loop
Integer
Flag (0, 1) Should the audio loop if it finishes before the widget has finished?

Responses

Status: 200 - successful operation

Name Type Format Description
Location String

widgetAssignedExpiryEdit

Set Widget From/To Dates

Control when this Widget is active on this Playlist


/playlist/widget/{widgetId}/expiry

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/playlist/widget/{widgetId}/expiry?fromDt=&toDt=&deleteOnExpiry="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WidgetApi;

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

public class WidgetApiExample {

    public static void main(String[] args) {
        
        WidgetApi apiInstance = new WidgetApi();
        Integer widgetId = 56; // Integer | Id of a widget to which you want to add audio or edit existing audio
        String fromDt = fromDt_example; // String | The From Date in Y-m-d H::i:s format
        String toDt = toDt_example; // String | The To Date in Y-m-d H::i:s format
        Integer deleteOnExpiry = 56; // Integer | Delete this Widget when it expires?
        try {
            apiInstance.widgetAssignedExpiryEdit(widgetId, fromDt, toDt, deleteOnExpiry);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#widgetAssignedExpiryEdit");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WidgetApi;

public class WidgetApiExample {

    public static void main(String[] args) {
        WidgetApi apiInstance = new WidgetApi();
        Integer widgetId = 56; // Integer | Id of a widget to which you want to add audio or edit existing audio
        String fromDt = fromDt_example; // String | The From Date in Y-m-d H::i:s format
        String toDt = toDt_example; // String | The To Date in Y-m-d H::i:s format
        Integer deleteOnExpiry = 56; // Integer | Delete this Widget when it expires?
        try {
            apiInstance.widgetAssignedExpiryEdit(widgetId, fromDt, toDt, deleteOnExpiry);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#widgetAssignedExpiryEdit");
            e.printStackTrace();
        }
    }
}
Integer *widgetId = 56; // Id of a widget to which you want to add audio or edit existing audio
String *fromDt = fromDt_example; // The From Date in Y-m-d H::i:s format (optional)
String *toDt = toDt_example; // The To Date in Y-m-d H::i:s format (optional)
Integer *deleteOnExpiry = 56; // Delete this Widget when it expires? (optional)

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

// Set Widget From/To Dates
[apiInstance widgetAssignedExpiryEditWith:widgetId
    fromDt:fromDt
    toDt:toDt
    deleteOnExpiry:deleteOnExpiry
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.WidgetApi()
var widgetId = 56; // {{Integer}} Id of a widget to which you want to add audio or edit existing audio
var opts = { 
  'fromDt': fromDt_example, // {{String}} The From Date in Y-m-d H::i:s format
  'toDt': toDt_example, // {{String}} The To Date in Y-m-d H::i:s format
  'deleteOnExpiry': 56 // {{Integer}} Delete this Widget when it expires?
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.widgetAssignedExpiryEdit(widgetId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class widgetAssignedExpiryEditExample
    {
        public void main()
        {

            var apiInstance = new WidgetApi();
            var widgetId = 56;  // Integer | Id of a widget to which you want to add audio or edit existing audio
            var fromDt = fromDt_example;  // String | The From Date in Y-m-d H::i:s format (optional) 
            var toDt = toDt_example;  // String | The To Date in Y-m-d H::i:s format (optional) 
            var deleteOnExpiry = 56;  // Integer | Delete this Widget when it expires? (optional) 

            try
            {
                // Set Widget From/To Dates
                apiInstance.widgetAssignedExpiryEdit(widgetId, fromDt, toDt, deleteOnExpiry);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WidgetApi.widgetAssignedExpiryEdit: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiWidgetApi();
$widgetId = 56; // Integer | Id of a widget to which you want to add audio or edit existing audio
$fromDt = fromDt_example; // String | The From Date in Y-m-d H::i:s format
$toDt = toDt_example; // String | The To Date in Y-m-d H::i:s format
$deleteOnExpiry = 56; // Integer | Delete this Widget when it expires?

try {
    $api_instance->widgetAssignedExpiryEdit($widgetId, $fromDt, $toDt, $deleteOnExpiry);
} catch (Exception $e) {
    echo 'Exception when calling WidgetApi->widgetAssignedExpiryEdit: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WidgetApi;

my $api_instance = WWW::SwaggerClient::WidgetApi->new();
my $widgetId = 56; # Integer | Id of a widget to which you want to add audio or edit existing audio
my $fromDt = fromDt_example; # String | The From Date in Y-m-d H::i:s format
my $toDt = toDt_example; # String | The To Date in Y-m-d H::i:s format
my $deleteOnExpiry = 56; # Integer | Delete this Widget when it expires?

eval { 
    $api_instance->widgetAssignedExpiryEdit(widgetId => $widgetId, fromDt => $fromDt, toDt => $toDt, deleteOnExpiry => $deleteOnExpiry);
};
if ($@) {
    warn "Exception when calling WidgetApi->widgetAssignedExpiryEdit: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WidgetApi()
widgetId = 56 # Integer | Id of a widget to which you want to add audio or edit existing audio
fromDt = fromDt_example # String | The From Date in Y-m-d H::i:s format (optional)
toDt = toDt_example # String | The To Date in Y-m-d H::i:s format (optional)
deleteOnExpiry = 56 # Integer | Delete this Widget when it expires? (optional)

try: 
    # Set Widget From/To Dates
    api_instance.widget_assigned_expiry_edit(widgetId, fromDt=fromDt, toDt=toDt, deleteOnExpiry=deleteOnExpiry)
except ApiException as e:
    print("Exception when calling WidgetApi->widgetAssignedExpiryEdit: %s\n" % e)

Parameters

Path parameters
Name Description
widgetId*
Integer
Id of a widget to which you want to add audio or edit existing audio
Required
Query parameters
Name Description
fromDt
String
The From Date in Y-m-d H::i:s format
toDt
String
The To Date in Y-m-d H::i:s format
deleteOnExpiry
Integer
Delete this Widget when it expires?

Responses

Status: 200 - successful operation

Name Type Format Description
Location String

widgetAssignedRegionSet

Set Widget Region

Set the Region this Widget is intended for - only suitable for Drawer Widgets


/playlist/widget/{widgetId}/region

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/playlist/widget/{widgetId}/region?targetRegionId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WidgetApi;

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

public class WidgetApiExample {

    public static void main(String[] args) {
        
        WidgetApi apiInstance = new WidgetApi();
        Integer widgetId = 56; // Integer | Id of the Widget to set region on
        String targetRegionId = targetRegionId_example; // String | The target regionId
        try {
            apiInstance.widgetAssignedRegionSet(widgetId, targetRegionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#widgetAssignedRegionSet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WidgetApi;

public class WidgetApiExample {

    public static void main(String[] args) {
        WidgetApi apiInstance = new WidgetApi();
        Integer widgetId = 56; // Integer | Id of the Widget to set region on
        String targetRegionId = targetRegionId_example; // String | The target regionId
        try {
            apiInstance.widgetAssignedRegionSet(widgetId, targetRegionId);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#widgetAssignedRegionSet");
            e.printStackTrace();
        }
    }
}
Integer *widgetId = 56; // Id of the Widget to set region on
String *targetRegionId = targetRegionId_example; // The target regionId

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

// Set Widget Region
[apiInstance widgetAssignedRegionSetWith:widgetId
    targetRegionId:targetRegionId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.WidgetApi()
var widgetId = 56; // {{Integer}} Id of the Widget to set region on
var targetRegionId = targetRegionId_example; // {{String}} The target regionId

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.widgetAssignedRegionSet(widgetId, targetRegionId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class widgetAssignedRegionSetExample
    {
        public void main()
        {

            var apiInstance = new WidgetApi();
            var widgetId = 56;  // Integer | Id of the Widget to set region on
            var targetRegionId = targetRegionId_example;  // String | The target regionId

            try
            {
                // Set Widget Region
                apiInstance.widgetAssignedRegionSet(widgetId, targetRegionId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WidgetApi.widgetAssignedRegionSet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiWidgetApi();
$widgetId = 56; // Integer | Id of the Widget to set region on
$targetRegionId = targetRegionId_example; // String | The target regionId

try {
    $api_instance->widgetAssignedRegionSet($widgetId, $targetRegionId);
} catch (Exception $e) {
    echo 'Exception when calling WidgetApi->widgetAssignedRegionSet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WidgetApi;

my $api_instance = WWW::SwaggerClient::WidgetApi->new();
my $widgetId = 56; # Integer | Id of the Widget to set region on
my $targetRegionId = targetRegionId_example; # String | The target regionId

eval { 
    $api_instance->widgetAssignedRegionSet(widgetId => $widgetId, targetRegionId => $targetRegionId);
};
if ($@) {
    warn "Exception when calling WidgetApi->widgetAssignedRegionSet: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WidgetApi()
widgetId = 56 # Integer | Id of the Widget to set region on
targetRegionId = targetRegionId_example # String | The target regionId

try: 
    # Set Widget Region
    api_instance.widget_assigned_region_set(widgetId, targetRegionId)
except ApiException as e:
    print("Exception when calling WidgetApi->widgetAssignedRegionSet: %s\n" % e)

Parameters

Path parameters
Name Description
widgetId*
Integer
Id of the Widget to set region on
Required
Query parameters
Name Description
targetRegionId*
String
The target regionId
Required

Responses

Status: 204 - successful operation


widgetAudioDelete

Delete assigned audio widget

Delete assigned audio widget from specified widget ID


/playlist/widget/{widgetId}/audio

Usage and SDK Samples

curl -X DELETE\
"https://premium.digitalsignagevision.com/api/playlist/widget/{widgetId}/audio"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WidgetApi;

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

public class WidgetApiExample {

    public static void main(String[] args) {
        
        WidgetApi apiInstance = new WidgetApi();
        Integer widgetId = 56; // Integer | Id of a widget from which you want to delete the audio from
        try {
            apiInstance.widgetAudioDelete(widgetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#widgetAudioDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WidgetApi;

public class WidgetApiExample {

    public static void main(String[] args) {
        WidgetApi apiInstance = new WidgetApi();
        Integer widgetId = 56; // Integer | Id of a widget from which you want to delete the audio from
        try {
            apiInstance.widgetAudioDelete(widgetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#widgetAudioDelete");
            e.printStackTrace();
        }
    }
}
Integer *widgetId = 56; // Id of a widget from which you want to delete the audio from

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

// Delete assigned audio widget
[apiInstance widgetAudioDeleteWith:widgetId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.WidgetApi()
var widgetId = 56; // {{Integer}} Id of a widget from which you want to delete the audio from

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

namespace Example
{
    public class widgetAudioDeleteExample
    {
        public void main()
        {

            var apiInstance = new WidgetApi();
            var widgetId = 56;  // Integer | Id of a widget from which you want to delete the audio from

            try
            {
                // Delete assigned audio widget
                apiInstance.widgetAudioDelete(widgetId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WidgetApi.widgetAudioDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiWidgetApi();
$widgetId = 56; // Integer | Id of a widget from which you want to delete the audio from

try {
    $api_instance->widgetAudioDelete($widgetId);
} catch (Exception $e) {
    echo 'Exception when calling WidgetApi->widgetAudioDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WidgetApi;

my $api_instance = WWW::SwaggerClient::WidgetApi->new();
my $widgetId = 56; # Integer | Id of a widget from which you want to delete the audio from

eval { 
    $api_instance->widgetAudioDelete(widgetId => $widgetId);
};
if ($@) {
    warn "Exception when calling WidgetApi->widgetAudioDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WidgetApi()
widgetId = 56 # Integer | Id of a widget from which you want to delete the audio from

try: 
    # Delete assigned audio widget
    api_instance.widget_audio_delete(widgetId)
except ApiException as e:
    print("Exception when calling WidgetApi->widgetAudioDelete: %s\n" % e)

Parameters

Path parameters
Name Description
widgetId*
Integer
Id of a widget from which you want to delete the audio from
Required

Responses

Status: 200 - successful operation


widgetDelete

Delete a Widget

Deleted a specified widget


/playlist/widget/{widgetId}

Usage and SDK Samples

curl -X DELETE\
"https://premium.digitalsignagevision.com/api/playlist/widget/{widgetId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WidgetApi;

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

public class WidgetApiExample {

    public static void main(String[] args) {
        
        WidgetApi apiInstance = new WidgetApi();
        Integer widgetId = 56; // Integer | The widget ID to delete
        try {
            apiInstance.widgetDelete(widgetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#widgetDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WidgetApi;

public class WidgetApiExample {

    public static void main(String[] args) {
        WidgetApi apiInstance = new WidgetApi();
        Integer widgetId = 56; // Integer | The widget ID to delete
        try {
            apiInstance.widgetDelete(widgetId);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#widgetDelete");
            e.printStackTrace();
        }
    }
}
Integer *widgetId = 56; // The widget ID to delete

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

// Delete a Widget
[apiInstance widgetDeleteWith:widgetId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.WidgetApi()
var widgetId = 56; // {{Integer}} The widget ID to delete

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

namespace Example
{
    public class widgetDeleteExample
    {
        public void main()
        {

            var apiInstance = new WidgetApi();
            var widgetId = 56;  // Integer | The widget ID to delete

            try
            {
                // Delete a Widget
                apiInstance.widgetDelete(widgetId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WidgetApi.widgetDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiWidgetApi();
$widgetId = 56; // Integer | The widget ID to delete

try {
    $api_instance->widgetDelete($widgetId);
} catch (Exception $e) {
    echo 'Exception when calling WidgetApi->widgetDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WidgetApi;

my $api_instance = WWW::SwaggerClient::WidgetApi->new();
my $widgetId = 56; # Integer | The widget ID to delete

eval { 
    $api_instance->widgetDelete(widgetId => $widgetId);
};
if ($@) {
    warn "Exception when calling WidgetApi->widgetDelete: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WidgetApi()
widgetId = 56 # Integer | The widget ID to delete

try: 
    # Delete a Widget
    api_instance.widget_delete(widgetId)
except ApiException as e:
    print("Exception when calling WidgetApi->widgetDelete: %s\n" % e)

Parameters

Path parameters
Name Description
widgetId*
Integer
The widget ID to delete
Required

Responses

Status: 200 - successful operation


widgetEditTransition

Adds In/Out transition

Adds In/Out transition to a specified widget


/playlist/widget/transition/{type}/{widgetId}

Usage and SDK Samples

curl -X PUT\
"https://premium.digitalsignagevision.com/api/playlist/widget/transition/{type}/{widgetId}?transitionType=&transitionDuration=&transitionDirection="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WidgetApi;

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

public class WidgetApiExample {

    public static void main(String[] args) {
        
        WidgetApi apiInstance = new WidgetApi();
        String type = type_example; // String | Transition type, available options: in, out
        Integer widgetId = 56; // Integer | The widget ID to add the transition to
        String transitionType = transitionType_example; // String | Type of a transition, available Options: fly, fadeIn, fadeOut
        Integer transitionDuration = 56; // Integer | Duration of this transition in milliseconds
        Integer transitionDirection = 56; // Integer | The direction for this transition, only appropriate for transitions that move, such as fly. Available options: N, NE, E, SE, S, SW, W, NW
        try {
            apiInstance.widgetEditTransition(type, widgetId, transitionType, transitionDuration, transitionDirection);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#widgetEditTransition");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WidgetApi;

public class WidgetApiExample {

    public static void main(String[] args) {
        WidgetApi apiInstance = new WidgetApi();
        String type = type_example; // String | Transition type, available options: in, out
        Integer widgetId = 56; // Integer | The widget ID to add the transition to
        String transitionType = transitionType_example; // String | Type of a transition, available Options: fly, fadeIn, fadeOut
        Integer transitionDuration = 56; // Integer | Duration of this transition in milliseconds
        Integer transitionDirection = 56; // Integer | The direction for this transition, only appropriate for transitions that move, such as fly. Available options: N, NE, E, SE, S, SW, W, NW
        try {
            apiInstance.widgetEditTransition(type, widgetId, transitionType, transitionDuration, transitionDirection);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetApi#widgetEditTransition");
            e.printStackTrace();
        }
    }
}
String *type = type_example; // Transition type, available options: in, out
Integer *widgetId = 56; // The widget ID to add the transition to
String *transitionType = transitionType_example; // Type of a transition, available Options: fly, fadeIn, fadeOut
Integer *transitionDuration = 56; // Duration of this transition in milliseconds (optional)
Integer *transitionDirection = 56; // The direction for this transition, only appropriate for transitions that move, such as fly. Available options: N, NE, E, SE, S, SW, W, NW (optional)

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

// Adds In/Out transition
[apiInstance widgetEditTransitionWith:type
    widgetId:widgetId
    transitionType:transitionType
    transitionDuration:transitionDuration
    transitionDirection:transitionDirection
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var RecubikApi = require('recubik_api');

var api = new RecubikApi.WidgetApi()
var type = type_example; // {{String}} Transition type, available options: in, out
var widgetId = 56; // {{Integer}} The widget ID to add the transition to
var transitionType = transitionType_example; // {{String}} Type of a transition, available Options: fly, fadeIn, fadeOut
var opts = { 
  'transitionDuration': 56, // {{Integer}} Duration of this transition in milliseconds
  'transitionDirection': 56 // {{Integer}} The direction for this transition, only appropriate for transitions that move, such as fly. Available options: N, NE, E, SE, S, SW, W, NW
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.widgetEditTransition(type, widgetId, transitionType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class widgetEditTransitionExample
    {
        public void main()
        {

            var apiInstance = new WidgetApi();
            var type = type_example;  // String | Transition type, available options: in, out
            var widgetId = 56;  // Integer | The widget ID to add the transition to
            var transitionType = transitionType_example;  // String | Type of a transition, available Options: fly, fadeIn, fadeOut
            var transitionDuration = 56;  // Integer | Duration of this transition in milliseconds (optional) 
            var transitionDirection = 56;  // Integer | The direction for this transition, only appropriate for transitions that move, such as fly. Available options: N, NE, E, SE, S, SW, W, NW (optional) 

            try
            {
                // Adds In/Out transition
                apiInstance.widgetEditTransition(type, widgetId, transitionType, transitionDuration, transitionDirection);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WidgetApi.widgetEditTransition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\ApiWidgetApi();
$type = type_example; // String | Transition type, available options: in, out
$widgetId = 56; // Integer | The widget ID to add the transition to
$transitionType = transitionType_example; // String | Type of a transition, available Options: fly, fadeIn, fadeOut
$transitionDuration = 56; // Integer | Duration of this transition in milliseconds
$transitionDirection = 56; // Integer | The direction for this transition, only appropriate for transitions that move, such as fly. Available options: N, NE, E, SE, S, SW, W, NW

try {
    $api_instance->widgetEditTransition($type, $widgetId, $transitionType, $transitionDuration, $transitionDirection);
} catch (Exception $e) {
    echo 'Exception when calling WidgetApi->widgetEditTransition: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::WidgetApi;

my $api_instance = WWW::SwaggerClient::WidgetApi->new();
my $type = type_example; # String | Transition type, available options: in, out
my $widgetId = 56; # Integer | The widget ID to add the transition to
my $transitionType = transitionType_example; # String | Type of a transition, available Options: fly, fadeIn, fadeOut
my $transitionDuration = 56; # Integer | Duration of this transition in milliseconds
my $transitionDirection = 56; # Integer | The direction for this transition, only appropriate for transitions that move, such as fly. Available options: N, NE, E, SE, S, SW, W, NW

eval { 
    $api_instance->widgetEditTransition(type => $type, widgetId => $widgetId, transitionType => $transitionType, transitionDuration => $transitionDuration, transitionDirection => $transitionDirection);
};
if ($@) {
    warn "Exception when calling WidgetApi->widgetEditTransition: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.WidgetApi()
type = type_example # String | Transition type, available options: in, out
widgetId = 56 # Integer | The widget ID to add the transition to
transitionType = transitionType_example # String | Type of a transition, available Options: fly, fadeIn, fadeOut
transitionDuration = 56 # Integer | Duration of this transition in milliseconds (optional)
transitionDirection = 56 # Integer | The direction for this transition, only appropriate for transitions that move, such as fly. Available options: N, NE, E, SE, S, SW, W, NW (optional)

try: 
    # Adds In/Out transition
    api_instance.widget_edit_transition(type, widgetId, transitionType, transitionDuration=transitionDuration, transitionDirection=transitionDirection)
except ApiException as e:
    print("Exception when calling WidgetApi->widgetEditTransition: %s\n" % e)

Parameters

Path parameters
Name Description
type*
String
Transition type, available options: in, out
Required
widgetId*
Integer
The widget ID to add the transition to
Required
Query parameters
Name Description
transitionType*
String
Type of a transition, available Options: fly, fadeIn, fadeOut
Required
transitionDuration
Integer
Duration of this transition in milliseconds
transitionDirection
Integer
The direction for this transition, only appropriate for transitions that move, such as fly. Available options: N, NE, E, SE, S, SW, W, NW

Responses

Status: 201 - successful operation

Name Type Format Description
Location String