Get all benefit plans for comparison
get
/hcmRestApi/resources/11.13.18.05/benefitPlansComparison
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 Finds a benefit plan for comparison that matches the specified primary key criteria.
Finder Variables- InstanceId; integer; Unique identifier for the benefit comparison plans.
- findByElectableInstanceId Finds the electable benefit plan for comparison based on the benefit comparison plans and person identifiers.
Finder Variables- EffectiveDate; string; Date when the plan is active for comparison.
- InstanceId; integer; Unique identifier for the benefit comparison plans.
- PersonId; integer; Unique identifier for the person.
- findByInstanceId Finds a benefit plan for comparison based on the benefit comparison plans identifier.
Finder Variables- InstanceId; integer; Unique identifier for the benefit comparison plans.
- findByPlanAttr Finds all benefit plans for comparison based on the specified criteria.
Finder Variables- EffectiveDate; string; Date on which a plan is active for comparison. By default, the effective date is the current date.
- Name; string; Name; string; of the benefit plan.
- PersonId; integer; Unique identifier for the person.
- TemplateId; integer; Unique identifier for the plan template.
- TemplateName; string; Name; string; of the plan template.
- PrimaryKey Finds a benefit plan for comparison 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:- ComparisonType; string; Comparison type of the plan template.
- FromDate; string; Date from which the benefit plan is active for comparison.
- InstanceId; integer; Unique identifier for the benefit comparison plans.
- LegislationCode; string; Legislation code of the plan template.
- Name; string; Name of the benefit plan.
- TemplateId; integer; Unique identifier for the plan template.
- TemplateName; string; Name of the plan template.
- TemplateType; string; Type of the plan template.
- ToDate; string; Date till when the benefit plan is active for comparison.
-
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 : benefitPlansComparison
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 : benefitPlansComparison-item-response
Type:
Show Source
object
-
ComparisonType: string
Title:
Comparison Type
Read Only:true
Maximum Length:128
Comparison type of the plan template. -
estimatedCosts: array
Estimated Costs
Title:
Estimated Costs
The estimatedCosts resource is a child of the benefitPlansComparison resource. This resource provides all estimated costs of the benefit plan. -
EstimatedCostType: string
Title:
Estimated Cost Period
Read Only:true
Maximum Length:80
Period of the estimated cost. -
EstimatedCostValue: string
Title:
Estimated Cost Value
Read Only:true
Maximum Length:1000
Estimated cost for the plan. -
featureValues: array
Feature Values
Title:
Feature Values
The featureValues resource is a child of the benefitPlansComparison resource. This resource provides all the values that are associated with the features of the benefit plan. -
footnotes: array
Footnotes
Title:
Footnotes
The footnotes resource is a child of the benefitPlansComparison resource. This resource provides all the footnotes that are associated with the plan template. -
FromDate: string
(date)
Title:
From Date
Read Only:true
Date from which the benefit plan is active for comparison. -
highlights: array
Highlights
Title:
Highlights
The highlights resource is a child of the benefitPlansComparison resource. This resource provides all the highlights of the benefit plan. -
ImageId: integer
(int64)
Title:
Image ID
Read Only:true
Unique identifier for the image. -
images: array
Images
Title:
Images
The images resource is a child of the benefitPlansComparison resource. This resource provides the image of the benefit plan. -
InstanceId: integer
(int64)
Title:
Instance ID
Read Only:true
Unique identifier for the benefit comparison plans. -
LegislationCode: string
Title:
Legislation Code
Read Only:true
Maximum Length:30
Legislation code of the plan template. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Plan Name
Read Only:true
Maximum Length:240
Name of the benefit plan. -
TemplateId: integer
(int64)
Title:
Template ID
Read Only:true
Unique identifier for the plan template. -
TemplateName: string
Title:
Template Name
Read Only:true
Maximum Length:128
Name of the plan template. -
TemplateType: string
Title:
Template Type
Read Only:true
Maximum Length:128
Type of the plan template. -
ToDate: string
(date)
Title:
To Date
Read Only:true
Date till when the benefit plan is active for comparison. -
UseGroupsFlag: boolean
Title:
Use Groups
Read Only:true
Maximum Length:30
Indicates whether the plan template uses groupings or not. The valid values are true and false. The default value is false. -
UseHeaderFlag: boolean
Title:
Use Headers
Read Only:true
Maximum Length:30
Indicates whether the plan template uses header or not. The valid values are true and false. The default value is false.
Nested Schema : Estimated Costs
Type:
array
Title:
Estimated Costs
The estimatedCosts resource is a child of the benefitPlansComparison resource. This resource provides all estimated costs of the benefit plan.
Show Source
Nested Schema : Feature Values
Type:
array
Title:
Feature Values
The featureValues resource is a child of the benefitPlansComparison resource. This resource provides all the values that are associated with the features of the benefit plan.
Show Source
Nested Schema : Footnotes
Type:
array
Title:
Footnotes
The footnotes resource is a child of the benefitPlansComparison resource. This resource provides all the footnotes that are associated with the plan template.
Show Source
Nested Schema : Highlights
Type:
array
Title:
Highlights
The highlights resource is a child of the benefitPlansComparison resource. This resource provides all the highlights of the benefit plan.
Show Source
Nested Schema : Images
Type:
array
Title:
Images
The images resource is a child of the benefitPlansComparison resource. This resource provides the image of the benefit plan.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : benefitPlansComparison-estimatedCosts-item-response
Type:
Show Source
object
-
EstimatedCost: string
Title:
Estimated Cost Value
Read Only:true
Maximum Length:1000
Estimated cost for the plan or option. -
InstanceValueId: integer
(int64)
Title:
Instance Value ID
Read Only:true
Unique identifier for the estimated costs. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OptionName: string
Title:
Option Name
Read Only:true
Maximum Length:128
Name of the option.
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 : benefitPlansComparison-featureValues-item-response
Type:
Show Source
object
-
CategoryId: integer
(int64)
Title:
Category ID
Read Only:true
Unique identifier for the category. -
CategoryName: string
Title:
Category Name
Read Only:true
Maximum Length:128
Name of the category. -
footnoteReferences: array
Footnote References
Title:
Footnote References
The footnoteReferences resource is a child of the featureValues resource. This resource provides all the footnote references that are associated with the particular feature value of the benefit plan. -
FootnoteRefs: string
Title:
Footnote References
Read Only:true
Maximum Length:1000
Footnote references associated with the feature value. -
GroupId: integer
(int64)
Title:
Group ID
Read Only:true
Unique identifier for the group of the feature. -
GroupName: string
Title:
Group Name
Read Only:true
Maximum Length:1000
Name of the group of the feature. -
InfoText: string
Title:
Feature Information Text
Read Only:true
Maximum Length:1000
Additional information about the feature. -
InstanceValueId: integer
(int64)
Title:
Instance Value ID
Read Only:true
Unique identifier for the feature value. -
ItemId: integer
(int64)
Title:
Item ID
Read Only:true
Unique identifier for the feature. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Feature Name
Read Only:true
Maximum Length:1000
Name of the feature. -
OptionId: integer
(int64)
Title:
Option ID
Read Only:true
Unique identifier for the option. -
OptionName: string
Title:
Option Name
Read Only:true
Maximum Length:128
Name of the option. -
UseCategoriesFlag: boolean
Title:
Use Categories
Read Only:true
Maximum Length:30
Indicates whether the feature uses categories or not. The valid values are true and false. The default value is false. -
UseOptionsFlag: boolean
Title:
Use Options
Read Only:true
Maximum Length:30
Indicates whether the feature uses options or not. The valid values are true and false. The default value is false. -
Value: string
Title:
Feature Value
Read Only:true
Maximum Length:1000
Value of the feature.
Nested Schema : Footnote References
Type:
array
Title:
Footnote References
The footnoteReferences resource is a child of the featureValues resource. This resource provides all the footnote references that are associated with the particular feature value of the benefit plan.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : benefitPlansComparison-featureValues-footnoteReferences-item-response
Type:
Show Source
object
-
Footnote: string
Title:
Footnote
Read Only:true
Maximum Length:1000
Display text for the footnote reference. -
ItemId: integer
Title:
Item ID
Read Only:true
Unique identifier for the footnote reference. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Sequence: integer
(int32)
Title:
Sequence
Read Only:true
Display sequence of the footnote reference.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : benefitPlansComparison-footnotes-item-response
Type:
Show Source
object
-
Footnote: string
Title:
Footnote
Read Only:true
Maximum Length:1000
Display text for the footnote. -
ItemId: integer
(int64)
Title:
Item ID
Read Only:true
Unique identifier for the footnote. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Sequence: integer
(int32)
Title:
Sequence
Read Only:true
Display sequence of the footnote.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : benefitPlansComparison-highlights-item-response
Type:
Show Source
object
-
InstanceValueId: integer
(int64)
Title:
Instance Value ID
Read Only:true
Unique identifier for the highlight. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Read Only:true
Maximum Length:1000
Name of the highlight. -
ValueFlag: boolean
Title:
Use Highlights
Read Only:true
Maximum Length:1000
Indicates whether the plan offers this highlight or not. The valid values are true and false. The default value is false.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : benefitPlansComparison-images-item-response
Type:
Show Source
object
-
FileName: string
Title:
Image File Name
Read Only:true
Maximum Length:4000
Name of the image file. -
Image: string
(byte)
Title:
Image
Read Only:true
File object for the image. -
ImageId: integer
(int64)
Title:
Image ID
Read Only:true
Unique identifier for the image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Image Name
Read Only:true
Maximum Length:4000
Name of the image.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source