Get an enrollment
get
/hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}
Request
Path Parameters
-
EnrollmentResultId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : benefitEnrollments-item-response
Type:
Show Source
object
-
costs: array
Costs
Title:
Costs
The costs resource is a child of the benefitEnrollments resource. It includes amounts, tax consequences and other information about standard rates, total flex credits, and imputed income calculated for a participant enrolled in a plan or option-in-plan. -
CoverageAmount: number
Title:
Benefit Coverage Amount
Read Only:true
Amount of coverage that a benefit offers. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the benefit record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the benefit record was created. -
CurrencyCode: string
Title:
Unit of Measure
Read Only:true
Maximum Length:30
Currency of the coverage amount, such as USD. -
dependents: array
Dependents
Title:
Dependents
The dependents resource is a child of the benefitEnrollments resource. It includes person records that a participant designated as dependents in the context of a program, plan type in program, or plan. The level at which dependent designations occur is defined at the program level for plans-in-program or at the plan level for plans-not-in-program. -
EnrollmentCoverageEndDate: string
(date)
Title:
Enrollment Coverage End Date
Read Only:true
Date when the continuous enrollment coverage ends. -
EnrollmentCoverageStartDate: string
(date)
Title:
Enrollment Coverage Start Date
Read Only:true
Date when the enrollment coverage starts. -
EnrollmentResultId: integer
(int64)
Title:
Enrollment Result ID
Read Only:true
Unique identifier of the enrollment result. This is an application generated primary key of the enrollment result. -
InterimFlag: boolean
Title:
Interim
Read Only:true
Maximum Length:30
Indicates whether the participant has interim coverage for the offering. Valid values are True and False. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the benefit record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the benefit record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NonMonetaryUnit: string
Title:
Nonmonetary Units
Read Only:true
Maximum Length:30
Nonmonetary unit of measure of the coverage amount, such as shares, hours, and units. -
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. -
OptionId: integer
(int64)
Title:
Option ID
Read Only:true
Unique identifier for the enrolled option. This is an application generated primary key. -
OptionName: string
Title:
Option Name
Read Only:true
Maximum Length:240
Name of the option in which the participant has enrolled. -
OriginalCoverageStartDate: string
(date)
Title:
Original Coverage Start Date
Read Only:true
Date when the continuous enrollment coverage starts. -
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
Display name of the participant. -
PlanId: integer
(int64)
Title:
Plan ID
Read Only:true
Unique identifier for the enrolled plan. This is an application generated primary key. -
PlanName: string
Title:
Plan Name
Read Only:true
Maximum Length:240
Name of the plan in which the participant has enrolled. -
PlanTypeId: integer
(int64)
Title:
Plan Type ID
Read Only:true
Unique identifier for the enrolled plan type. This is an application generated primary key. -
PlanTypeName: string
Title:
Plan Type Name
Read Only:true
Maximum Length:240
Name of the plan type in which the person enrolled. -
ProgramId: integer
(int64)
Title:
Program ID
Read Only:true
Unique identifier for the enrolled program. This is an application generated primary key. -
ProgramName: string
Title:
Program Name
Read Only:true
Maximum Length:240
Name of the benefits program in which the person enrolled. -
providers: array
Providers
Title:
Providers
The providers resource is a child of the benefitEnrollments resource. It includes the external or internal organizations responsible for providing goods or services to the participants of the enrolled plan, such as third party agents and self-insured companies. -
SuspendFlag: boolean
Title:
Suspended
Read Only:true
Maximum Length:30
Indicates whether the enrollment is suspended. Valid values are True and False.
Nested Schema : Costs
Type:
array
Title:
Costs
The costs resource is a child of the benefitEnrollments resource. It includes amounts, tax consequences and other information about standard rates, total flex credits, and imputed income calculated for a participant enrolled in a plan or option-in-plan.
Show Source
Nested Schema : Dependents
Type:
array
Title:
Dependents
The dependents resource is a child of the benefitEnrollments resource. It includes person records that a participant designated as dependents in the context of a program, plan type in program, or plan. The level at which dependent designations occur is defined at the program level for plans-in-program or at the plan level for plans-not-in-program.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Providers
Type:
array
Title:
Providers
The providers resource is a child of the benefitEnrollments resource. It includes the external or internal organizations responsible for providing goods or services to the participants of the enrolled plan, such as third party agents and self-insured companies.
Show Source
Nested Schema : benefitEnrollments-costs-item-response
Type:
Show Source
object
-
ActivityTypeCode: string
Title:
Activity Type
Read Only:true
Maximum Length:30
Activity type for the rate. -
AnnualRateAmount: number
Title:
Annual Rate Amount
Read Only:true
Annual rate value. -
CommunicatedRateAmount: number
Title:
Communicated Amount
Read Only:true
Communicated amount for the rate. -
EnrollmentResultId: integer
(int64)
Title:
Enrollment Result ID
Read Only:true
Unique identifier for the enrollment result. This is an application generated primary key of the enrollment result. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RateEndDate: string
(date)
Title:
Rate End Date
Read Only:true
Date when the rate ends. -
RateStartDate: string
(date)
Title:
Rate Start Date
Read Only:true
Date when the rate starts. -
RateValueId: integer
(int64)
Title:
Rate Value ID
Read Only:true
Unique identifier for the rate value. This is an application generated primary key. -
TaxTypeCode: string
Title:
Tax Type
Read Only:true
Maximum Length:30
Tax type for the rate.
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.
Nested Schema : benefitEnrollments-dependents-item-response
Type:
Show Source
object
-
CoveredDependentId: integer
(int64)
Title:
Covered Dependent ID
Read Only:true
Unique identifier for the covered dependent. This is an application generated primary key. -
DependentCoverageEndDate: string
Title:
Coverage End Date
Read Only:true
Maximum Length:18
Date when the benefit coverage ends. -
DependentCoverageStartDate: string
(date)
Title:
Coverage Start Date
Read Only:true
Date when the benefit coverage starts. -
DependentName: string
Title:
Dependent Name
Read Only:true
Maximum Length:240
Display name of the covered dependent . -
DependentPersonId: integer
(int64)
Title:
Dependent Person ID
Read Only:true
Unique identifier for the dependent. This is an application generated primary key. -
EnrollmentResultId: integer
(int64)
Title:
Enrollment Result ID
Read Only:true
Unique identifier for the enrollment result. This is an application generated primary key of the enrollment result. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RelationshipCode: string
Read Only:
true
Maximum Length:30
Relationship of the dependent with the participant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : benefitEnrollments-providers-item-response
Type:
Show Source
object
-
CustomerNumber: number
Title:
Customer Identifier Number
Read Only:true
Customer number for the provider organization. -
EffectiveEndDate: string
(date)
Title:
End Date
Read Only:true
Date when the provider organization ceases to be effective. -
EffectiveStartDate: string
(date)
Title:
Start Date
Read Only:true
Start date when the provider organization is effective. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Title:
Organization ID
Read Only:true
Unique identifier for the organization. This is an application generated primary key. -
OrganizationName: string
Title:
Organization Name
Read Only:true
Maximum Length:240
Name of the plan provider organization. -
PlanId: integer
(int64)
Title:
Plan ID
Read Only:true
Unique identifier for the provider plan. This is an application generated primary key. -
PolicyNumber: string
Title:
Policy or Group Identifier
Read Only:true
Maximum Length:90
Unique identifier for the policy or group. This is an application generated primary key. -
ProviderOrganizationId: integer
Title:
Provider Organization ID
Read Only:true
Unique identifier for the plan provider organization. This is an application generated primary key. -
providerRoles: array
Provider Roles
Title:
Provider Roles
The providerRoles resource is a child of the providers resource. It includes the services or functions performed by an organization to the participants of the enrolled plan.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Provider Roles
Type:
array
Title:
Provider Roles
The providerRoles resource is a child of the providers resource. It includes the services or functions performed by an organization to the participants of the enrolled plan.
Show Source
Nested Schema : benefitEnrollments-providers-providerRoles-item-response
Type:
Show Source
object
-
DesigneeName: string
Title:
Organization Designee
Read Only:true
Maximum Length:240
Name of the organization role in the program or plan. -
DesigneeRole: string
Title:
Organization Role
Read Only:true
Maximum Length:80
Organization role type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProviderOrganizationId: integer
(int64)
Title:
Provider Organization ID
Read Only:true
Unique identifier for the plan provider organization. This is an application generated primary key. -
ProviderOrganizationRoleId: integer
Title:
Provider Organization Role ID
Read Only:true
Unique identifier for the provider organization role. This is an application generated primary key.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- costs
-
Parameters:
- EnrollmentResultId:
$request.path.EnrollmentResultId
The costs resource is a child of the benefitEnrollments resource. It includes amounts, tax consequences and other information about standard rates, total flex credits, and imputed income calculated for a participant enrolled in a plan or option-in-plan. - EnrollmentResultId:
- dependents
-
Operation: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/dependentsParameters:
- EnrollmentResultId:
$request.path.EnrollmentResultId
The dependents resource is a child of the benefitEnrollments resource. It includes person records that a participant designated as dependents in the context of a program, plan type in program, or plan. The level at which dependent designations occur is defined at the program level for plans-in-program or at the plan level for plans-not-in-program. - EnrollmentResultId:
- providers
-
Operation: /hcmRestApi/resources/11.13.18.05/benefitEnrollments/{EnrollmentResultId}/child/providersParameters:
- EnrollmentResultId:
$request.path.EnrollmentResultId
The providers resource is a child of the benefitEnrollments resource. It includes the external or internal organizations responsible for providing goods or services to the participants of the enrolled plan, such as third party agents and self-insured companies. - EnrollmentResultId: