Disability Event Groups

Create DisabilityEventGroup

Creates a new DisabilityEventGroup

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
disabilityEventGroup_Key
required
integer <int32>

Unique Identifier for the DisabilityEventGroup table. Note: This field is marked as NOT NULL in the database and therefore required by the API.

disabilityEventCaseChanged_Key
integer or null <int32>

Unique Identifier for the DisabilityEventCaseChanged table.

disabilityEventChanged_Key
integer or null <int32>

Unique Identifier for the DisabilityEventChanged table.

disabilityEventDeductionChanged_Key
integer or null <int32>

Unique Identifier for the DisabilityEventDeductionChanged table.

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

group_ID
string or null <= 20 characters

Group ID for the DisabilityEventGroup

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

Responses
200

Success

401

Unauthorized

post/disability-event-groups
Request samples
{
  • "disabilityEventGroup_Key": 0,
  • "disabilityEventCaseChanged_Key": 0,
  • "disabilityEventChanged_Key": 0,
  • "disabilityEventDeductionChanged_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List DisabilityEventGroup

Lists all DisabilityEventGroup

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
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.

page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/disability-event-groups
Request samples 
Response samples 
No sample
Get DisabilityEventGroup
Gets DisabilityEventGroup


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
DisabilityEventGroup_Key
required
integer <int32> 
DisabilityEventGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/disability-event-groups/{DisabilityEventGroup_Key}
Request samples 
Response samples 
No sample
Update DisabilityEventGroup
Updates a specific DisabilityEventGroup.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
DisabilityEventGroup_Key
required
integer <int32> 
DisabilityEventGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
disabilityEventGroup_Key
required
integer <int32> 
Unique Identifier for the DisabilityEventGroup table. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
disabilityEventCaseChanged_Key
integer or null <int32> 
Unique Identifier for the DisabilityEventCaseChanged table.


 
disabilityEventChanged_Key
integer or null <int32> 
Unique Identifier for the DisabilityEventChanged table.


 
disabilityEventDeductionChanged_Key
integer or null <int32> 
Unique Identifier for the DisabilityEventDeductionChanged table.


 
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


 
group_ID
string or null  <= 20 characters 
Group ID for the DisabilityEventGroup


 
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


 
Responses 
200
Success


401
Unauthorized


put/disability-event-groups/{DisabilityEventGroup_Key}
Request samples 
{
  • "disabilityEventGroup_Key": 0,
  • "disabilityEventCaseChanged_Key": 0,
  • "disabilityEventChanged_Key": 0,
  • "disabilityEventDeductionChanged_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete DisabilityEventGroup
Deletes an DisabilityEventGroup


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
DisabilityEventGroup_Key
required
integer <int32> 
DisabilityEventGroup Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/disability-event-groups/{DisabilityEventGroup_Key}
Request samples 
Create or Update Batch DisabilityEventGroup
Create or Update multiple DisabilityEventGroup at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
disabilityEventGroup_Key
required
integer <int32> 
Unique Identifier for the DisabilityEventGroup table. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
disabilityEventCaseChanged_Key
integer or null <int32> 
Unique Identifier for the DisabilityEventCaseChanged table.


 
disabilityEventChanged_Key
integer or null <int32> 
Unique Identifier for the DisabilityEventChanged table.


 
disabilityEventDeductionChanged_Key
integer or null <int32> 
Unique Identifier for the DisabilityEventDeductionChanged table.


 
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


 
group_ID
string or null  <= 20 characters 
Group ID for the DisabilityEventGroup


 
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


 
Responses 
207
Success


401
Unauthorized


put/disability-event-groups-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}