v1

latestOpenAPI 3.0.12026-07-267912192.3 MB

Resource Master

Executes the Add action for the Resource Master data object.

Adds an Resource record

post/direct/subscribers/{subscriber_code}/vista/hr/2/data/resources/actions/add

Path parameters

subscriber_codestring required

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

Headers

X-Application-Keystring required

Used to authorize access to the Direct API.

Request body

HRCointeger

Key natural(HRCo, HRRef).

SortNamestring

Optional, if omitted This value will be calculated based on Vista defaulting logic with trailing digits incase of non unique results.

LastNamestring

FirstNamestring nullable

Optional, if omitted null will be defaulted.

MidNamestring nullable

Optional, if omitted null will be defaulted.

Suffixstring nullable

Optional, if omitted null will be defaulted.

MaritalStatus'S' | 'M' | 'D' | 'O' | 'null' nullable

[PROTECTED FIELD] Options:S-Single, M-Married, D-Divorced, O-Other.

MaidenNamestring nullable

[PROTECTED FIELD]

SpouseNamestring nullable

[PROTECTED FIELD]

Addressstring nullable

Address2string nullable

Citystring nullable

Statestring nullable

Key to HQ State.

Zipstring nullable

Countrystring nullable

Key to HQ Country.

Phonestring nullable

WorkPhonestring nullable

Pagerstring nullable

CellPhonestring nullable

Emailstring nullable

Racestring nullable

[PROTECTED FIELD] Key to Race

Statusstring nullable

Employment Status. Key to Status Code.

BirthDatestring date nullable

[PROTECTED FIELD] Format: YYYY-MM-DD.

Sex'M' | 'F'

[PROTECTED FIELD] If omitted, 'M' will be defaulted.

GenderIdentity'M' | 'F' | 'X' | 'O' | 'null' nullable

GenderIdentityOtherstring nullable

Notesstring nullable

__custom_fieldsobject

Add properties to this object for any custom fields you want to update.

ExistsInPR'Y' | 'N' nullable

Response

Success

idstring

operationstring

statusstring