ACABenefitCategory
API | Description |
---|---|
GET api/ACABenefitCategory/GetValues?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of all available ACA Benefit Categories for the Company |
POST api/ACABenefitCategory/PostValue?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional ACA Benefit Categories for the provided LocationID or CompanyID |
GET api/ACABenefitCategory?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of all available ACA Benefit Categories for the Company |
POST api/ACABenefitCategory?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional ACA Benefit Categories for the provided LocationID or CompanyID |
Altametrics
API | Description |
---|---|
POST api/Altametrics/setEmployeeConfirmation?AuthenticationGUID={AuthenticationGUID} |
Sets the employee confirmation for a given list of responseValues |
POST api/Altametrics/errorCodeResponse?errorData={errorData} |
No documentation available. |
POST api/Altametrics?AuthenticationGUID={AuthenticationGUID} |
Sets the employee confirmation for a given list of responseValues |
POST api/Altametrics?errorData={errorData} |
No documentation available. |
Bonus
API | Description |
---|---|
GET api/Bonus/GetValues?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available bonus types for a LocationID or CompanyID |
POST api/Bonus/PostValue?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Bonus Types for the provided LocationID or CompanyID |
GET api/Bonus?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available bonus types for a LocationID or CompanyID |
POST api/Bonus?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Bonus Types for the provided LocationID or CompanyID |
Branch
API | Description |
---|---|
GET api/Branch/GetValues?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available Branches for a LocationID or CompanyID |
POST api/Branch/PostValue?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Branches for the provided LocationID or CompanyID |
GET api/Branch?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available Branches for a LocationID or CompanyID |
POST api/Branch?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Branches for the provided LocationID or CompanyID |
Company
API | Description |
---|---|
GET api/Company/GetValues?AuthenticationGUID={AuthenticationGUID} |
Returns a list of Companies for the supplied Authentication GUID. This contract will return more than one record if you are a Service Bureau customer |
GET api/Company/GetValues?AuthenticationGUID={AuthenticationGUID}&ExternalID={ExternalID} |
Returns a Company class for the supplied AuthenticationGUID and ExternalID |
PUT api/Company/PutValue?AuthenticationGUID={AuthenticationGUID} |
Returns a Company class for the supplied AuthenticationGUID and CompanyID |
GET api/Company?AuthenticationGUID={AuthenticationGUID} |
Returns a list of Companies for the supplied Authentication GUID. This contract will return more than one record if you are a Service Bureau customer |
GET api/Company?AuthenticationGUID={AuthenticationGUID}&ExternalID={ExternalID} |
Returns a Company class for the supplied AuthenticationGUID and ExternalID |
PUT api/Company?AuthenticationGUID={AuthenticationGUID} |
Returns a Company class for the supplied AuthenticationGUID and CompanyID |
Department
API | Description |
---|---|
GET api/Department/GetValues?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available Departments for a LocationID or CompanyID |
POST api/Department/PostValue?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Departments for the provided LocationID or CompanyID |
GET api/Department?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available Departments for a LocationID or CompanyID |
POST api/Department?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Departments for the provided LocationID or CompanyID |
DirectDepositType
API | Description |
---|---|
GET api/DirectDepositType/GetValues?AuthenticationGUID={AuthenticationGUID} |
Returns an array of available Direct Deposit Types for the company or service bureau identified by the authorization GUID |
GET api/DirectDepositType?AuthenticationGUID={AuthenticationGUID} |
Returns an array of available Direct Deposit Types for the company or service bureau identified by the authorization GUID |
Division
API | Description |
---|---|
GET api/Division/GetValues?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available Divisions for a LocationID or CompanyID |
POST api/Division/PostValue?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Divisions for the provided LocationID or CompanyID |
GET api/Division?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available Divisions for a LocationID or CompanyID |
POST api/Division?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Divisions for the provided LocationID or CompanyID |
Employee
EmployeeStatus
API | Description |
---|---|
GET api/EmployeeStatus/GetValues?AuthenticationGUID={AuthenticationGUID} |
Returns an array of available Employee Statuses for the company or service bureau identified by the authorization GUID |
GET api/EmployeeStatus/GetValues?AuthenticationGUID={AuthenticationGUID}&EmployeeID={EmployeeID} |
Returns employee status based on provided employee ID. |
GET api/EmployeeStatus?AuthenticationGUID={AuthenticationGUID} |
Returns an array of available Employee Statuses for the company or service bureau identified by the authorization GUID |
GET api/EmployeeStatus?AuthenticationGUID={AuthenticationGUID}&EmployeeID={EmployeeID} |
Returns employee status based on provided employee ID. |
EmployeeType
API | Description |
---|---|
GET api/EmployeeType/GetValues?AuthenticationGUID={AuthenticationGUID} |
Returns an array of available Employee Types for the company or service bureau identified by the authorization GUID |
GET api/EmployeeType?AuthenticationGUID={AuthenticationGUID} |
Returns an array of available Employee Types for the company or service bureau identified by the authorization GUID |
ExactStaffIncompleteList
API | Description |
---|---|
GET api/ExactStaffIncompleteList/GetValue?AuthenticationGUID={AuthenticationGUID} |
No documentation available. |
GET api/ExactStaffIncompleteList?AuthenticationGUID={AuthenticationGUID} |
No documentation available. |
Form
API | Description |
---|---|
GET api/Form/GetValue?AuthenticationGUID={AuthenticationGUID}&RegReqID={RegReqID} |
Returns a base-64 encoded string that represents the PDF form for the supplied |
GET api/Form/GetAttachmentList?AuthenticationGUID={AuthenticationGUID}&RegReqID={RegReqID} |
No documentation available. |
GET api/Form/GetAttachment?AuthenticationGUID={AuthenticationGUID}&RegReqID={RegReqID}&index={index} |
No documentation available. |
GET api/Form?AuthenticationGUID={AuthenticationGUID}&RegReqID={RegReqID}&index={index} |
No documentation available. |
Gender
API | Description |
---|---|
GET api/Gender/GetValues?AuthenticationGUID={AuthenticationGUID} |
Returns an array of available Genders for the company or service bureau identified by the authorization GUID |
GET api/Gender?AuthenticationGUID={AuthenticationGUID} |
Returns an array of available Genders for the company or service bureau identified by the authorization GUID |
Location
API | Description |
---|---|
GET api/Location/GetValues?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID} |
Returns a list of Active Locations for the supplied Authentication GUID and Company. |
GET api/Location/GetValues?AuthenticationGUID={AuthenticationGUID}&ExternalManagerID={ExternalManagerID}&ExternalCompanyID={ExternalCompanyID} |
Returns an array of locations for the supplied AuthenticationGUID, ExternalManagerID and ExternalCompanyID. |
GET api/Location/GetValues?AuthenticationGUID={AuthenticationGUID}&ManagerID={ManagerID} |
Retrieves a list of Locations for the given ManagerID |
POST api/Location/PostValue?AuthenticationGUID={AuthenticationGUID} |
Imports an List of Location classes to the EHX Database. Returns a List of Location classes. |
PUT api/Location/PutValue?AuthenticationGUID={AuthenticationGUID} |
Updates a location in the EHX Database. Returns a Location class for the supplied AuthenticationGUID and Location. |
GET api/Location?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID} |
Returns a list of Active Locations for the supplied Authentication GUID and Company. |
GET api/Location?AuthenticationGUID={AuthenticationGUID}&ExternalManagerID={ExternalManagerID}&ExternalCompanyID={ExternalCompanyID} |
Returns an array of locations for the supplied AuthenticationGUID, ExternalManagerID and ExternalCompanyID. |
GET api/Location?AuthenticationGUID={AuthenticationGUID}&ManagerID={ManagerID} |
Retrieves a list of Locations for the given ManagerID |
POST api/Location?AuthenticationGUID={AuthenticationGUID} |
Imports an List of Location classes to the EHX Database. Returns a List of Location classes. |
PUT api/Location?AuthenticationGUID={AuthenticationGUID} |
Updates a location in the EHX Database. Returns a Location class for the supplied AuthenticationGUID and Location. |
LocationCode
API | Description |
---|---|
GET api/LocationCode/GetValues?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Gets locations codes for the provided LocationID |
POST api/LocationCode/PostValue?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Location Codes for the provided LocationID |
GET api/LocationCode?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Gets locations codes for the provided LocationID |
POST api/LocationCode?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Location Codes for the provided LocationID |
Manager
API | Description |
---|---|
GET api/Manager/GetValues?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID} |
Returns an array of managers for a given AuthenticationGUID, and CompanyID |
POST api/Manager/PostValue?AuthenticationGUID={AuthenticationGUID} |
Imports a List of Manager Classes to the EHX Database. Returns a list of Manager classes |
PUT api/Manager/PutValue?AuthenticationGUID={AuthenticationGUID} |
Updates a manager in the EHX Database. Returns the updated manager. |
PUT api/Manager/PutValue?AuthenticationGUID={AuthenticationGUID}&ManagerID={ManagerID} |
Updates locations associated with a Manager ID based on a list of Location IDs. Returns a "SUCCESS" on successful update, or Error information as a string |
GET api/Manager?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID} |
Returns an array of managers for a given AuthenticationGUID, and CompanyID |
POST api/Manager?AuthenticationGUID={AuthenticationGUID} |
Imports a List of Manager Classes to the EHX Database. Returns a list of Manager classes |
PUT api/Manager?AuthenticationGUID={AuthenticationGUID} |
Updates a manager in the EHX Database. Returns the updated manager. |
PUT api/Manager?AuthenticationGUID={AuthenticationGUID}&ManagerID={ManagerID} |
Updates locations associated with a Manager ID based on a list of Location IDs. Returns a "SUCCESS" on successful update, or Error information as a string |
MaritalStatus
API | Description |
---|---|
GET api/MaritalStatus/GetValues?AuthenticationGUID={AuthenticationGUID} |
Returns an array of available Marital Statuses for the company or service bureau identified by the authorization GUID |
GET api/MaritalStatus?AuthenticationGUID={AuthenticationGUID} |
Returns an array of available Marital Statuses for the company or service bureau identified by the authorization GUID |
OfferLetterTemplate
API | Description |
---|---|
GET api/OfferLetterTemplate/GetValues?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available Offer letter templates for a LocationID or CompanyID |
POST api/OfferLetterTemplate/PostValue?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Offer letter templates for the provided LocationID or CompanyID |
GET api/OfferLetterTemplate?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available Offer letter templates for a LocationID or CompanyID |
POST api/OfferLetterTemplate?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Offer letter templates for the provided LocationID or CompanyID |
Package
API | Description |
---|---|
GET api/Package/GetValues?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available Packages for a LocationID or CompanyID |
POST api/Package/PostValue?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Packages for the provided LocationID or CompanyID |
GET api/Package?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available Packages for a LocationID or CompanyID |
POST api/Package?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Packages for the provided LocationID or CompanyID |
PayFrequency
API | Description |
---|---|
GET api/PayFrequency/GetValues?AuthenticationGUID={AuthenticationGUID} |
Returns an array of available Pay Frequencies for the company or service bureau identified by the authorization GUID |
GET api/PayFrequency?AuthenticationGUID={AuthenticationGUID} |
Returns an array of available Pay Frequencies for the company or service bureau identified by the authorization GUID |
PayrollDeduction
API | Description |
---|---|
GET api/PayrollDeduction/GetValues?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available payroll deducations for a LocationID or CompanyID |
POST api/PayrollDeduction/PostValue?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Payroll Deducations for the provided LocationID or CompanyID |
GET api/PayrollDeduction?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available payroll deducations for a LocationID or CompanyID |
POST api/PayrollDeduction?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Payroll Deducations for the provided LocationID or CompanyID |
PayType
API | Description |
---|---|
GET api/PayType/GetValues?AuthenticationGUID={AuthenticationGUID} |
Returns an array of available Pay Types for the company or service bureau identified by the authorization GUID |
GET api/PayType?AuthenticationGUID={AuthenticationGUID} |
Returns an array of available Pay Types for the company or service bureau identified by the authorization GUID |
Position
API | Description |
---|---|
GET api/Position/GetValues?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available Positions for a LocationID or CompanyID |
POST api/Position/PostValue?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Positions for the provided LocationID or CompanyID |
GET api/Position?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available Positions for a LocationID or CompanyID |
POST api/Position?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional Positions for the provided LocationID or CompanyID |
RegRequest
API | Description |
---|---|
POST api/RegRequest/SetRegRequestAsExported?AuthenticationGUID={AuthenticationGUID}&RegRequestID={RegRequestID} |
Sets the specified Registration Request to Exported. |
GET api/RegRequest/GetRegRequestByStatusByDate?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}&RegRequestStatus={RegRequestStatus}&RegRequestType={RegRequestType}&DaysBack={DaysBack} |
Gets all RegRequests for the given company created in the last {DaysBack} number of days. |
POST api/RegRequest?AuthenticationGUID={AuthenticationGUID}&RegRequestID={RegRequestID} |
Sets the specified Registration Request to Exported. |
GET api/RegRequest?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}&RegRequestStatus={RegRequestStatus}&RegRequestType={RegRequestType}&DaysBack={DaysBack} |
Gets all RegRequests for the given company created in the last {DaysBack} number of days. |
RegRequestExport
API | Description |
---|---|
GET api/RegRequestExport/GetValues?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}&RegistrationTypeCode={RegistrationTypeCode}&RegistrationStatus={RegistrationStatus} |
Will return all employee regId's ready for export by company |
GET api/RegRequestExport?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}&RegistrationTypeCode={RegistrationTypeCode}&RegistrationStatus={RegistrationStatus} |
Will return all employee regId's ready for export by company |
RegTypeCode
API | Description |
---|---|
GET api/RegTypeCode/GetValues?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID} |
Gets all avalable Reg type codes for a company |
GET api/RegTypeCode?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID} |
Gets all avalable Reg type codes for a company |
RegTypeStatuses
API | Description |
---|---|
GET api/RegTypeStatuses/GetValues?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID} |
Gets all avalable Reg Request statusess for a company |
GET api/RegTypeStatuses/GetValues?AuthenticationGUID={AuthenticationGUID}&RegRequestID={RegRequestID} |
Returns employee status based on provided registration request. |
GET api/RegTypeStatuses?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID} |
Gets all avalable Reg Request statusess for a company |
GET api/RegTypeStatuses?AuthenticationGUID={AuthenticationGUID}&RegRequestID={RegRequestID} |
Returns employee status based on provided registration request. |
Reimbursement
API | Description |
---|---|
GET api/Reimbursement/GetValues?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available reimbursement for a LocationID or CompanyID |
POST api/Reimbursement/PostValue?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional reimbursement types for the provided LocationID or CompanyID |
GET api/Reimbursement?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available reimbursement for a LocationID or CompanyID |
POST api/Reimbursement?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional reimbursement types for the provided LocationID or CompanyID |
SSO
API | Description |
---|---|
GET api/SSO/GetValues?AuthenticationGUID={AuthenticationGUID}&EmployeeID={EmployeeID} |
Returns a Single Sign-on URL for a given AuthenticationGUID and PartyID. This contract applies for all user roles in EHX: Employee, Manager, Administrator. The EF API will manage security for the user in EHX. |
GET api/SSO/GetValues?AuthenticationGUID={AuthenticationGUID}&ExternalManagerID={ExternalManagerID}&ExternalCompanyID={ExternalCompanyID} |
Returns a Single Sign-on URL for a given AuthenticationGUID ExternalManagerID, ExternalCompanyID. This contract applies for all user roles in EHX: Employee, Manager, Administrator. The EF API will manage security for the user in EHX. |
GET api/SSO?AuthenticationGUID={AuthenticationGUID}&EmployeeID={EmployeeID} |
Returns a Single Sign-on URL for a given AuthenticationGUID and PartyID. This contract applies for all user roles in EHX: Employee, Manager, Administrator. The EF API will manage security for the user in EHX. |
GET api/SSO?AuthenticationGUID={AuthenticationGUID}&ExternalManagerID={ExternalManagerID}&ExternalCompanyID={ExternalCompanyID} |
Returns a Single Sign-on URL for a given AuthenticationGUID ExternalManagerID, ExternalCompanyID. This contract applies for all user roles in EHX: Employee, Manager, Administrator. The EF API will manage security for the user in EHX. |
Test
API | Description |
---|---|
GET api/Test/getData?test={test} |
No documentation available. |
POST api/Test/updateData |
No documentation available. |
GET api/Test?test={test} |
No documentation available. |
POST api/Test |
No documentation available. |
WOTCPositionCode
API | Description |
---|---|
GET api/WOTCPositionCode/GetValues?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available WOTC position codes for a LocationID or CompanyID |
POST api/WOTCPositionCode/PostValue?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional WOTC Position Codes for the provided LocationID or CompanyID |
GET api/WOTCPositionCode?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Returns an array of available WOTC position codes for a LocationID or CompanyID |
POST api/WOTCPositionCode?AuthenticationGUID={AuthenticationGUID}&PartyID={PartyID} |
Adds Additional WOTC Position Codes for the provided LocationID or CompanyID |