Get all enrollment opportunities
get
/hcmRestApi/resources/11.13.18.05/benefitEnrollmentOpportunities
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Enrollment opportunity that matches the specified primary key criteria.
Finder Variables- ElectableChoicePoplId; integer; Unique identifier for the benefitEnrollmentOpportunities resource.
- findByEventAttr Finds enrollment opportunities for all persons based on life event name and life event occurred date.
Finder Variables- LifeEventName; string; Name of the life event.
- LifeEventOccuredDate; string; Day on which the life event began.
- findByPersonNumber Finds enrollment opportunities for a person based on the person number of Participant.
Finder Variables- PersonNumber; string; Person number of the participant.
- PrimaryKey Enrollment opportunity that matches the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- BenefitRelationId; integer; Unique identifier for the benefits relationship.
- ElectableChoicePoplId; integer; System generated unique identifier for the benefitEnrollmentOpportunities resource. It identifies the benefits offering that's available as an electable choice for a person as a result of a life event.
- EnrollmentPeriodEndDate; string; The last date on which the participant can enroll in the program or plan.
- EnrollmentPeriodStartDate; string; The date on which the participant can enroll in the program or plan.
- LegalEntityId; integer; Unique identifier for the participant's legal employer.
- LifeEventName; string; Name of the life event.
- LifeEventOccuredDate; string; The day on which the life event began.
- LifeEventTypeCode; string; The category of the life event definition.
- PersonId; integer; Unique identifier for the participant.
- PersonName; string; Participant display name.
- PersonNumber; string; Person number of the participant.
- PlanId; integer; Unique identifier for the plan not in program in which a participant can enroll in a given enrollment window period.
- PlanName; string; Plan name in which a participant can enroll in a given enrollment window period.
- ProgramId; integer; Unique identifier for the program in which a participant can enroll in a given enrollment window period.
- ProgramName; string; Program name in which a participant can enroll in a given enrollment window period.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : benefitEnrollmentOpportunities
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : benefitEnrollmentOpportunities-item-response
Type:
Show Source
object
-
AutomaticAssignedDate: string
(date)
Title:
Automatically Assigned
Read Only:true
The date on which this program or plan was automatically assigned to this person. -
BenefitRelationId: integer
(int64)
Title:
Benefits Relationship ID
Read Only:true
Unique identifier for the benefits relationship. -
BenefitRelationName: string
Title:
Benefits Relationship Name
Read Only:true
Maximum Length:240
Name of the benefits relationship. -
BenefitRelationType: string
Title:
Usage
Read Only:true
Maximum Length:30
Type of the benefits relationship. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Who column. Indicates the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column. Indicates the creation date and time of the row. -
DefaultAssignedDate: string
(date)
Title:
Default Assigned Date
Read Only:true
The date on which this program or plan was assigned as the default if the participant failed to make an election. -
ElectableChoicePoplId: integer
Title:
Program or Plan Choice ID
Read Only:true
System generated unique identifier for the benefitEnrollmentOpportunities resource. It identifies the benefits offering that's available as an electable choice for a person as a result of a life event. -
ElectionsMadeDate: string
(date)
Title:
Election Made Date
Read Only:true
The date on which the participant elected this benefit. -
EnrollmentPeriodEndDate: string
(date)
Title:
Enrollment Period End Date
Read Only:true
The last date on which the participant can enroll in the program or plan. -
EnrollmentPeriodStartDate: string
(date)
Title:
Enrollment Period Start Date
Read Only:true
The date on which the participant can enroll in the program or plan. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Who column. Indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column. Indicates the user who last updated the row. -
LegalEntityId: integer
(int64)
Title:
Legal Entity ID
Read Only:true
Unique identifier for the participant's legal employer. -
LifeEventName: string
Title:
Life Event Name
Read Only:true
Maximum Length:240
Name of the life event. -
LifeEventOccuredDate: string
(date)
Title:
Life Event Occurred Date
Read Only:true
The day on which the life event began. -
LifeEventStatusCode: string
Title:
Life Event Status
Read Only:true
Maximum Length:30
The present state of the life event. -
LifeEventTypeCode: string
Title:
Life Event Type
Read Only:true
Maximum Length:30
The category of the life event definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
Read Only:true
Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was last queried. -
PersonId: integer
(int64)
Title:
Person ID
Read Only:true
Unique identifier for the participant. -
PersonName: string
Title:
Person Name
Read Only:true
Maximum Length:240
Participant display name. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number of the participant. -
PlanId: integer
(int64)
Title:
Plan ID
Read Only:true
Unique identifier for the plan not in program in which a participant can enroll in a given enrollment window period. -
PlanName: string
Title:
Plan Name
Read Only:true
Maximum Length:240
Plan name in which a participant can enroll in a given enrollment window period. -
ProcessingEndDate: string
(date)
Title:
Processing End Date
Read Only:true
The end date of the last participation process that was run. -
ProgramId: integer
(int64)
Title:
Program ID
Read Only:true
Unique identifier for the program in which a participant can enroll in a given enrollment window period. -
ProgramName: string
Title:
Program Name
Read Only:true
Maximum Length:240
Program name in which a participant can enroll in a given enrollment window period. -
VisibleToEmployeeFlag: boolean
Title:
Visible on Self-Service Pages
Read Only:true
Maximum Length:240
Check box to indicate whether employees can select the life event on self-service pages, regardless of any applicable eligibility criteria.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.