Add a new scheduled event for a Campaign/Layout to be shown on a Display Group/Display.
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)
| 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
|