| Employee Class |
Represent employees or organizations.
Employee is a hierarchical object representing a person or organization who is a part of instance’s workforce.
Main purpose of Employees is to be assigned to Work Order and execute them.
Web service access scope - Full access
Inheritance HierarchySystemObject
CorrigoService.EntitiesCorrigoEntity
CorrigoServiceCorrigoEntityWithOptimisticLock
CorrigoServiceRemovableCorrigoEntity
CorrigoService.EntitiesEmployee
CorrigoService.EntitiesCorrigoEntity
CorrigoServiceCorrigoEntityWithOptimisticLock
CorrigoServiceRemovableCorrigoEntity
CorrigoService.EntitiesEmployee
Namespace: CorrigoService.Entities
Assembly: ClientXMLDoc (in ClientXMLDoc.exe) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
[SerializableAttribute] public class Employee : RemovableCorrigoEntity
The Employee type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AccessToAllWorkZones |
True means Technician has access to all work zones and thus his Team,
Portfolio and direct Work Zone scope are irrelevant for determining list of accessible work zones.
|
| ActorTypeId |
Actor type, supported values are ActorType.Employee and ActorType.Provider (Technicians and Providers).
Is required.
|
| Address |
Address
|
| AlertSubscriptions |
Alert Subscriptions
|
| BillAtZero |
True indicates “dedicated” Technicians whose salary is paid by Customer and whose work thus should be billed at zero rate (affects WO billing logic). This field is not used by Providers.
|
| ContactAddresses |
Contact Addresses
|
| CustomerGroups |
Customer Groups
|
| CustomFields |
Custom Fields
|
| DefaultPriceList |
Default Price List
|
| DisplayAs |
Displayable name.
Max Length=256.
Is required.
|
| DtPwdChange |
Date (no time part) when password was set/changed last time; based on server time.
This value is used by code enforcing password policies. This field is not used by Providers.
|
| ExternalId |
Used by Providers.
Max Length=64.
|
| FederalId |
Federal ID#. Used for tax purposes.
Max Length=64.
|
| FirstName |
First name.
Max Length=80.
Is required.
|
| ForcePasswordReset |
True means Technician must reset his password upon login.
This field is not used by Providers.
|
| FreeTextAllowed |
True means Provider can enter free-text entries (i.e. not based on price list imposed by requestor) when preparing invoices.
This field is not used by Technicians.
|
| Instructions |
Special instructions.
This field contains HTML message shown to the end user when new WO is created.
Max Length=3072.
|
| IsElectronicPayment |
True means Provider prefers electronic payments.
This field is not used by Technicians.
|
| IsSupplier |
Used by Providers. True means particular Provider can be used as Supplier.
Obsolete. Disabled for writing since 9.6su1.
|
| JobTitle |
Job Title.
Max Length=256.
|
| LabelId |
User-defined Provider label.
This field is not used by Technicians.
|
| LanguageId |
Preferred language.
|
| LastName |
Last name.
Max Length=176.
Is required.
|
| LimitAssignmentByPortfolioId |
Defines Portfolio-based restriction for WO assignment; used only for Providers.
Non-zero value means Provider can be assigned only to WOs within specified Portfolio.
For Technicians this field is always zero.
|
| Number |
Number (often used as integration key).
Max Length=64.
|
| Organization |
Organization
|
| Password |
User’s password for login.
Max Length=64.
Is required.
|
| PayRates |
Pay Rates
|
| Portfolios |
Portfolios
|
| PriceLists |
Price Lists
|
| ProviderInvitedOn |
Date (no time part) when Provider was invited to WON (Work Order Network) last time.
This field is not used by Technicians.
|
| ProviderStatusId |
WON (Work Order Network) status.
This field is computed automatically in response to modifications for certain fields.
|
| ProviderTypeId |
Used by Providers. Defines provider type based on enumeration (Regular, Supplier, Landlord).
Tied with Is Supplier for backward compatibility.
|
| RadiusUnit |
Stores units for service radius.
Supported values are kilometers and miles.
|
| Role |
Role, required for Technicians; not used by Providers.
Is required.
|
| Services |
Services
|
| Specialties |
Specialties
|
| StockLocations |
Stock Locations
|
| TaxExempt |
Used by Providers. True means particular Provider is tax-exempt. It affects tax validation for Vendor Invoice.
|
| TaxWarnOnly |
True means application will warn provider when tax validation for his invoice fails – rather than rejecting it. In other words, this provider is treated exceptionally.
|
| Teams |
Teams
|
| Username |
User ID. Providers typically use GUID for this field. This field is unique for non-deleted Employees.
Max Length=256.
Is required.
|
| WonLocationId |
WON (Work Order Network) location ID;
This field is not used by Technicians.
Setting this field for Providers affects WON status ID.
|
| WonMemberId |
WON (Work Order Network) member ID; non-zero indicates connected Providers.
This field is not used by Technicians.
Setting this field for Providers affects WON status ID.
|
| WonServiceRadius |
Service radius in miles or kilometers, depending on WonRadiusType value.
This field is defined only for non-connected Providers and ignored by other types of Employees; it’s used by provider search routines. Supported values are 0 – 10000.
Is required.
|
| WorkZones |
Work Zones
|
See Also