App |  |
Customer contracts are broken out into a separate namespace as they tend to denote the pure class or entity of the underlying object that is reflected in the data store. These classes represent the data entities themselves that are passed between services.
Classes| Class | Description | |
|---|---|---|
 | CustomField | CustomFields model represents the custom fields for the user |
| LaborLevelDetailHierarchyAddModel | LaborLevelDetailHierarchyAddModel represents the inbound request object for adding a new node in the labor level hierarchy |
| LaborLevelDetailHierarchyDeleteModel | LaborLevelDetailHierarchyDeleteModel represents the inbound request object for deleteing nodes in the labor level hierarchy |
| LaborLevelDetailHierarchyModel | LaborLevelDetailHierarchyModel represents labor level detail with labor level hierarchy information |
| LaborLevelDetailModel | LaborLevelDetailModel represents the basic model for labor level details information |
| LaborLevelDetailModelUpdate | LaborLevelDetailUpdateModel represents the basic model for updating labor level details information |
| LaborLevelModel | LaborLevelModel defines the base model for labor level information |
| LLCustomField | LLCustomField model represents the custom field for the labor level detail |
| OverTimeParamsOut | OverTimeParamsOut represents the response object for overtime information |
| PunchPromptEmpAnswerModel | Custom punch prompt model which is a part of the punch request(TimeSlicePreModel). |
| QueryParam | A generic class used to pass in an authtoken and perform specific actions |
| SingleToken | A generic class used to pass in an AuthToken. Alias of QueryParam |
| SSORequestBaseParams | Base classed used for all SSO Request Parameter Objects |
| SSORequestByEmpIdentifierParamsIn | Inbound payload used to retreive the SSO url by employee ID |
| SSORequestByLoginIDParamsIn | The inbound payload used to get the SSO URL by users login-id credentials |
| SSORequestByLoginParamsIn | The inbound payload used to get the SSO URL by users login credentials |
| TimeAddPunchBatchParamsIn | TimeAddPunchBatchParamsIn represent the input object to add a time punch |
| TimeAddPunchBatchParamsOut | TimeAddPunchBatchParamsOut represent the input object to add a time punch |
| TimeAddPunchParamsOut | TimeAddPunchParamsOut represent the response object to the Time Slice add punch operation |
| TimeAddPunchValidationParamIn | Inbound request object for the punch add request |
| TimeAddPunchValidationParamOut | Outbound response object for the punch add request |
| TimeExportParamIn | TimeExportParamIn represents the inbound object for Time Export |
| TimeExportParamOut | TimeExportParamOut represents the response object for Time Export |
| TimeGetLastPunchByEmpIdentifierParamIn | inbound request object of Last punch details |
| TimeGetLastPunchByEmpIdentifierParamOut | Outbound object of Last Punch details |
| TimeGetPunchesParamsIn | TimeGetPunchesParamsIn represents the time slice or punch object for inbound requests |
| TimeGetPunchesParamsOut | TimeGetPunchesParamsOut represents the response punch object |
| TimeGetStatusBoardParamsIn | Obsolete. **SUNSET** TimeGetStatusBoardParamsIn represents the status board object for the inbound requests |
| TimeGetStatusBoardParamsOut | Obsolete. **OBSOLETE** TimeGetStatusBoardParamsOut represents the response object of the status board |
| TimeOffGetBalanceParamsIn | TimeOffGetBalanceParamsIn represents the required parameters for getting time off balance |
| TimeOffGetRequestParamsIn | TimeOffGetRequestsParamsIn represents the required parameters for getting time off requests |
| TimeOffGetRequestParamsInBase | **OBSOLETE** TimeOffGetRequestParamsInBase represents a set of common parameters required for getting time off requests and its details |
| TimeOffRequestDetailModel | TimeOffRequestDetailModel represents a detail which is a part of the time off request. |
| TimeOffRequestModel | TimeOffRequestModel represents a time off request and the dependencies that are attached to a time off request in the time-web system of record. |
| TimeOffUserBalanceModel | **OBSOLETE** TimeOffUserBalanceModel represents time off balance information of a user |
| TimeOffUserModelBase | TimeOffUserModelBase class has the user related properties that will be included as part of the outbound objects of the time off methods. |
| TimeOffUserRequestModel | TimeOffUserRequestModel represents information about a user and list of time off requests made by that user. |
| TimeSlicePreModel | TimeSlicePreModel represents the basic model for time slice information object |
| UserInfoAddParamsOut | UserInfoAddParamsOut is an outbound response object used to represent the status of the userInfo model add or update status |
| UserInfoBaseModel | UserInfoBaseModel is a light weight version of UserInfoModel. It is designed to return a smaller footprint for a given user. This entity is returned from requests like UserInfoGetAll(). |
| UserInfoGetParamsIn | UserInfoGetParamsIn is an inbound request object used to query data for requests like UserInfoGetEmployeeByEffectiveDate() |
| UserInfoGetPolicyDurationIn | Contains the parameters required to retreive a list of UserInfoGetPolicyDurationModel |
| UserInfoGetPolicyDurationModel | Represents the basic model to get a list of employees meal/break duration's. |
| UserInfoGetPolicyDurationOut | Contains the resultset for a list of UserInfoGetPolicyDurationModel |
| UserInfoModel | UserInfoModel represents a complete user and all the dependencies that are attached to a user in the time-web system of record. This entity is used in operations like UserInfoAdd() and UserInfoGetByUserID() where the request returns or accepts a single user entity. |
Structures| Structure | Description | |
|---|---|---|
  | BreakItems | A structure that contains all the data that belongs to a payroll policy break duration |
| DurationItems | A structure that contains all the data that belongs to a payroll policy meal duration |
| MealItems | A structure that contains all the data that belongs to a payroll policy meal duration |
Enumerations| Enumeration | Description | |
|---|---|---|
 | AutoType | Represents the AutoType |
| ExportItemTypes | ExportItemTypes represents the type of export item |
| ExportMatrixSelectionTypes | ExportMatrixSelectionTypes represents the Export matrix selection |
| ExportMatrixType | ExportMatrixType represents the Export matrix type |
| FieldTypes | Represents the custom field types |
| LLCutomFieldTypes | Represents the custom field types |
| PunchTypes | The type of the user Punch |
| SearchActions | SearchActions represents the type of date used to fetch Payroll policy |
| SSOLocation | Represents the custom field types |
| StatusTypes | Used to represent status type of the time off request and time off request detail. |
| UserInfoActivityMode | UserInfoActivityMode is used for the outbound response object of UserInfo Model Add and Update commands |
| UserInfoActivityStatus | UserInfoActivityStatus is used for the outbound response object of UserInfo Model Add and Update commands. Which describes the status of the request |
| UserInfoGetPolicyDurationModel_RuleType | Represents the policy duration break types a user can have. |
| UserInfoGetPolicyDurationModel_Type | Represents the policy duration types a user can have. |