Group Student Age Settings

Create GroupStudentAge

Creates a new GroupStudentAge

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupStudentAge_Key
required
integer <int32>

Unique identifer for each Student/Age configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.

age_From
integer or null <int32>

Indicates the starting age of the acceptable student age range.

age_Thru
integer or null <int32>

Indicates the ending age of the acceptable student age range.

age_Type
string or null <= 16 characters

Indicates the exact date when the age range applies: Birth Date - student age settings become effective/expire as of the birth date during the year in which they reach the chosen age. End of Birth Month - student age settings become effective/expired as of the end of the birth moth during the year in which they reach the chosen age. End of Birth Year - student age settings become effective/expired as of the end of the birth year in which they reach the chosen age.

division_ID
string or null <= 20 characters

References the GroupDivision.Division_ID value on the parent record.

effective_Date
string or null <date-time>

Date when the student age setting becomes/became effective.

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.

ex_Code
string or null <= 6 characters

Ex code that will be applied to claims of students from the Group who fall within the designated criteria.

group_ID
string or null <= 20 characters

References the GroupDivision.Group_ID value on the parent record.

state
string or null <= 2 characters

Identifies the state in which the student age settings apply.

state_Type
string or null <= 16 characters

Indicates if the state used in this settings is the member, subscriber or employer state.

term_Date
string or null <date-time>

Date when the student age setting expires/expired.

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/groups/{groupID}/student-ages
Request samples
{
  • "groupStudentAge_Key": 0,
  • "age_From": 0,
  • "age_Thru": 0,
  • "age_Type": "string",
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "group_ID": "string",
  • "state": "st",
  • "state_Type": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List GroupStudentAge

Lists all GroupStudentAge 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}/student-ages
Request samples 
Response samples 
No sample
Get GroupStudentAge
Gets GroupStudentAge


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupStudentAgeKey
required
integer <int32> 
GroupStudentAge Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/groups/{groupID}/student-ages/{groupStudentAgeKey}
Request samples 
Response samples 
No sample
Update GroupStudentAge
Updates a specific GroupStudentAge.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupStudentAgeKey
required
integer <int32> 
GroupStudentAge Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
groupStudentAge_Key
required
integer <int32> 
Unique identifer for each Student/Age configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age_From
integer or null <int32> 
Indicates the starting age of the acceptable student age range.


 
age_Thru
integer or null <int32> 
Indicates the ending age of the acceptable student age range.


 
age_Type
string or null  <= 16 characters 
Indicates the exact date when the age range applies: Birth Date - student age settings become effective/expire as of the birth date during the year in which they reach the chosen age. End of Birth Month - student age settings become effective/expired as of the end of the birth moth during the year in which they reach the chosen age. End of Birth Year - student age settings become effective/expired as of the end of the birth year in which they reach the chosen age.


 
division_ID
string or null  <= 20 characters 
References the GroupDivision.Division_ID value on the parent record.


 
effective_Date
string or null <date-time> 
Date when the student age setting becomes/became effective.


 
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.


 
ex_Code
string or null  <= 6 characters 
Ex code that will be applied to claims of students from the Group who fall within the designated criteria.


 
group_ID
string or null  <= 20 characters 
References the GroupDivision.Group_ID value on the parent record.


 
state
string or null  <= 2 characters 
Identifies the state in which the student age settings apply.


 
state_Type
string or null  <= 16 characters 
Indicates if the state used in this settings is the member, subscriber or employer state.


 
term_Date
string or null <date-time> 
Date when the student age setting expires/expired.


 
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/groups/{groupID}/student-ages/{groupStudentAgeKey}
Request samples 
{
  • "groupStudentAge_Key": 0,
  • "age_From": 0,
  • "age_Thru": 0,
  • "age_Type": "string",
  • "division_ID": "string",
  • "effective_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "group_ID": "string",
  • "state": "st",
  • "state_Type": "string",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete GroupStudentAge
Deletes an GroupStudentAge


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
groupID
required
string
Group ID


 
groupStudentAgeKey
required
integer <int32> 
GroupStudentAge Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/groups/{groupID}/student-ages/{groupStudentAgeKey}
Request samples 
Create or Update Batch GroupStudentAge
Create or Update multiple GroupStudentAge 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 
groupStudentAge_Key
required
integer <int32> 
Unique identifer for each Student/Age configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age_From
integer or null <int32> 
Indicates the starting age of the acceptable student age range.


 
age_Thru
integer or null <int32> 
Indicates the ending age of the acceptable student age range.


 
age_Type
string or null  <= 16 characters 
Indicates the exact date when the age range applies: Birth Date - student age settings become effective/expire as of the birth date during the year in which they reach the chosen age. End of Birth Month - student age settings become effective/expired as of the end of the birth moth during the year in which they reach the chosen age. End of Birth Year - student age settings become effective/expired as of the end of the birth year in which they reach the chosen age.


 
division_ID
string or null  <= 20 characters 
References the GroupDivision.Division_ID value on the parent record.


 
effective_Date
string or null <date-time> 
Date when the student age setting becomes/became effective.


 
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.


 
ex_Code
string or null  <= 6 characters 
Ex code that will be applied to claims of students from the Group who fall within the designated criteria.


 
group_ID
string or null  <= 20 characters 
References the GroupDivision.Group_ID value on the parent record.


 
state
string or null  <= 2 characters 
Identifies the state in which the student age settings apply.


 
state_Type
string or null  <= 16 characters 
Indicates if the state used in this settings is the member, subscriber or employer state.


 
term_Date
string or null <date-time> 
Date when the student age setting expires/expired.


 
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/groups/{groupID}/student-ages-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}