API Catalog

Retrieve HR Employee Elected Plans by Code

06 Jan 2025
1 Minute to read

Print
Dark
Light

Retrieve HR Employee Elected Plans by Code

Updated on 06 Jan 2025
1 Minute to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/hcm-rest-api/rest/1/hrelectedplans

Query Standards

Finder

Following row finders are available for data filtering and optimizing request performance.

Select By Code
By UUID

Select By Code

Recommended finder parameters. Refer to Query Parameters for example.

Parameter	Description	Sample
EmpNo	Employee Number	TST1
PlanCode	Plan Code	DEFAULT
PloCode	Plan Option Code	CHILD
EffDate	Effective Date	2018-12-31
ElectedCode	Elected Plan Code	AD&D
EndDate	End Date	2022-10-06

By UUID

This is an optional finder for querying a specific Employee Elected Plan by row ID.

Parameter	Description	Sample
/VUUID	The VUuid attribute is the Unique row ID	/hcm-rest-api/rest/1/hrelectedplans/F05ACE4E269C2547E05316821FAC3C18

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExampleselectByCode;EmpNo=TST1,PlanCode=DEFAULT,PloCode=CHILD, EffDate=2018-12-31, ElectedCode=AD%26D, EndDate=2022-10-06

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

ExampleTrue

orderBy

string

ExampleEldVUuid

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

{
  "items": [
    {
      "EldBdAmount": 15,
      "EldBdCodeDesc": "Accid Death & Dismemberment",
      "EldBdTypeDesc": "Lump Sum",
      "EldCode": "AD&D",
      "EldCodeType": "BN",
      "EldCompCode": "001",
      "EldEffectiveDate": "2019-01-01T00:00:00Z",
      "EldEmpNo": "TST1",
      "EldEmplrEffectiveDate": null,
      "EldEndDate": null,
      "EldEndedPlan": null,
      "EldEnrollDependentFlag": "N",
      "EldLastUpdDate": "2022-12-21T17:23:08Z",
      "EldLastUpdUser": "ARCORO",
      "EldLtdTotalAmt": null,
      "EldNewRow": "N",
      "EldOldEffectiveDate": "2019-01-01T00:00:00Z",
      "EldPlanCode": "DEFAULT",
      "EldPloCode": "CHILD",
      "EldPrnCode": "WK",
      "EldPygCode": "HRLY",
      "EldRemittanceTotAmt": null,
      "EldRowCreationDate": "2022-12-21T17:23:08Z",
      "EldRowCreationUser": "ARCORO",
      "EldRowTag": "Elected",
      "EldVUuid": "F05ACE4E269C2547E05316821FAC3C18",
      "EldVendor": "ZURICH",
      "EldVendorComments": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/hrelectedplans/F05ACE4E269C2547E05316821FAC3C18",
          "name": "hrelectedplans",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/hrelectedplans/F05ACE4E269C2547E05316821FAC3C18",
          "name": "hrelectedplans",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/hrelectedplans",
      "name": "hrelectedplans",
      "kind": "collection"
    }
  ]
}

object

What's Next

Retrieve a Specific HR Employee Elected Plan By VUUID

Retrieve HR Employee Elected Plans by Code

Query Standards

Finder

Select By Code

By UUID

What's Next

Contact Us