API Catalog

Retrieve PY Plan Options By Code

27 Feb 2025
3 Minutes to read

Print
Dark
Light

Retrieve PY Plan Options By Code

Updated on 27 Feb 2025
3 Minutes to read

Print
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback!

Get

/hcm-rest-api/rest/1/pyplanoption

Query Standards

Finder

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

Find By Date
Find By Plan
Primary Key

Find By Date

Recommended finder parameters. Refer to Query Parameters for example.

Parameter	Description	Sample
AuditDate	Create or Update Date Time Filter	2022-12-20

Find By Plan

This is an optional finder for querying Plan Options by Plan Code.

Parameter	Description	Sample
planCode	Plan Code (The plan option is associated with)	401K

Primary Key

This is an optional finder for querying a specific Plan Option by Primary Key (PlnCode + PloCode).

Parameter	Description	Sample
PloPlnCode	Plan Code (The plan option is associated with)	401K
PloCode	Plan Option Code	401K 1%

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExamplefindByDate;auditDate=2015-01-01

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

ExampleTrue

orderBy

string

ExamplePloCode

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

example-0

Successful Response - Finder - findByDate

{
  "items": [
    {
      "PloPlnCode": "401K",
      "PloCode": "401K 1%",
      "PloDescription": "401K 1%",
      "PloShortDesc": "401K 1%",
      "PloUser": "ADWAIT",
      "PloDepCovLevel": null,
      "PloMaxAgeInSchool": null,
      "PloMaxAgeNotInSchool": null,
      "PloLastUpdDate": "2015-05-04T18:15:28Z",
      "PloIuCreateDate": "2015-05-04T18:15:28Z",
      "PloIuCreateUser": "ADWAIT",
      "PloIuUpdateDate": null,
      "PloIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/0002000000043430314B000000073430314B203125",
          "name": "pyplanoption",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/0002000000043430314B000000073430314B203125",
          "name": "pyplanoption",
          "kind": "item"
        }
      ]
    },
    {
      "PloPlnCode": "401K",
      "PloCode": "401K 2-5%",
      "PloDescription": "401K 2-5%",
      "PloShortDesc": "401K 2-5%",
      "PloUser": "ADWAIT",
      "PloDepCovLevel": null,
      "PloMaxAgeInSchool": null,
      "PloMaxAgeNotInSchool": null,
      "PloLastUpdDate": "2015-05-04T18:15:28Z",
      "PloIuCreateDate": "2015-05-04T18:15:28Z",
      "PloIuCreateUser": "ADWAIT",
      "PloIuUpdateDate": null,
      "PloIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/0002000000043430314B000000093430314B20322D3525",
          "name": "pyplanoption",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/0002000000043430314B000000093430314B20322D3525",
          "name": "pyplanoption",
          "kind": "item"
        }
      ]
    },
    {
      "PloPlnCode": "DEFAULT",
      "PloCode": "CHILD",
      "PloDescription": "Child",
      "PloShortDesc": "Child",
      "PloUser": "ADWAIT",
      "PloDepCovLevel": null,
      "PloMaxAgeInSchool": null,
      "PloMaxAgeNotInSchool": null,
      "PloLastUpdDate": "2015-05-04T18:10:20Z",
      "PloIuCreateDate": "2015-05-04T18:10:20Z",
      "PloIuCreateUser": "ADWAIT",
      "PloIuUpdateDate": null,
      "PloIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/00020000000744454641554C54000000054348494C44",
          "name": "pyplanoption",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/00020000000744454641554C54000000054348494C44",
          "name": "pyplanoption",
          "kind": "item"
        }
      ]
    },
    {
      "PloPlnCode": "DEFAULT",
      "PloCode": "DEFAULT",
      "PloDescription": "Default",
      "PloShortDesc": "Default",
      "PloUser": "ADWAIT",
      "PloDepCovLevel": null,
      "PloMaxAgeInSchool": null,
      "PloMaxAgeNotInSchool": null,
      "PloLastUpdDate": "2015-05-04T18:10:20Z",
      "PloIuCreateDate": "2015-05-04T18:10:20Z",
      "PloIuCreateUser": "ADWAIT",
      "PloIuUpdateDate": null,
      "PloIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/00020000000744454641554C540000000744454641554C54",
          "name": "pyplanoption",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/00020000000744454641554C540000000744454641554C54",
          "name": "pyplanoption",
          "kind": "item"
        }
      ]
    },
    {
      "PloPlnCode": "DEFAULT",
      "PloCode": "SPOUSE",
      "PloDescription": "Spouse",
      "PloShortDesc": "Spouse",
      "PloUser": "ADWAIT",
      "PloDepCovLevel": null,
      "PloMaxAgeInSchool": null,
      "PloMaxAgeNotInSchool": null,
      "PloLastUpdDate": "2015-05-04T18:10:20Z",
      "PloIuCreateDate": "2015-05-04T18:10:20Z",
      "PloIuCreateUser": "ADWAIT",
      "PloIuUpdateDate": null,
      "PloIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/00020000000744454641554C540000000653504F555345",
          "name": "pyplanoption",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/00020000000744454641554C540000000653504F555345",
          "name": "pyplanoption",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 5,
  "hasMore": true,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption",
      "name": "pyplanoption",
      "kind": "collection"
    }
  ]
}

example-1

Successful Response - Finder - PrimaryKey

{
  "items": [
    {
      "PloPlnCode": "401K",
      "PloCode": "401K 1%",
      "PloDescription": "401K 1%",
      "PloShortDesc": "401K 1%",
      "PloUser": "ADWAIT",
      "PloDepCovLevel": null,
      "PloMaxAgeInSchool": null,
      "PloMaxAgeNotInSchool": null,
      "PloLastUpdDate": "2015-05-04T18:15:28Z",
      "PloIuCreateDate": "2015-05-04T18:15:28Z",
      "PloIuCreateUser": "ADWAIT",
      "PloIuUpdateDate": null,
      "PloIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/0002000000043430314B000000073430314B203125",
          "name": "pyplanoption",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/0002000000043430314B000000073430314B203125",
          "name": "pyplanoption",
          "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/pyplanoption",
      "name": "pyplanoption",
      "kind": "collection"
    }
  ]
}

example-2

Successful Response - Finder - findByPlan

{
  "items": [
    {
      "PloPlnCode": "401K",
      "PloCode": "401K 1%",
      "PloDescription": "401K 1%",
      "PloShortDesc": "401K 1%",
      "PloUser": "ADWAIT",
      "PloDepCovLevel": null,
      "PloMaxAgeInSchool": null,
      "PloMaxAgeNotInSchool": null,
      "PloLastUpdDate": "2015-05-04T18:15:28Z",
      "PloIuCreateDate": "2015-05-04T18:15:28Z",
      "PloIuCreateUser": "ADWAIT",
      "PloIuUpdateDate": null,
      "PloIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/0002000000043430314B000000073430314B203125",
          "name": "pyplanoption",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/0002000000043430314B000000073430314B203125",
          "name": "pyplanoption",
          "kind": "item"
        }
      ]
    },
    {
      "PloPlnCode": "401K",
      "PloCode": "401K 2-5%",
      "PloDescription": "401K 2-5%",
      "PloShortDesc": "401K 2-5%",
      "PloUser": "ADWAIT",
      "PloDepCovLevel": null,
      "PloMaxAgeInSchool": null,
      "PloMaxAgeNotInSchool": null,
      "PloLastUpdDate": "2015-05-04T18:15:28Z",
      "PloIuCreateDate": "2015-05-04T18:15:28Z",
      "PloIuCreateUser": "ADWAIT",
      "PloIuUpdateDate": null,
      "PloIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/0002000000043430314B000000093430314B20322D3525",
          "name": "pyplanoption",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption/0002000000043430314B000000093430314B20322D3525",
          "name": "pyplanoption",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pyplanoption",
      "name": "pyplanoption",
      "kind": "collection"
    }
  ]
}

object

What's Next

Create new Benefit Code

Retrieve PY Plan Options By Code

Query Standards

Finder

Find By Date

Find By Plan

Primary Key

What's Next

Contact Us