v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Resource Master

Gets one Resource Master object from the cache.

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

Vista view: HRRM

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

PRCointeger nullable

PREmpinteger nullable

LastNamestring required

FirstNamestring nullable

MiddleNamestring nullable

SortNamestring required

Addressstring nullable

Citystring nullable

Statestring nullable

Zipstring nullable

Address2string nullable

Phonestring nullable

WorkPhonestring nullable

Pagerstring nullable

CellPhonestring nullable

SSNstring nullable

[PROTECTED FIELD]

Sexstring required

[PROTECTED FIELD]

Racestring nullable

[PROTECTED FIELD]

BirthDatestring datetime nullable

[PROTECTED FIELD] Format: YYYY-MM-DD

HireDatestring datetime nullable

Format: YYYY-MM-DD

TermDatestring datetime nullable

Format: YYYY-MM-DD

TermReasonstring nullable

[PROTECTED FIELD]

ActiveYN'Y' | 'N' required

Statusstring nullable

PRGroupinteger nullable

PRDeptstring nullable

StdCraftstring nullable

StdClassstring nullable

StdInsCodestring nullable

StdTaxStatestring nullable

StdUnempStatestring nullable

StdInsStatestring nullable

StdLocalstring nullable

W4CompleteYN'Y' | 'N' required

PositionCodestring nullable

NoRehireYN'Y' | 'N' required

[PROTECTED FIELD]

MaritalStatusstring nullable

[PROTECTED FIELD]

MaidenNamestring nullable

[PROTECTED FIELD]

SpouseNamestring nullable

[PROTECTED FIELD]

PassPort'Y' | 'N' required

RelativesYN'Y' | 'N' required

[PROTECTED FIELD]

HandicapYN'Y' | 'N' required

[PROTECTED FIELD]

HandicapDescstring nullable

[PROTECTED FIELD]

VetJobCategorystring nullable

[PROTECTED FIELD]

PhysicalYN'Y' | 'N' required

PhysDatestring datetime nullable

Format: YYYY-MM-DD

PhysExpireDatestring datetime nullable

Format: YYYY-MM-DD

PhysResultsstring nullable

[PROTECTED FIELD]

LicNumberstring nullable

[PROTECTED FIELD]

LicTypestring nullable

LicStatestring nullable

LicExpDatestring datetime nullable

Format: YYYY-MM-DD

DriveCoVehiclesYN'Y' | 'N' required

I9Statusstring nullable

[PROTECTED FIELD]

I9Citizenstring nullable

[PROTECTED FIELD]

I9ReviewDatestring datetime nullable

[PROTECTED FIELD] Format: YYYY-MM-DD

TrainingBudgetstring nullable

[PROTECTED FIELD]

CafeteriaPlanBudgetstring nullable

[PROTECTED FIELD]

HighSchoolstring nullable

[PROTECTED FIELD]

HSGradDatestring datetime nullable

[PROTECTED FIELD] Format: YYYY-MM-DD

College1string nullable

[PROTECTED FIELD]

College1BegDatestring datetime nullable

[PROTECTED FIELD] Format: YYYY-MM-DD

College1EndDatestring datetime nullable

[PROTECTED FIELD] Format: YYYY-MM-DD

College1Degreestring nullable

[PROTECTED FIELD]

College2string nullable

[PROTECTED FIELD]

College2BegDatestring datetime nullable

[PROTECTED FIELD] Format: YYYY-MM-DD

College2EndDatestring datetime nullable

[PROTECTED FIELD] Format: YYYY-MM-DD

College2Degreestring nullable

[PROTECTED FIELD]

ApplicationDatestring datetime nullable

Format: YYYY-MM-DD

AvailableDatestring datetime nullable

Format: YYYY-MM-DD

LastContactDatestring datetime nullable

Format: YYYY-MM-DD

ContactPhonestring nullable

AltContactPhonestring nullable

ExpectedSalarystring nullable

[PROTECTED FIELD]

Sourcestring nullable

SourceCoststring nullable

CurrentEmployerstring nullable

CurrentTimestring nullable

PrevEmployerstring nullable

PrevTimestring nullable

NoContactEmplYN'Y' | 'N' required

HistSeqinteger nullable

Notesstring nullable

ExistsInPR'Y' | 'N' required

EarnCodeinteger nullable

PhotoNamestring nullable

UniqueAttchIDstring nullable

TempWorker'Y' | 'N' required

Emailstring nullable

Suffixstring nullable

DisabledVetYN'Y' | 'N' | 'null' nullable

[PROTECTED FIELD]

VietnamVetYN'Y' | 'N' | 'null' nullable

[PROTECTED FIELD]

OtherVetYN'Y' | 'N' | 'null' nullable

[PROTECTED FIELD]

VetDischargeDatestring datetime nullable

[PROTECTED FIELD] Format: YYYY-MM-DD

OccupCatstring nullable

CatStatusstring nullable

LicClassstring nullable

DOLHireStatestring nullable

NonResAlienYNstring required

[PROTECTED FIELD]

KeyIDinteger required

Countrystring nullable

LicCountrystring nullable

OTOptstring nullable

OTSchedinteger nullable

Shiftinteger nullable

PTOAppvrGrpinteger nullable

HDAmtstring nullable

[PROTECTED FIELD]

F1Amtstring nullable

[PROTECTED FIELD]

LCFStockstring nullable

[PROTECTED FIELD]

LCPStockstring nullable

[PROTECTED FIELD]

AFServiceMedalVetYN'Y' | 'N' required

WOTaxStatestring nullable

WOLocalCodestring nullable

StatusCodestring nullable

LookBackGroupinteger nullable

InitialMeasurementStartDatestring datetime nullable

Format: YYYY-MM-DD

InitialMeasurementEndDatestring datetime nullable

Format: YYYY-MM-DD

InitialAdministrativeStartDatestring datetime nullable

Format: YYYY-MM-DD

InitialAdministrativeEndDatestring datetime nullable

Format: YYYY-MM-DD

InitialStabilityStartDatestring datetime nullable

Format: YYYY-MM-DD

InitialStabilityEndDatestring datetime nullable

Format: YYYY-MM-DD

HiringLocationIDinteger nullable

Example response

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