Event Schedules

Create EventSchedule

Creates a new EventSchedule

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
eventID
required
integer <int32>

Event ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
schedule_ID
required
integer <int32>

ID of the event schedule. Note: This field is marked as NOT NULL in the database and therefore required by the API.

description
string or null <= 10 characters

Description of the event schedule.

end_Date
string or null <date-time>

Indicates the date when the event will stop occurring.

end_Option
integer or null <int32>

Indicates how the event will end.

end_Time
string or null <date-time>

Indicates at what time the event will cease to occur on the defined date(s).

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

event_ID
required
integer <int32>

ID of the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.

frequency
integer or null <int32>

Month the event occurs.

frequency_Factor
integer or null <int32>

Day the event occurs.

friday
required
boolean

Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.

interval_Option
integer or null <int32>

Interval Options are Days, Weekdays, Day in Month, Relative Day in Month, Date, or date in Month.

monday
required
boolean

Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.

next_Scheduled_Date
string or null <date-time>

Date when the next event occurrence will take place.

next_Scheduled_Time
string or null <date-time>

Time when the next event occurrence will take place.

play_Sound
required
boolean

Flag identifying a sound is associated with the event Note: This field is marked as NOT NULL in the database and therefore required by the API.

regenerate_Event
required
boolean

Flag specifying the event should be regenerated upon completion Note: This field is marked as NOT NULL in the database and therefore required by the API.

regeneration_Date_Part
string or null <= 10 characters

Date part used to qualify the length of interval when the event will regenerate

regeneration_Interval
integer or null <int32>

Length of interval when the event will regenerate

relative_Frequency
integer or null <int32>

Day of the week the event occurs.

saturday
required
boolean

Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.

schedule_Interval
integer or null <int32>

Indicates how often the event will occur. The interval will determine which options are available for the event schedule.

sound_File
string or null <= 256 characters

Sound file to be played in association with the event

start_Date
string or null <date-time>

Indicates the date when the event will begin occurring by the defined recurrence options.

start_Time
string or null <date-time>

Indicates at what time the event will occur on the defined date(s).

sunday
required
boolean

Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.

thursday
required
boolean

Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.

total_Occurrences
integer or null <int32>

Number of occurrences that will take place before the event ends.

tuesday
required
boolean

Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

wednesday
required
boolean

Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/events/{eventID}/schedules
Request samples
{
  • "schedule_ID": 0,
  • "description": "string",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "end_Option": 0,
  • "end_Time": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "event_ID": 0,
  • "frequency": 0,
  • "frequency_Factor": 0,
  • "friday": true,
  • "interval_Option": 0,
  • "monday": true,
  • "next_Scheduled_Date": "2019-08-24T14:15:22Z",
  • "next_Scheduled_Time": "2019-08-24T14:15:22Z",
  • "play_Sound": true,
  • "regenerate_Event": true,
  • "regeneration_Date_Part": "string",
  • "regeneration_Interval": 0,
  • "relative_Frequency": 0,
  • "saturday": true,
  • "schedule_Interval": 0,
  • "sound_File": "string",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "start_Time": "2019-08-24T14:15:22Z",
  • "sunday": true,
  • "thursday": true,
  • "total_Occurrences": 0,
  • "tuesday": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "wednesday": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List EventSchedule

Lists all EventSchedule for a given Event ID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
eventID
required
integer <int32>

Event ID

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/events/{eventID}/schedules
Request samples 
Response samples 
No sample
Get EventSchedule
Gets EventSchedule


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eventID
required
integer <int32> 
Event ID


 
scheduleID
required
integer <int32> 
Schedule ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/events/{eventID}/schedules/{scheduleID}
Request samples 
Response samples 
No sample
Update EventSchedule
Updates a specific EventSchedule.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eventID
required
integer <int32> 
Event ID


 
scheduleID
required
integer <int32> 
Schedule ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
schedule_ID
required
integer <int32> 
ID of the event schedule. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 10 characters 
Description of the event schedule.


 
end_Date
string or null <date-time> 
Indicates the date when the event will stop occurring.


 
end_Option
integer or null <int32> 
Indicates how the event will end.


 
end_Time
string or null <date-time> 
Indicates at what time the event will cease to occur on the defined date(s).


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
event_ID
required
integer <int32> 
ID of the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
frequency
integer or null <int32> 
Month the event occurs.


 
frequency_Factor
integer or null <int32> 
Day the event occurs.


 
friday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
interval_Option
integer or null <int32> 
Interval Options are Days, Weekdays, Day in Month, Relative Day in Month, Date, or date in Month.


 
monday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
next_Scheduled_Date
string or null <date-time> 
Date when the next event occurrence will take place.


 
next_Scheduled_Time
string or null <date-time> 
Time when the next event occurrence will take place.


 
play_Sound
required
boolean
Flag identifying a sound is associated with the event Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
regenerate_Event
required
boolean
Flag specifying the event should be regenerated upon completion Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
regeneration_Date_Part
string or null  <= 10 characters 
Date part used to qualify the length of interval when the event will regenerate


 
regeneration_Interval
integer or null <int32> 
Length of interval when the event will regenerate


 
relative_Frequency
integer or null <int32> 
Day of the week the event occurs.


 
saturday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
schedule_Interval
integer or null <int32> 
Indicates how often the event will occur. The interval will determine which options are available for the event schedule.


 
sound_File
string or null  <= 256 characters 
Sound file to be played in association with the event


 
start_Date
string or null <date-time> 
Indicates the date when the event will begin occurring by the defined recurrence options.


 
start_Time
string or null <date-time> 
Indicates at what time the event will occur on the defined date(s).


 
sunday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
thursday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
total_Occurrences
integer or null <int32> 
Number of occurrences that will take place before the event ends.


 
tuesday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
wednesday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/events/{eventID}/schedules/{scheduleID}
Request samples 
{
  • "schedule_ID": 0,
  • "description": "string",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "end_Option": 0,
  • "end_Time": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "event_ID": 0,
  • "frequency": 0,
  • "frequency_Factor": 0,
  • "friday": true,
  • "interval_Option": 0,
  • "monday": true,
  • "next_Scheduled_Date": "2019-08-24T14:15:22Z",
  • "next_Scheduled_Time": "2019-08-24T14:15:22Z",
  • "play_Sound": true,
  • "regenerate_Event": true,
  • "regeneration_Date_Part": "string",
  • "regeneration_Interval": 0,
  • "relative_Frequency": 0,
  • "saturday": true,
  • "schedule_Interval": 0,
  • "sound_File": "string",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "start_Time": "2019-08-24T14:15:22Z",
  • "sunday": true,
  • "thursday": true,
  • "total_Occurrences": 0,
  • "tuesday": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "wednesday": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete EventSchedule
Deletes an EventSchedule


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eventID
required
integer <int32> 
Event ID


 
scheduleID
required
integer <int32> 
Schedule ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/events/{eventID}/schedules/{scheduleID}
Request samples 
Create or Update Batch EventSchedule
Create or Update multiple EventSchedule at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
eventID
required
integer <int32> 
Event ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
schedule_ID
required
integer <int32> 
ID of the event schedule. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 10 characters 
Description of the event schedule.


 
end_Date
string or null <date-time> 
Indicates the date when the event will stop occurring.


 
end_Option
integer or null <int32> 
Indicates how the event will end.


 
end_Time
string or null <date-time> 
Indicates at what time the event will cease to occur on the defined date(s).


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
event_ID
required
integer <int32> 
ID of the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
frequency
integer or null <int32> 
Month the event occurs.


 
frequency_Factor
integer or null <int32> 
Day the event occurs.


 
friday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
interval_Option
integer or null <int32> 
Interval Options are Days, Weekdays, Day in Month, Relative Day in Month, Date, or date in Month.


 
monday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
next_Scheduled_Date
string or null <date-time> 
Date when the next event occurrence will take place.


 
next_Scheduled_Time
string or null <date-time> 
Time when the next event occurrence will take place.


 
play_Sound
required
boolean
Flag identifying a sound is associated with the event Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
regenerate_Event
required
boolean
Flag specifying the event should be regenerated upon completion Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
regeneration_Date_Part
string or null  <= 10 characters 
Date part used to qualify the length of interval when the event will regenerate


 
regeneration_Interval
integer or null <int32> 
Length of interval when the event will regenerate


 
relative_Frequency
integer or null <int32> 
Day of the week the event occurs.


 
saturday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
schedule_Interval
integer or null <int32> 
Indicates how often the event will occur. The interval will determine which options are available for the event schedule.


 
sound_File
string or null  <= 256 characters 
Sound file to be played in association with the event


 
start_Date
string or null <date-time> 
Indicates the date when the event will begin occurring by the defined recurrence options.


 
start_Time
string or null <date-time> 
Indicates at what time the event will occur on the defined date(s).


 
sunday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
thursday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
total_Occurrences
integer or null <int32> 
Number of occurrences that will take place before the event ends.


 
tuesday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
wednesday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


put/events/{eventID}/schedules-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}