Executes the Update action for the Resource Master data object.

post

https://api.xchange.trimble.com/connect/v1/direct/subscribers/{subscriber_code}/vista/hr/2/data/resources/actions/update

Changes an existing Resource record

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscriber_code

string

required

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

Body Params

__key

required

LastName

string

length ≤ 30

Optional, if omitted value will remain unchanged.

FirstName

string | null

Optional, if omitted value will remain unchanged.

MiddleName

string | null

Optional, if omitted value will remain unchanged.

Suffix

string | null

Optional, if omitted value will remain unchanged.

SortName

string

length ≤ 15

Optional, if omitted value will remain unchanged.

MaritalStatus

string | null

enum

[PROTECTED FIELD] Options:S-Single, M-Married, D-Divorced, O-Other. Optional, if omitted value will remain unchanged.

Allowed:

MaidenName

string | null

[PROTECTED FIELD] Optional, if omitted value will remain unchanged.

SpouseName

string | null

[PROTECTED FIELD] Optional, if omitted value will remain unchanged.

Address

string | null

Optional, if omitted value will remain unchanged.

Address2

string | null

Optional, if omitted value will remain unchanged.

City

string | null

Optional, if omitted value will remain unchanged.

State

string | null

Optional, if omitted value will remain unchanged.

Zip

string | null

Optional, if omitted value will remain unchanged.

Country

string | null

Optional, if omitted value will remain unchanged.

Phone

string | null

Optional, if omitted value will remain unchanged.

WorkPhone

string | null

Optional, if omitted value will remain unchanged.

Pager

string | null

Optional, if omitted value will remain unchanged.

CellPhone

string | null

Optional, if omitted value will remain unchanged.

string | null

Optional, if omitted value will remain unchanged.

Race

string | null

[PROTECTED FIELD] Optional, if omitted value will remain unchanged.

Status

string | null

Optional, if omitted value will remain unchanged.

BirthDate

string | null

[PROTECTED FIELD] Format: YYYY-MM-DD. Optional, if omitted value will remain unchanged.

Sex

string

length ≤ 1

[PROTECTED FIELD] Optional, if omitted value will remain unchanged.

GenderIdentity

string | null

enum

Optional, if omitted value will remain unchanged.

Allowed:

GenderIdentityOther

string | null

Notes

string | null

Optional, if omitted value will remain unchanged.

__payroll

object

Collection of properties from the Payroll Info Tab. Optional, if omitted each properties value will remain unchanged.

__other

object

Collection or properties from the Other Info tab. Optional, if omitted each properties value will remain unchanged.

__physicalResults

object

Collection of properties from the Physical Results tab. Optional, if omitted each properties value will remain unchanged.

__application

object

Collection of properties from the Application tab. Optional, if omitted each properties value will remain unchanged.

__canada

object

Only used if PRCo Country is CA. Optional, if omitted each properties value will remain unchanged.

__custom_fields

object

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.

Headers

X-Application-Key

string

required

Used to authorize access to the Direct API.

Responses

401

You have not provided a proper X-Application-Key in the header of this request.

403

The X-Application-Key provided is valid but the key does not have access to this resource.

404

The object with the given ID was not found OR a subscriber with the given URL was not found.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Describes issues with the request.