List SubEnrollmentPlan

Request

Lists all SubEnrollmentPlan for the given Subscriber, Group, Division and Enrollment

Security

apiKeyAuth and bearerAuth

Path

subscriberIDstringrequired

Subscriber ID

groupIDstringrequired

Group ID

divisionIDstringrequired

Division ID

groupCoverageStartstring, (date-time)required

Group Coverage Start

startDatestring, (date-time)required

Start Date

Query

pageinteger, (int32)

Page number. Pages start at 1; page 0 returns 500.

Default:1

pageSizeinteger, (int32)

Items per page. Defaults to 100. The server sets no maximum; choose a size your client can process in one response.

Default:100

sortBystring

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.

vbasoftware-databasestringrequired

Target database

curl -i -X GET \
  'https://vbapi.vbasoftware.com/vbasoftware/subscribers/{subscriberID}/enrollments/{groupID}/{divisionID}/{groupCoverageStart}/{startDate}/plans?page=1&pageSize=100&sortBy=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Success

Headers

X-Paginationstring

Paging metadata as JSON: TotalCount, TotalPages, CurrentPage, PageSize. Pages start at 1.

Example:"{\"TotalCount\":250,\"TotalPages\":3,\"CurrentPage\":1,\"PageSize\":100}"

Bodyapplication/json

dataArray of objects or null

errorobject

debugobject

Response

{
  "data": [ … ],
  "error": { … },
  "debug": { … }
}