API Catalog

Retrieve HR Employee Relatives by Code

25 Sep 2024
1 Minute to read

Print
Dark
Light

Retrieve HR Employee Relatives by Code

Updated on 25 Sep 2024
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/hremrelatives

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	30351
RelCode	Relative Type Code	SPOUSE
SsnNum	SSN Number	000121321

By UUID

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

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

Security

HTTP

Type basic

Basic authentication

Query parameters

finder

string

ExampleselectByCode;EmpNo=30351,RelCode=SPOUSE, SsnNum=000121321

limit

integer

Example500

offset

integer

Example0

totalResults

boolean

Exampletrue

orderBy

string

ExampleEdpVUuid:desc

Responses

200

Headers

Content-Type

string

Exampleapplication/vnd.oracle.adf.resourcecollection+json

{
  "items": [
    {
      "EdpFirstName": "Bradley",
      "EdpMiddleName": null,
      "EdpLastName": "Cooper",
      "EdpAddress1": null,
      "EdpAddress2": null,
      "EdpAddress3": null,
      "EdpZipCode": "10001",
      "EdpSex": "M",
      "EdpDependFlag": "1",
      "EdpEmgconFlag": "0",
      "EdpBenfFlag": "0",
      "EdpBenfType": null,
      "EdpDateBirth": "1975-10-17",
      "EdpPlaceBirth": "Toronto",
      "EdpLivingFlag": "1",
      "EdpMedicalSuppFlag": "0",
      "EdpFullStudentFlag": "0",
      "EdpPrimPhone": null,
      "EdpAltPhone": null,
      "EdpFax": null,
      "EdpCellNo": null,
      "EdpPager": null,
      "EdpEmailAddress": null,
      "EdpPriority": 3,
      "CountryCtrCountryCode": "US",
      "StateStaCountryCode": null,
      "StateStaStateCode": "NY",
      "CountyCntCountyCode": null,
      "CountyCntStateCode": null,
      "CountyCntCountryCode": null,
      "CityCtyCountryCode": null,
      "CityCtyStateCode": null,
      "CityCtyCountyCode": null,
      "CityCtyCityCode": null,
      "EmployeeEmpNo": "30351",
      "EmployeeEmpNoWorkingAs": null,
      "EdpRelCode": "SPOUSE",
      "EdpRelName": "SPOUSE",
      "EdpSeqNo": 9801,
      "EdpSsnNum": null,
      "EdpInsur1Pct": null,
      "EdpInsur2Pct": null,
      "EdpCompCode": "001",
      "EdpUser": "DEMOSAM",
      "EdpLastUpdDate": "2022-10-16T10:11:39Z",
      "EdpVUuid": "EB2F063E3D6003B6E05316821FACC841",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/hremrelatives/EB2F063E3D6003B6E05316821FACC841",
          "name": "hremrelatives",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001740020454232463036334533443630303342364530353331363832314641434338343178"
          }
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/hremrelatives/EB2F063E3D6003B6E05316821FACC841",
          "name": "hremrelatives",
          "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/hremrelatives",
      "name": "hremrelatives",
      "kind": "collection"
    }
  ]
}

object

What's Next

Retrieve a Specific HR Emloyee Relative

Retrieve HR Employee Relatives by Code

Query Standards

Finder

Select By Code

By UUID

What's Next

Contact Us