v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Resource Dependents

Gets one Resource Dependents object from the cache.

Represents data found in Vista™ Human Resource Dependents program.

Vista view: HRDP

get/direct/subscribers/{subscriber_code}/vista/hr/2/data/resource_dependents/cache/{ryvitId_value}

Path parameters

subscriber_codestring required

The code of the subscriber that you are making this request for.

ryvitId_valuestring required

The code of the data object you want to get.

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Response

Success

__ryvitKeysstring[]

Array of key paths that can be used to retrieve this object.

__modifiedUTCstring

UTC timestamp of when this object was last modified in the cache.

HRCointeger required

HRRefinteger required

Seqinteger required

Namestring required

[PROTECTED FIELD]

Relationshipstring nullable

[PROTECTED FIELD]

BirthDatestring date-time nullable

[PROTECTED FIELD]

SSNstring nullable

[PROTECTED FIELD]

Sexstring required

[PROTECTED FIELD]

HistSeqinteger nullable

Addressstring nullable

Citystring nullable

Statestring nullable

Zipstring nullable

Phonestring nullable

WorkPhonestring nullable

Notesstring nullable

UniqueAttchIDstring nullable

KeyIDinteger required

Countrystring nullable

FirstNamestring nullable

MiddleNamestring nullable

Suffixstring nullable

__custom_fieldsobject

This property will be added if there are any custom fields defined for this object in Vista. Each custom field will be a property of this object.

GenderIdentitystring nullable

(M)ale, (F)emale, (X) Nonbinary, (O)ther

GenderIdentityOtherstring nullable

Example response

{
  "__modifiedUTC": "2020-01-01T13:01:01.1234567Z"
}