Group Volumes

Create GroupVolume

Creates a new GroupVolume

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupVolume_Key
required
integer <int32>

Unique identifier for each Volume configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.

benefit_Code
string or null <= 10 characters

When configuration is Benefit specific, fill this in. When empty, applies to entire Group/Division/Plan.

dist_Volume_Amount
number or null <double>

Based on volume type, this settings determines the volume.

dist_Volume_Pct
required
boolean

Based on volume type, this settings determines the volume. Note: This field is marked as NOT NULL in the database and therefore required by the API.

division_ID
string or null <= 20 characters

When configuration is Division specific, fill this in. When empty, applies to the entire Group.

effective_Date
string or null <date-time>

The effective date of the volume setting.

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.

gI_Volume_Max
number or null <double>

Based on volume type, this settings determines the volume.

gI_Volume_Min
number or null <double>

Based on volume type, this settings determines the volume.

group_ID
required
string [ 1 .. 20 ] characters

References Groups.Group_ID value on the parent record.

plan_ID
string or null <= 20 characters

When configuration is Plan specific, fill this in. When empty, applies to entire Group/Division.

term_Date
string or null <date-time>

The term date for this volume setting.

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.

use_Dist_Volume
required
boolean

Based on volume type, this settings determines the volume. Note: This field is marked as NOT NULL in the database and therefore required by the API.

volume
number or null <double>

Based on volume type, this settings determines the volume.

volume_ID
string or null <= 32 characters

This is a User definable field to name the volume being entered.

volume_Max
number or null <double>

Based on volume type, this settings determines the volume.

volume_Min
number or null <double>

Based on volume type, this settings determines the volume.

volume_Round_Precision
integer or null <int32>

Based on volume type, this settings determines the volume.

volume_Round_Type
string or null <= 16 characters

Based on volume type, this settings determines the volume.

volume_Type
string or null <= 16 characters

This value indicates what setting is used to calculate volume. The fileds that reference this setting are noted and drive the specific volume type. Reference VBASoftware application documentation for detailed explanation.

volume_Type_From
integer or null <int32>

Based on volume type, this settings determines the volume.

volume_Type_Pct
number or null <double>

Based on volume type, this settings determines the volume.

volume_Type_Thru
integer or null <int32>

Based on volume type, this settings determines the volume.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/volumes
Request samples
{
  • "groupVolume_Key": 0,
  • "benefit_Code": "string",
  • "dist_Volume_Amount": 0.1,
  • "dist_Volume_Pct": true,
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "gI_Volume_Max": 0.1,
  • "gI_Volume_Min": 0.1,
  • "group_ID": "string",
  • "plan_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Dist_Volume": true,
  • "volume": 0.1,
  • "volume_ID": "string",
  • "volume_Max": 0.1,
  • "volume_Min": 0.1,
  • "volume_Round_Precision": 0,
  • "volume_Round_Type": "string",
  • "volume_Type": "string",
  • "volume_Type_From": 0,
  • "volume_Type_Pct": 0.1,
  • "volume_Type_Thru": 0
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupVolume

Lists all GroupVolume for the given groupID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

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/groups/{groupID}/volumes
Request samples 
Response samples 
No sample
List GroupVolume nested by Division/Plan/Benefit
Lists all GroupVolume for the given groupID and have it nested by Division, then by Plan, then by Benefit.


SecurityapiKeyAuth and bearerAuth 
Request 
query Parameters
groupID
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups-volumes-nested
Request samples 
Response samples 
No sample
Get GroupVolume
Gets GroupVolume


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupVolumeKey
required
integer <int32> 
GroupVolume Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/volumes/{groupVolumeKey}
Request samples 
Response samples 
No sample
Update GroupVolume
Updates a specific GroupVolume.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupVolumeKey
required
integer <int32> 
GroupVolume Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupVolume_Key
required
integer <int32> 
Unique identifier for each Volume configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Code
string or null  <= 10 characters 
When configuration is Benefit specific, fill this in. When empty, applies to entire Group/Division/Plan.


 
dist_Volume_Amount
number or null <double> 
Based on volume type, this settings determines the volume.


 
dist_Volume_Pct
required
boolean
Based on volume type, this settings determines the volume. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
division_ID
string or null  <= 20 characters 
When configuration is Division specific, fill this in. When empty, applies to the entire Group.


 
effective_Date
string or null <date-time> 
The effective date of the volume setting.


 
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.


 
gI_Volume_Max
number or null <double> 
Based on volume type, this settings determines the volume.


 
gI_Volume_Min
number or null <double> 
Based on volume type, this settings determines the volume.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References Groups.Group_ID value on the parent record.


 
plan_ID
string or null  <= 20 characters 
When configuration is Plan specific, fill this in. When empty, applies to entire Group/Division.


 
term_Date
string or null <date-time> 
The term date for this volume setting.


 
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.


 
use_Dist_Volume
required
boolean
Based on volume type, this settings determines the volume. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
volume
number or null <double> 
Based on volume type, this settings determines the volume.


 
volume_ID
string or null  <= 32 characters 
This is a User definable field to name the volume being entered.


 
volume_Max
number or null <double> 
Based on volume type, this settings determines the volume.


 
volume_Min
number or null <double> 
Based on volume type, this settings determines the volume.


 
volume_Round_Precision
integer or null <int32> 
Based on volume type, this settings determines the volume.


 
volume_Round_Type
string or null  <= 16 characters 
Based on volume type, this settings determines the volume.


 
volume_Type
string or null  <= 16 characters 
This value indicates what setting is used to calculate volume. The fileds that reference this setting are noted and drive the specific volume type. Reference VBASoftware application documentation for detailed explanation.


 
volume_Type_From
integer or null <int32> 
Based on volume type, this settings determines the volume.


 
volume_Type_Pct
number or null <double> 
Based on volume type, this settings determines the volume.


 
volume_Type_Thru
integer or null <int32> 
Based on volume type, this settings determines the volume.


 
Responses 
200
Success


401
Unauthorized


put/groups/{groupID}/volumes/{groupVolumeKey}
Request samples 
{
  • "groupVolume_Key": 0,
  • "benefit_Code": "string",
  • "dist_Volume_Amount": 0.1,
  • "dist_Volume_Pct": true,
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "gI_Volume_Max": 0.1,
  • "gI_Volume_Min": 0.1,
  • "group_ID": "string",
  • "plan_ID": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Dist_Volume": true,
  • "volume": 0.1,
  • "volume_ID": "string",
  • "volume_Max": 0.1,
  • "volume_Min": 0.1,
  • "volume_Round_Precision": 0,
  • "volume_Round_Type": "string",
  • "volume_Type": "string",
  • "volume_Type_From": 0,
  • "volume_Type_Pct": 0.1,
  • "volume_Type_Thru": 0
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupVolume
Deletes an GroupVolume


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupVolumeKey
required
integer <int32> 
GroupVolume Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/volumes/{groupVolumeKey}
Request samples 
Create or Update Batch GroupVolume
Create or Update multiple GroupVolume 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
groupID
required
string
Group ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
groupVolume_Key
required
integer <int32> 
Unique identifier for each Volume configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
benefit_Code
string or null  <= 10 characters 
When configuration is Benefit specific, fill this in. When empty, applies to entire Group/Division/Plan.


 
dist_Volume_Amount
number or null <double> 
Based on volume type, this settings determines the volume.


 
dist_Volume_Pct
required
boolean
Based on volume type, this settings determines the volume. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
division_ID
string or null  <= 20 characters 
When configuration is Division specific, fill this in. When empty, applies to the entire Group.


 
effective_Date
string or null <date-time> 
The effective date of the volume setting.


 
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.


 
gI_Volume_Max
number or null <double> 
Based on volume type, this settings determines the volume.


 
gI_Volume_Min
number or null <double> 
Based on volume type, this settings determines the volume.


 
group_ID
required
string  [ 1 .. 20 ] characters 
References Groups.Group_ID value on the parent record.


 
plan_ID
string or null  <= 20 characters 
When configuration is Plan specific, fill this in. When empty, applies to entire Group/Division.


 
term_Date
string or null <date-time> 
The term date for this volume setting.


 
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.


 
use_Dist_Volume
required
boolean
Based on volume type, this settings determines the volume. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
volume
number or null <double> 
Based on volume type, this settings determines the volume.


 
volume_ID
string or null  <= 32 characters 
This is a User definable field to name the volume being entered.


 
volume_Max
number or null <double> 
Based on volume type, this settings determines the volume.


 
volume_Min
number or null <double> 
Based on volume type, this settings determines the volume.


 
volume_Round_Precision
integer or null <int32> 
Based on volume type, this settings determines the volume.


 
volume_Round_Type
string or null  <= 16 characters 
Based on volume type, this settings determines the volume.


 
volume_Type
string or null  <= 16 characters 
This value indicates what setting is used to calculate volume. The fileds that reference this setting are noted and drive the specific volume type. Reference VBASoftware application documentation for detailed explanation.


 
volume_Type_From
integer or null <int32> 
Based on volume type, this settings determines the volume.


 
volume_Type_Pct
number or null <double> 
Based on volume type, this settings determines the volume.


 
volume_Type_Thru
integer or null <int32> 
Based on volume type, this settings determines the volume.


 
Responses 
207
Success


401
Unauthorized


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