Premium Rate Add-Ons

Create PremRateAddOn

Creates a new PremRateAddOn

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

PremRate Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
premRateAddOn_Key
required
integer <int32>

Unique ID of the Add On Rate associated with a given Premium Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.

addOn_PremRate_Key
required
integer <int32>

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

add_On_Grouping_ID
string or null <= 32 characters

Used to identify Add On rates by Group

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

premRate_Key
required
integer <int32>

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

sequence
integer or null <int32>

The suquence of this Category on the "INV" report.

update_Date
string <date-time>

Date when 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/premium-rates/{PremRate_Key}/add-ons
Request samples
{
  • "premRateAddOn_Key": 0,
  • "addOn_PremRate_Key": 0,
  • "add_On_Grouping_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "premRate_Key": 0,
  • "sequence": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PremRateAddOn

Lists all PremRateAddOn for the given PremRate_Key

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

PremRate 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/premium-rates/{PremRate_Key}/add-ons
Request samples 
Response samples 
No sample
Get PremRateAddOn
Gets PremRateAddOn


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
PremRate_Key
required
integer <int32> 
PremRate Key


 
PremRateAddOn_Key
required
integer <int32> 
PremRateAddOn Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/premium-rates/{PremRate_Key}/add-ons/{PremRateAddOn_Key}
Request samples 
Response samples 
No sample
Update PremRateAddOn
Updates a specific PremRateAddOn.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
PremRate_Key
required
integer <int32> 
PremRate Key


 
PremRateAddOn_Key
required
integer <int32> 
PremRateAddOn Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
premRateAddOn_Key
required
integer <int32> 
Unique ID of the Add On Rate associated with a given Premium Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
addOn_PremRate_Key
required
integer <int32> 
Unique ID of the Add On Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
add_On_Grouping_ID
string or null  <= 32 characters 
Used to identify Add On rates by Group


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


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


 
sequence
integer or null <int32> 
The suquence of this Category on the "INV" report.


 
update_Date
string <date-time> 
Date when 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/premium-rates/{PremRate_Key}/add-ons/{PremRateAddOn_Key}
Request samples 
{
  • "premRateAddOn_Key": 0,
  • "addOn_PremRate_Key": 0,
  • "add_On_Grouping_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "premRate_Key": 0,
  • "sequence": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PremRateAddOn
Deletes an PremRateAddOn


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
PremRate_Key
required
integer <int32> 
PremRate Key


 
PremRateAddOn_Key
required
integer <int32> 
PremRateAddOn Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/premium-rates/{PremRate_Key}/add-ons/{PremRateAddOn_Key}
Request samples 
Create or Update Batch PremRateAddOn
Create or Update multiple PremRateAddOn 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
PremRate_Key
required
integer <int32> 
PremRate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
premRateAddOn_Key
required
integer <int32> 
Unique ID of the Add On Rate associated with a given Premium Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
addOn_PremRate_Key
required
integer <int32> 
Unique ID of the Add On Rate Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
add_On_Grouping_ID
string or null  <= 32 characters 
Used to identify Add On rates by Group


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


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


 
sequence
integer or null <int32> 
The suquence of this Category on the "INV" report.


 
update_Date
string <date-time> 
Date when 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/premium-rates/{PremRate_Key}/add-ons-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}