# List GroupVolume

Lists all GroupVolume for the given groupID

Endpoint: GET /groups/{groupID}/volumes
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

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

## Path parameters:

  - `groupID` (string, required)
    Group ID

## Query parameters:

  - `page` (integer)
    Page

  - `pageSize` (integer)
    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.

## Response 200 fields (text/plain):

  - `data` (array,null)

  - `data.groupVolume_Key` (integer, required)
    Unique identifier for each Volume configuration. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.benefit_Code` (string,null)
    When configuration is Benefit specific, fill this in. When empty, applies to entire Group/Division/Plan.

  - `data.dist_Volume_Amount` (number,null)
    Based on volume type, this settings determines the volume.

  - `data.dist_Volume_Pct` (boolean, required)
    Based on volume type, this settings determines the volume. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.division_ID` (string,null)
    When configuration is Division specific, fill this in. When empty, applies to the entire Group.

  - `data.effective_Date` (string,null)
    The effective date of the volume setting.

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

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

  - `data.gI_Volume_Max` (number,null)
    Based on volume type, this settings determines the volume.

  - `data.gI_Volume_Min` (number,null)
    Based on volume type, this settings determines the volume.

  - `data.group_ID` (string, required)
    References Groups.Group_ID value on the parent record.

  - `data.plan_ID` (string,null)
    When configuration is Plan specific, fill this in. When empty, applies to entire Group/Division.

  - `data.term_Date` (string,null)
    The term date for this volume setting.

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

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

  - `data.use_Dist_Volume` (boolean, required)
    Based on volume type, this settings determines the volume. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.volume` (number,null)
    Based on volume type, this settings determines the volume.

  - `data.volume_ID` (string,null)
    This is a User definable field to name the volume being entered.

  - `data.volume_Max` (number,null)
    Based on volume type, this settings determines the volume.

  - `data.volume_Min` (number,null)
    Based on volume type, this settings determines the volume.

  - `data.volume_Round_Precision` (integer,null)
    Based on volume type, this settings determines the volume.

  - `data.volume_Round_Type` (string,null)
    Based on volume type, this settings determines the volume.

  - `data.volume_Type` (string,null)
    This value indicates what setting is used to calculate volume. The fileds that reference this setting are noted and drive the specific volume type. Reference VBASoftware application documentation for detailed explanation.

  - `data.volume_Type_From` (integer,null)
    Based on volume type, this settings determines the volume.

  - `data.volume_Type_Pct` (number,null)
    Based on volume type, this settings determines the volume.

  - `data.volume_Type_Thru` (integer,null)
    Based on volume type, this settings determines the volume.

  - `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