# Group Disenroll

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

Endpoint: POST /groups/{groupID}/disenroll
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Path parameters:

  - `groupID` (string, required)
    Group ID

## Request fields (application/json):

  - `user_ID` (string, required)
    The user for which this request is executed on behalf of.

  - `group_ID` (string, required)
    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,null)
    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` (string, required)
    The Disenroll Date for this disenroll process.

  - `term_Date` (string,null)
    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` (integer, required)
    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` (integer, required)
    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` (boolean, required)
    The TerminateAuth flag lets us know if Auths approved or requested beyond the Disenroll Date should be cancelled.

  - `disenrollFuture` (integer, required)
    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` (boolean, required)
    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.

## Response 200 fields (text/plain):

  - `data` (object)

  - `data.vbaProcess_Key` (integer, required)
    Unique Identifier for the VBAProcess table Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.vbaProcess_Type` (string, required)
    Type used to determine the process that triggers.

  - `data.description` (string,null)
    Description of the process.

  - `data.entry_Date` (string)
    Date record was first added to the system

  - `data.entry_User` (string,null)
    User that first added the record to the system

  - `data.process_End` (string,null)
    Date and time the process ended.

  - `data.process_Result` (string,null)
    Result of the process.

  - `data.process_Start` (string,null)
    Date and time the process started.

  - `data.process_User` (string,null)
    User that started the process.

  - `data.update_Date` (string)
    Date the record was last updated in the system

  - `data.update_User` (string,null)
    User that last updated the record in the system

  - `error` (object)

  - `error.detail` (string,null)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string,null)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string,null)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string,null)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)


## Response 401 fields