v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Resource Benefits

Gets one Resource Benefits object from the cache.

Represents data found in Vista™ Human Resource Benefits Master program.

Vista views: HREB,HRBL,HRBE,HRResBenACACoverageHist

get/direct/subscribers/{subscriber_code}/vista/hr/2/data/resource_benefits/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

BenefitCodestring required

DependentSeqinteger required

EligDatestring nullable

Format: YYYY-MM-DD

ReminderDatestring nullable

Format: YYYY-MM-DD

ActiveYN'Y' | 'N' | 'null' nullable

EffectDatestring nullable

[PROTECTED FIELD] Format: YYYY-MM-DD

EndDatestring nullable

[PROTECTED FIELD] Format: YYYY-MM-DD

ReinstateYN'Y' | 'N' | 'null' nullable

ReinstateDatestring nullable

[PROTECTED FIELD] Format: YYYY-MM-DD

SmokerYN'Y' | 'N' | 'null' nullable

[PROTECTED FIELD]

IDstring nullable

[PROTECTED FIELD]

EmployerCoststring nullable

[PROTECTED FIELD]

HistSeqinteger nullable

UpdatedYN'Y' | 'N' | 'null' nullable

Notesstring nullable

CafePlanYN'Y' | 'N' | 'null' nullable

[PROTECTED FIELD]

CafePlanAmtstring nullable

[PROTECTED FIELD]

BatchIdinteger nullable

InUseBatchIdinteger nullable

InUseMthstring nullable

Ben1string nullable

[PROTECTED FIELD]

Rel1string nullable

[PROTECTED FIELD]

Ben2string nullable

[PROTECTED FIELD]

Rel2string nullable

[PROTECTED FIELD]

UniqueAttchIDstring nullable

KeyIDinteger required

SeriesTwoCodestring 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.

Example response

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