Getting StartedAPI Reference
API Reference

Executes the Add action for the Classes data object.

post
https://api.xchange.trimble.com/connect/v1/direct/subscribers//vista/pr/2/data/classes/actions/add

Adds a new record to Viewpoint® Vista™ PR Craft Classes program.

Vista views: PRCC, PRCP, PRCE, PRCF, PRCD

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

Body Params
integer
required

Processing Company (Primary Key Component)

string
required
length ≤ 10

Craft Code (Primary Key Component)

string
required
length ≤ 10

Class Code (Primary Key Component)

string | null
string | null
string
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

Old Capital Limit (Omitted for Add Action)

string
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

New Capital Limit

string | null
string | null
[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}
string
enum

Weighted Average Overtime Flag. Options: Y-Yes, N-No.

Allowed:
string
^[-+]?[0-9]{1,10}(?:.[0-9]{0,2})?$

Superannuation Weekly Minimum

string
enum
length ≤ 1

Options: S-Standard, F-Cash Fringe Factored, G-Generous Fringe Benefit Pkg #1, B-Generous Fringe Benefit Pkg #2, C-Constant Fringe Benefit Rate

Allowed:
string
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

Old Basic Hourly Rate (Omitted for Add Action)

string
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

New Basic Hourly Rate

string
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

Old Fringe Benefit Rate (Omitted for Add Action)

string
^[-+]?[0-9]{1,11}(?:.[0-9]{0,5})?$

New Fringe Benefit Rate

string | null
^[-+]?[0-9]{1,3}(?:.[0-9]{0,2})?$

Wage Percentage

string | null
__custom_fields
object

Custom fields defined in Vista.

PayRates
array of objects

Shift Pay Rates associated with the Class

PayRates
VariableEarnings
array of objects

Variable Earnings associated with the Class

VariableEarnings
AddonEarnings
array of objects

Addon Earnings associated with the Class

AddonEarnings
DednLiabs
array of objects

Deductions and Liabilities associated with the Class

DednLiabs
Headers
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.

Updated 4 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago