Consumer
Decription: This API controller fetch Consumer information based on search criteria.
| API | Description |
|---|---|
| POST api/{programid}/Consumer |
Searches for a consumer |
| POST api/{programid}/Consumer/GetNewConsumersToVendor/{agencyVendorID} |
Get the New Consumers (Participants) created to a specific vendor. In TOP 25 count each time |
| POST api/{programid}/Consumer/GetEmployer |
Searches for employers related to the consumer |
| POST api/{programid}/Consumer/GetCoPay |
Searches for employers related to the consumer |
| POST api/{programid}/Consumer/GetCoPayForMyAccount |
Retrieves CoPay records for a given consumer |
| POST api/{programid}/Consumer/GetCoPayDetails |
Retrieves CoPay payment details for a given CoPay record |
| GET api/{programid}/Consumer/{consumerNo}/PayCycles/{dateFrom}/{dateOfService} |
Returns the paycycles of the consumer based on PPL Setup configuration (District or Consumer based) |
| POST api/{programid}/Consumer/Enrollments |
Returns the MCOs the consumer is enrolled to |
| POST api/{programid}/Consumer/{ConsumerNo}/CheckList |
Gets the consumer checklist |
| POST api/{programid}/Consumer/{consumerNo}/LiveInExemptionDates/{providerNo} |
Gets the live in exemption dates for the consumer provider pair |
| POST api/{programid}/Consumer/GetAddress |
Gets the consumer address |
| POST api/{programid}/Consumer/{consumerNo}/GetTimeZone |
Gets the Consumer's Timezone |
| POST api/{programid}/Consumer/EVVDate |
Gets the Consumer's EVV Effective Date |
| POST api/{programid}/Consumer/EVVUtilization |
Call to get a list of Consumer EVV Utilization Objects |
| GET api/{programid}/Consumer/{consumerNo}/EmployeeAssociations |
Returns all the records of the [Consumer Employee Assoc_] table filtered by the consumer number provided. It includes terminated associations as well, in which case the TerminationDate field won't be null. |
| GET api/{programid}/Consumer/{consumerNo}/Contacts |
Returns the consumer contacts based on the consumer number provided. |
| GET api/{programid}/Consumer/{consumerNo}/EmployeeChecklistTraining |
Returns the consumer pending training popup notifications based on the consumer number provided. |
| GET api/{programid}/Consumer/{consumerNo}/ReimbursementSettings | |
| GET api/{programid}/Consumer/{consumerNo}/GetFullName |
Returns the consumer full name (concatenaded first name and last name fields). |
| POST api/Consumer?programId={programId} | |
| POST api/Consumer/{id}?programId={programId} | |
| POST api/Consumer/InitProgram?programId={programId} |
Notification
| API | Description |
|---|---|
| PUT api/{programid}/Notification/BlockedProviderNotification |
Description : This call will help to send notification for blocked providers |
| PUT api/{programid}/SubmittedLinesApproveNotification |
Description : This call will help to send notification for approved lines |
| PUT api/{programid}/RejectLinesNotification |
Description : This call will help to send notification lines for Rejected Lines |
| POST api/Notification?programId={programId} | |
| POST api/Notification/{id}?programId={programId} | |
| POST api/Notification/InitProgram?programId={programId} |
CaseManager
| API | Description |
|---|---|
| POST api/{programid}/CaseManager/GetCaseManagerDetails |
Description : Fetching list based on filetrs |
| POST api/CaseManager?programId={programId} | |
| POST api/CaseManager/{id}?programId={programId} | |
| POST api/CaseManager/InitProgram?programId={programId} |
File
| API | Description |
|---|---|
| POST api/{programid}/File/Upload |
No documentation available. |
| POST api/{programid}/File/Delete |
No documentation available. |
| POST api/File?programId={programId} | |
| POST api/File/{id}?programId={programId} | |
| POST api/File/InitProgram?programId={programId} |
Budget
| API | Description |
|---|---|
| POST api/{programid}/Budget/GetBudgetDetails |
Description : Fetching Budget list from Consumer Budget tables |
| POST api/Budget?programId={programId} | |
| POST api/Budget/{id}?programId={programId} | |
| POST api/Budget/InitProgram?programId={programId} |
TimeEntry
| API | Description |
|---|---|
| POST api/{programid}/TimeEntry/SubmitTimeEntry |
No documentation available. |
| POST api/{programid}/TimeEntry/SaveEntries |
Creates or updates a timesheet line with a Saved status (WIP) |
| POST api/{programid}/TimeEntry/UpdatePendMessagesWIP |
Updates the pend messages related to a saved (WIP) time entry |
| POST api/{programid}/TimeEntry/DeletePendMessagesWIP |
Deletes the pend messages related to the time entry specified |
| GET api/{programid}/TimeEntry/OvernightShift/{shiftId}/Info |
No documentation available. |
| POST api/{programid}/TimeEntry/SearchLineLevelMobile |
Returns a list of time entries based on the filters provided. This function is specifically for Mobile/T4C |
| POST api/{programid}/TimeEntry/SearchTimeSheetsForRuleOverride |
Returns a list of time entries based on the filters provided. This function is specifically for Mobile/T4C |
| POST api/TimeEntry?programId={programId} | |
| POST api/TimeEntry/{id}?programId={programId} | |
| POST api/TimeEntry/InitProgram?programId={programId} |
Timesheet
This controller handles all the transactions related to timesheets
| API | Description |
|---|---|
| GET api/{programid}/Timesheets |
Search Timesheets Select one or more of the following status: S - Submitted R - Rejected A - Approved W - Saved XS - Approved with Exception XR - Rejected with Exception GOOD TO PAY - Good to Pay PAID - Paid PENDING - Pending IN PROCESS - In Process To include one status use only the code, i.e. S To include several statuses (use | as OR) i.e. S|A|GOOD TO PAY To include all statuses but some (use "less than" and "greater than" as NOT IN) i.e. (less than symbol)(greater than symbol)R|PENDING|W |
| POST api/{programid}/Timesheets/SearchWithComplexObject |
No documentation available. |
| POST api/{programid}/Timesheets/SearchTimeEntries |
Search Timesheets Select one or more of the following status: S - Submitted R - Rejected A - Approved W - Saved XS - Approved with Exception XR - Rejected with Exception GOOD TO PAY - Good to Pay PAID - Paid PENDING - Pending IN PROCESS - In Process To include one status use only the code, i.e. S To include several statuses (use | as OR) i.e. S|A|GOOD TO PAY To include all statuses but some (use "less than" and "greater than" as NOT IN) i.e. (less than symbol)(greater than symbol)R|PENDING|W |
| POST api/{programid}/Timesheets/SearchTimeEntriesIVR |
No documentation available. |
| POST api/{programid}/Timesheets/GetTimesheetEntriesWithObject | |
| POST api/{programid}/Timesheets/SearchTimeEntriesDashboard |
Retrieves all the timesheet lines for EVV Dashboard |
| POST api/{programid}/Timesheets/SearchLocDiscpTimeEntriesDashboard |
Retrieves aggregate data for Location Discrepancy Time Entries for EVV Dashboard |
| POST api/{programid}/Timesheets/RecentEarningsSnapshot |
Retrieves Recent Earnings Snapshot data for Time Entries Dashboard |
| POST api/{programid}/Timesheets/GetRecentEarningsSnapshotFilters |
Retrieves Available Filter Optionss for Recent Earnings Snapshot Dashboard |
| GET api/{programid}/Timesheets/SearchPayPeriodForConsumer |
Retrieves all the timesheet lines for EVV Dashboard |
| GET api/{programid}/Timesheets/LinesByDay/{date}/Employees/{employeeNo} |
Retrieves all the timesheet lines for the specified day, regardless of their status |
| GET api/{programid}/Timesheets/ByPayPeriod?EmployeeNo={EmployeeNo}&ConsumerNo={ConsumerNo}&PayPeriodStartDate={PayPeriodStartDate}&PayPeriodEndDate={PayPeriodEndDate}&CheckNo={CheckNo}&CategoryType={CategoryType}&TimesheetModel={TimesheetModel} |
Retrieves all the timesheet lines for the specified employee, consumer and pay period |
| GET api/{programid}/Timesheets/{timesheetNo} |
Retrieves information of the specified timesheet. Timesheet Header: General information of the timesheeet Rejection Detail: History of rejection messages Timesheet Lines: Hours and services included in the timesheet Timesheet Service Activities: List of activities by timesheet line Timesheet Line Messages: Pending messages related to the timesheet lines |
| GET api/{programid}/Timesheets/{timesheetNo}/PendHistory |
Retrieves the pend history of a specific timesheet |
| GET api/{programid}/Timesheets/PendHistory/ByPayPeriod?EmployeeNo={EmployeeNo}&ConsumerNo={ConsumerNo}&PayPeriodStartDate={PayPeriodStartDate}&PayPeriodEndDate={PayPeriodEndDate} |
Returns the |
| POST api/{programid}/Timesheets?ignoreOptionalRules={ignoreOptionalRules} |
Create a new timesheet |
| POST api/{programid}/Timesheets/Adjustment?ignoreOptionalRules={ignoreOptionalRules} |
Create an adjustment timesheet. It supports sending only the lines that are being adjusted. It creates a new timesheet that includes the reversal lines for all the time entries in the period and the lines that where adjusted. The lines that did not change will generate a net-zero (one negative line and one positive) |
| POST api/{programid}/Timesheets/Saved |
Create a new saved (WIP) timesheet |
| POST api/{programid}/Timesheets/Lines/ManualEntry?ignoreOptionalRules={ignoreOptionalRules} |
Create timesheet line (Manual entry) |
| PUT api/{programid}/Timesheets/{timesheetNo}?ignoreOptionalRules={ignoreOptionalRules} |
Updates the specified timesheet with Saved (WIP) status. |
| PUT api/{programid}/Timesheets/Saved/{timesheetNo}?ignoreOptionalRules={ignoreOptionalRules} |
Updates the specified timesheet. |
| PUT api/{programid}/Timesheets/{timesheetNo}/Lines/{lineNo}?ignoreOptionalRules={ignoreOptionalRules} |
Update timesheet line |
| PUT api/{programid}/Timesheets/{timesheetNo}/Approve |
Changes the timesheet status to approved |
| PUT api/{programid}/Timesheets/Lines/ApproveMobile |
Approves a list of timesheet lines |
| PUT api/{programid}/Timesheets/Lines/Approve |
Approves a list of timesheet lines |
| PUT api/{programid}/Timesheets/Lines/ApproveIVR |
Approves a list of timesheet lines |
| PUT api/{programid}/Timesheets/{timesheetNo}/Reject |
Changes the timesheet status to rejected |
| PUT api/{programid}/Timesheets/Lines/Reject |
Rejects a list of timesheet lines |
| DELETE api/{programid}/Timesheets/{timesheetNo} |
Deletes a timesheet. |
| DELETE api/{programid}/Timesheets/{timesheetNo}/Lines/{lineNo} |
Delete timesheet line (Cancel clock in/out entry) |
| DELETE api/{programid}/Timesheets/Evv/Lines |
No documentation available. |
| POST api/{programid}/Timesheets/Evv/Lines/Search |
No documentation available. |
| GET api/{programid}/Timesheets/Evv/Shifts/{shiftId}/TimesheetNos |
No documentation available. |
| PUT api/{programid}/Timesheets/{timesheetNo}/Deny |
No documentation available. |
| POST api/{programid}/Timesheets/ClockIn |
Telephony Clock In |
| POST api/{programid}/Timesheets/ClockOut?ignoreOptionalRules={ignoreOptionalRules} |
Telephony Clock Out |
| POST api/{programid}/Timesheets/SaveEntries |
Creates or updates a timesheet line with a Saved status (WIP) (Deprecated): Keeping this function for backwards compatibility in Time4Care old design (Mobile API v1). Please use the SaveEntries endpoint from TimeEntryController. |
| GET api/{programid}/Timesheets/AdjustmentReasons |
No documentation available. |
| GET api/{programid}/Timesheets/ManualEntryReasons |
Retrieves all Manual Entry Reasons |
| GET api/{programid}/Timesheets/RejectionReasons |
No documentation available. |
| POST api/{programid}/Timesheets/IVRManualEntryReasons |
No documentation available. |
| POST api/{programid}/Timesheets/GetTimeEntryRecurrence |
Get TimeEntry Recurrence by ID |
| POST api/{programid}/Timesheets/PTO/GetEarnedBalance |
View earned PTO balance for a speicific provider for each participant. |
| POST api/{programid}/Timesheets/PTO/GetHistory |
View PTO History for the selected participant for a provider. |
| POST api/{programid}/Timesheets/GetSickLeave |
Call to get Sick Leave data |
| POST api/{programid}/Timesheets/GetSickLeaveFilters |
Call to get Sick Leave filters |
| POST api/{programid}/Timesheets/UpdateSickLeave |
Call to update Sick Leave balances |
| POST api/{programid}/Timesheets/SaveTimeEntryRecurrence |
Creates or updates a TimeEntry Recurrence (with WIP lines) |
| POST api/{programid}/Timesheets/DeleteTimeEntryRecurrence |
Delete TimeEntry Recurrece based on ID and DateWorked passed (when DateWorked if NULL, whole Recurrences and releated WIP will be deleted) |
| POST api/Timesheet?programId={programId} | |
| POST api/Timesheet/{id}?programId={programId} | |
| POST api/Timesheet/InitProgram?programId={programId} |
ServiceGroup
| API | Description |
|---|---|
| POST api/{programid}/ServiceGroup |
No documentation available. |
| POST api/ServiceGroup?programId={programId} | |
| POST api/ServiceGroup/{id}?programId={programId} | |
| POST api/ServiceGroup/InitProgram?programId={programId} |
Authorizations
| API | Description |
|---|---|
| POST api/{programid}/Authorizations/GetAuthorizationDetails |
Description : Fetching list from Authorization Line and Authorization Line Entry Table |
| POST api/{programid}/Authorizations/AuthArchLine |
Description : Fetching list from Authorization Line and Authorization Archive Line Table |
| POST api/{programid}/Authorizations/GetAuthPaidDetails |
Descriptiom : Fetching list from Payroll Journal Line and Payroll Leadger Entry Table |
| POST api/{programid}/Authorizations/GetServiceCodesForAssociation |
Description : Fetching list of services for consumer/employee association, based on consumer authorization and allowed employee services |
| POST api/{programid}/Authorizations/CreateCase |
Description : Calling CreateCrmCase |
| POST api/{programid}/Authorizations/ConsumerUpdate |
Description : Calling Consumer/Update |
| POST api/Authorizations?programId={programId} | |
| POST api/Authorizations/{id}?programId={programId} | |
| POST api/Authorizations/InitProgram?programId={programId} |
ConsumerReimbursements
| API | Description |
|---|---|
| GET api/{programid}/ConsumerReimbursements?ConsumerNo={ConsumerNo}&TimesheetNo={TimesheetNo}&LineNo={LineNo}&FromDate={FromDate}&ToDate={ToDate}&LineStatus={LineStatus}&PageNumber={PageNumber}&RowsPerPage={RowsPerPage} |
No documentation available. |
| POST api/{programid}/ConsumerReimbursements |
No documentation available. |
| DELETE api/{programid}/ConsumerReimbursements/{timesheetNo}/{lineNo} |
No documentation available. |
| POST api/{programid}/ConsumerReimbursements/Attachments/Download |
No documentation available. |
| POST api/{programid}/ConsumerReimbursements/Attachments/Delete |
No documentation available. |
| PUT api/{programid}/ConsumerReimbursements/Lines/Reject |
No documentation available. |
| PUT api/{programid}/ConsumerReimbursements/Lines/Approve |
No documentation available. |
| POST api/ConsumerReimbursements?programId={programId} | |
| POST api/ConsumerReimbursements/{id}?programId={programId} | |
| POST api/ConsumerReimbursements/InitProgram?programId={programId} |
Employee
Decription: This API controller fetch Employee information based on search criteria.
| API | Description |
|---|---|
| POST api/{programid}/Employee |
This post method accept partially filled employee object and returns employee object with all information we have in database. |
| POST api/{programid}/Employee/EmploymentType | |
| PUT api/{programid}/Employee/Update/{employeeNo} | |
| GET api/{programid}/Employee/Mobile/{employeeNo}/{consumerNo} |
Returns the employee (provider) information for the Time4Care mobile app login |
| GET api/{programid}/Employee/{employeeNo}/ConsumerAssociations |
Returns all the records of the [Consumer Employee Assoc_] table filtered by the employee number provided. It includes terminated associations as well, in which case the TerminationDate field won't be null. |
| POST api/{programid}/Employee/{employeeNo}/SearchConsumerAssociations |
Returns all the records of the [Consumer Employee Assoc_] table filtered by the employee number provided. It includes terminated associations as well, in which case the TerminationDate field won't be null. |
| GET api/{programid}/Employee/AssociatedParticipants/{employeeNo} |
No documentation available. |
| GET api/{programid}/Employee/ServiceList |
No documentation available. |
| POST api/{programid}/Employee/PayStubYearList |
Get pay stub years for a provider. |
| POST api/{programid}/Employee/PayStubList |
Get pay stubs for a provider. |
| POST api/{programid}/Employee/PayStubContent |
Get pay stub as PDF attachment. |
| POST api/{programid}/Employee/GetPayStub |
Get pay stub as EmployeePayStubResponse class. |
| POST api/{programid}/Employee/GetLastPayStub |
Returns the most recent PayStub for a Provider |
| GET api/{programid}/Employee/GetNextPayDate |
Get Next Pay Date. |
| GET api/{programid}/Employee/{employeeNo}/GetFullName |
Returns the employee full name (concatenaded first name and last name fields) based on the employee number provided. |
| POST api/{programid}/Employee/CheckDisassociation |
Returns if the date worked is after or before disassociation |
| GET api/{programid}/Employee/{employeeNo}/Contacts |
Returns the employee contacts based on the employee number provided. |
| GET api/{programid}/Employee/{employeeNo}/ChecklistTraining |
Returns the employee pending training popup notifications based on the consumer number provided. |
| POST api/Employee?programId={programId} | |
| POST api/Employee/{id}?programId={programId} | |
| POST api/Employee/InitProgram?programId={programId} |
GeoLocation
| API | Description |
|---|---|
| POST api/GeoLocation/GetAddress |
No documentation available. |
| POST api/GeoLocation/GetLocation |
No documentation available. |
| POST api/GeoLocation?programId={programId} | |
| POST api/GeoLocation/{id}?programId={programId} | |
| POST api/GeoLocation/InitProgram?programId={programId} |
Consumer2
ProgramInformation
| API | Description |
|---|---|
| POST api/{programid}/ProgramInformation |
Description: Fetching the program information from client program and budget information |
| POST api/ProgramInformation?programId={programId} | |
| POST api/ProgramInformation/{id}?programId={programId} | |
| POST api/ProgramInformation/InitProgram?programId={programId} |
ParticipantBudget
| API | Description |
|---|---|
| POST api/{programid}/Participant/Budget/GetCategories |
Returns the budget categories available for a participant. |
| POST api/{programid}/Participant/Budget/GetPeriods |
Returns the list of periods, auth. or budget start and end dates, for a participant. Filtered to only return from a year ago to date. |
| POST api/{programid}/Participant/Budget/GetSnapshot |
Returns the participant budget snapshot based on the selected period and budget category. |
| POST api/ParticipantBudget?programId={programId} | |
| POST api/ParticipantBudget/{id}?programId={programId} | |
| POST api/ParticipantBudget/InitProgram?programId={programId} |
NVPConfig
| API | Description |
|---|---|
| POST api/{programid}/NVPConfig/GetNVPValue |
No documentation available. |
| POST api/NVPConfig?programId={programId} | |
| POST api/NVPConfig/{id}?programId={programId} | |
| POST api/NVPConfig/InitProgram?programId={programId} |
Budget2
Contains the Budget API v2
| API | Description |
|---|---|
| GET api/{programid}/v2/Budget/GetCurrentBudgetDetails/{consumerNumber} |
Retrieves the information about the current budget for a specific consumer |
| GET api/{programid}/v2/Budget/GetBillableRate/{consumerNumber}/{employeeNumber}/{serviceCode} |
Retrieves the rate information for a given employee / consumer / service |
| POST api/Budget2?programId={programId} | |
| POST api/Budget2/{id}?programId={programId} | |
| POST api/Budget2/InitProgram?programId={programId} |
UserDocument
| API | Description |
|---|---|
| POST api/{programid}/UserDocument/Add |
No documentation available. |
| POST api/{programid}/UserDocument/Search |
No documentation available. |
| POST api/{programid}/UserDocument/Delete |
No documentation available. |
| POST api/UserDocument?programId={programId} | |
| POST api/UserDocument/{id}?programId={programId} | |
| POST api/UserDocument/InitProgram?programId={programId} |
MyAccountMigration
| API | Description |
|---|---|
| POST api/{programid}/MyAccountMigration/Consumers/{pplId}/ContactInfo |
Updates consumer mobile phone and email address information. |
| POST api/{programid}/MyAccountMigration/Providers/{pplId}/ContactInfo |
Updates provider mobile phone and email address information. |
| GET api/{programid}/MyAccountMigration/RequiresContactInfoUpdate/{pplId} |
Determines whether the user (provider or consumer) requires an update of contact info |
| POST api/MyAccountMigration?programId={programId} | |
| POST api/MyAccountMigration/{id}?programId={programId} | |
| POST api/MyAccountMigration/InitProgram?programId={programId} |
| API | Description |
|---|---|
| POST api/{programid}/v2/email/sendEmail |
Sends and email through SMTP |
| POST api/Email?programId={programId} | |
| POST api/Email/{id}?programId={programId} | |
| POST api/Email/InitProgram?programId={programId} |
Service
Service related functionality
| API | Description |
|---|---|
| POST api/{programid}/Service |
No documentation available. |
| GET api/{programid}/Service/{serviceCode}/GetDescription |
Returns the service description based on a service code |
| POST api/{programid}/Service/GetDescription |
Returns the service description based on a service code |
| POST api/Service?programId={programId} | |
| POST api/Service/{id}?programId={programId} | |
| POST api/Service/InitProgram?programId={programId} |
MCOConfiguration
Configurations for MCOs
| API | Description |
|---|---|
| POST api/{programid}/McoConfig/TimesheetModel |
No documentation available. |
| POST api/{programid}/McoConfig/Configuration |
No documentation available. |
| POST api/MCOConfiguration?programId={programId} | |
| POST api/MCOConfiguration/{id}?programId={programId} | |
| POST api/MCOConfiguration/InitProgram?programId={programId} |
T4CNotifications
| API | Description |
|---|---|
| POST api/T4C/Notifications/Create |
No documentation available. |
| POST api/T4C/Notifications/CancelProvider |
No documentation available. |
| POST api/T4C/Notifications/CancelProgram |
No documentation available. |
| POST api/T4CNotifications?programId={programId} | |
| POST api/T4CNotifications/{id}?programId={programId} | |
| POST api/T4CNotifications/InitProgram?programId={programId} |
Master
| API | Description |
|---|---|
| POST api/Master?programId={programId} | |
| POST api/Master/{id}?programId={programId} | |
| POST api/Master/InitProgram?programId={programId} |