Adv. Group Divisions

Copy a GroupDivision Advanced API

Copy a specific GroupDivision to a new GroupDivision

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
groupID
required
string non-empty

The owning Group

sourceDivisionID
required
string non-empty

The division from which values will be copied.

destinationGroupID
required
string non-empty

The Destination Group ID

destinationDivisionID
required
string non-empty

Name of the new divion

copyContracts
string or null

Flag indicating to copy this field or not. Default is false.

copyPlans
string or null

Flag indicating to copy this field or not. Default is false.

copyRiders
string or null

Flag indicating to copy this field or not. Default is false.

copyAdditional
string or null

Flag indicating to copy this field or not. Default is false.

copyClassOptions
string or null

Flag indicating to copy this field or not. Default is false.

copyCommissions
string or null

Flag indicating to copy this field or not. Default is false.

copyDisabilityOptions
string or null

Flag indicating to copy this field or not. Default is false.

copyNetworksTiers
string or null

Flag indicating to copy this field or not. Default is false.

copyPlanYears
string or null

Flag indicating to copy this field or not. Default is false.

copyPremiums
string or null

Flag indicating to copy this field or not. Default is false.

copySelfAdmin
string or null

Flag indicating to copy this field or not. Default is false.

copyStudentAge
string or null

Flag indicating to copy this field or not. Default is false.

copyVolumeDetails
string or null

Flag indicating to copy this field or not. Default is false.

copyIDCodes
string or null

Flag indicating to copy this field or not. Default is false.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/divisions/{divisionID}/copy
Request samples
{
  • "groupID": "string",
  • "sourceDivisionID": "string",
  • "destinationGroupID": "string",
  • "destinationDivisionID": "string",
  • "copyContracts": "string",
  • "copyPlans": "string",
  • "copyRiders": "string",
  • "copyAdditional": "string",
  • "copyClassOptions": "string",
  • "copyCommissions": "string",
  • "copyDisabilityOptions": "string",
  • "copyNetworksTiers": "string",
  • "copyPlanYears": "string",
  • "copyPremiums": "string",
  • "copySelfAdmin": "string",
  • "copyStudentAge": "string",
  • "copyVolumeDetails": "string",
  • "copyIDCodes": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get Group enrollment summary information Advanced API

Gets enrollment summary for the given group id and division id.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

divisionID
required
string

Division ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/groups/{groupID}/divisions/{divisionID}/enrollment-summary
Request samples 
Response samples 
No sample