Group Self Admin Settings

Create GroupSelfAdmin

Creates a new GroupSelfAdmin

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupSelfAdmin_Key
required
integer <int32>

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

active
required
boolean

Notes if this coniguration is active for calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

age
integer or null <int32>

The age for this invoice calculation.

benefit_Code
string or null <= 10 characters

If there is Benefit level configuration, you would apply that here. If blank, this configuration applies to all benefits inside the group.

dependents
integer or null <int32>

The dependent count for this invoice calculation.

division_ID
string or null <= 20 characters

If there is Division level configuration, you would apply that here. If blank, this confiruation applies to the entire group.

entry_Date
string <date-time>

User that first added the record to the system.

entry_User
string or null <= 20 characters

Date when the record was first added to the system.

group_ID
required
string [ 1 .. 20 ] characters

References Groups.Group_ID values on parent record.

invoice_Level
string or null <= 1 characters

Notes the invoice level for self-admin invoicing. Works smilar to GroupDivision setting in that it combines other self-admin confiration to the common level.

members
integer or null <int32>

The member count for this invoice calculation.

plan_ID
string or null <= 20 characters

If there is Plan level configuration, you would apply that here. If blank, this configuration applies to all plans inside the group.

sex
string or null <= 1 characters

The gender for this invoice calculation.

subscribers
integer or null <int32>

The subscriber count for this invoice calculation.

update_Date
string <date-time>

User that last updated the record in the system.

update_User
string or null <= 20 characters

Date when the record was last updated in the system.

use_Volume_Scale
required
boolean

Indicates if volume scale determines the volume for this invoice calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.

volume
number or null <double>

The volume for this invoice calculation.

Responses
200

Success

401

Unauthorized

post/group-self-admins
Request samples
{
  • "groupSelfAdmin_Key": 0,
  • "active": true,
  • "age": 0,
  • "benefit_Code": "string",
  • "dependents": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "invoice_Level": "s",
  • "members": 0,
  • "plan_ID": "string",
  • "sex": "s",
  • "subscribers": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Volume_Scale": true,
  • "volume": 0.1
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupSelfAdmin

Lists all GroupSelfAdmin

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/group-self-admins
Request samples 
Response samples 
No sample
Get GroupSelfAdmin
Gets GroupSelfAdmin


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupSelfAdminKey
required
integer <int32> 
GroupSelfAdmin Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/group-self-admins/{groupSelfAdminKey}
Request samples 
Response samples 
No sample
Update GroupSelfAdmin
Updates a specific GroupSelfAdmin.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupSelfAdminKey
required
integer <int32> 
GroupSelfAdmin Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
active
required
boolean
Notes if this coniguration is active for calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age
integer or null <int32> 
The age for this invoice calculation.


 
benefit_Code
string or null  <= 10 characters 
If there is Benefit level configuration, you would apply that here. If blank, this configuration applies to all benefits inside the group.


 
dependents
integer or null <int32> 
The dependent count for this invoice calculation.


 
division_ID
string or null  <= 20 characters 
If there is Division level configuration, you would apply that here. If blank, this confiruation applies to the entire group.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


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


 
invoice_Level
string or null  <= 1 characters 
Notes the invoice level for self-admin invoicing. Works smilar to GroupDivision setting in that it combines other self-admin confiration to the common level.


 
members
integer or null <int32> 
The member count for this invoice calculation.


 
plan_ID
string or null  <= 20 characters 
If there is Plan level configuration, you would apply that here. If blank, this configuration applies to all plans inside the group.


 
sex
string or null  <= 1 characters 
The gender for this invoice calculation.


 
subscribers
integer or null <int32> 
The subscriber count for this invoice calculation.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
use_Volume_Scale
required
boolean
Indicates if volume scale determines the volume for this invoice calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
volume
number or null <double> 
The volume for this invoice calculation.


 
Responses 
200
Success


401
Unauthorized


put/group-self-admins/{groupSelfAdminKey}
Request samples 
{
  • "groupSelfAdmin_Key": 0,
  • "active": true,
  • "age": 0,
  • "benefit_Code": "string",
  • "dependents": 0,
  • "division_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "group_ID": "string",
  • "invoice_Level": "s",
  • "members": 0,
  • "plan_ID": "string",
  • "sex": "s",
  • "subscribers": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "use_Volume_Scale": true,
  • "volume": 0.1
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupSelfAdmin
Deletes an GroupSelfAdmin


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupSelfAdminKey
required
integer <int32> 
GroupSelfAdmin Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/group-self-admins/{groupSelfAdminKey}
Request samples 
Create or Update Batch GroupSelfAdmin
Create or Update multiple GroupSelfAdmin 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 
groupSelfAdmin_Key
required
integer <int32> 
Unique identifier for each Self Admin configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
active
required
boolean
Notes if this coniguration is active for calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age
integer or null <int32> 
The age for this invoice calculation.


 
benefit_Code
string or null  <= 10 characters 
If there is Benefit level configuration, you would apply that here. If blank, this configuration applies to all benefits inside the group.


 
dependents
integer or null <int32> 
The dependent count for this invoice calculation.


 
division_ID
string or null  <= 20 characters 
If there is Division level configuration, you would apply that here. If blank, this confiruation applies to the entire group.


 
entry_Date
string <date-time> 
User that first added the record to the system.


 
entry_User
string or null  <= 20 characters 
Date when the record was first added to the system.


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


 
invoice_Level
string or null  <= 1 characters 
Notes the invoice level for self-admin invoicing. Works smilar to GroupDivision setting in that it combines other self-admin confiration to the common level.


 
members
integer or null <int32> 
The member count for this invoice calculation.


 
plan_ID
string or null  <= 20 characters 
If there is Plan level configuration, you would apply that here. If blank, this configuration applies to all plans inside the group.


 
sex
string or null  <= 1 characters 
The gender for this invoice calculation.


 
subscribers
integer or null <int32> 
The subscriber count for this invoice calculation.


 
update_Date
string <date-time> 
User that last updated the record in the system.


 
update_User
string or null  <= 20 characters 
Date when the record was last updated in the system.


 
use_Volume_Scale
required
boolean
Indicates if volume scale determines the volume for this invoice calculation. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
volume
number or null <double> 
The volume for this invoice calculation.


 
Responses 
207
Success


401
Unauthorized


put/group-self-admins-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}