APIs for VBASoftware
VBASoftware (v1)
- application/json
- text/json
- application/*+json
The user for which this request is executed on behalf of.
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.
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.
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 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).
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).
The TerminateAuth flag lets us know if Auths approved or requested beyond the Disenroll Date should be cancelled.
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
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.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/disenroll
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/disenroll' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"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
}'No response example- application/json
- text/json
- application/*+json
The user for which this request is executed on behalf of.
- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/reenroll
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/reenroll' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE' \
-d '{
"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": [
{
"plan_ID": "string",
"tier": "string"
}
],
"memberSeqCriterias": [
"string"
]
}'No response example- VBAPI VBASoftwarehttps://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/enrollment-summary
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://vbapi.vbasoftware.com/vbasoftware/groups/{groupID}/enrollment-summary' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'vbasoftware-database: string' \
-H 'x-api-key: YOUR_API_KEY_HERE'No response example