Disenroll Log Rates

Create DisenrollLogRate

Creates a new DisenrollLogRate

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

DisenrollLog Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
disenrollLog_Key
required
integer <int32>

ID for the specific disenroll log record Note: This field is marked as NOT NULL in the database and therefore required by the API.

premRate_Key
required
integer <int32>

Unique key of the Premium Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.

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

premRate_Category
string or null <= 32 characters

Category specifying what area the Premium Rate applies to

premRate_ID
string or null <= 32 characters

Unique identifier of the Premium Rate

rate
number or null <double>

Premium rate that applies to the specific enrollment

rate_Description
string or null <= 512 characters

Description of the premium rate that applies to the enrollment

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/disenroll-logs/{DisenrollLog_Key}/rates
Request samples
{
  • "disenrollLog_Key": 0,
  • "premRate_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "premRate_Category": "string",
  • "premRate_ID": "string",
  • "rate": 0.1,
  • "rate_Description": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List DisenrollLogRate

Lists all DisenrollLogRate for the given DisenrollLog_Key

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

DisenrollLog Key

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/disenroll-logs/{DisenrollLog_Key}/rates
Request samples 
Response samples 
No sample
Get DisenrollLogRate
Gets DisenrollLogRate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
DisenrollLog_Key
required
integer <int32> 
DisenrollLog Key


 
PremRate_Key
required
integer <int32> 
PremRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/disenroll-logs/{DisenrollLog_Key}/rates/{PremRate_Key}
Request samples 
Response samples 
No sample
Update DisenrollLogRate
Updates a specific DisenrollLogRate.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
DisenrollLog_Key
required
integer <int32> 
DisenrollLog Key


 
PremRate_Key
required
integer <int32> 
PremRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
disenrollLog_Key
required
integer <int32> 
ID for the specific disenroll log record Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
premRate_Key
required
integer <int32> 
Unique key of the Premium Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
premRate_Category
string or null  <= 32 characters 
Category specifying what area the Premium Rate applies to


 
premRate_ID
string or null  <= 32 characters 
Unique identifier of the Premium Rate


 
rate
number or null <double> 
Premium rate that applies to the specific enrollment


 
rate_Description
string or null  <= 512 characters 
Description of the premium rate that applies to the enrollment


 
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/disenroll-logs/{DisenrollLog_Key}/rates/{PremRate_Key}
Request samples 
{
  • "disenrollLog_Key": 0,
  • "premRate_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "premRate_Category": "string",
  • "premRate_ID": "string",
  • "rate": 0.1,
  • "rate_Description": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete DisenrollLogRate
Deletes an DisenrollLogRate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
DisenrollLog_Key
required
integer <int32> 
DisenrollLog Key


 
PremRate_Key
required
integer <int32> 
PremRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/disenroll-logs/{DisenrollLog_Key}/rates/{PremRate_Key}
Request samples 
Create or Update Batch DisenrollLogRate
Create or Update multiple DisenrollLogRate 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
DisenrollLog_Key
required
integer <int32> 
DisenrollLog Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
disenrollLog_Key
required
integer <int32> 
ID for the specific disenroll log record Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
premRate_Key
required
integer <int32> 
Unique key of the Premium Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
premRate_Category
string or null  <= 32 characters 
Category specifying what area the Premium Rate applies to


 
premRate_ID
string or null  <= 32 characters 
Unique identifier of the Premium Rate


 
rate
number or null <double> 
Premium rate that applies to the specific enrollment


 
rate_Description
string or null  <= 512 characters 
Description of the premium rate that applies to the enrollment


 
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/disenroll-logs/{DisenrollLog_Key}/rates-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}