APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
ID of the event schedule. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates at what time the event will cease to occur on the defined date(s).
ID of the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.
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 Options are Days, Weekdays, Day in Month, Relative Day in Month, Date, or date in Month.
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.
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.
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.
Date part used to qualify the length of interval when the event will regenerate
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.
Indicates how often the event will occur. The interval will determine which options are available for the event schedule.
Indicates the date when the event will begin occurring by the defined recurrence options.
Indicates at what time the event will occur on the defined date(s).
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.
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.
Number of occurrences that will take place before the event ends.
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.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/events/{eventID}/schedules
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/events/{eventID}/schedules' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"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
}'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/events/{eventID}/schedules
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/events/{eventID}/schedules?page=1&pageSize=100&sortBy=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/events/{eventID}/schedules/{scheduleID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/events/{eventID}/schedules/{scheduleID}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example