v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Benefit Codes

Gets one Benefit Codes object from the cache.

Represents data found in Vista™ Human Benefit Codes Master program.

Vista view: HRBC

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

BenefitCodestring required

Descriptionstring nullable

PlanNamestring nullable

PlanNumberstring nullable

ReportInfostring nullable

VendorGroupinteger

Vendorinteger nullable

Addressstring nullable

Citystring nullable

Statestring nullable

Zipstring nullable

Contactstring nullable

Phonestring nullable

Faxstring nullable

Emailstring nullable

EligBasisstring nullable

EligPeriodinteger nullable

Notesstring nullable

UpdatePRYN'Y' | 'N' | 'null' nullable

UniqueAttchIDstring nullable

KeyIDinteger required

Countrystring nullable

ACAHealthCareYN'Y' | 'N'

ACAMinEssenCoverageYN'Y' | 'N'

ACASelfInsuredYN'Y' | 'N'

__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"
}