Adv. Groups

Group Disenroll Advanced API

Disenrolls a Group and/or Division. A VBAProcess object is returned representing the process state. See VBAProcess area for more information.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
user_ID
required
string [ 1 .. 20 ] characters

The user for which this request is executed on behalf of.

group_ID
required
string [ 1 .. 20 ] characters

The Group ID you would like to perform the disenroll. You can use the List Groups API (https://vbapi.vbasoftware.com/vbasoftware/groups) to get the values you need.

division_ID
string or null <= 20 characters

The Division ID to be disenrolled if you intend to disenroll only a specific Division. Leave this blank if you intend to disenroll all Divisions in a group. You can use the List GroupDivisions API (https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/divisions) to get the values you need.

disenroll_Date
required
string <date-time>

The Disenroll Date for this disenroll process.

term_Date
string or null <date-time>

Term Date is an informational field used in some reports. It doesn't impact the process but is often populated with the same value as the Disenroll Date.

reason_ID
required
integer <int32>

Reason ID is the reson for this disenroll. You can get a list of valid Reason IDs from the List Reasons API (https://vbapi.vbasoftware.com/vbasoftware/reasons).

disenrollFamily
required
integer <int32>

The DisenrollFamily indicator lets the Disenroll process know exactly how to perform the Disenroll. You can get a list of valid DisenrollFamily values from the List Disenrollment Family Options API (https://vbapi.vbasoftware.com/vbasoftware/disenroll-family-options).

terminateAuth
required
boolean

The TerminateAuth flag lets us know if Auths approved or requested beyond the Disenroll Date should be cancelled.

disenrollFuture
required
integer <int32>

The DisenrollFuture indicator will tell us how to handle any future enrollments beyond the Disenroll Date related to this disenroll. The valid values are: 2 - Disenroll Future Enrollments 3 - Do Not Disenroll any Future Enrollments

groupDisenroll
required
boolean

The flag is required and is set based on the disenroll you are performing. Set this value to true if you intend to Disenroll the Group. If you send in Divisioni_ID to disenroll a specific Division, this flag will then disenroll the group and the division sent but not other divisions.

Responses
200

Success

401

Unauthorized

post/groups/{groupID}/disenroll
Request samples
{
  • "user_ID": "string",
  • "group_ID": "string",
  • "division_ID": "string",
  • "disenroll_Date": "2019-08-24T14:15:22Z",
  • "term_Date": "2019-08-24T14:15:22Z",
  • "reason_ID": 0,
  • "disenrollFamily": 0,
  • "terminateAuth": true,
  • "disenrollFuture": 0,
  • "groupDisenroll": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Group Reenroll Advanced API

Re-enrolls a Group and/or Division. A VBAProcess object is returned representing the process state. See VBAProcess area for more information.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
user_ID
required
string [ 1 .. 20 ] characters

The user for which this request is executed on behalf of.

subscriber_ID
string or null
member_Seq
string or null
group_ID
string or null
division_ID
string or null
reenrollFamily
integer or null <int32>
subscriber
boolean
start_Date
string or null <date-time>
reenrollCOBRA
boolean
resetAuth
boolean
disenroll_Date
string or null <date-time>
cobraDivision
string or null
cobraCovStart
string or null <date-time>
cobraStart
string or null <date-time>
cobraEnd
string or null <date-time>
cobraReason
integer or null <int32>
generateInvoice
boolean
invoiceDate
string or null <date-time>
groupReenroll
boolean
resetGroupDisenroll
boolean
reenrollAll
boolean
Array of objects or null (COBRAPlanCriteria)
memberSeqCriterias
Array of strings or null
Responses
200

Success

401

Unauthorized

post/groups/{groupID}/reenroll
Request samples
{
  • "user_ID": "string",
  • "subscriber_ID": "string",
  • "member_Seq": "string",
  • "group_ID": "string",
  • "division_ID": "string",
  • "reenrollFamily": 0,
  • "subscriber": true,
  • "start_Date": "2019-08-24T14:15:22Z",
  • "reenrollCOBRA": true,
  • "resetAuth": true,
  • "disenroll_Date": "2019-08-24T14:15:22Z",
  • "cobraDivision": "string",
  • "cobraCovStart": "2019-08-24T14:15:22Z",
  • "cobraStart": "2019-08-24T14:15:22Z",
  • "cobraEnd": "2019-08-24T14:15:22Z",
  • "cobraReason": 0,
  • "generateInvoice": true,
  • "invoiceDate": "2019-08-24T14:15:22Z",
  • "groupReenroll": true,
  • "resetGroupDisenroll": true,
  • "reenrollAll": true,
  • "cobraPlanCriterias": [
    ],
  • "memberSeqCriterias": [
    ]
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get Group enrollment summary information Advanced API

Gets Group enrollment summary for the given group id.

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
groupID
required
string

Group ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

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