# List SubEnrollment

Lists all SubEnrollment for the given subscriberID

Endpoint: GET /subscribers/{subscriberID}/enrollments
Version: v1
Security: apiKeyAuth, bearerAuth

## Security:

  - `apiKeyAuth` (unknown)
    apiKey in header x-api-key

  - `bearerAuth` (unknown)
    http bearer JWT

## Path parameters:

  - `subscriberID` (string, required)
    Subscriber ID

## Query parameters:

  - `page` (integer)
    Page number. Pages start at 1; page 0 returns 500.

  - `pageSize` (integer)
    Items per page. Defaults to 100. The server sets no maximum; choose a size your client can process in one response.

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

## Header parameters:

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

## Response 200:

  - `200` (unknown)
    Success

## Response 200 fields (application/json):

  - `data` (array)

  - `data.subscriber_ID` (string, required)
    References Subscribers.Subscriber_ID value on the parent record.

  - `data.group_ID` (string, required)
    References the GroupContract.Group_ID value in the parent table.

  - `data.division_ID` (string, required)
    References the GroupContract.Division_ID value in the parent table.

  - `data.group_Coverage_Start` (string, required)
    References the GroupContract.Coverage_Start value in the parent table.

  - `data.start_Date` (string, required)
    Start date of Subenrollment coverage.

  - `data.annual_Max` (number)
    Annual maximum for identified policy. [Informational Only]

  - `data.date_Employed` (string)
    Start date of the Subscriber's employment.

  - `data.eligibility_Date` (string)
    Date the Subscriber was eligible for coverage.

  - `data.end_Date` (string)
    End date of Subenrollment coverage.

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

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

  - `data.lifetime_Max` (number)
    Lifetime maximum for indentified policy. [Informational Only]

  - `data.original_Enrollment_Date` (string)
    Identifies the date the Enrollment began. This is useful if a new Group is added and insured Members have been covered under the Group Plan earlier than their start date with you.

  - `data.paid_Through` (string)
    Date that the premiums have been paid through. This field will auto populate with the most recent closed invoice ‘Bill Thru’ date if 'Set Paid Thru' is set through the Control Panel. The 'Paid Thru Exceeded' Ex Code will be applied to Claims adjudicated with a service date beyond this date.

  - `data.policy_Number` (string)
    Policy number issued from Insurer. [Informational Only]

  - `data.term_Date` (string)
    Termination date of the Subscriber's employment.

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

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

  - `data.retro_Start_Date` (string)
    Original Start_Date retained when the enrollment start is moved later via Modify Enrollment, so retro adjustments
can be identified for the vacated period. Read-only for API clients: populated on GET, ignored on create/update,
and set by the EnrollmentServiceChangeSubenrollment stored procedure.

  - `error` (object)

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

  - `error.instance` (string)
    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)
    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)
    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 200 headers (application/json):

  - `X-Pagination` (string)
    Paging metadata as JSON: `TotalCount`, `TotalPages`, `CurrentPage`, `PageSize`. Pages start at 1.
    Example: {"TotalCount":250,"TotalPages":3,"CurrentPage":1,"PageSize":100}

## Response 401:

  - `401` (unknown)
    Unauthorized

## Response 403:

  - `403` (unknown)
    Forbidden. The x-api-key header is missing or not valid. The API gateway sends this response, not VBAPI, so the body is not the VBAPI envelope; see Errors and troubleshooting.

## Response 429:

  - `429` (unknown)
    Too many requests. The limit is 25 requests per second sustained, with bursts up to 50, per API key. Wait and retry with exponential backoff and jitter.