APIs for VBASoftware
- Delete Event
List of Claim Invoice Statuses
Create Event
List Event
List Schedule Intervals
List Schedule Interval Options
List Schedule Interval End Options
List Days Of Week
List Months Of Year
List Event Actions
List Schedule Actions
List Durations
List Priorities
List Snoozes
List Active User Events
Get Event
Update Event
Create or Update Batch Event
Reschedule Event
Next Scheduled Date
Snooze an Event
List Report Args
Delete Event
VBASoftware (v1)
Download OpenAPI description
Languages
Servers
VBAPI VBASoftware
https://vbapi.vbasoftware.com/vbasoftware
Bodyrequired
- application/json
- text/json
- application/*+json
ID of the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Flag to indicate if the event triggers a Claim Audit. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Date when the 'Assigned User' will receive the next event reminder.
Flag to indicate if the event triggers a Report Series. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates that the 'Assigned User' should receive a reminder regarding the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Key value identifying the User Group to whom the event is assigned
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/events/{eventID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- application/json
- text/json
- application/*+json
curl -i -X PUT \
'https://vbapi.vbasoftware.com/vbasoftware/events/{eventID}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"event_ID": 0,
"claim_Audit_Event": true,
"completion_Date": "2019-08-24T14:15:22Z",
"completion_Percent": 0.1,
"due_Date": "2019-08-24T14:15:22Z",
"end_Date": "2019-08-24T14:15:22Z",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"event_Processor": "string",
"event_Type": "string",
"meta_Data": "string",
"next_Scheduled_Date": "2019-08-24T14:15:22Z",
"next_Scheduled_Time": "2019-08-24T14:15:22Z",
"priority": "string",
"process_Automation_Event": true,
"reminder": true,
"reminder_Event_ID": 0,
"reportSeries_Key": 0,
"start_Date": "2019-08-24T14:15:22Z",
"status": "string",
"subject": "string",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"userGroup_Key": 0,
"user_ID": "string"
}'Response
- text/plain
- application/json
- text/json
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/events/{eventID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://vbapi.vbasoftware.com/vbasoftware/events/{eventID}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Request
Create or Update multiple Event at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.
Security
apiKeyAuth and bearerAuth
- application/json
- text/json
- application/*+json
ID of the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Flag to indicate if the event triggers a Claim Audit. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Date when the 'Assigned User' will receive the next event reminder.
Flag to indicate if the event triggers a Report Series. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates that the 'Assigned User' should receive a reminder regarding the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Key value identifying the User Group to whom the event is assigned
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/events-batch
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- application/json
- text/json
- application/*+json
curl -i -X PUT \
https://vbapi.vbasoftware.com/vbasoftware/events-batch \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '[
{
"event_ID": 0,
"claim_Audit_Event": true,
"completion_Date": "2019-08-24T14:15:22Z",
"completion_Percent": 0.1,
"due_Date": "2019-08-24T14:15:22Z",
"end_Date": "2019-08-24T14:15:22Z",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"event_Processor": "string",
"event_Type": "string",
"meta_Data": "string",
"next_Scheduled_Date": "2019-08-24T14:15:22Z",
"next_Scheduled_Time": "2019-08-24T14:15:22Z",
"priority": "string",
"process_Automation_Event": true,
"reminder": true,
"reminder_Event_ID": 0,
"reportSeries_Key": 0,
"start_Date": "2019-08-24T14:15:22Z",
"status": "string",
"subject": "string",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"userGroup_Key": 0,
"user_ID": "string"
}
]'Response
- text/plain
- application/json
- text/json
No response exampleBodyrequired
- application/json
- text/json
- application/*+json
ID of the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Flag to indicate if the event triggers a Claim Audit. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Date when the 'Assigned User' will receive the next event reminder.
Flag to indicate if the event triggers a Report Series. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates that the 'Assigned User' should receive a reminder regarding the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Key value identifying the User Group to whom the event is assigned
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/events/{eventID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- application/json
- text/json
- application/*+json
curl -i -X PUT \
'https://vbapi.vbasoftware.com/vbasoftware/events/{eventID}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"event_ID": 0,
"claim_Audit_Event": true,
"completion_Date": "2019-08-24T14:15:22Z",
"completion_Percent": 0.1,
"due_Date": "2019-08-24T14:15:22Z",
"end_Date": "2019-08-24T14:15:22Z",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"event_Processor": "string",
"event_Type": "string",
"meta_Data": "string",
"next_Scheduled_Date": "2019-08-24T14:15:22Z",
"next_Scheduled_Time": "2019-08-24T14:15:22Z",
"priority": "string",
"process_Automation_Event": true,
"reminder": true,
"reminder_Event_ID": 0,
"reportSeries_Key": 0,
"start_Date": "2019-08-24T14:15:22Z",
"status": "string",
"subject": "string",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"userGroup_Key": 0,
"user_ID": "string"
}'Response
- text/plain
- application/json
- text/json
No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/events/{eventID}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://vbapi.vbasoftware.com/vbasoftware/events/{eventID}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'Request
Create or Update multiple Event at once. If the entity exists, it will be updated. If the entity does not exist, it will be created.
Security
apiKeyAuth and bearerAuth
- application/json
- text/json
- application/*+json
ID of the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Flag to indicate if the event triggers a Claim Audit. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Date when the 'Assigned User' will receive the next event reminder.
Flag to indicate if the event triggers a Report Series. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Indicates that the 'Assigned User' should receive a reminder regarding the event. Note: This field is marked as NOT NULL in the database and therefore required by the API.
Key value identifying the User Group to whom the event is assigned
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/events-batch
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- application/json
- text/json
- application/*+json
curl -i -X PUT \
https://vbapi.vbasoftware.com/vbasoftware/events-batch \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '[
{
"event_ID": 0,
"claim_Audit_Event": true,
"completion_Date": "2019-08-24T14:15:22Z",
"completion_Percent": 0.1,
"due_Date": "2019-08-24T14:15:22Z",
"end_Date": "2019-08-24T14:15:22Z",
"entry_Date": "2019-08-24T14:15:22Z",
"entry_User": "string",
"event_Processor": "string",
"event_Type": "string",
"meta_Data": "string",
"next_Scheduled_Date": "2019-08-24T14:15:22Z",
"next_Scheduled_Time": "2019-08-24T14:15:22Z",
"priority": "string",
"process_Automation_Event": true,
"reminder": true,
"reminder_Event_ID": 0,
"reportSeries_Key": 0,
"start_Date": "2019-08-24T14:15:22Z",
"status": "string",
"subject": "string",
"update_Date": "2019-08-24T14:15:22Z",
"update_User": "string",
"userGroup_Key": 0,
"user_ID": "string"
}
]'Response
- text/plain
- application/json
- text/json
No response example