Enrollment Waiting Periods

Create EnrollmentWaitingPeriod

Creates a new EnrollmentWaitingPeriod

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
enrollmentWaitingPeriod_Key
required
integer <int32>
division_ID
string or null <= 20 characters
effective_Date
string or null <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
group_ID
string or null <= 20 characters
include_Hire_Date
required
boolean
plan_ID
string or null <= 20 characters
term_Date
string or null <date-time>
update_Date
string <date-time>
update_User
string or null <= 20 characters
waiting_Period
integer or null <int32>
waiting_Period_Type
string or null <= 32 characters
Responses
200

Success

401

Unauthorized

post/enrollment-waiting-periods
Request samples
{
  • "enrollmentWaitingPeriod_Key": 0,
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "include_Hire_Date": true,
  • "plan_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "waiting_Period": 0,
  • "waiting_Period_Type": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List EnrollmentWaitingPeriod

Lists all EnrollmentWaitingPeriod

SecurityapiKeyAuth and bearerAuth
Request
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/enrollment-waiting-periods
Request samples 
Response samples 
No sample
Get EnrollmentWaitingPeriod
Gets EnrollmentWaitingPeriod


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
enrollmentWaitingPeriodKey
required
integer <int32> 
EnrollmentWaitingPeriod Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/enrollment-waiting-periods/{enrollmentWaitingPeriodKey}
Request samples 
Response samples 
No sample
Update EnrollmentWaitingPeriod
Updates a specific EnrollmentWaitingPeriod.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
enrollmentWaitingPeriodKey
required
integer <int32> 
EnrollmentWaitingPeriod Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
enrollmentWaitingPeriod_Key
required
integer <int32> 
 
division_ID
string or null  <= 20 characters 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
group_ID
string or null  <= 20 characters 
 
include_Hire_Date
required
boolean
 
plan_ID
string or null  <= 20 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
waiting_Period
integer or null <int32> 
 
waiting_Period_Type
string or null  <= 32 characters 
 
Responses 
200
Success


401
Unauthorized


put/enrollment-waiting-periods/{enrollmentWaitingPeriodKey}
Request samples 
{
  • "enrollmentWaitingPeriod_Key": 0,
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "include_Hire_Date": true,
  • "plan_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "waiting_Period": 0,
  • "waiting_Period_Type": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete EnrollmentWaitingPeriod
Deletes an EnrollmentWaitingPeriod


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
enrollmentWaitingPeriodKey
required
integer <int32> 
EnrollmentWaitingPeriod Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/enrollment-waiting-periods/{enrollmentWaitingPeriodKey}
Request samples 
Create or Update Batch EnrollmentWaitingPeriod
Create or Update multiple EnrollmentWaitingPeriod 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 
enrollmentWaitingPeriod_Key
required
integer <int32> 
 
division_ID
string or null  <= 20 characters 
 
effective_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
group_ID
string or null  <= 20 characters 
 
include_Hire_Date
required
boolean
 
plan_ID
string or null  <= 20 characters 
 
term_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
waiting_Period
integer or null <int32> 
 
waiting_Period_Type
string or null  <= 32 characters 
 
Responses 
207
Success


401
Unauthorized


put/enrollment-waiting-periods-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}